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

	getSchemeObj ($config, $context)

	validate ($config, $context)

	toString ()

	isLocal ($config, $context)

	isBenign ($config, $context)

Public Attributes
	$scheme

	$userinfo

	$host

	$port

	$path

	$query

	$fragment

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 8871 of file HTMLPurifier.standalone.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$scheme
string	$userinfo
string	$host
int	$port
string	$path
string	$query
string	$fragment

Note: Automatically normalizes scheme and port

Definition at line 8918 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ getSchemeObj()

HTMLPurifier_URI::getSchemeObj	(	$config,
		$context
	)

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

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: HTMLPurifier_URIScheme Scheme object appropriate for validating this URI

Definition at line 8935 of file HTMLPurifier.standalone.php.

◆ isBenign()

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

Parameters

HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: bool

Definition at line 9155 of file HTMLPurifier.standalone.php.

◆ isLocal()

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.

Parameters