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
	$hierarchical = false
	$may_omit_host = 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

doValidate	(	&$	uri,
		$	config,
		$	context
	)		[abstract]

Validates the components of a URI for a specific scheme.

Parameters:

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

Returns:

Bool success or failure

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

Here is the caller graph for this function:

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

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

Parameters:

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

Returns:

Bool success or failure

Definition at line 52 of file URIScheme.php.

Here is the call graph for this function:

---

Field Documentation

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

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

Definition at line 20 of file URIScheme.php.

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

Reimplemented in HTMLPurifier_URIScheme_ftp, HTMLPurifier_URIScheme_http, HTMLPurifier_URIScheme_https, and HTMLPurifier_URIScheme_nntp.

Definition at line 14 of file URIScheme.php.

$hierarchical = false

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

Reimplemented in HTMLPurifier_URIScheme_ftp, and HTMLPurifier_URIScheme_http.

Definition at line 26 of file URIScheme.php.

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

Reimplemented in HTMLPurifier_URIScheme_data, HTMLPurifier_URIScheme_file, HTMLPurifier_URIScheme_mailto, and HTMLPurifier_URIScheme_news.

Definition at line 33 of file URIScheme.php.

---

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

• C:/xampp/htdocs/moodle/lib/htmlpurifier/HTMLPurifier/URIScheme.php