3 * A filter chain for pre and post filters
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
24 class FilterChain extends BaseFrameworkSystem implements Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $chainInstance An instance of this class
40 public static final function createFilterChain () {
42 $chainInstance = new FilterChain();
44 // Return the prepared instance
45 return $chainInstance;
51 * @param $filerInstance An instance of a filter class
54 public final function addFilter (Filterable $filterInstance) {
55 $this->pushValueToGenericArrayKey('filters', 'generic', 'dummy', $filterInstance);
59 * "Getter" for filters array
61 * @return $filters The filters array holding all filter instances
63 protected function getFilters () {
64 // Default is nothing found
67 // Are some filters set?
68 if ($this->isValidGenericArrayKey('filters', 'generic', 'dummy')) {
70 $filters = $this->getGenericArrayKey('filters', 'generic', 'dummy');
78 * Process all added filters. Please note that filters must throw
79 * FilterChainException if they need to interrupt the filter chain.
81 * @param $requestInstance An instance of a request class
82 * @param $responseInstance An instance of a response class
85 public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
87 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('COUNT=' . $this->countGenericArray('filters'));
88 foreach ($this->getFilters() as $filterInstance) {
89 // Must be an instance of Filterable
90 assert($filterInstance instanceof Filterable);
92 // Try to execute this filter
94 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
95 $filterInstance->execute($requestInstance, $responseInstance);
96 //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
97 } catch (FilterChainException $e) {
98 // This exception can be thrown to just skip any further processing
99 self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());