Updated ApplicationHelper class to latest API
authorRoland Häder <roland@mxchange.org>
Thu, 20 Dec 2012 21:19:45 +0000 (21:19 +0000)
committerRoland Häder <roland@mxchange.org>
Thu, 20 Dec 2012 21:19:45 +0000 (21:19 +0000)
application/qa/class_ApplicationHelper.php

index b19ff75..1ec577a 100644 (file)
  * loader is loading classes from "exceptions", "interfaces" and "main"!
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
- * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 QA Developer Team
+ * @version            0.0
+ * @copyright  Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 QA Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @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
@@ -37,9 +36,9 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable {
+class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication, Registerable {
        /**
         * The version number of this application
         */
@@ -56,17 +55,12 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
        private $shortName = '';
 
        /**
-        * An instance of a controller
-        */
-       private $controllerInstance = NULL;
-
-       /**
         * An instance of this class
         */
        private static $selfInstance = NULL;
 
        /**
-        * Protected constructor
+        * Private constructor
         *
         * @return      void
         */
@@ -93,22 +87,20 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
        /**
         * Getter for the version number
         *
-        * @return      $appVersion             The application's version number
+        * @return      $appVersion     The application's version number
         */
        public final function getAppVersion () {
                return $this->appVersion;
        }
-
        /**
         * Setter for the version number
         *
-        * @param       $appVersion             The application's version number
+        * @param       $appVersion     The application's version number
         * @return      void
         */
        public final function setAppVersion ($appVersion) {
                // Cast and set it
-               $appVersion = (string) $appVersion;
-               $this->appVersion = $appVersion;
+               $this->appVersion = (string) $appVersion;
        }
 
        /**
@@ -128,8 +120,7 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
         */
        public final function setAppName ($appName) {
                // Cast and set it
-               $appName = (string) $appName;
-               $this->appName = $appName;
+               $this->appName = (string) $appName;;
        }
 
        /**
@@ -149,25 +140,11 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
         */
        public final function setAppShortName ($shortName) {
                // Cast and set it
-               $shortName = (string) $shortName;
-               $this->shortName = $shortName;
-       }
-
-       /**
-        * Builds the master template's name
-        *
-        * @return      $masterTemplateName             Name of the master template
-        */
-       public function buildMasterTemplateName () {
-               // Get short name and add suffix
-               $masterTemplateName = str_replace("-", "", $this->getAppShortName()) . "_main";
-
-               // Return it
-               return $masterTemplateName;
+               $this->shortName = (string) $shortName;
        }
 
        /**
-        * Launches the admin area
+        * Launches the application
         *
         * @return      void
         */
@@ -175,16 +152,16 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
                // Set this application in registry
                Registry::getRegistry()->addInstance('app', $this);
 
+               // Default response is console
+               $response = $this->getResponseTypeFromSystem();
+               $responseType = $this->getResponseTypeFromSystem();
+
                // Create a new request object
-               $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
+               $requestInstance = ObjectFactory::createObjectByName($this->convertToClassName($response) . 'Request');
 
                // 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
@@ -200,7 +177,7 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
                $this->setResponseInstance($responseInstance);
 
                // Get the parameter from the request
-               $commandName = $requestInstance->getRequestElement('page');
+               $commandName = $requestInstance->getRequestElement('command');
 
                // If it is null then get default command
                if (is_null($commandName)) {
@@ -208,24 +185,18 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
                        $commandName = $responseInstance->getDefaultCommand();
 
                        // Set it in request
-                       $requestInstance->setRequestElement('page', $commandName);
+                       $requestInstance->setRequestElement('command', $commandName);
                } // END - if
 
                // Get a resolver
-               $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
+               $resolverClass = $this->convertToClassName($this->getAppShortName() . '_' . $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);
+               $this->setControllerInstance($resolverInstance->resolveController());
 
-               // Handle the request
-               $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
+               // Launch the main routine here
+               $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
        }
 
        /**
@@ -238,19 +209,17 @@ class ApplicationHelper extends BaseApplication implements ManageableApplication
        public function handleFatalMessages (array $messageList) {
                // Walk through all messages
                foreach ($messageList as $message) {
-                       print("MSG:".$message."<br />\n");
-               } // END - if
+                       exit(__METHOD__ . ':MSG:' . $message);
+               } // END - foreach
        }
 
        /**
-        * Assigns application-depending data
+        * Builds the master template's name
         *
-        * @param       $templateInstance       An instance of a template engine
-        * @return      void
+        * @return      $masterTemplateName             Name of the master template
         */
-       public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
-               // Assign charset
-               $templateInstance->assignConfigVariable('header_charset');
+       public function buildMasterTemplateName () {
+               return 'node_main';
        }
 }