Cheetah
Public Member Functions | Public Attributes | List of all members
HTMLPurifier_Filter Class Reference
Inheritance diagram for HTMLPurifier_Filter:
HTMLPurifier_Filter_AddChLinksClass HTMLPurifier_Filter_ExtractStyleBlocks HTMLPurifier_Filter_LocalIframe HTMLPurifier_Filter_LocalMovie HTMLPurifier_Filter_YouTube HTMLPurifier_Filter_YoutubeIframe

Public Member Functions

 preFilter ($html, $config, $context)
 
 postFilter ($html, $config, $context)
 

Public Attributes

 $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

Definition at line 5133 of file HTMLPurifier.standalone.php.

Member Function Documentation

◆ postFilter()

HTMLPurifier_Filter::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_LocalIframe, HTMLPurifier_Filter_YoutubeIframe, HTMLPurifier_Filter_YouTube, and HTMLPurifier_Filter_LocalMovie.

Definition at line 5161 of file HTMLPurifier.standalone.php.

◆ preFilter()

HTMLPurifier_Filter::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_LocalIframe, HTMLPurifier_Filter_AddChLinksClass, HTMLPurifier_Filter_YoutubeIframe, HTMLPurifier_Filter_YouTube, HTMLPurifier_Filter_LocalMovie, and HTMLPurifier_Filter_ExtractStyleBlocks.

Definition at line 5149 of file HTMLPurifier.standalone.php.

Member Data Documentation

◆ $name

HTMLPurifier_Filter::$name

Name of the filter for identification purposes. @type string

Definition at line 5140 of file HTMLPurifier.standalone.php.


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