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

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