inc/classes/main/filter/class_AbstractFilterDecorator.php

   1 <?php
   2 /**
   3  * An abstract filter decorator for decorating filters with other filters
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 abstract class AbstractFilterDecorator extends BaseFrameworkSystem implements Filterable {
  25         /**
  26          * The decorated filter instance
  27          */
  28         private $filterInstance = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the real class' name
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Setter for the decorated filter instance
  47          *
  48          * @param       $filterInstance         An instance of a filter
  49          * @return      void
  50          */
  51         protected final function setFilterInstance (Filterable $filterInstance) {
  52                 $this->filterInstance = $filterInstance;
  53         }
  54
  55         /**
  56          * Getter for the decorated filter instance
  57          *
  58          * @return      $filterInstance         An instance of a filter
  59          */
  60         protected final function getFilterInstance () {
  61                 return $this->filterInstance;
  62         }
  63
  64         /**
  65          * Execute the inner filter
  66          *
  67          * @param       $requestInstance        An instance of a request class
  68          * @param       $responseInstance       An instance of a response class
  69          * @return      void
  70          */
  71         public final function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 $this->getFilterInstance()->execute($requestInstance, $responseInstance);
  73         }
  74
  75
  76         /**
  77          * Do the execution of the filter
  78          *
  79          * @param       $requestInstance        An instance of a request class
  80          * @param       $responseInstance       An instance of a response class
  81          * @return      void
  82          */
  83         abstract public function doExecute (Requestable $requestInstance, Responseable $responseInstance);
  84 }
  85
  86 // [EOF]
  87 ?>