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, this is free software
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 {
28 * Instance of a CommandResolver class
30 private $resolverInstance = null;
33 * Pre filter chain instance
35 private $preFilterChain = null;
38 * Post filter chain instance
40 private $postFilterChain = null;
43 * Protected constructor
47 protected function __construct ($class) {
48 // Call parent constructor
49 parent::__construct($class);
52 $this->removeNumberFormaters();
53 $this->removeSystemArray();
55 // Initialize both filter chains
56 $this->preFilterChain = FilterChain::createFilterChain();
57 $this->postFilterChain = FilterChain::createFilterChain();
61 * Getter for a command resolver instance
63 * @return $resolverInstance An instance of a command resolver class
65 public final function getResolverInstance () {
66 return $this->resolverInstance;
70 * Setter for a command resolver instance
72 * @param $resolverInstance An instance of a command resolver class
75 public final function setResolverInstance (CommandResolver $resolverInstance) {
76 $this->resolverInstance = $resolverInstance;
80 * Adds a filter to the pre filter chain
82 * @param $filterInstance An instance of a filter
85 public function addPreFilter (Filterable $filterInstance) {
87 $this->preFilterChain->addFilter($filterInstance);
91 * Adds a filter to the post filter chain
93 * @param $filterInstance An instance of a filter
96 public function addPostFilter (Filterable $filterInstance) {
97 // Add the post filter
98 $this->postFilterChain->addFilter($filterInstance);
102 * Executes all pre filters
104 * @param $requestInstance An instance of a request class
105 * @param $responseInstance An instance of a response class
108 protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
109 // Execute all pre filters
110 $this->preFilterChain->processFilters($requestInstance, $responseInstance);
114 * Executes all post filters
116 * @param $requestInstance An instance of a request class
117 * @param $responseInstance An instance of a response class
120 protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
121 // Execute all post filters
122 $this->postFilterChain->processFilters($requestInstance, $responseInstance);