portal/patient/fwk/libs/savant/Savant3/Filter.php

   1 <?php
   2
   3 /**
   4  *
   5  * Abstract Savant3_Filter class.
   6  *
   7  * @package Savant3
   8  *
   9  * @author Paul M. Jones <pmjones@ciaweb.net>
  10  *
  11  * @license http://www.gnu.org/copyleft/lesser.html LGPL
  12  *
  13  * @version $Id: Filter.php,v 1.5 2005/04/29 16:23:50 pmjones Exp $
  14  *
  15  */
  16
  17 /**
  18  *
  19  * Abstract Savant3_Filter class.
  20  *
  21  * You have to extend this class for it to be useful; e.g., "class
  22  * Savant3_Filter_example extends Savant3_Filter".
  23  *
  24  * @package Savant3
  25  *
  26  * @author Paul M. Jones <pmjones@ciaweb.net>
  27  *
  28  *
  29  */
  30 abstract class Savant3_Filter
  31 {
  32
  33     /**
  34      *
  35      * Optional reference to the calling Savant object.
  36      *
  37      * @access protected
  38      *
  39      * @var object
  40      *
  41      */
  42     protected $Savant = null;
  43
  44     /**
  45      *
  46      * Constructor.
  47      *
  48      * @access public
  49      *
  50      * @param array $conf
  51      *          An array of configuration keys and values for
  52      *          this filter.
  53      *
  54      * @return void
  55      *
  56      */
  57     public function __construct($conf = null)
  58     {
  59         settype($conf, 'array');
  60         foreach ($conf as $key => $val) {
  61             $this->$key = $val;
  62         }
  63     }
  64
  65     /**
  66      *
  67      * Stub method for extended behaviors.
  68      *
  69      * @access public
  70      *
  71      * @param string $text
  72      *          The text buffer to filter.
  73      *
  74      * @return string The text buffer after it has been filtered.
  75      *
  76      */
  77     public static function filter($text)
  78     {
  79         return $text;
  80     }
  81 }