3 * A command for the login form
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class WebLoginCommand extends BaseCommand implements Commandable, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $resolverInstance An instance of a command resolver class
39 * @return $commandInstance An instance a prepared command class
41 public final static function createWebLoginCommand (CommandResolver $resolverInstance) {
43 $commandInstance = new WebLoginCommand();
45 // Set the application instance
46 $commandInstance->setResolverInstance($resolverInstance);
48 // Return the prepared instance
49 return $commandInstance;
53 * Executes the given command with given request and response objects
55 * @param $requestInstance An instance of a class with an Requestable interface
56 * @param $responseInstance An instance of a class with an Responseable interface
59 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60 // Set request instance as extra instance
61 Registry::getRegistry()->addInstance('extra', $this);
63 // Get the application instance
64 $appInstance = $this->getResolverInstance()->getApplicationInstance();
66 // Prepare a template instance
67 $templateInstance = $this->prepareTemplateInstance($appInstance);
69 // Assign application data with template engine
70 $templateInstance->assignApplicationData($appInstance);
73 $templateInstance->assignConfigVariable('base_url');
75 // Load the master template
76 $masterTemplate = $appInstance->buildMasterTemplateName();
78 // Load header template
79 $templateInstance->loadCodeTemplate('header');
81 // Compile and assign it with a variable
82 $templateInstance->compileTemplate();
83 $templateInstance->assignTemplateWithVariable('header', 'header');
85 // Load footer template
86 $templateInstance->loadCodeTemplate('footer');
88 // Compile and assign it with a variable
89 $templateInstance->compileTemplate();
90 $templateInstance->assignTemplateWithVariable('footer', 'footer');
92 // Load the home template
93 $templateInstance->loadCodeTemplate('login_form');
95 // Assign the home template with the master template as a content ... ;)
96 $templateInstance->assignTemplateWithVariable('login_form', 'content');
98 // Load the master template
99 $templateInstance->loadCodeTemplate($masterTemplate);
102 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
104 // Construct the menu in every command. We could do this in BaseCommand class. But this means
105 // *every* command has a navigation system and that is want we don't want.
106 $menuInstance = ObjectFactory::createObjectByConfiguredName('login_menu_class', array($appInstance));
108 // ... and all variables. This should be merged together in a pattern
109 // to make things easier. A cache mechanism should be added between
110 // these two calls to cache compiled templates.
111 $templateInstance->compileVariables();
113 // Get the content back from the template engine and put it in response class
114 $templateInstance->transferToResponse($responseInstance);
118 * Adds extra filters to the given controller instance
120 * @param $controllerInstance A controller instance
121 * @param $requestInstance An instance of a class with an Requestable interface
124 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {