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\Registry\Registerable;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
15 * A command for the login form
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2015, 2016 City Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class CityHtmlLoginCommand extends BaseCommand implements Commandable, Registerable {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this class
50 * @param $resolverInstance An instance of a command resolver class
51 * @return $commandInstance An instance a prepared command class
53 public static final function createCityHtmlLoginCommand (CommandResolver $resolverInstance) {
55 $commandInstance = new CityHtmlLoginCommand();
57 // Set the application instance
58 $commandInstance->setResolverInstance($resolverInstance);
60 // Return the prepared instance
61 return $commandInstance;
65 * Executes the given command with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Set request instance as extra instance
73 GenericRegistry::getRegistry()->addInstance('extra', $this);
75 // Get the application instance
76 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
78 // Prepare a template instance
79 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
81 // Assign application data with template engine
82 $templateInstance->assignApplicationData($applicationInstance);
85 $templateInstance->assignConfigVariable('base_url');
87 // Load the master template
88 $masterTemplate = $applicationInstance->buildMasterTemplateName();
90 // Load header template
91 $templateInstance->loadCodeTemplate('header');
93 // Compile and assign it with a variable
94 $templateInstance->compileTemplate();
95 $templateInstance->assignTemplateWithVariable('header', 'header');
97 // Load footer template
98 $templateInstance->loadCodeTemplate('footer');
100 // Compile and assign it with a variable
101 $templateInstance->compileTemplate();
102 $templateInstance->assignTemplateWithVariable('footer', 'footer');
104 // Load the home template
105 $templateInstance->loadCodeTemplate('login_form');
107 // Assign the home template with the master template as a content ... ;)
108 $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
110 // Load the master template
111 $templateInstance->loadCodeTemplate($masterTemplate);
114 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
117 * Construct the menu in every command. We could do this in BaseCommand class. But this means
118 * *every* command has a navigation system and that is want we don't want.
120 $menuInstance = ObjectFactory::createObjectByConfiguredName('login_menu_class', array($applicationInstance));
123 $menuInstance->renderMenu();
125 // Transfer it to the template engine instance
126 $menuInstance->transferContentToTemplateEngine($templateInstance);
129 * ... and all variables. This should be merged together in a pattern
130 * to make things easier. A cache mechanism should be added between
131 * these two calls to cache compiled templates.
133 $templateInstance->compileVariables();
135 // Get the content back from the template engine and put it in response class
136 $templateInstance->transferToResponse($responseInstance);
140 * Adds extra filters to the given controller instance
142 * @param $controllerInstance A controller instance
143 * @param $requestInstance An instance of a class with an Requestable interface
146 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {