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)

Direct known subclasses

HTMLPurifier_URIFilter_DisableExternal, HTMLPurifier_URIFilter_DisableResources, HTMLPurifier_URIFilter_HostBlacklist, HTMLPurifier_URIFilter_MakeAbsolute, HTMLPurifier_URIFilter_Munge, HTMLPurifier_URIFilter_SafeIframe

Indirect known subclasses

HTMLPurifier_URIFilter_DisableExternalResources

Abstract
Warning: This filter is called before scheme object validation occurs. Make sure, if you require a specific scheme object, you you check that it exists. This allows filters to convert proprietary URI schemes into regular ones.
Located at x2engine/framework/vendors/htmlpurifier/HTMLPurifier.standalone.php

Methods summary
`public boolean`	# `prepare( HTMLPurifier_Config $config )` 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. Parameters `$config` `HTMLPurifier_Config` $config Returns `boolean`
`abstract public boolean`	# `filter( HTMLPurifier_URI & $uri, HTMLPurifier_Config $config, HTMLPurifier_Context $context )` Filter a URI object Filter a URI object Parameters `$uri` `HTMLPurifier_URI` $uri Reference to URI object variable `$config` `HTMLPurifier_Config` $config `$context` `HTMLPurifier_Context` $context Returns `boolean` 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

Properties summary
`public mixed`	`$name`		# Unique identifier of filter. Unique identifier of filter. Type string
`public boolean`	`$post`	`false`	# True if this filter should be run after scheme validation. True if this filter should be run after scheme validation. Type bool
`public boolean`	`$always_load`	`false`	# True if this filter should always be loaded. This permits a filter to be named Foo without the corresponding %URI.Foo directive existing. True if this filter should always be loaded. This permits a filter to be named Foo without the corresponding %URI.Foo directive existing. Type bool

Packages

Classes

Interfaces

Exceptions

Functions

Class HTMLPurifier_URIFilter

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Type

Type

Type