Fixes and double->single converted
[core.git] / 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 - 2012 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 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->pushValueToGenericArrayElement('filters', 'generic', 'dummy', $filterInstance);
56         }
57
58         /**
59          * Getter for filters array
60          *
61          * @return      $filters        The filters array holding all filter instances
62          */
63         protected function getFilters () {
64                 return $this->getGenericArray('filters');
65         }
66
67         /**
68          * Process all added filters
69          *
70          * @param       $requestInstance        An instance of a request class
71          * @param       $responseInstance       An instance of a response class
72          * @return      void
73          */
74         public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
75                 // Run all filters
76                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('COUNT=' . $this->countGenericArray('filters'));
77                 foreach ($this->getFilters() as $filterInstance) {
78                         // Try to execute this filter
79                         try {
80                                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
81                                 $filterInstance->execute($requestInstance, $responseInstance);
82                                 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
83                         } catch (FilterChainException $e) {
84                                 // This exception can be thrown to just skip any further processing
85                                 self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
86                                 break;
87                         }
88                 } // END - foreach
89         }
90 }
91
92 // [EOF]
93 ?>