3 * A filter chain for pre and post filters
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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 * All filters together
28 private $filters = array();
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
41 * Creates an instance of this class
43 * @return $chainInstance An instance of this class
45 public static final function createFilterChain () {
47 $chainInstance = new FilterChain();
49 // Return the prepared instance
50 return $chainInstance;
56 * @param $filerInstance An instance of a filter class
59 public final function addFilter (Filterable $filterInstance) {
60 $this->filters[] = $filterInstance;
64 * Getter for filters array
66 * @return $filters The filters array holding all filter instances
68 protected function getFilters () {
69 return $this->filters;
73 * Process all added filters
75 * @param $requestInstance An instance of a request class
76 * @param $responseInstance An instance of a response class
79 public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
81 //* DEBUG */ $this->debugOutput('COUNT=' . count($this->filters));
82 foreach ($this->getFilters() as $filterInstance) {
83 // Try to execute this filter
85 //* DEBUG */ $this->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
86 $filterInstance->execute($requestInstance, $responseInstance);
87 //* DEBUG */ $this->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
88 } catch (FilterChainException $e) {
89 // This exception can be thrown to just skip any further processing
90 $this->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());