framework/main/classes/commands/html/class_HtmlLoginCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Command\Login;
   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\Factory\ObjectFactory;
  10 use Org\Mxchange\CoreFramework\Registry\Registry;
  11 use Org\Mxchange\CoreFramework\Request\Requestable;
  12 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  13 use Org\Mxchange\CoreFramework\Response\Responseable;
  14
  15 /**
  16  * A command for the login form
  17  *
  18  * @author              Roland Haeder <webmaster@shipsimu.org>
  19  * @version             0.0.0
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  24  * This program is free software: you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation, either version 3 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License
  35  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  36  */
  37 class HtmlLoginCommand extends BaseCommand implements Commandable {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of this class
  50          *
  51          * @param       $resolverInstance       An instance of a command resolver class
  52          * @return      $commandInstance        An instance a prepared command class
  53          */
  54         public static final function createHtmlLoginCommand (CommandResolver $resolverInstance) {
  55                 // Get new instance
  56                 $commandInstance = new HtmlLoginCommand();
  57
  58                 // Set the application instance
  59                 $commandInstance->setResolverInstance($resolverInstance);
  60
  61                 // Return the prepared instance
  62                 return $commandInstance;
  63         }
  64
  65         /**
  66          * Executes the given command with given request and response objects
  67          *
  68          * @param       $requestInstance        An instance of a class with an Requestable interface
  69          * @param       $responseInstance       An instance of a class with an Responseable interface
  70          * @return      void
  71          */
  72         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  73                 // Set request instance as extra instance
  74                 Registry::getRegistry()->addInstance('extra', $this);
  75
  76                 // Get the application instance
  77                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  78
  79                 // Prepare a template instance
  80                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  81
  82                 // Assign application data with template engine
  83                 $templateInstance->assignApplicationData($applicationInstance);
  84
  85                 // Assign base URL
  86                 $templateInstance->assignConfigVariable('base_url');
  87
  88                 // Load the master template
  89                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
  90
  91                 // Load header template
  92                 $templateInstance->loadCodeTemplate('header');
  93
  94                 // Compile and assign it with a variable
  95                 $templateInstance->compileTemplate();
  96                 $templateInstance->assignTemplateWithVariable('header', 'header');
  97
  98                 // Load footer template
  99                 $templateInstance->loadCodeTemplate('footer');
 100
 101                 // Compile and assign it with a variable
 102                 $templateInstance->compileTemplate();
 103                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
 104
 105                 // Load the home template
 106                 $templateInstance->loadCodeTemplate('login_form');
 107
 108                 // Assign the home template with the master template as a content ... ;)
 109                 $templateInstance->assignTemplateWithVariable('login_form', 'main_content');
 110
 111                 // Load the master template
 112                 $templateInstance->loadCodeTemplate($masterTemplate);
 113
 114                 // Set title
 115                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_login_title'));
 116
 117                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 118                 // *every* command has a navigation system and that is want we don't want.
 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
 149 }