lib/htmlpurifier/HTMLPurifier/Filter.php

   1 <?php
   2
   3 /**
   4  * Represents a pre or post processing filter on HTML Purifier's output
   5  *
   6  * Sometimes, a little ad-hoc fixing of HTML has to be done before
   7  * it gets sent through HTML Purifier: you can use filters to acheive
   8  * this effect. For instance, YouTube videos can be preserved using
   9  * this manner. You could have used a decorator for this task, but
  10  * PHP's support for them is not terribly robust, so we're going
  11  * to just loop through the filters.
  12  *
  13  * Filters should be exited first in, last out. If there are three filters,
  14  * named 1, 2 and 3, the order of execution should go 1->preFilter,
  15  * 2->preFilter, 3->preFilter, purify, 3->postFilter, 2->postFilter,
  16  * 1->postFilter.
  17  */
  18
  19 class HTMLPurifier_Filter
  20 {
  21
  22     /**
  23      * Name of the filter for identification purposes
  24      */
  25     var $name;
  26
  27     /**
  28      * Pre-processor function, handles HTML before HTML Purifier
  29      */
  30     function preFilter($html, $config, &$context) {}
  31
  32     /**
  33      * Post-processor function, handles HTML after HTML Purifier
  34      */
  35     function postFilter($html, $config, &$context) {}
  36
  37 }
  38