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@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 {
  25         /**
  26          * All filters together
  27          */
  28         private $filters = array();
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38         }
  39
  40         /**
  41          * Creates an instance of this class
  42          *
  43          * @return      $chainInstance  An instance of this class
  44          */
  45         public static final function createFilterChain () {
  46                 // Get a new instance
  47                 $chainInstance = new FilterChain();
  48
  49                 // Return the prepared instance
  50                 return $chainInstance;
  51         }
  52
  53         /**
  54          * Add a new filter
  55          *
  56          * @param       $filerInstance  An instance of a filter class
  57          * @return      void
  58          */
  59         public final function addFilter (Filterable $filterInstance) {
  60                 $this->filters[] = $filterInstance;
  61         }
  62
  63         /**
  64          * Process all added filters
  65          *
  66          * @param       $requestInstance        An instance of a request class
  67          * @param       $responseInstance       An instance of a response class
  68          * @return      void
  69          */
  70         public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
  71                 // Run all filters
  72                 //* DEBUG */ $this->debugOutput('COUNT=' . count($this->filters));
  73                 foreach ($this->filters as $filterInstance) {
  74                         // Try to execute this filter
  75                         try {
  76                                 //* DEBUG */ $this->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
  77                                 $filterInstance->execute($requestInstance, $responseInstance);
  78                                 //* DEBUG */ $this->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
  79                         } catch (FilterChainException $e) {
  80                                 // This exception can be thrown to just skip any further processing
  81                                 $this->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
  82                                 break;
  83                         }
  84                 } // END - foreach
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>