Chainable filters for custom URI processing. More...

Inheritance diagram for HTMLPurifier_URIFilter:

Collaboration diagram for HTMLPurifier_URIFilter:

Public Member Functions
	prepare ($config)
	Performs initialization for the filter.
	filter (&$uri, $config, $context)
	Filter a URI object.

Data Fields
	$name
	Unique identifier of filter.
	$post = false
	True if this filter should be run after scheme validation.

Detailed Description

Chainable filters for custom URI processing.

These filters can perform custom actions on a URI filter object, including transformation or blacklisting.

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.

Definition at line 14 of file URIFilter.php.

Member Function Documentation

HTMLPurifier_URIFilter::filter	(	&	$uri,
			$config,
			$context
	)

abstract

Filter a URI object.

Parameters

$uri	Reference to URI object variable
$config	Instance of HTMLPurifier_Config
$context	Instance of HTMLPurifier_Context

Returns: bool 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

HTMLPurifier_URIFilter::prepare ( $config )

Performs initialization for the filter.

Definition at line 30 of file URIFilter.php.

{return true;}

HTMLPurifier_URIFilter::$name

Unique identifier of filter.

Definition at line 20 of file URIFilter.php.

HTMLPurifier_URIFilter::$post = false

True if this filter should be run after scheme validation.

Definition at line 25 of file URIFilter.php.

The documentation for this class was generated from the following file: