Added sendGenericGetResponse() which sends a generic HTML GET response to the

[core.git] / inc / classes / main / commands / class_BaseCommand.php

diff --git a/inc/classes/main/commands/class_BaseCommand.php b/inc/classes/main/commands/class_BaseCommand.php
index 9b9238885cc7eebbedf348c3bdf2f776b0158040..03c715ac770693c635e974867cd1c2a21e191e8a 100644 (file)
--- a/inc/classes/main/commands/class_BaseCommand.php
+++ b/inc/classes/main/commands/class_BaseCommand.php
@@ -2,11 +2,11 @@
 /**
  * A general (base) command
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -22,11 +22,6 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class BaseCommand extends BaseFrameworkSystem {
-       /**
-        * The controller we need for this command
-        */
-       private $controllerName = '';
-
        /**
         * Protected constructor
         *
@@ -39,22 +34,73 @@ class BaseCommand extends BaseFrameworkSystem {
        }
 
        /**
-        * Setter for controller name
+        * Sends a generic HTTP response with header, menu, content and footer
         *
-        * @param       $controllerName         Name of the controller assigned with this command
+        * @param       $requestInstance        An instance of a class with an Requestable interface
+        * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
         */
-       public final function setControllerName ($controllerName) {
-               $this->controllerName = (string) $controllerName;
-       }
+       protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance) {
+               // This command doesn't handle any POST requests, so only handle get request
+               assert(!$requestInstance->isPostRequestMethod());
 
-       /**
-        * Getter for controller name
-        *
-        * @return      $controllerName         Name of the controller assigned with this command
-        */
-       public final function getControllerName () {
-               return $this->controllerName;
+               // Get the application instance
+               $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
+
+               // Prepare a template instance
+               $templateInstance = $this->prepareTemplateInstance($applicationInstance);
+
+               // Transfer application data
+               $templateInstance->assignApplicationData($applicationInstance);
+
+               // Load the master template
+               $masterTemplate = $applicationInstance->buildMasterTemplateName();
+
+               // Load header template
+               $templateInstance->loadCodeTemplate('header');
+
+               // Compile and assign it with a variable
+               $templateInstance->compileTemplate();
+               $templateInstance->assignTemplateWithVariable('header', 'header');
+
+               // Load footer template
+               $templateInstance->loadCodeTemplate('footer');
+
+               // Compile and assign it with a variable
+               $templateInstance->compileTemplate();
+               $templateInstance->assignTemplateWithVariable('footer', 'footer');
+
+               // Load the content template
+               $templateInstance->loadCodeTemplate($this->getResolverInstance()->getCommandName());
+
+               // Assign the content template with the master template as a content ... ;)
+               $templateInstance->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
+
+               // Load the master template
+               $templateInstance->loadCodeTemplate($masterTemplate);
+
+               // Set title
+               $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
+
+               // Construct the menu in every command. We could do this in BaseCommand class. But this means
+               // *every* command has a navigation system and that is want we don't want.
+               $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance));
+
+               // Render the menu
+               $menuInstance->renderMenu();
+
+               // Transfer it to the template engine instance
+               $menuInstance->transferContentToTemplateEngine($templateInstance);
+
+               /*
+                * ... and all variables. This should be merged together in a pattern
+                * to make things easier. A cache mechanism should be added between
+                * these two calls to cache compiled templates.
+                */
+               $templateInstance->compileVariables();
+
+               // Get the content back from the template engine and put it in response class
+               $templateInstance->transferToResponse($responseInstance);
        }
 }