Copyright updated, menu class added for 'home'
[shipsimu.git] / application / selector / class_ApplicationHelper.php
index 19b45b7ba0d59268304940f3f02f04c880ce25dd..1d4f9e710e6f7026aa9c519f17bbea257107b3ec 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 <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @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
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * 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/>.
  */
-class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication {
+class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable {
        /**
         * The version number of this application
         */
@@ -35,32 +51,28 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        private $appName = "";
 
        /**
-        * The short uni*-like name of this application
+        * The short uni*-like name for this application
         */
        private $shortName = "";
 
+       /**
+        * An instance of a controller
+        */
+       private $controllerInstance = null;
+
        /**
         * An instance of this class
         */
        private static $thisInstance = null;
 
        /**
-        * Private constructor
+        * Protected constructor
         *
         * @return      void
         */
-       private function __construct () {
+       protected function __construct () {
                // Call parent constructor
-               parent::constructor(__CLASS__);
-
-               // Set description
-               $this->setPartDescr("Application-Helper");
-
-               // Create an unique ID
-               $this->createUniqueID();
-
-               // Tidy up a little
-               $this->removeSystemArray();
+               parent::__construct(__CLASS__);
        }
 
        /**
@@ -81,7 +93,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        /**
         * 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;
@@ -90,7 +102,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        /**
         * 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) {
@@ -111,7 +123,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        /**
         * Setter for human-readable name
         *
-        * @param               $appName        The application's human-readable name
+        * @param       $appName        The application's human-readable name
         * @return      void
         */
        public final function setAppName ($appName) {
@@ -132,7 +144,7 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        /**
         * Setter for short uni*-like name
         *
-        * @param               $shortName      The application's short uni*-like name
+        * @param       $shortName      The application's short uni*-like name
         * @return      void
         */
        public final function setAppShortName ($shortName) {
@@ -142,26 +154,88 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica
        }
 
        /**
-        * Launcher for the application selector
+        * 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;
+       }
+
+       /**
+        * Launches the admin area
         *
         * @return      void
-        * @see         ApplicationSelector
         */
        public final function entryPoint () {
-               // Get a prepared instance of ApplicationSelector
-               $selInstance = ApplicationSelector::createApplicationSelector(LanguageSystem::getInstance(), FileIOHandler::getInstance());
+               // Create a new request object
+               $requestInstance = ObjectFactory::createObjectByName('HttpRequest');
+
+               // Default response is HTTP (HTML page) and type is "Web"
+               $response = "http";
+               $responseType = "web";
 
-               // Remove the ignore list from the object
-               $selInstance->removeDirIgnoreList();
+               // Do we have another response?
+               if ($requestInstance->isRequestElementSet('request')) {
+                       // Then use it
+                       $response = strtolower($requestInstance->getRequestElement('request'));
+                       $responseType = $response;
+               } // END - if
 
-               // Next load all templates for the respective short app names
-               $selInstance->loadApplicationTemplates();
+               // ... and a new response object
+               $responseClass = sprintf("%sResponse", $this->convertToClassName($response));
+               $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this));
 
-               // Then load the selector's own template
-               $selInstance->loadSelectorTemplate();
+               // Remember both in this application
+               $this->setRequestInstance($requestInstance);
+               $this->setResponseInstance($responseInstance);
 
-               // Insert all application templates
-               $selInstance->insertApplicationTemplates();
+               // Get the parameter from the request
+               $commandName = $requestInstance->getRequestElement('page');
+
+               // If it is null then get default command
+               if (is_null($commandName)) {
+                       $commandName = $responseInstance->getDefaultCommand();
+               } // END - if
+
+               // Get a resolver
+               $resolverClass = sprintf("%sControllerResolver", $this->convertToClassName($responseType));
+               $resolverInstance = ObjectFactory::createObjectByName($resolverClass, array($commandName, $this));
+
+               // Get a controller instance as well
+               $this->controllerInstance = $resolverInstance->resolveController();
+
+               // Handle the request
+               $this->controllerInstance->handleRequest($requestInstance, $responseInstance);
+       }
+
+       /**
+        * 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) {
+                       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');
        }
 }