HTMLPurifier 4.4.0
HTMLPurifier_URIScheme Class Reference

Validator for the components of a URI for a specific scheme. More...

Inheritance diagram for HTMLPurifier_URIScheme:
HTMLPurifier_URIScheme_data HTMLPurifier_URIScheme_data HTMLPurifier_URIScheme_file HTMLPurifier_URIScheme_file HTMLPurifier_URIScheme_ftp HTMLPurifier_URIScheme_ftp HTMLPurifier_URIScheme_http HTMLPurifier_URIScheme_http HTMLPurifier_URIScheme_mailto HTMLPurifier_URIScheme_mailto HTMLPurifier_URIScheme_news HTMLPurifier_URIScheme_news HTMLPurifier_URIScheme_nntp HTMLPurifier_URIScheme_nntp

List of all members.

Public Member Functions

 doValidate (&$uri, $config, $context)
 Validates the components of a URI for a specific scheme.
 validate (&$uri, $config, $context)
 Public interface for validating components of a URI.
 doValidate (&$uri, $config, $context)
 Validates the components of a URI for a specific scheme.
 validate (&$uri, $config, $context)
 Public interface for validating components of a URI.

Public Attributes

 $default_port = null
 Scheme's default port (integer).
 $browsable = false
 Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.
 $secure = false
 Whether or not data transmitted over this scheme is encrypted.
 $hierarchical = false
 Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute.
 $may_omit_host = false
 Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

Detailed Description

Validator for the components of a URI for a specific scheme.

Definition at line 6 of file URIScheme.php.


Member Function Documentation

HTMLPurifier_URIScheme::doValidate ( &$  uri,
config,
context 
) [abstract]
HTMLPurifier_URIScheme::doValidate ( &$  uri,
config,
context 
) [abstract]
HTMLPurifier_URIScheme::validate ( &$  uri,
config,
context 
)

Public interface for validating components of a URI.

Performs a bunch of default actions. Don't overload this method.

Parameters:
$uriReference to a HTMLPurifier_URI object
$configHTMLPurifier_Config object
$contextHTMLPurifier_Context object
Returns:
Bool success or failure

Definition at line 7650 of file HTMLPurifier.standalone.php.

References $config, and doValidate().

HTMLPurifier_URIScheme::validate ( &$  uri,
config,
context 
)

Public interface for validating components of a URI.

Performs a bunch of default actions. Don't overload this method.

Parameters:
$uriReference to a HTMLPurifier_URI object
$configHTMLPurifier_Config object
$contextHTMLPurifier_Context object
Returns:
Bool success or failure

Definition at line 58 of file URIScheme.php.

References $config, and doValidate().


Member Data Documentation

HTMLPurifier_URIScheme::$browsable = false

Whether or not URIs of this schem are locatable by a browser http and ftp are accessible, while mailto and news are not.

Reimplemented in HTMLPurifier_URIScheme_data, HTMLPurifier_URIScheme_file, HTMLPurifier_URIScheme_ftp, HTMLPurifier_URIScheme_http, HTMLPurifier_URIScheme_mailto, HTMLPurifier_URIScheme_news, and HTMLPurifier_URIScheme_nntp.

Definition at line 20 of file URIScheme.php.

HTMLPurifier_URIScheme::$default_port = null

Scheme's default port (integer).

If an explicit port number is specified that coincides with the default port, it will be elided.

Reimplemented in HTMLPurifier_URIScheme_ftp, HTMLPurifier_URIScheme_http, HTMLPurifier_URIScheme_https, and HTMLPurifier_URIScheme_nntp.

Definition at line 14 of file URIScheme.php.

HTMLPurifier_URIScheme::$hierarchical = false

Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute.

Reimplemented in HTMLPurifier_URIScheme_ftp, and HTMLPurifier_URIScheme_http.

Definition at line 32 of file URIScheme.php.

HTMLPurifier_URIScheme::$may_omit_host = false

Whether or not the URI may omit a hostname when the scheme is explicitly specified, ala file:///path/to/file.

As of writing, 'file' is the only scheme that browsers support his properly.

Reimplemented in HTMLPurifier_URIScheme_data, HTMLPurifier_URIScheme_file, HTMLPurifier_URIScheme_mailto, and HTMLPurifier_URIScheme_news.

Definition at line 39 of file URIScheme.php.

HTMLPurifier_URIScheme::$secure = false

Whether or not data transmitted over this scheme is encrypted.

https is secure, http is not.

Reimplemented in HTMLPurifier_URIScheme_https.

Definition at line 26 of file URIScheme.php.


The documentation for this class was generated from the following files: