Abstract Class HTMLPurifier_URIScheme

InheritanceHTMLPurifier_URIScheme

Validator for the components of a URI for a specific scheme

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$browsable Whether or not URIs of this scheme are locatable by a browser http and ftp are accessible, while mailto and news are not. HTMLPurifier_URIScheme
$default_port Scheme's default port (integer). If an explicit port number is specified that coincides with the default port, it will be elided. HTMLPurifier_URIScheme
$hierarchical Whether or not the URI always uses , resolves edge cases with making relative URIs absolute HTMLPurifier_URIScheme
$may_omit_host 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. HTMLPurifier_URIScheme
$secure Whether or not data transmitted over this scheme is encrypted. HTMLPurifier_URIScheme

Public Methods

Hide inherited methods

MethodDescriptionDefined By
doValidate() Validates the components of a URI for a specific scheme. HTMLPurifier_URIScheme
validate() Public interface for validating components of a URI. Performs a bunch of default actions. Don't overload this method. HTMLPurifier_URIScheme

Property Details

$browsable public property
public $browsable false
$default_port public property
public $default_port null
$hierarchical public property
public $hierarchical false
$may_omit_host public property
public $may_omit_host false
$secure public property

https is secure, http is not.

public $secure false

Method Details

doValidate() public abstract method

Validates the components of a URI for a specific scheme.

public abstract bool doValidate ( <b>&</b>$uri, $config, $context )
$uri HTMLPurifier_URI

Reference to a HTMLPurifier_URI object

$config HTMLPurifier_Config
$context HTMLPurifier_Context
return bool

Success or failure

validate() public method

Public interface for validating components of a URI. Performs a bunch of default actions. Don't overload this method.

public bool validate ( <b>&</b>$uri, $config, $context )
$uri HTMLPurifier_URI

Reference to a HTMLPurifier_URI object

$config HTMLPurifier_Config
$context HTMLPurifier_Context
return bool

Success or failure