Updated copyright:
[core.git] / inc / classes / main / controller / console / class_ConsoleDefaultNewsController.php
1 <?php
2 /**
3  * The default controller with news for e.g. home or news page
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class ConsoleDefaultNewsController extends BaseController implements Controller {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @param       $resolverInstance               An instance of a command resolver class
39          * @return      $controllerInstance             A prepared instance of this class
40          */
41         public static final function createConsoleDefaultNewsController (CommandResolver $resolverInstance) {
42                 // Create the instance
43                 $controllerInstance = new ConsoleDefaultNewsController();
44
45                 // Set the command resolver
46                 $controllerInstance->setResolverInstance($resolverInstance);
47
48                 // Add news filters to this controller
49                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter'));
50                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter'));
51
52                 // Return the prepared instance
53                 return $controllerInstance;
54         }
55
56         /**
57          * Handles the given request and response
58          *
59          * @param       $requestInstance        An instance of a request class
60          * @param       $responseInstance       An instance of a response class
61          * @return      void
62          */
63         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
64                 // Get the command instance from the resolver by sending a request instance to the resolver
65                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
66
67                 // Add more filters by the command
68                 $commandInstance->addExtraFilters($this, $requestInstance);
69
70                 // Run the pre filters
71                 $this->executePreFilters($requestInstance, $responseInstance);
72
73                 // This request was valid! :-D
74                 $requestInstance->requestIsValid();
75
76                 // Execute the command
77                 $commandInstance->execute($requestInstance, $responseInstance);
78
79                 // Run the pre filters
80                 $this->executePostFilters($requestInstance, $responseInstance);
81
82                 // Flush the response out
83                 $responseInstance->flushBuffer();
84         }
85 }
86
87 // [EOF]
88 ?>