ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Filter.php

Documentation is available at Filter.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Filter
  23.  * @package    ForwardFW
  24.  * @subpackage Main
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009,2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.1
  31.  */
  32.  
  33. /**
  34.  * This abstract class needs to be extended to be a callable filter.
  35.  *
  36.  * @category   Filter
  37.  * @package    ForwardFW
  38.  * @subpackage Main
  39.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  40.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  41.  * @link       http://forwardfw.sourceforge.net
  42.  */
  43. abstract class ForwardFW_Filter
  44. {
  45.     /**
  46.      * Child filter that should be executed after your Incoming process.
  47.      *
  48.      * @var ForwardFW_Filter 
  49.      */
  50.     protected $child = null;
  51.  
  52.     /**
  53.      * Constructor
  54.      *
  55.      * @param ForwardFW_Filter $_child The child filter or null if you are the last
  56.      *
  57.      * @return new instance
  58.      */
  59.     public function __construct(ForwardFW_Filter $_child = null)
  60.     {
  61.         $this->child = $_child;
  62.     }
  63.  
  64.     /**
  65.      * Function to process before your child
  66.      *
  67.      * @return void 
  68.      */
  69.     abstract public function doIncomingFilter();
  70.  
  71.  
  72.     /**
  73.      * Function to process after your child
  74.      *
  75.      * @return void 
  76.      */
  77.     abstract public function doOutgoingFilter();
  78.  
  79.     /**
  80.      * Function to process filtering incoming/child/outgoing
  81.      *
  82.      * @return void 
  83.      */
  84.     public function doFilter()
  85.     {
  86.         $this->doIncomingFilter();
  87.         if (!is_null($this->child)) {
  88.             $this->child->doFilter();
  89.         }
  90.         $this->doOutgoingFilter();
  91.     }
  92. }
  93.  
  94. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:41 +0100 by phpDocumentor 1.4.3