inc/main/classes/filter/class_BaseFilterDecorator.php

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