Public Member Functions
	__construct ($scheme, $userinfo, $host, $port, $path, $query, $fragment)

	getSchemeObj ($config, $context)

	isBenign ($config, $context)

	isLocal ($config, $context)

	toString ()

	validate ($config, $context)

Public Attributes
	$fragment

	$host

	$path

	$port

	$query

	$scheme

	$userinfo

Detailed Description

HTML Purifier's internal representation of a URI.

Note: Internal data-structures are completely escaped. If the data needs to be used in a non-URI context (which is very unlikely), be sure to decode it first. The URI may not necessarily be well-formed until validate() is called.

Definition at line 11 of file URI.php.

Constructor & Destructor Documentation

HTMLPurifier_URI::__construct	(	$scheme,
		$userinfo,
		$host,
		$port,
		$path,
		$query,
		$fragment
	)

Note: Automatically normalizes scheme and port

Definition at line 19 of file URI.php.

References $fragment, $host, $path, $port, $query, $scheme, and $userinfo.

Member Function Documentation

HTMLPurifier_URI::getSchemeObj	(	$config,
		$context
	)

Retrieves a scheme object corresponding to the URI's scheme/default

Parameters

$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Returns: Scheme object appropriate for validating this URI

Definition at line 35 of file URI.php.

References $config, $registry, and HTMLPurifier_URISchemeRegistry\instance().

Referenced by isBenign().

Here is the call graph for this function:

Here is the caller graph for this function:

HTMLPurifier_URI::isBenign	(	$config,
		$context
	)

Returns true if this URL should be considered a 'benign' URL, that is:

 - It is a local URL (isLocal), and
 - It has a equal or better level of security

Definition at line 225 of file URI.php.

References $config, getSchemeObj(), and isLocal().

Here is the call graph for this function:

HTMLPurifier_URI::isLocal	(	$config,
		$context
	)

Returns true if this URL might be considered a 'local' URL given the current context. This is true when the host is null, or when it matches the host supplied to the configuration.

Note that this does not do any scheme checking, so it is mostly only appropriate for metadata that doesn't care about protocol security. isBenign is probably what you actually want.

Definition at line 211 of file URI.php.

References $config.

Referenced by isBenign().

Here is the caller graph for this function:

HTMLPurifier_URI::toString ( )

Convert URI back to string

Returns: String URI appropriate for output

Definition at line 173 of file URI.php.

References $fragment, $host, $path, $port, $query, and $result.

HTMLPurifier_URI::validate	(	$config,
		$context
	)

Generic validation method applicable for all schemes. May modify this URI in order to get it into a compliant form.

Parameters

$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Returns: True if validation/filtering succeeds, false if failure

Definition at line 63 of file URI.php.

References $config.