]> git.mxchange.org Git - shipsimu.git/blobdiff - application/selector/class_ApplicationHelper.php
Updated to latest 'core' + convertToClassName() and convertDashesToUnderscores()...
[shipsimu.git] / application / selector / class_ApplicationHelper.php
index feafd2489e39815195a031b898502b13abb7e421..204800fa0989a380bd091bf2684522ff4badb73b 100644 (file)
  * Please remember that this include file is being loaded *before* the class
  * 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, this is free software
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0
+ * @copyright  Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Ship-Simu 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
  * 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 BaseFrameworkSystem implements ManageableApplication {
+class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication, Registerable {
        /**
         * The version number of this application
         */
-       private $appVersion = "";
+       private $appVersion = '';
 
        /**
         * The human-readable name for this application
         */
-       private $appName = "";
+       private $appName = '';
 
        /**
-        * The short uni*-like name of this application
+        * The short uni*-like name for this application
         */
-       private $shortName = "";
-
-       /**
-        * Name of the master template
-        */
-       private $masterTemplate = "";
+       private $shortName = '';
 
        /**
         * An instance of this class
         */
-       private static $thisInstance = null;
+       private static $selfInstance = NULL;
 
        /**
-        * Protected constructor
+        * Private constructor
         *
         * @return      void
         */
        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();
        }
 
        /**
         * Getter for an instance of this class
         *
-        * @return      $thisInstance           An instance of this class
+        * @return      $selfInstance   An instance of this class
         */
-       public final static function getInstance () {
+       public static final function getSelfInstance () {
                // Is the instance there?
-               if (is_null(self::$thisInstance)) {
-                       self::$thisInstance = new ApplicationHelper();
-               }
+               if (is_null(self::$selfInstance)) {
+                       self::$selfInstance = new ApplicationHelper();
+               } // END - if
 
                // Return the instance
-               return self::$thisInstance;
+               return self::$selfInstance;
        }
 
        /**
@@ -107,7 +92,6 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        public final function getAppVersion () {
                return $this->appVersion;
        }
-
        /**
         * Setter for the version number
         *
@@ -116,8 +100,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         */
        public final function setAppVersion ($appVersion) {
                // Cast and set it
-               $appVersion = (string) $appVersion;
-               $this->appVersion = $appVersion;
+               $this->appVersion = (string) $appVersion;
        }
 
        /**
@@ -137,8 +120,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         */
        public final function setAppName ($appName) {
                // Cast and set it
-               $appName = (string) $appName;
-               $this->appName = $appName;
+               $this->appName = (string) $appName;;
        }
 
        /**
@@ -158,40 +140,102 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
         */
        public final function setAppShortName ($shortName) {
                // Cast and set it
-               $shortName = (string) $shortName;
-               $this->shortName = $shortName;
+               $this->shortName = (string) $shortName;
        }
 
        /**
-        * Getter for master template name
+        * Launches the application
         *
-        * @return      $masterTemplate         Name of the master template
+        * @return      void
         */
-       public final function getMasterTemplate () {
-               return $this->masterTemplate;
+       public final function entryPoint () {
+               // Set this application in registry
+               Registry::getRegistry()->addInstance('app', $this);
+
+               // Default response is console
+               $response = self::getResponseTypeFromSystem();
+               $responseType = self::getResponseTypeFromSystem();
+
+               // Create a new request object
+               $requestInstance = ObjectFactory::createObjectByName(self::convertToClassName($response) . 'Request');
+
+               // Remember request instance here
+               $this->setRequestInstance($requestInstance);
+
+               // 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
+               $responseClass = sprintf('%sResponse', self::convertToClassName($response));
+               $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
+
+               // Remember response instance here
+               $this->setResponseInstance($responseInstance);
+
+               // Get the parameter from the request
+               $commandName = $requestInstance->getRequestElement('command');
+
+               // If it is null then get default command
+               if (is_null($commandName)) {
+                       // Get default command
+                       $commandName = $responseInstance->determineDefaultCommand();
+
+                       // Set it in request
+                       $requestInstance->setRequestElement('command', $commandName);
+               } // END - if
+
+               // Get a controller resolver
+               $resolverClass = self::convertToClassName($this->getAppShortName() . '_' . $responseType . '_controller_resolver');
+               $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
+
+               // Get a controller instance as well
+               $this->setControllerInstance($resolverInstance->resolveController());
+
+               // Initialize language system
+               $languageInstance = ObjectFactory::createObjectByConfiguredName('language_system_class');
+
+               // And set it here
+               $this->setLanguageInstance($languageInstance);
+
+               // Launch the main routine here
+               $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
        }
 
        /**
-        * Launcher for the application selector
+        * Assigns extra application-depending data
         *
+        * @param       $templateInstance       An instance of a CompileableTemplate
         * @return      void
-        * @see         ApplicationSelector
+        * @todo        Nothing to add?
         */
-       public final function entryPoint () {
-               // Get a prepared instance of ApplicationSelector
-               $selInstance = ApplicationSelector::createApplicationSelector(LanguageSystem::getInstance(), FileIoHandler::getInstance());
-
-               // Remove the ignore list from the object
-               $selInstance->removeDirIgnoreList();
-
-               // Next load all templates for the respective short app names
-               $selInstance->loadApplicationTemplates();
+       public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
+       }
 
-               // Then load the selector's own template
-               $selInstance->loadSelectorTemplate();
+       /**
+        * Handle the indexed array of fatal messages and puts them out in an
+        * acceptable fasion
+        *
+        * @param       $messageList    An array of fatal messages
+        * @return      void
+        */
+       public function handleFatalMessages (array $messageList) {
+               // Walk through all messages
+               foreach ($messageList as $message) {
+                       exit(__METHOD__ . ':MSG:' . $message);
+               } // END - foreach
+       }
 
-               // Insert all application templates
-               $selInstance->insertApplicationTemplates();
+       /**
+        * Builds the master template's name
+        *
+        * @return      $masterTemplateName             Name of the master template
+        */
+       public function buildMasterTemplateName () {
+               return 'node_main';
        }
 }