Renamed getInstance() to getSelfInstance(), conflicts BaseRegistry versus several...

[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 43cac8875ee8dd3b00f605b940da6f9ce5ed83ba..9d40b3d915ee3e04433e0dbd30e956f2401b6a3a 100644 (file)
--- a/application/ship-simu/class_ApplicationHelper.php
+++ b/application/ship-simu/class_ApplicationHelper.php
@@ -22,7 +22,7 @@
  *
  * @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
  *
@@ -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
         */
@@ -78,10 +73,6 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Tidy up a little
-               $this->removeSystemArray();
-               $this->removeNumberFormaters();
        }
 
        /**
@@ -89,11 +80,11 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         *
         * @return      $thisInstance           An instance of this class
         */
-       public final static function getInstance () {
+       public static final function getInstance () {
                // Is the instance there?
                if (is_null(self::$thisInstance)) {
                        self::$thisInstance = new ApplicationHelper();
-               }
+               } // END - if
 
                // Return the instance
                return self::$thisInstance;
@@ -163,39 +154,53 @@ 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
         */
        public final function entryPoint () {
+               // Set this application in registry
+               Registry::getRegistry()->addInstance('app', $this);
+
+               // Analyze the environment for type of response/request
+               $type = ConsoleTools::analyzeEnvironmentForType();
+               $classType = ConsoleTools::analyzeEnvironmentForClassType();
+
                // Create a new request object
-               $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
+               $requestInstance = ObjectFactory::createObjectByName(ucfirst($type) . 'Request');
+
+               // Remember request instance here
+               $this->setRequestInstance($requestInstance);
 
-               // Default response is HTTP (HTML page) and type is "Web"
-               $response = "http";
-               $responseType = "web";
+               // Default response is HTTP (HTML page) and type is 'Web'
+               $response = $type;
+               $responseType = $classType;
 
                // Do we have another response?
-               if ($requestInstance->isRequestElementSet('response')) {
+               if ($requestInstance->isRequestElementSet('request')) {
                        // Then use it
-                       $response = strtolower($requestInstance->getRequestElement('response'));
+                       $response = strtolower($requestInstance->getRequestElement('request'));
                        $responseType = $response;
                } // END - if
 
                // ... and a new response object
-               $responseInstance = ObjectFactory::createObjectByName(ucfirst($response)."Response", array($this));
+               $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
+               $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
 
-               // Remember both in this application
-               $this->setRequestInstance($requestInstance);
+               // Remember response instance here
                $this->setResponseInstance($responseInstance);
 
                // Get the parameter from the request
@@ -203,15 +208,26 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
 
                // If it is null then get default command
                if (is_null($commandName)) {
+                       // Get the default command
                        $commandName = $responseInstance->getDefaultCommand();
+
+                       // Set it in request
+                       $requestInstance->setRequestElement('page', $commandName);
                } // END - if
 
                // Get a resolver
-               $resolverInstance = ObjectFactory::createObjectByName(ucfirst($responseType)."ControllerResolver", array($commandName, $this));
+               $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
+               $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
 
                // Get a controller instance as well
                $this->controllerInstance = $resolverInstance->resolveController();
 
+               // Get a web output class
+               $outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($this));
+
+               // Set it in this application
+               $this->setWebOutputInstance($outputInstance);
+
                // Handle the request
                $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
        }
@@ -229,6 +245,17 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
                        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');
+       }
 }
 
 // [EOF]