'public static final' is correct
[core.git] / inc / classes / main / controller / web / class_WebDefaultController.php
1 <?php
2 /**
3  * The default controller for all other web requests
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  * @todo                This controller shall still provide some headlines for sidebars
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class WebDefaultController extends BaseController implements Controller {
26         /**
27          * Protected constructor
28          *
29          * @return      void
30          */
31         protected function __construct () {
32                 // Call parent constructor
33                 parent::__construct(__CLASS__);
34         }
35
36         /**
37          * Creates an instance of this class
38          *
39          * @param       $resolverInstance               An instance of a command resolver class
40          * @return      $controllerInstance             A prepared instance of this class
41          */
42         public static final function createWebDefaultController (CommandResolver $resolverInstance) {
43                 // Create the instance
44                 $controllerInstance = new WebDefaultController();
45
46                 // Set the command resolver
47                 $controllerInstance->setResolverInstance($resolverInstance);
48
49                 // Return the prepared instance
50                 return $controllerInstance;
51         }
52
53         /**
54          * Handles the given request and response
55          *
56          * @param       $requestInstance        An instance of a request class
57          * @param       $responseInstance       An instance of a response class
58          * @return      void
59          */
60         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
61                 // Get the command instance
62                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
63
64                 // This request was valid! :-D
65                 $requestInstance->requestIsValid();
66
67                 // Execute the command
68                 $commandInstance->execute($requestInstance, $responseInstance);
69
70                 // Flush the response out
71                 $responseInstance->flushBuffer();
72         }
73 }
74
75 // [EOF]
76 ?>