PHP Class HTMLPurifier_URIScheme, yii

ファイルを表示 Open project: yiisoft/yii Class Usage Examples

Public Properties

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

Public Methods

Method Description
doValidate ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean Validates the components of a URI for a specific scheme.
validate ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean Public interface for validating components of a URI. Performs a bunch of default actions. Don't overload this method.

Method Details

doValidate() abstract public method

Validates the components of a URI for a specific scheme.
abstract public doValidate ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean
$uri HTMLPurifier_URI Reference to a HTMLPurifier_URI object
$config HTMLPurifier_Config
$context HTMLPurifier_Context
return boolean 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 validate ( HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context ) : boolean
$uri HTMLPurifier_URI Reference to a HTMLPurifier_URI object
$config HTMLPurifier_Config
$context HTMLPurifier_Context
return boolean success or failure

Property Details

$browsable public_oe property

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

$default_port public_oe property

Scheme's default port (integer). If an explicit port number is specified that coincides with the default port, it will be elided.
public $default_port

$hierarchical public_oe property

Whether or not the URI always uses , resolves edge cases with making relative URIs absolute
public $hierarchical

$may_omit_host public_oe property

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.
public $may_omit_host

$secure public_oe property

https is secure, http is not.
public $secure