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

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