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@shipsimu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.shipsimu.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 {
27 // Exception constants
28 const EXCEPTION_FILTER_CHAIN_INVALID = 0xf10;
30 // Names of controller's own filter chains
31 const FILTER_CHAIN_PRE_COMMAND = 'controller_pre_command';
32 const FILTER_CHAIN_POST_COMMAND = 'controller_post_command';
35 * Generic filter chains
37 private $filterChains = array();
40 * Protected constructor
42 * @param $className Name of the class
45 protected function __construct ($className) {
46 // Call parent constructor
47 parent::__construct($className);
49 // Initialize both filter chains
50 $this->initFilterChain(self::FILTER_CHAIN_PRE_COMMAND);
51 $this->initFilterChain(self::FILTER_CHAIN_POST_COMMAND);
53 // Add this controller to the registry
54 Registry::getRegistry()->addInstance('controller', $this);
58 * Private method to initialize a given filter chain
60 * @param $filterChain Name of the filter chain
63 protected function initFilterChain ($filterChain) {
64 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ' init: START');
65 $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
66 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ' init: FINISHED');
70 * Adds a filter to a given filter chain
72 * @param $filterChain Chain of the filter
73 * @param $filterInstance An instance of a filter
75 * @throws InvalidFilterChainException If the filter chain is invalid
77 protected function addFilter ($filterChain, Filterable $filterInstance) {
78 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: START');
80 // Test if the filter is there
81 if (!isset($this->filterChains[$filterChain])) {
82 // Throw an exception here
83 throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
87 $this->filterChains[$filterChain]->addFilter($filterInstance);
88 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: FINISH');
92 * Adds a filter to the pre filter chain
94 * @param $filterInstance An instance of a filter
97 public function addPreFilter (Filterable $filterInstance) {
99 $this->addFilter(self::FILTER_CHAIN_PRE_COMMAND, $filterInstance);
103 * Adds a filter to the post filter chain
105 * @param $filterInstance An instance of a filter
108 public function addPostFilter (Filterable $filterInstance) {
109 // Add the post filter
110 $this->addFilter(self::FILTER_CHAIN_POST_COMMAND, $filterInstance);
114 * Executes given filter chain chain
116 * @param $filterChain Chain of the filter to execute
117 * @param $requestInstance An instance of a request class
118 * @param $responseInstance An instance of a response class
120 * @throws InvalidFilterChainException If the filter chain is invalid
122 protected function executeFilters ($filterChain, Requestable $requestInstance, Responseable $responseInstance) {
123 // Test if the filter is there
124 if (!isset($this->filterChains[$filterChain])) {
125 // Throw an exception here
126 throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
130 $this->filterChains[$filterChain]->processFilters($requestInstance, $responseInstance);
134 * Executes all pre filters
136 * @param $requestInstance An instance of a request class
137 * @param $responseInstance An instance of a response class
140 protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
141 // Execute all pre filters
142 $this->executeFilters(self::FILTER_CHAIN_PRE_COMMAND, $requestInstance, $responseInstance);
146 * Executes all post filters
148 * @param $requestInstance An instance of a request class
149 * @param $responseInstance An instance of a response class
152 protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
153 // Execute all post filters
154 $this->executeFilters(self::FILTER_CHAIN_POST_COMMAND, $requestInstance, $responseInstance);
158 * Add a shutdown filter
160 * @param $filterInstance A Filterable class
163 public function addShutdownFilter (Filterable $filterInstance) {
164 $this->addFilter('shutdown', $filterInstance);
168 * Executes all shutdown filters
170 * @param $requestInstance A Requestable class
171 * @param $responseInstance A Responseable class
174 public function executeShutdownFilters (Requestable $requestInstance, Responseable $responseInstance) {
175 $this->executeFilters('shutdown', $requestInstance, $responseInstance);