framework/main/classes/commands/html/class_HtmlStatusCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Command\Status;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
   7 use Org\Mxchange\CoreFramework\Command\Commandable;
   8 use Org\Mxchange\CoreFramework\Controller\Controller;
   9 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  12 use Org\Mxchange\CoreFramework\Response\Responseable;
  13
  14 /**
  15  * A command for Status page
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class HtmlStatusCommand extends BaseCommand implements Commandable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this class
  49          *
  50          * @param       $resolverInstance       An instance of a command resolver class
  51          * @return      $commandInstance        An instance a prepared command class
  52          */
  53         public static final function createHtmlStatusCommand (CommandResolver $resolverInstance) {
  54                 // Get new instance
  55                 $commandInstance = new HtmlStatusCommand();
  56
  57                 // Set the application instance
  58                 $commandInstance->setResolverInstance($resolverInstance);
  59
  60                 // Return the prepared instance
  61                 return $commandInstance;
  62         }
  63
  64         /**
  65          * Executes the given command with given request and response objects
  66          *
  67          * @param       $requestInstance        An instance of a class with an Requestable interface
  68          * @param       $responseInstance       An instance of a class with an Responseable interface
  69          * @return      void
  70          * @todo        0% done
  71          */
  72         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  73                 // Get the application instance
  74                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
  75
  76                 // Prepare a template instance
  77                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  78
  79                 // Transfer application data
  80                 $templateInstance->assignApplicationData();
  81
  82                 // Load the master template
  83                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
  84
  85                 // Load header template
  86                 $templateInstance->loadCodeTemplate('header');
  87
  88                 // Compile and assign it with a variable
  89                 $templateInstance->compileTemplate();
  90                 $templateInstance->assignTemplateWithVariable('header', 'header');
  91
  92                 // Load footer template
  93                 $templateInstance->loadCodeTemplate('footer');
  94
  95                 // Compile and assign it with a variable
  96                 $templateInstance->compileTemplate();
  97                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
  98
  99                 // Load the status template
 100                 $templateInstance->loadCodeTemplate('status');
 101
 102                 // Assign the status template with the master template as a content ... ;)
 103                 $templateInstance->assignTemplateWithVariable('status', 'main_content');
 104
 105                 // Load the master template
 106                 $templateInstance->loadCodeTemplate($masterTemplate);
 107
 108                 // Set title
 109                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_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('status_menu_class', array($applicationInstance));
 114
 115                 // Render the menu
 116                 $menuInstance->renderMenu();
 117
 118                 // Transfer it to the template engine instance
 119                 $menuInstance->transferContentToTemplateEngine($templateInstance);
 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                 $templateInstance->compileVariables();
 127
 128                 // Get the content back from the template engine and put it in response class
 129                 $templateInstance->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 }