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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Command\Status;
   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 Status 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 HtmlStatusCommand 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 createHtmlStatusCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new HtmlStatusCommand();
  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          * @todo        0% done
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Get the application instance
  71                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
  72
  73                 // Prepare a template instance
  74                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  75
  76                 // Transfer application data
  77                 $templateInstance->assignApplicationData($applicationInstance);
  78
  79                 // Load the master template
  80                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
  81
  82                 // Load header template
  83                 $templateInstance->loadCodeTemplate('header');
  84
  85                 // Compile and assign it with a variable
  86                 $templateInstance->compileTemplate();
  87                 $templateInstance->assignTemplateWithVariable('header', 'header');
  88
  89                 // Load footer template
  90                 $templateInstance->loadCodeTemplate('footer');
  91
  92                 // Compile and assign it with a variable
  93                 $templateInstance->compileTemplate();
  94                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
  95
  96                 // Load the status template
  97                 $templateInstance->loadCodeTemplate('status');
  98
  99                 // Assign the status template with the master template as a content ... ;)
 100                 $templateInstance->assignTemplateWithVariable('status', 'main_content');
 101
 102                 // Load the master template
 103                 $templateInstance->loadCodeTemplate($masterTemplate);
 104
 105                 // Set title
 106                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_status_title'));
 107
 108                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 109                 // *every* command has a navigation system and that is want we don't want.
 110                 $menuInstance = ObjectFactory::createObjectByConfiguredName('status_menu_class', array($applicationInstance));
 111
 112                 // Render the menu
 113                 $menuInstance->renderMenu();
 114
 115                 // Transfer it to the template engine instance
 116                 $menuInstance->transferContentToTemplateEngine($templateInstance);
 117
 118                 /*
 119                  * ... and all variables. This should be merged together in a pattern
 120                  * to make things easier. A cache mechanism should be added between
 121                  * these two calls to cache compiled templates.
 122                  */
 123                 $templateInstance->compileVariables();
 124
 125                 // Get the content back from the template engine and put it in response class
 126                 $templateInstance->transferToResponse($responseInstance);
 127         }
 128
 129         /**
 130          * Adds extra filters to the given controller instance
 131          *
 132          * @param       $controllerInstance             A controller instance
 133          * @param       $requestInstance                An instance of a class with an Requestable interface
 134          * @return      void
 135          */
 136         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 137                 // Empty for now
 138         }
 139
 140 }