Abstract Class HTMLPurifier_URIFilter
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)
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$always_load | True if this filter should always be loaded. | HTMLPurifier_URIFilter | |
$name | Unique identifier of filter. | HTMLPurifier_URIFilter | |
$post | True if this filter should be run after scheme validation. | HTMLPurifier_URIFilter |
Public Methods
Method | Description | Defined By |
---|---|---|
filter() | Filter a URI object | HTMLPurifier_URIFilter |
prepare() | Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active. | HTMLPurifier_URIFilter |
Property Details
This permits a filter to be named Foo without the corresponding %URI.Foo directive existing.
Method Details
Filter a URI object
public abstract bool filter ( <b>&</b>$uri, $config, $context ) | ||
$uri | HTMLPurifier_URI | Reference to URI object variable |
$config | HTMLPurifier_Config | |
$context | HTMLPurifier_Context | |
return | bool | Whether or not to continue processing: false indicates
|
---|
Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active.
public bool prepare ( $config ) | ||
$config | HTMLPurifier_Config |