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