Inheritance diagram for HTMLPurifier_Filter:

Public Member Functions
	preFilter ($html, $config, $context)

	postFilter ($html, $config, $context)

Data Fields
	$name

Detailed Description

Represents a pre or post processing filter on HTML Purifier's output

Sometimes, a little ad-hoc fixing of HTML has to be done before it gets sent through HTML Purifier: you can use filters to acheive this effect. For instance, YouTube videos can be preserved using this manner. You could have used a decorator for this task, but PHP's support for them is not terribly robust, so we're going to just loop through the filters.

Filters should be exited first in, last out. If there are three filters, named 1, 2 and 3, the order of execution should go 1->preFilter, 2->preFilter, 3->preFilter, purify, 3->postFilter, 2->postFilter, 1->postFilter.

Note: Methods are not declared abstract as it is perfectly legitimate for an implementation not to want anything to happen on a step

Member Function Documentation

◆ postFilter()

postFilter	(	$html,
		$config,
		$context
	)

Post-processor function, handles HTML after HTML Purifier

Parameters

string	$html
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: string

Reimplemented in HTMLPurifier_Filter_YouTube.

◆ preFilter()

preFilter	(	$html,
		$config,
		$context
	)

Pre-processor function, handles HTML before HTML Purifier

Parameters

string	$html
HTMLPurifier_Config	$config
HTMLPurifier_Context	$context

Returns: string

Reimplemented in HTMLPurifier_Filter_ExtractStyleBlocks, and HTMLPurifier_Filter_YouTube.

Field Documentation

◆ $name

$name

Name of the filter for identification purposes. @type string

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

C:/xoops2511b2/htdocs/xoops_lib/modules/protector/library/HTMLPurifier/Filter.php