inc/classes/main/commands/web/class_WebLoginAreaCommand.php

   1 <?php
   2 /**
   3  * A command for the login area (member/gamer area)
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class WebLoginAreaCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set special description
  35                 $this->setObjectDescription("Command for the &quot;home&quot; page");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @param       $resolverInstance               An instance of a command resolver class
  48          * @return      $commandInstance                An instance a prepared command class
  49          */
  50         public final static function createWebLoginAreaCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new WebLoginAreaCommand();
  53
  54                 // Set the application instance
  55                 $commandInstance->setResolverInstance($resolverInstance);
  56
  57                 // Load general data like user status and such
  58                 $commandInstance->prepareCommand();
  59
  60                 // Return the prepared instance
  61                 return $commandInstance;
  62         }
  63
  64         /**
  65          * Prepares some general data which shall be displayed on every page
  66          *
  67          * @return      void
  68          */
  69         protected function prepareCommand () {
  70                 /* @TODO Add some stuff here: Some personal data, app/game related data */
  71         }
  72
  73         /**
  74          * Executes the given command with given request and response objects
  75          *
  76          * @param       $requestInstance                An instance of a class with an Requestable interface
  77          * @param       $responseInstance               An instance of a class with an Responseable interface
  78          * @return      void
  79          */
  80         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  81                 // Default action is the one from configuration
  82                 $actionClass = sprintf("login_%s_action_class", $this->getConfigInstance()->readConfig('login_default_action'));
  83                 $action = sprintf("login_%s", $this->getConfigInstance()->readConfig('login_default_action'));
  84
  85                 // Get "action" from request
  86                 $actReq = $requestInstance->getRequestElement('action');
  87
  88                 // Do we have a "action" parameter set?
  89                 if (is_string($actReq)) {
  90                         // Then use it with prefix
  91                         $actionClass = sprintf("login_%s_action_class", $actReq);
  92                         $action = sprintf("login_%s", $actReq);
  93                 } // END - if
  94
  95                 // Get an action instance
  96                 $actionInstance = ObjectFactory::createObjectByConfiguredName($actionClass);
  97
  98                 // Execute the action (shall not output anything, see below why)
  99                 $actionInstance->execute($requestInstance, $responseInstance);
 100
 101                 // Get the application instance
 102                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
 103
 104                 // Prepare a template instance
 105                 $templateInstance = $this->prepareTemplateEngine($appInstance);
 106
 107                 // Assign all the application's data with template variables
 108                 $templateInstance->assignApplicationData($appInstance);
 109
 110                 // Load the master template
 111                 $masterTemplate = $appInstance->getMasterTemplate();
 112
 113                 // Load header template
 114                 $templateInstance->loadCodeTemplate("header");
 115
 116                 // Compile and assign it with a variable
 117                 $templateInstance->compileTemplate();
 118                 $templateInstance->assignTemplateWithVariable("header", "header");
 119
 120                 // Load footer template
 121                 $templateInstance->loadCodeTemplate("footer");
 122
 123                 // Compile and assign it with a variable
 124                 $templateInstance->compileTemplate();
 125                 $templateInstance->assignTemplateWithVariable("footer", "footer");
 126
 127                 // Load the matching template
 128                 $templateInstance->loadCodeTemplate($action);
 129
 130                 // Assign the template with the master template as a content ... ;)
 131                 $templateInstance->assignTemplateWithVariable($action, "content");
 132
 133                 // Load the master template
 134                 $templateInstance->loadCodeTemplate($masterTemplate);
 135
 136                 // Set title
 137                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage("login_{$action}_title"));
 138
 139                 // ... and all variables. This should be merged together in a pattern
 140                 // to make things easier. A cache mechanism should be added between
 141                 // these two calls to cache compiled templates.
 142                 $templateInstance->compileVariables();
 143
 144                 // Get the content back from the template engine and put it in the response class
 145                 $templateInstance->transferToResponse($responseInstance);
 146         }
 147 }
 148
 149 // [EOF]
 150 ?>