framework/main/classes/filter/class_BaseFilterDecorator.php

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