inc/main/classes/filter/null/class_NullFilter.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\Generic;
   4
   5 // Import framework stuff
   6 use CoreFramework\Request\Requestable;
   7 use CoreFramework\Response\Responseable;
   8
   9 /**
  10  * As the name said: A null filter does just pass through the data. This is
  11  * useful to make other filters switch on/off-able.
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class NullFilter extends BaseFilter implements Filterable {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this filter class
  45          *
  46          * @return      $filterInstance                 An instance of this filter class
  47          */
  48         public static final function createNullFilter () {
  49                 // Get a new instance
  50                 $filterInstance = new NullFilter();
  51
  52                 // Return the instance
  53                 return $filterInstance;
  54         }
  55
  56         /**
  57          * Executes the filter with given request and response objects
  58          *
  59          * @param       $requestInstance        An instance of a class with an Requestable interface
  60          * @param       $responseInstance       An instance of a class with an Responseable interface
  61          * @return      void
  62          */
  63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  64                 // Not implemented, just passing through
  65         }
  66
  67 }