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