3 namespace CoreFramework\Command\Login;
5 // Import framework stuff
6 use CoreFramework\Registry\Registerable;
9 * A command for the login form
11 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
30 class HtmlLoginCommand extends BaseCommand implements Commandable, Registerable {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this class
44 * @param $resolverInstance An instance of a command resolver class
45 * @return $commandInstance An instance a prepared command class
47 public static final function createHtmlLoginCommand (CommandResolver $resolverInstance) {
49 $commandInstance = new HtmlLoginCommand();
51 // Set the application instance
52 $commandInstance->setResolverInstance($resolverInstance);
54 // Return the prepared instance
55 return $commandInstance;
59 * Executes the given command with given request and response objects
61 * @param $requestInstance An instance of a class with an Requestable interface
62 * @param $responseInstance An instance of a class with an Responseable interface
65 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
66 // Set request instance as extra instance
67 Registry::getRegistry()->addInstance('extra', $this);
69 // Get the application instance
70 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
72 // Prepare a template instance
73 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
75 // Assign application data with template engine
76 $templateInstance->assignApplicationData($applicationInstance);
79 $templateInstance->assignConfigVariable('base_url');
81 // Load the master template
82 $masterTemplate = $applicationInstance->buildMasterTemplateName();
84 // Load header template
85 $templateInstance->loadCodeTemplate('header');
87 // Compile and assign it with a variable
88 $templateInstance->compileTemplate();
89 $templateInstance->assignTemplateWithVariable('header', 'header');
91 // Load footer template
92 $templateInstance->loadCodeTemplate('footer');
94 // Compile and assign it with a variable
95 $templateInstance->compileTemplate();
96 $templateInstance->assignTemplateWithVariable('footer', 'footer');
98 // Load the home template
99 $templateInstance->loadCodeTemplate('login_form');
101 // Assign the home template with the master template as a content ... ;)
102 $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
104 // Load the master template
105 $templateInstance->loadCodeTemplate($masterTemplate);
108 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
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));
115 $menuInstance->renderMenu();
117 // Transfer it to the template engine instance
118 $menuInstance->transferContentToTemplateEngine($templateInstance);
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.
125 $templateInstance->compileVariables();
127 // Get the content back from the template engine and put it in response class
128 $templateInstance->transferToResponse($responseInstance);
132 * Adds extra filters to the given controller instance
134 * @param $controllerInstance A controller instance
135 * @param $requestInstance An instance of a class with an Requestable interface
138 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {