3 * A command for the login area (member/gamer area)
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
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 WebLoginAreaCommand extends BaseCommand implements Commandable {
28 private $actionName = "";
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set special description
40 $this->setObjectDescription("Command for the "login area" page");
42 // Create unique ID number
43 $this->generateUniqueId();
46 $this->removeSystemArray();
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 final static function createWebLoginAreaCommand (CommandResolver $resolverInstance) {
57 $commandInstance = new WebLoginAreaCommand();
59 // Set the application instance
60 $commandInstance->setResolverInstance($resolverInstance);
62 // Load general data like user status and such
63 $commandInstance->prepareCommand();
65 // Return the prepared instance
66 return $commandInstance;
70 * Prepares some general data which shall be displayed on every page
73 * @todo Add some stuff here: Some personal data, app/game related data
75 protected function prepareCommand () {
79 * Executes the given command with given request and response objects
81 * @param $requestInstance An instance of a class with an Requestable interface
82 * @param $responseInstance An instance of a class with an Responseable interface
85 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
86 // Get the action instance from registry
87 $actionInstance = Registry::getRegistry()->getInstance('action');
89 // Do we have an action here?
90 if ($actionInstance instanceof PerformableAction) {
91 // Execute the action (shall not output anything, see below why)
92 $actionInstance->execute($requestInstance, $responseInstance);
95 // Get the application instance
96 $appInstance = $this->getResolverInstance()->getApplicationInstance();
98 // Prepare a template instance
99 $templateInstance = $this->prepareTemplateEngine($appInstance);
102 $templateInstance->assignConfigVariable('base_url');
104 // Assign all the application's data with template variables
105 $templateInstance->assignApplicationData($appInstance);
107 // Load the master template
108 $masterTemplate = $appInstance->getMasterTemplate();
110 // Load header template
111 $templateInstance->loadCodeTemplate('header');
113 // Compile and assign it with a variable
114 $templateInstance->compileTemplate();
115 $templateInstance->assignTemplateWithVariable('header', 'header');
117 // Load footer template
118 $templateInstance->loadCodeTemplate('footer');
120 // Compile and assign it with a variable
121 $templateInstance->compileTemplate();
122 $templateInstance->assignTemplateWithVariable('footer', 'footer');
124 // Load the matching template
125 $templateInstance->loadCodeTemplate($this->actionName);
127 // Assign the template with the master template as a content ... ;)
128 $templateInstance->compileTemplate();
129 $templateInstance->assignTemplateWithVariable($this->actionName, "login_content");
131 // Load main template
132 $templateInstance->loadCodeTemplate('login_main');
134 // Assign the main template with the master template as a content ... ;)
135 $templateInstance->compileTemplate();
136 $templateInstance->assignTemplateWithVariable('login_main', 'content');
138 // Load the master template
139 $templateInstance->loadCodeTemplate($masterTemplate);
142 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage($this->actionName . '_title'));
144 // ... and all variables. This should be merged together in a pattern
145 // to make things easier. A cache mechanism should be added between
146 // these two calls to cache compiled templates.
147 $templateInstance->compileVariables();
149 // Get the content back from the template engine and put it in the response class
150 $templateInstance->transferToResponse($responseInstance);
154 * Adds extra filters to the given controller instance
156 * @param $controllerInstance A controller instance
157 * @param $requestInstance An instance of a class with an Requestable interface
160 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
161 // Default is no action
162 $actionInstance = null;
164 // Default action is the one from configuration
165 $this->actionName = sprintf("login_%s", $this->getConfigInstance()->readConfig('login_default_action'));
167 // Get "action" from request
168 $actReq = $requestInstance->getRequestElement('action');
170 // Do we have a "action" parameter set?
171 if ((is_string($actReq)) && (!empty($actReq))) {
172 // Then use it with prefix
173 $this->actionName = sprintf("login_%s", $actReq);
176 // Get application instance
177 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
179 // Try to get an action resolver for the given action
182 $actionResolver = WebActionResolver::createWebActionResolver($this->actionName, $applicationInstance);
184 // Resolve the action
185 $actionInstance = $actionResolver->resolveAction();
187 // Add more action-specific filters
188 $actionInstance->addExtraFilters($controllerInstance, $requestInstance);
190 // Remember this action in registry
191 Registry::getRegistry()->addInstance('action', $actionInstance);
192 } catch (InvalidActionException $e) {
193 // Silently ignored because no special action was found