Class HTMLPurifier_URI

All Classes | Properties | Methods
InheritanceHTMLPurifier_URI

HTML Purifier's internal representation of a URI.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$fragment HTMLPurifier_URI
$host HTMLPurifier_URI
$path HTMLPurifier_URI
$port HTMLPurifier_URI
$query HTMLPurifier_URI
$scheme HTMLPurifier_URI
$userinfo HTMLPurifier_URI

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() HTMLPurifier_URI
getSchemeObj() Retrieves a scheme object corresponding to the URI's scheme/default HTMLPurifier_URI
isBenign() Returns true if this URL should be considered a 'benign' URL, that is: HTMLPurifier_URI
isLocal() 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. HTMLPurifier_URI
toString() Convert URI back to string HTMLPurifier_URI
validate() Generic validation method applicable for all schemes. May modify this URI in order to get it into a compliant form. HTMLPurifier_URI

Property Details

$fragment public property
public $fragment = null
$host public property
public $host = null
$path public property
public $path = null
$port public property
public $port = null
$query public property
public $query = null
$scheme public property
public $scheme = null
$userinfo public property
public $userinfo = null

Method Details

__construct() public method

public void __construct ( $scheme, $userinfo, $host, $port, $path, $query, $fragment )
$scheme string
$userinfo string
$host string
$port int
$path string
$query string
$fragment string
getSchemeObj() public method

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

public HTMLPurifier_URIScheme getSchemeObj ( $config, $context )
$config HTMLPurifier_Config
$context HTMLPurifier_Context
return HTMLPurifier_URIScheme

Scheme object appropriate for validating this URI
isBenign() public method

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
public bool isBenign ( $config, $context )
$config HTMLPurifier_Config
$context HTMLPurifier_Context
isLocal() public method

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.

public bool isLocal ( $config, $context )
$config HTMLPurifier_Config
$context HTMLPurifier_Context
toString() public method

Convert URI back to string

public string toString ( )
return string

URI appropriate for output
validate() public method

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

public bool validate ( $config, $context )
$config HTMLPurifier_Config
$context HTMLPurifier_Context
return bool

True if validation/filtering succeeds, false if failure