readConfig() is not naming convention, renamed to getConfigEntry()

[shipsimu.git] / application / ship-simu / class_ApplicationHelper.php

diff --git a/application/ship-simu/class_ApplicationHelper.php b/application/ship-simu/class_ApplicationHelper.php
index abe7536647c7cfdd4949261f724c2e09b51bf6de..f459a64580f07b87f0511978696bd9f57a99856e 100644 (file)
--- a/application/ship-simu/class_ApplicationHelper.php
+++ b/application/ship-simu/class_ApplicationHelper.php
@@ -22,9 +22,9 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.ship-simu.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
@@ -39,7 +39,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication {
+class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable {
        /**
         * The version number of this application
         */
@@ -55,11 +55,6 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         */
        private $shortName = "";
 
-       /**
-        * The name of the master template
-        */
-       private $masterTemplate = "shipsimu_main";
-
        /**
         * An instance of a controller
         */
@@ -69,6 +64,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         * An instance of this class
         */
        private static $thisInstance = null;
+
        /**
         * Protected constructor
         *
@@ -77,15 +73,6 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Set description
-               $this->setObjectDescription("Application-Helper");
-
-               // Create an unique ID
-               $this->createUniqueID();
-
-               // Tidy up a little
-               $this->removeSystemArray();
        }
 
        /**
@@ -167,16 +154,20 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        }
 
        /**
-        * Getter for master template name
+        * Builds the master template's name
         *
-        * @return      $masterTemplate         Name of the master template
+        * @return      $masterTemplateName             Name of the master template
         */
-       public final function getMasterTemplate () {
-               return $this->masterTemplate;
+       public function buildMasterTemplateName () {
+               // Get short name and add suffix
+               $masterTemplateName = str_replace("-", "", $this->getAppShortName()) . "_main";
+
+               // Return it
+               return $masterTemplateName;
        }
 
        /**
-        * Launches the ship-simulator game
+        * Launches the admin area
         *
         * @return      void
         */
@@ -184,25 +175,45 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
                // Create a new request object
                $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
 
+               // Remember request instance here
+               $this->setRequestInstance($requestInstance);
+
+               // Default response is HTTP (HTML page) and type is "Web"
+               $response = "http";
+               $responseType = "web";
+
+               // Do we have another response?
+               if ($requestInstance->isRequestElementSet('request')) {
+                       // Then use it
+                       $response = strtolower($requestInstance->getRequestElement('request'));
+                       $responseType = $response;
+               } // END - if
+
                // ... and a new response object
-               $responseInstance = HttpResponse::createHttpResponse($this);
+               $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
+               $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
 
-               // Get command parameter
-               $commandPara = $this->getConfigInstance()->readConfig('command_parameter');
+               // Remember response instance here
+               $this->setResponseInstance($responseInstance);
 
                // Get the parameter from the request
-               $commandName = $requestInstance->getRequestElement($commandPara);
+               $commandName = $requestInstance->getRequestElement('page');
 
                // If it is null then get default command
                if (is_null($commandName)) {
-                       $commandName = $this->getConfigInstance()->readConfig('default_command');
-               }
+                       // Get the default command
+                       $commandName = $responseInstance->getDefaultCommand();
+
+                       // Set it in request
+                       $requestInstance->setRequestElement('page');
+               } // END - if
 
                // Get a resolver
-               $resolverInstance = WebControllerResolver::createWebControllerResolver($commandName, $this);
+               $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
+               $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
 
                // Get a controller instance as well
-               $this->controllerInstance = $resolverInstance->resolveCommandController();
+               $this->controllerInstance = $resolverInstance->resolveController();
 
                // Handle the request
                $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
@@ -219,7 +230,18 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
                // Walk through all messages
                foreach ($messageList as $message) {
                        print("MSG:".$message."<br />\n");
-               }
+               } // END - if
+       }
+
+       /**
+        * Assigns application-depending data
+        *
+        * @param       $templateInstance       An instance of a template engine
+        * @return      void
+        */
+       public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
+               // Assign charset
+               $templateInstance->assignConfigVariable('header_charset');
        }
 }