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