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

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