3 * A generic controller class. You should extend this base class if you want to
4 * write your own controller. You get the advantage that you can use the pre and
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class BaseController extends BaseFrameworkSystem implements Registerable {
28 * Generic filter chains
30 private $filterChains = array();
33 * Protected constructor
35 * @param $className Name of the class
38 protected function __construct ($className) {
39 // Call parent constructor
40 parent::__construct($className);
43 $this->removeNumberFormaters();
44 $this->removeSystemArray();
46 // Initialize both filter chains
47 $this->initFilterChain('pre');
48 $this->initFilterChain('post');
50 // Add this controller to the registry
51 Registry::getRegistry()->addInstance('controller', $this);
55 * Private method to initialize a given filter chain
57 * @param $filterChain Name of the filter chain
60 protected function initFilterChain ($filterChain) {
61 $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
65 * Adds a filter to a given filter group
67 * @param $filterGroup Group of the filter
68 * @param $filterInstance An instance of a filter
71 protected function addFilter ($filterGroup, Filterable $filterInstance) {
72 $this->filterChains[$filterGroup]->addFilter($filterInstance);
76 * Adds a filter to the pre filter chain
78 * @param $filterInstance An instance of a filter
81 public function addPreFilter (Filterable $filterInstance) {
83 $this->addFilter('pre', $filterInstance);
87 * Adds a filter to the post filter chain
89 * @param $filterInstance An instance of a filter
92 public function addPostFilter (Filterable $filterInstance) {
93 // Add the post filter
94 $this->addFilter('post', $filterInstance);
98 * Executes given filter chain group
100 * @param $filterGroup Group of the filter to execute
101 * @param $requestInstance An instance of a request class
102 * @param $responseInstance An instance of a response class
105 protected function executeFilters ($filterGroup, Requestable $requestInstance, Responseable $responseInstance) {
106 $this->filterChains[$filterGroup]->processFilters($requestInstance, $responseInstance);
110 * Executes all pre filters
112 * @param $requestInstance An instance of a request class
113 * @param $responseInstance An instance of a response class
116 protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
117 // Execute all pre filters
118 $this->executeFilters('pre', $requestInstance, $responseInstance);
122 * Executes all post filters
124 * @param $requestInstance An instance of a request class
125 * @param $responseInstance An instance of a response class
128 protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
129 // Execute all post filters
130 $this->executeFilters('post', $requestInstance, $responseInstance);