XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
HTMLPurifier_URIScheme Class Reference
Inheritance diagram for HTMLPurifier_URIScheme:
Inheritance graph

Public Member Functions

 doValidate (&$uri, $config, $context)
 
 validate (&$uri, $config, $context)
 

Public Attributes

 $browsable = false
 
 $default_port = null
 
 $hierarchical = false
 
 $may_omit_host = false
 
 $secure = false
 

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

Validates the components of a URI for a specific scheme.

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

Referenced by validate().

Here is the caller graph for this function:

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().

Here is the call graph for this function:

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.

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.

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

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.

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.

Definition at line 26 of file URIScheme.php.


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