XHTMLCompiler/TextFilter.php

   1 <?php
   2
   3 /**
   4  * Represents a filter that performs processing on documents. Read-only.
   5  */
   6 abstract class XHTMLCompiler_TextFilter extends XHTMLCompiler_Filter
   7 {
   8
   9     /**
  10      * Defines a filter that processes string text.
  11      * @param $text String text to process
  12      * @param $page XHTMLCompiler_Page object representing the context
  13      * @param $manager Currently running XHTMLCompiler_FilterManager
  14      * @return Processed string text
  15      * @note These filters should be used sparingly, only when a DOM
  16      *       solution would not work.
  17      */
  18     abstract public function process($text, $page, $manager);
  19
  20 }