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