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 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 {
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 final static 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 * Process all added filters
66 * @param $requestInstance An instance of a request class
67 * @param $responseInstance An instance of a response class
70 public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
72 //* DEBUG */ echo "COUNT=".count($this->filters)."<br />\n";
73 foreach ($this->filters as $filterInstance) {
74 // Try to execute this filter
76 //* DEBUG */ echo "FILTER: ".$filterInstance->__toString().": Processing started.<br />\n";
77 $filterInstance->execute($requestInstance, $responseInstance);
78 //* DEBUG */ echo "FILTER: ".$filterInstance->__toString().": Processing ended.<br />\n";
79 } catch (FilterChainException $e) {
80 // This exception can be thrown to just skip any further processing