PHPTAL-NP-0.7.0/libs/PHPTAL/Filter.php

   1 <?php
   2
   3 define('PHPTAL_PRE_FILTER', 1);
   4 define('PHPTAL_POST_FILTER', 2);
   5
   6 /**
   7  * Interface for source filter.
   8  *
   9  * This interface may be used to implement input / output filters.
  10  *
  11  * If the template intermediate php code is up to date, pre filters won't be
  12  * used on it.
  13  *
  14  * Output filters are only called on main template result.
  15  *
  16  *
  17  * <?
  18  * class MyFilter extends PHPTAL_Filter
  19  * {
  20  *     function filter(&$tpl, $data, $mode)
  21  *     {
  22  *         // just to present $mode usage for input/output filters
  23  *         if ($mode == PHPTAL_POST_FILTER) {
  24  *             return PEAR::raiseError("MyFilter mustn't be used as a pre-filter');
  25  *         }
  26  *
  27  *         // remove html comments from template source
  28  *         return preg_replace('/(<\!--.*?-->)/sm', '', $data);
  29  *     }
  30  * }
  31  *
  32  * $tpl = PHPTAL('mytemplate.html');
  33  * $tpl->addInputFilter( new MyFilter() );
  34  * echo $tpl->execute();
  35  *
  36  * ?>
  37  *
  38  * @author    Laurent Bedubourg <laurent.bedubourg@free.fr>
  39  */
  40 class PHPTAL_Filter
  41 {
  42     /**
  43      * Filter some template source string.
  44      *
  45      * @param PHPTAL_Template $tpl
  46      *        The template which invoked this filter.
  47      *
  48      * @param string $data
  49      *        Data to filter.
  50      *
  51      * @param int $mode
  52      *        PHPTAL_PRE_FILTER | PHPTAL_POST_FILTER depending if this filter
  53      *        is registered as a pre-filter or as a post-filter.
  54      *
  55      */
  56     function filter(&$tpl, $data, $mode)
  57     {
  58         return $data;
  59     }
  60 }
  61
  62 ?>