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