Docs For Class HTMLPurifier_Filter

Class HTMLPurifier_Filter_YouTube

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.

Located in /lib/core/Parsers/htmlpurifier/standalone/HTMLPurifier/Filter/YouTube.php (line 3)

HTMLPurifier_Filter
   |
   --HTMLPurifier_Filter_YouTube

Variable Summary

mixed $name

Method Summary

void armorUrl ( $url)

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

void postFilterCallback ( $matches)

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

Variables

mixed $name = 'YouTube' (line 6)

access: public

Redefinition of:

HTMLPurifier_Filter::$name: Name of the filter for identification purposes

Methods

armorUrl (line 20)

access: protected

void armorUrl ( $url)

$url

postFilter (line 15)

access: public

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

$html
$config
$context

Redefinition of:

HTMLPurifier_Filter::postFilter(): Post-processor function, handles HTML after HTML Purifier

postFilterCallback (line 24)

access: protected

void postFilterCallback ( $matches)

$matches

preFilter (line 8)

access: public

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

$html
$config
$context

Redefinition of:

HTMLPurifier_Filter::preFilter(): Pre-processor function, handles HTML before HTML Purifier

Inherited Methods

Inherited From HTMLPurifier_Filter

HTMLPurifier_Filter::postFilter()
HTMLPurifier_Filter::preFilter()

Documentation generated on Sun, 06 Mar 2011 00:25:24 -0500 by phpDocumentor 1.4.3