HTMLPurifier_URI
in package
HTML Purifier's internal representation of a URI.
Tags
Table of Contents
Properties
- $fragment : mixed
- $host : mixed
- $path : mixed
- $port : mixed
- $query : mixed
- $scheme : mixed
- $userinfo : mixed
Methods
- __construct() : mixed
- getSchemeObj() : HTMLPurifier_URIScheme
- Retrieves a scheme object corresponding to the URI's scheme/default
- isBenign() : bool
- Returns true if this URL should be considered a 'benign' URL, that is:
- isLocal() : bool
- 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.
- toString() : string
- Convert URI back to string
- validate() : bool
- Generic validation method applicable for all schemes. May modify this URI in order to get it into a compliant form.
Properties
$fragment
public
mixed
$fragment
Tags
$host
public
mixed
$host
Tags
$path
public
mixed
$path
Tags
$port
public
mixed
$port
Tags
$query
public
mixed
$query
Tags
$scheme
public
mixed
$scheme
Tags
$userinfo
public
mixed
$userinfo
Tags
Methods
__construct()
public
__construct(string $scheme, string $userinfo, string $host, int $port, string $path, string $query, string $fragment) : mixed
Parameters
- $scheme : string
- $userinfo : string
- $host : string
- $port : int
- $path : string
- $query : string
- $fragment : string
Tags
getSchemeObj()
Retrieves a scheme object corresponding to the URI's scheme/default
public
getSchemeObj(HTMLPurifier_Config $config, HTMLPurifier_Context $context) : HTMLPurifier_URIScheme
Parameters
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
HTMLPurifier_URIScheme —Scheme object appropriate for validating this URI
isBenign()
Returns true if this URL should be considered a 'benign' URL, that is:
public
isBenign(HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
- It is a local URL (isLocal), and
- It has a equal or better level of security
Parameters
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
boolisLocal()
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.
public
isLocal(HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
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
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
booltoString()
Convert URI back to string
public
toString() : string
Return values
string —URI appropriate for output
validate()
Generic validation method applicable for all schemes. May modify this URI in order to get it into a compliant form.
public
validate(HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
Parameters
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
bool —True if validation/filtering succeeds, false if failure