3 namespace Org\Mxchange\City\Command;
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\Registry\Registerable;
12 use Org\Mxchange\CoreFramework\Request\Requestable;
13 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
14 use Org\Mxchange\CoreFramework\Response\Responseable;
17 * A command for the login form
19 * @author Roland Haeder <webmaster@shipsimu.org>
21 * @copyright Copyright (c) 2015, 2016 City Developer Team
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class CityHtmlLoginCommand extends BaseCommand implements Commandable, Registerable {
40 * Protected constructor
44 protected function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this class
52 * @param $resolverInstance An instance of a command resolver class
53 * @return $commandInstance An instance a prepared command class
55 public static final function createCityHtmlLoginCommand (CommandResolver $resolverInstance) {
57 $commandInstance = new CityHtmlLoginCommand();
59 // Set the application instance
60 $commandInstance->setResolverInstance($resolverInstance);
62 // Return the prepared instance
63 return $commandInstance;
67 * Executes the given command with given request and response objects
69 * @param $requestInstance An instance of a class with an Requestable interface
70 * @param $responseInstance An instance of a class with an Responseable interface
73 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
74 // Set request instance as extra instance
75 GenericRegistry::getRegistry()->addInstance('extra', $this);
77 // Get the application instance
78 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
80 // Prepare a template instance
81 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
83 // Assign application data with template engine
84 $templateInstance->assignApplicationData();
87 $templateInstance->assignConfigVariable('base_url');
89 // Load the master template
90 $masterTemplate = $applicationInstance->buildMasterTemplateName();
92 // Load header template
93 $templateInstance->loadCodeTemplate('header');
95 // Compile and assign it with a variable
96 $templateInstance->compileTemplate();
97 $templateInstance->assignTemplateWithVariable('header', 'header');
99 // Load footer template
100 $templateInstance->loadCodeTemplate('footer');
102 // Compile and assign it with a variable
103 $templateInstance->compileTemplate();
104 $templateInstance->assignTemplateWithVariable('footer', 'footer');
106 // Load the home template
107 $templateInstance->loadCodeTemplate('login_form');
109 // Assign the home template with the master template as a content ... ;)
110 $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
112 // Load the master template
113 $templateInstance->loadCodeTemplate($masterTemplate);
116 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
119 * Construct the menu in every command. We could do this in BaseCommand class. But this means
120 * *every* command has a navigation system and that is want we don't want.
122 $menuInstance = ObjectFactory::createObjectByConfiguredName('login_menu_class', array($applicationInstance));
125 $menuInstance->renderMenu();
127 // Transfer it to the template engine instance
128 $menuInstance->transferContentToTemplateEngine($templateInstance);
131 * ... and all variables. This should be merged together in a pattern
132 * to make things easier. A cache mechanism should be added between
133 * these two calls to cache compiled templates.
135 $templateInstance->compileVariables();
137 // Get the content back from the template engine and put it in response class
138 $templateInstance->transferToResponse($responseInstance);
142 * Adds extra filters to the given controller instance
144 * @param $controllerInstance A controller instance
145 * @param $requestInstance An instance of a class with an Requestable interface
148 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {