X-Git-Url: https://git.mxchange.org/?p=shipsimu.git;a=blobdiff_plain;f=application%2Fselector%2Fclass_ApplicationHelper.php;h=204800fa0989a380bd091bf2684522ff4badb73b;hp=19b45b7ba0d59268304940f3f02f04c880ce25dd;hb=d12af3294af2d790e423a16891f395d88b139832;hpb=ff66822b5fb6a92f5dc8af55290ecb89ec7f1aaf diff --git a/application/selector/class_ApplicationHelper.php b/application/selector/class_ApplicationHelper.php index 19b45b7..204800f 100644 --- a/application/selector/class_ApplicationHelper.php +++ b/application/selector/class_ApplicationHelper.php @@ -20,62 +20,68 @@ * Please remember that this include file is being loaded *before* the class * loader is loading classes from "exceptions", "interfaces" and "main"! * - * @author Roland Haeder - * @version 0.1 + * @author Roland Haeder + * @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 + * + * 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 . */ -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 = ""; + private $shortName = ''; /** * An instance of this class */ - private static $thisInstance = null; + private static $selfInstance = NULL; /** * Private 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__); } /** * 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; } /** @@ -86,17 +92,15 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica 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; } /** @@ -111,13 +115,12 @@ 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) { // Cast and set it - $appName = (string) $appName; - $this->appName = $appName; + $this->appName = (string) $appName;; } /** @@ -132,36 +135,107 @@ 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) { // Cast and set it - $shortName = (string) $shortName; - $this->shortName = $shortName; + $this->shortName = (string) $shortName; } /** - * Launcher for the application selector + * Launches the application * * @return void - * @see ApplicationSelector */ public final function entryPoint () { - // Get a prepared instance of ApplicationSelector - $selInstance = ApplicationSelector::createApplicationSelector(LanguageSystem::getInstance(), FileIOHandler::getInstance()); + // 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)); - // Remove the ignore list from the object - $selInstance->removeDirIgnoreList(); + // Get a controller instance as well + $this->setControllerInstance($resolverInstance->resolveController()); - // Next load all templates for the respective short app names - $selInstance->loadApplicationTemplates(); + // Initialize language system + $languageInstance = ObjectFactory::createObjectByConfiguredName('language_system_class'); - // Then load the selector's own template - $selInstance->loadSelectorTemplate(); + // And set it here + $this->setLanguageInstance($languageInstance); - // Insert all application templates - $selInstance->insertApplicationTemplates(); + // Launch the main routine here + $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance); + } + + /** + * Assigns extra application-depending data + * + * @param $templateInstance An instance of a CompileableTemplate + * @return void + * @todo Nothing to add? + */ + public function assignExtraTemplateData (CompileableTemplate $templateInstance) { + } + + /** + * 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 + } + + /** + * Builds the master template's name + * + * @return $masterTemplateName Name of the master template + */ + public function buildMasterTemplateName () { + return 'node_main'; } }