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