XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
HTMLPurifier_Filter Class Reference
Inheritance diagram for HTMLPurifier_Filter:
Inheritance graph

Public Member Functions

 postFilter ($html, $config, $context)
 
 preFilter ($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 22 of file Filter.php.

Member Function Documentation

HTMLPurifier_Filter::postFilter (   $html,
  $config,
  $context 
)

Post-processor function, handles HTML after HTML Purifier

Definition at line 40 of file Filter.php.

References $html.

HTMLPurifier_Filter::preFilter (   $html,
  $config,
  $context 
)

Pre-processor function, handles HTML before HTML Purifier

Definition at line 33 of file Filter.php.

References $html.

Member Data Documentation

HTMLPurifier_Filter::$name

Name of the filter for identification purposes

Definition at line 28 of file Filter.php.


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