ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
HTMLPurifier_URIScheme Class Reference

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

+ Inheritance diagram for HTMLPurifier_URIScheme:
+ Collaboration diagram for HTMLPurifier_URIScheme:

Public Member Functions

 validate (&$uri, $config, $context)
 Validates the components of a URI.

Data Fields

 $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.
 $hierarchical = false
 Whether or not the URI always uses <hier_part>, resolves edge cases with making relative URIs absolute.

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::validate ( $uri,
  $config,
  $context 
)

Validates the components of a URI.

Note
This implementation should be called by children if they define a default port, as it does port processing.
Parameters
$uriInstance of HTMLPurifier_URI
$configHTMLPurifier_Config object
$contextHTMLPurifier_Context object
Returns
Bool success or failure

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

Definition at line 35 of file URIScheme.php.

{
if ($this->default_port == $uri->port) $uri->port = null;
return true;
}

Field 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.

Definition at line 18 of file URIScheme.php.

HTMLPurifier_URIScheme::$default_port = null

Scheme's default port (integer)

Definition at line 12 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.

Definition at line 24 of file URIScheme.php.


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