HTMLPurifier_URIFilter
in package
Chainable filters for custom URI processing.
These filters can perform custom actions on a URI filter object, including transformation or blacklisting. A filter named Foo must have a corresponding configuration directive %URI.Foo, unless always_load is specified to be true.
The following contexts may be available while URIFilters are being processed:
- EmbeddedURI: true if URI is an embedded resource that will
be loaded automatically on page load
- CurrentToken: a reference to the token that is currently
being processed
- CurrentAttr: the name of the attribute that is currently being
processed
- CurrentCSSProperty: the name of the CSS property that is
currently being processed (if applicable)
Tags
Table of Contents
Properties
- $always_load : mixed
- True if this filter should always be loaded.
- $name : mixed
- Unique identifier of filter.
- $post : mixed
- True if this filter should be run after scheme validation.
Methods
- filter() : bool
- Filter a URI object
- prepare() : bool
- Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.
Properties
$always_load
True if this filter should always be loaded.
public
mixed
$always_load
= \false
This permits a filter to be named Foo without the corresponding %URI.Foo directive existing.
Tags
$name
Unique identifier of filter.
public
mixed
$name
Tags
$post
True if this filter should be run after scheme validation.
public
mixed
$post
= \false
Tags
Methods
filter()
Filter a URI object
public
abstract filter(HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
Parameters
- $uri : HTMLPurifier_URI
-
Reference to URI object variable
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
bool —Whether or not to continue processing: false indicates URL is no good, true indicates continue processing. Note that all changes are committed directly on the URI object
prepare()
Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.
public
prepare(HTMLPurifier_Config $config) : bool
Parameters
- $config : HTMLPurifier_Config