application/city/classes/commands/html/class_CityHtmlLoginCommand.php

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