Source for file Filter.class.php

Documentation is available at Filter.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Filter
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Filter Interface
  22.  * 
  23.  * A Filter is responsible for removing certain parts of supplied data, returning
  24.  * the changed data.  The Library provides a Blank Filter.  This will simply
  25.  * return the data as it's passed.
  26.  * 
  27.  * A single Filter will be responsible for performing a specific Filtering task.  If
  28.  * data needs to remove HTML tags, then use the Filter_Tags class.  The Library
  29.  * provides a default set of Filters, however more can be created.  Simply create
  30.  * a class that implements the Filter Interface.  If adding to the Library, place
  31.  * the Filter inside the 'gumbo/filter/*' directory, supplying a unique name.
  32.  *
  33.  * @category Gumbo
  34.  * @package Filter
  35.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  36.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  37.  * @author Michael Luster <mluster79@yahoo.com>
  38.  * @link http://sourceforge.net/projects/phpgumbo
  39.  * @desc Filter Interface
  40.  * @version 0.0.1
  41.  */
  42.  
  43. interface Gumbo_Interface_Filter {
  44.     
  45.     /**
  46.      * Runs the Filter process, returning the results
  47.      * @param mixed $data data to filter
  48.      * @return mixed 
  49.      */
  50.     public function run ($data);
  51.     
  52. }
  53.  
  54. ?>