3 * The default controller with news for e.g. home or news page
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2015 City Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 CityConsoleDefaultNewsController extends BaseController implements Controller {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Init additional filter chains
35 foreach (array('bootstrap', 'activation','shutdown') as $filterChain) {
36 $this->initFilterChain($filterChain);
41 * Creates an instance of this class
43 * @param $resolverInstance An instance of a command resolver class
44 * @return $controllerInstance A prepared instance of this class
46 public static final function createCityConsoleDefaultNewsController (CommandResolver $resolverInstance) {
47 // Create the instance
48 $controllerInstance = new CityConsoleDefaultNewsController();
50 // Set the command resolver
51 $controllerInstance->setResolverInstance($resolverInstance);
53 // Add news filters to this controller
54 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter'));
55 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter'));
57 // Return the prepared instance
58 return $controllerInstance;
62 * Handles the given request and response
64 * @param $requestInstance An instance of a request class
65 * @param $responseInstance An instance of a response class
68 public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get the command instance from the resolver by sending a request instance to the resolver
70 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
72 // Add more filters by the command
73 $commandInstance->addExtraFilters($this, $requestInstance);
75 // Run the pre filters
76 $this->executePreFilters($requestInstance, $responseInstance);
78 // This request was valid! :-D
79 $requestInstance->requestIsValid();
81 // Execute the command
82 $commandInstance->execute($requestInstance, $responseInstance);
84 // Run the pre filters
85 $this->executePostFilters($requestInstance, $responseInstance);
87 // Flush the response out
88 $responseInstance->flushBuffer();
92 * Add a bootstrap filter
94 * @param $filterInstance A Filterable class
97 public function addBootstrapFilter (Filterable $filterInstance) {
98 $this->addFilter('bootstrap', $filterInstance);
102 * Executes all bootstrap filters
104 * @param $requestInstance A Requestable class
105 * @param $responseInstance A Responseable class
108 public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
109 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
113 * Add a city activation filter
115 * @param $filterInstance A Filterable class
118 public function addActivationFilter (Filterable $filterInstance) {
119 $this->addFilter('activation', $filterInstance);
123 * Executes all city activation filters
125 * @param $requestInstance A Requestable class
126 * @param $responseInstance A Responseable class
129 public function executeActivationFilters (Requestable $requestInstance, Responseable $responseInstance) {
130 $this->executeFilters('activation', $requestInstance, $responseInstance);