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