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

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