64cba33ea447cb94eab94515c85a3d38d1c8efc2
[shipsimu.git] / inc / classes / main / commands / web / class_WebLoginCommand.php
1 <?php
2 /**
3  * A command for the login form
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 WebLoginCommand extends BaseCommand implements Commandable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set special description
35                 $this->setObjectDescription("Command for the login form page");
36
37                 // Create unique ID number
38                 $this->generateUniqueId();
39
40                 // Clean up a little
41                 $this->removeSystemArray();
42         }
43
44         /**
45          * Creates an instance of this class
46          *
47          * @param       $resolverInstance               An instance of a command resolver class
48          * @return      $commandInstance                An instance a prepared command class
49          */
50         public final static function createWebLoginCommand (CommandResolver $resolverInstance) {
51                 // Get new instance
52                 $commandInstance = new WebLoginCommand();
53
54                 // Set the application instance
55                 $commandInstance->setResolverInstance($resolverInstance);
56
57                 // Return the prepared instance
58                 return $commandInstance;
59         }
60
61         /**
62          * Executes the given command with given request and response objects
63          *
64          * @param       $requestInstance                An instance of a class with an Requestable interface
65          * @param       $responseInstance               An instance of a class with an Responseable interface
66          * @return      void
67          */
68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69                 // Get the application instance
70                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
71
72                 // Prepare a template instance
73                 $templateInstance = $this->prepareTemplateEngine($appInstance);
74
75                 // Assign application data with template engine
76                 $templateInstance->assignApplicationData($appInstance);
77
78                 // Load the master template
79                 $masterTemplate = $appInstance->getMasterTemplate();
80
81                 // Load header template
82                 $templateInstance->loadCodeTemplate("header");
83
84                 // Compile and assign it with a variable
85                 $templateInstance->compileTemplate();
86                 $templateInstance->assignTemplateWithVariable("header", "header");
87
88                 // Load footer template
89                 $templateInstance->loadCodeTemplate("footer");
90
91                 // Compile and assign it with a variable
92                 $templateInstance->compileTemplate();
93                 $templateInstance->assignTemplateWithVariable("footer", "footer");
94
95                 // Load the home template
96                 $templateInstance->loadCodeTemplate("login_form");
97
98                 // Assign the home template with the master template as a content ... ;)
99                 $templateInstance->assignTemplateWithVariable("login_form", "content");
100
101                 // Load the master template
102                 $templateInstance->loadCodeTemplate($masterTemplate);
103
104                 // Set title
105                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
106
107                 // ... and all variables. This should be merged together in a pattern
108                 // to make things easier. A cache mechanism should be added between
109                 // these two calls to cache compiled templates.
110                 $templateInstance->compileVariables();
111
112                 // Get the content back from the template engine and put it in the response class
113                 $templateInstance->transferToResponse($responseInstance);
114         }
115 }
116
117 // [EOF]
118 ?>