Continued:
[core.git] / inc / main / classes / commands / html / class_HtmlLoginCommand.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Command\Login;
4
5 // Import framework stuff
6 use CoreFramework\Registry\Registerable;
7
8 /**
9  * A command for the login form
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
29  */
30 class HtmlLoginCommand extends BaseCommand implements Commandable, Registerable {
31         /**
32          * Protected constructor
33          *
34          * @return      void
35          */
36         protected function __construct () {
37                 // Call parent constructor
38                 parent::__construct(__CLASS__);
39         }
40
41         /**
42          * Creates an instance of this class
43          *
44          * @param       $resolverInstance       An instance of a command resolver class
45          * @return      $commandInstance        An instance a prepared command class
46          */
47         public static final function createHtmlLoginCommand (CommandResolver $resolverInstance) {
48                 // Get new instance
49                 $commandInstance = new HtmlLoginCommand();
50
51                 // Set the application instance
52                 $commandInstance->setResolverInstance($resolverInstance);
53
54                 // Return the prepared instance
55                 return $commandInstance;
56         }
57
58         /**
59          * Executes the given command with given request and response objects
60          *
61          * @param       $requestInstance        An instance of a class with an Requestable interface
62          * @param       $responseInstance       An instance of a class with an Responseable interface
63          * @return      void
64          */
65         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
66                 // Set request instance as extra instance
67                 Registry::getRegistry()->addInstance('extra', $this);
68
69                 // Get the application instance
70                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
71
72                 // Prepare a template instance
73                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
74
75                 // Assign application data with template engine
76                 $templateInstance->assignApplicationData($applicationInstance);
77
78                 // Assign base URL
79                 $templateInstance->assignConfigVariable('base_url');
80
81                 // Load the master template
82                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
83
84                 // Load header template
85                 $templateInstance->loadCodeTemplate('header');
86
87                 // Compile and assign it with a variable
88                 $templateInstance->compileTemplate();
89                 $templateInstance->assignTemplateWithVariable('header', 'header');
90
91                 // Load footer template
92                 $templateInstance->loadCodeTemplate('footer');
93
94                 // Compile and assign it with a variable
95                 $templateInstance->compileTemplate();
96                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
97
98                 // Load the home template
99                 $templateInstance->loadCodeTemplate('login_form');
100
101                 // Assign the home template with the master template as a content ... ;)
102                 $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
103
104                 // Load the master template
105                 $templateInstance->loadCodeTemplate($masterTemplate);
106
107                 // Set title
108                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
109
110                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
111                 // *every* command has a navigation system and that is want we don't want.
112                 $menuInstance = ObjectFactory::createObjectByConfiguredName('login_menu_class', array($applicationInstance));
113
114                 // Render the menu
115                 $menuInstance->renderMenu();
116
117                 // Transfer it to the template engine instance
118                 $menuInstance->transferContentToTemplateEngine($templateInstance);
119
120                 /*
121                  * ... and all variables. This should be merged together in a pattern
122                  * to make things easier. A cache mechanism should be added between
123                  * these two calls to cache compiled templates.
124                  */
125                 $templateInstance->compileVariables();
126
127                 // Get the content back from the template engine and put it in response class
128                 $templateInstance->transferToResponse($responseInstance);
129         }
130
131         /**
132          * Adds extra filters to the given controller instance
133          *
134          * @param       $controllerInstance             A controller instance
135          * @param       $requestInstance                An instance of a class with an Requestable interface
136          * @return      void
137          */
138         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
139                 // Empty for now
140         }
141 }
142
143 // [EOF]
144 ?>