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