inc/main/classes/commands/html/class_HtmlLoginAreaCommand.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Command\Login;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Registry\Generic\Registry;
   8 use CoreFramework\Request\Requestable;
   9 use CoreFramework\Response\Responseable;
  10
  11 /**
  12  * A command for the login area (member/gamer area)
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class HtmlLoginAreaCommand extends BaseCommand implements Commandable {
  34         /**
  35          * Name of the action
  36          */
  37         private $actionName = '';
  38
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         protected function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Creates an instance of this class
  51          *
  52          * @param       $resolverInstance       An instance of a command resolver class
  53          * @return      $commandInstance        An instance a prepared command class
  54          */
  55         public static final function createHtmlLoginAreaCommand (CommandResolver $resolverInstance) {
  56                 // Get new instance
  57                 $commandInstance = new HtmlLoginAreaCommand();
  58
  59                 // Set the application instance
  60                 $commandInstance->setResolverInstance($resolverInstance);
  61
  62                 // Load general data like user status and such
  63                 $commandInstance->prepareCommand();
  64
  65                 // Return the prepared instance
  66                 return $commandInstance;
  67         }
  68
  69         /**
  70          * Prepares some general data which shall be displayed on every page
  71          *
  72          * @return      void
  73          * @todo        Add some stuff here: Some personal data, app/game related data
  74          */
  75         protected function prepareCommand () {
  76         }
  77
  78         /**
  79          * Executes the given command with given request and response objects
  80          *
  81          * @param       $requestInstance        An instance of a class with an Requestable interface
  82          * @param       $responseInstance       An instance of a class with an Responseable interface
  83          * @return      void
  84          */
  85         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  86                 // Get the action instance from registry
  87                 $actionInstance = Registry::getRegistry()->getInstance('action');
  88
  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);
  93                 } // END - if
  94
  95                 // Get the application instance
  96                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
  97
  98                 // Prepare a template instance
  99                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
 100
 101                 // Assign base URL
 102                 $templateInstance->assignConfigVariable('base_url');
 103
 104                 // Assign all the application's data with template variables
 105                 $templateInstance->assignApplicationData($applicationInstance);
 106
 107                 // Load the master template
 108                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
 109
 110                 // Load header template
 111                 $templateInstance->loadCodeTemplate('header');
 112
 113                 // Compile and assign it with a variable
 114                 $templateInstance->compileTemplate();
 115                 $templateInstance->assignTemplateWithVariable('header', 'header');
 116
 117                 // Load footer template
 118                 $templateInstance->loadCodeTemplate('footer');
 119
 120                 // Compile and assign it with a variable
 121                 $templateInstance->compileTemplate();
 122                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
 123
 124                 // Load the matching template
 125                 $templateInstance->loadCodeTemplate('action_' . $this->actionName);
 126
 127                 // Assign the template with the master template as a content ... ;)
 128                 $templateInstance->compileTemplate();
 129                 $templateInstance->assignTemplateWithVariable('action_' . $this->actionName, 'login_content');
 130
 131                 // Load main template
 132                 $templateInstance->loadCodeTemplate('login_main');
 133
 134                 // Assign the main template with the master template as a content ... ;)
 135                 $templateInstance->compileTemplate();
 136                 $templateInstance->assignTemplateWithVariable('login_main', 'main_content');
 137
 138                 // Load the master template
 139                 $templateInstance->loadCodeTemplate($masterTemplate);
 140
 141                 // Set title
 142                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage($this->actionName . '_title'));
 143
 144                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 145                 // *every* command has a navigation system and that is want we don't want.
 146                 $menuInstance = ObjectFactory::createObjectByConfiguredName('login_area_menu_class', array($applicationInstance));
 147
 148                 // Render the menu
 149                 $menuInstance->renderMenu();
 150
 151                 // Transfer it to the template engine instance
 152                 $menuInstance->transferContentToTemplateEngine($templateInstance);
 153
 154                 /*
 155                  * ... and all variables. This should be merged together in a pattern
 156                  * to make things easier. A cache mechanism should be added between
 157                  * these two calls to cache compiled templates.
 158                  */
 159                 $templateInstance->compileVariables();
 160
 161                 // Get the content back from the template engine and put it in response class
 162                 $templateInstance->transferToResponse($responseInstance);
 163         }
 164
 165         /**
 166          * Adds extra filters to the given controller instance. An corresponding action class must now exist!
 167          *
 168          * @param       $controllerInstance             A controller instance
 169          * @param       $requestInstance                An instance of a class with an Requestable interface
 170          * @return      void
 171          */
 172         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 173                 // Default is no action
 174                 $actionInstance = NULL;
 175
 176                 // Get registry
 177                 $registryInstance = Registry::getRegistry();
 178
 179                 // Get our application instance from the registry
 180                 $applicationInstance = $registryInstance->getInstance('application');
 181
 182                 // Default action is the one from configuration
 183                 $this->actionName = self::convertDashesToUnderscores($applicationInstance->getAppShortName()) . '_login_' . $this->getConfigInstance()->getConfigEntry('login_default_action');
 184
 185                 // Get "action" from request
 186                 $actReq = $requestInstance->getRequestElement('action');
 187
 188                 // Do we have a "action" parameter set?
 189                 if ((is_string($actReq)) && (!empty($actReq))) {
 190                         // Then use it with prefix
 191                         $this->actionName = self::convertDashesToUnderscores($applicationInstance->getAppShortName()) . '_login_' . $actReq;
 192                 } // END - if
 193
 194                 // Get application instance
 195                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
 196
 197                 // Get a resolver
 198                 $actionResolver = HtmlActionResolver::createHtmlActionResolver($this->actionName, $applicationInstance);
 199
 200                 // Resolve the action
 201                 $actionInstance = $actionResolver->resolveAction();
 202
 203                 // Add more action-specific filters
 204                 $actionInstance->addExtraFilters($controllerInstance, $requestInstance);
 205
 206                 // Remember this action in registry
 207                 Registry::getRegistry()->addInstance('action', $actionInstance);
 208         }
 209
 210 }