HTMLPurifier_URIScheme Class Reference

Inheritance diagram for HTMLPurifier_URIScheme:

Public Member Functions
	doValidate (&$uri, $config, $context)
	validate (&$uri, $config, $context)

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

Detailed Description

Validator for the components of a URI for a specific scheme

Member Function Documentation

doValidate()

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

abstract

Validates the components of a URI for a specific scheme.

Parameters

HTMLPurifier_URI	$uri	Reference to a HTMLPurifier_URI object
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool success or failure

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

Here is the caller graph for this function:

validate()

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

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

Parameters

HTMLPurifier_URI	$uri	Reference to a HTMLPurifier_URI object
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns

bool success or failure

Here is the call graph for this function:

Field Documentation

$browsable

$browsable = false

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

$default_port

$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. @type int

$hierarchical

$hierarchical = false

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

$may_omit_host

$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. @type bool

$secure

$secure = false

Whether or not data transmitted over this scheme is encrypted. https is secure, http is not. @type bool

---

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

• C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/URIScheme.php