More conventions than code added:
[shipsimu.git] / inc / classes / main / controller / web / class_WebLoginController.php
1 <?php
2 /**
3  * Controller for login form with password reminder and maybe enabled
4  * "guest-login" button
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
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 WebLoginController 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                 // Set part description
36                 $this->setObjectDescription("Controller for login form");
37
38                 // Create unique ID number
39                 $this->generateUniqueId();
40         }
41
42         /**
43          * Creates an instance of this class
44          *
45          * @param       $resolverInstance               An instance of a command resolver class
46          * @return      $controllerInstance             A prepared instance of this class
47          * @todo        Add some filters to this controller
48          */
49         public final static function createWebLoginController (CommandResolver $resolverInstance) {
50                 // Create the instance
51                 $controllerInstance = new WebLoginController();
52
53                 // Set the command resolver
54                 $controllerInstance->setResolverInstance($resolverInstance);
55
56
57                 // Return the prepared instance
58                 return $controllerInstance;
59         }
60
61         /**
62          * Handles the given request and response
63          *
64          * @param       $requestInstance        An instance of a request class
65          * @param       $responseInstance       An instance of a response class
66          * @return      void
67          */
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);
71
72                 // Add more filters by the command
73                 $commandInstance->addExtraFilters($this, $requestInstance);
74
75                 // Run the pre filters
76                 $this->executePreFilters($requestInstance, $responseInstance);
77
78                 // This request was valid! :-D
79                 $requestInstance->requestIsValid();
80
81                 // Execute the command
82                 $commandInstance->execute($requestInstance, $responseInstance);
83
84                 // Run the pre filters
85                 $this->executePostFilters($requestInstance, $responseInstance);
86
87                 // Flush the response out
88                 $responseInstance->flushBuffer();
89         }
90 }
91
92 // [EOF]
93 ?>