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