abstract |
|---|
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:
| Methods | ||||
|---|---|---|---|---|
public
|
prepare(HTMLPurifier_Config $config): bool
Performs initialization for the filter. If the filter returns
false, this means that it shouldn't be considered active.
Performs initialization for the filter. If the filter returns false, this means that it shouldn't be considered active. Overriden by |
# | ||
abstract
public
|
filter(HTMLPurifier_URI &$uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context): bool
Filter a URI object
Filter a URI object Parameters
ReturnsWhether 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 Implemented by |
# | ||
| Properties | |||
|---|---|---|---|
public
|
|
$name
Unique identifier of filter.
Unique identifier of filter. |
# |
public
|
|
$post = false
True if this filter should be run after scheme validation.
True if this filter should be run after scheme validation. |
# |
public
|
|
$always_load = false
True if this filter should always be loaded.
This permits a filter to be named Foo without the corresponding
%URI.Foo…
True if this filter should always be loaded. This permits a filter to be named Foo without the corresponding %URI.Foo directive existing. |
# |