inc/classes/main/filter/class_FilterChain.php

   1 <?php
   2 /**
   3  * A filter chain for pre and post filters
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 class FilterChain extends BaseFrameworkSystem implements Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $chainInstance  An instance of this class
  39          */
  40         public static final function createFilterChain () {
  41                 // Get a new instance
  42                 $chainInstance = new FilterChain();
  43
  44                 // Return the prepared instance
  45                 return $chainInstance;
  46         }
  47
  48         /**
  49          * Add a new filter
  50          *
  51          * @param       $filerInstance  An instance of a filter class
  52          * @return      void
  53          */
  54         public final function addFilter (Filterable $filterInstance) {
  55                 $this->pushValueToGenericArrayKey('filters', 'generic', 'dummy', $filterInstance);
  56         }
  57
  58         /**
  59          * Add a new post-filter
  60          *
  61          * @param       $filerInstance  An instance of a post-filter class
  62          * @return      void
  63          */
  64         public final function addPostFilter (Filterable $filterInstance) {
  65                 $this->pushValueToGenericArrayKey('filters', 'post', 'dummy', $filterInstance);
  66         }
  67
  68         /**
  69          * "Getter" for filters array
  70          *
  71          * @return      $filters        The filters array holding all filter instances
  72          */
  73         protected function getFilters () {
  74                 // Default is nothing found
  75                 $filters = array();
  76
  77                 // Are some filters set?
  78                 if ($this->isValidGenericArrayKey('filters', 'generic', 'dummy')) {
  79                         // Then get them
  80                         $filters = $this->getGenericArrayKey('filters', 'generic', 'dummy');
  81                 } // END - if
  82
  83                 // Return it
  84                 return $filters;
  85         }
  86
  87         /**
  88          * "Getter" for post-filters array
  89          *
  90          * @return      $filters        The filters array holding all post-filter instances
  91          */
  92         protected function getPostFilters () {
  93                 // Default is nothing found
  94                 $filters = array();
  95
  96                 // Are some filters set?
  97                 if ($this->isValidGenericArrayKey('filters', 'post', 'dummy')) {
  98                         // Then get them
  99                         $filters = $this->getGenericArrayKey('filters', 'post', 'dummy');
 100                 } // END - if
 101
 102                 // Return it
 103                 return $filters;
 104         }
 105
 106         /**
 107          * Process all added filters. Please note that filters must throw
 108          * FilterChainException if they need to interrupt the filter chain.
 109          *
 110          * @param       $requestInstance        An instance of a request class
 111          * @param       $responseInstance       An instance of a response class
 112          * @return      void
 113          */
 114         public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
 115                 // Run all filters
 116                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('COUNT=' . $this->countGenericArray('filters'));
 117                 foreach ($this->getFilters() as $filterInstance) {
 118                         // Must be an instance of Filterable
 119                         assert($filterInstance instanceof Filterable);
 120
 121                         // Try to execute this filter
 122                         try {
 123                                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
 124                                 $filterInstance->execute($requestInstance, $responseInstance);
 125                                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
 126                         } catch (FilterChainException $e) {
 127                                 // This exception can be thrown to just skip any further processing
 128                                 self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
 129                                 break;
 130                         }
 131                 } // END - foreach
 132         }
 133 }
 134
 135 // [EOF]
 136 ?>