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