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