\HTMLPurifier_URIFilter_Munge

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)

Summary

Methods
Properties
Constants
prepare()
filter()
$name
$post
$always_load
No constants found
makeReplace()
$replace
N/A
No private methods found
$target
$parser
$doEmbed
$secretKey
N/A

Properties

$name

$name

Unique identifier of filter.

$post

$post

True if this filter should be run after scheme validation.

$always_load

$always_load

True if this filter should always be loaded.

This permits a filter to be named Foo without the corresponding %URI.Foo directive existing.

$replace

$replace

$target

$target

$parser

$parser

$doEmbed

$doEmbed

$secretKey

$secretKey

Methods

prepare()

prepare(\HTMLPurifier_Config  $config) : bool

Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.

Parameters

\HTMLPurifier_Config $config

Returns

bool —

filter()

filter(\HTMLPurifier_URI  $uri, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : bool

Filter a URI object

Parameters

\HTMLPurifier_URI $uri
\HTMLPurifier_Config $config
\HTMLPurifier_Context $context

Returns

bool —

makeReplace()

makeReplace(\HTMLPurifier_URI  $uri, \HTMLPurifier_Config  $config, \HTMLPurifier_Context  $context) : mixed

Parameters

\HTMLPurifier_URI $uri
\HTMLPurifier_Config $config
\HTMLPurifier_Context $context

Returns

mixed —