dd3b3699db207de630b83cfab5b7e1a7e8cb9ad3
[shipsimu.git] / inc / classes / main / controller / default / class_WebDefaultNewsController.php
1 <?php
2 /**
3  * The default controller with news for e.g. home or news page
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 WebDefaultNewsController extends BaseController implements Controller {
25         /**
26          * Instance of a CommandResolver class
27          */
28         private $resolverInstance = null;
29
30         /**
31          * Private constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38
39                 // Set part description
40                 $this->setObjectDescription("Standart-Controller mit News-Auflistung");
41
42                 // Create unique ID number
43                 $this->createUniqueID();
44
45                 // Clean up a little
46                 $this->removeSystemArray();
47         }
48
49         /**
50          * Creates an instance of this class
51          *
52          * @param       $resolverInstance               An instance of a command resolver class
53          * @return      $controllerInstance             A prepared instance of this class
54          */
55         public final static function createWebDefaultNewsController (CommandResolver $resolverInstance) {
56                 // Create the instance
57                 $controllerInstance = new WebDefaultNewsController();
58
59                 // Set the command resolver
60                 $controllerInstance->setResolverInstance($resolverInstance);
61
62                 // Return the prepared instance
63                 return $controllerInstance;
64         }
65
66         /**
67          * Setter for a command resolver instance
68          *
69          * @param       $resolverInstance       An instance of a command resolver class
70          * @return      void
71          */
72         public final function setResolverInstance (CommandResolver $resolverInstance) {
73                 $this->resolverInstance = $resolverInstance;
74         }
75
76         /**
77          * Handles the given request and response
78          *
79          * @param       $requestInstance        An instance of a request class
80          * @param       $responseInstance       An instance of a response class
81          * @return      void
82          */
83         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
84                 // Get the command instance from the resolver by sending a request instance to the resolver
85                 $commandInstance = $this->resolverInstance->resolvCommandByRequest($requestInstance);
86
87                 // Get the news page variable from the request instance
88                 $newsPage = $requestInstance->getRequestElement("news_page");
89
90                 // Load the news here
91                 $this->loadNews($newsPage);
92
93                 // Execute the command
94                 $commandInstance->execute($requestInstance, $responseInstance);
95
96                 // Flush the response out
97                 $responseInstance->flushResponse();
98         }
99
100         /**
101          * Loads news from the connected database for later usage
102          *
103          * @param       $newsPage       Page of listed news we want to read
104          * @return      void
105          */
106         private function loadNews ($newsPage) {
107         }
108 }
109
110 // [EOF]
111 ?>