HTMLPurifier_URIFilter_Munge
extends 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)
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.
- $replace : mixed
- $doEmbed : mixed
- $parser : mixed
- $secretKey : mixed
- $target : mixed
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.
- makeReplace() : mixed
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
= 'Munge'
Tags
$post
True if this filter should be run after scheme validation.
public
mixed
$post
= \true
Tags
$replace
protected
mixed
$replace
= array()
Tags
$doEmbed
private
mixed
$doEmbed
Tags
$parser
private
mixed
$parser
Tags
$secretKey
private
mixed
$secretKey
Tags
$target
private
mixed
$target
Tags
Methods
filter()
Filter a URI object
public
filter(HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : bool
Parameters
- $uri : HTMLPurifier_URI
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context
Return values
boolprepare()
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
Return values
boolmakeReplace()
protected
makeReplace(HTMLPurifier_URI $uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context) : mixed
Parameters
- $uri : HTMLPurifier_URI
- $config : HTMLPurifier_Config
- $context : HTMLPurifier_Context