X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fship-simu%2Fclass_ApplicationHelper.php;h=ff98b1cfb1793327f58842c7773479da54682520;hb=f695b17ece7b104b29f010ad2b06503c42f907ed;hp=a177d343c228d6c88a80909479d0fe8aa0fe0b9b;hpb=ff66822b5fb6a92f5dc8af55290ecb89ec7f1aaf;p=shipsimu.git diff --git a/application/ship-simu/class_ApplicationHelper.php b/application/ship-simu/class_ApplicationHelper.php index a177d34..ff98b1c 100644 --- a/application/ship-simu/class_ApplicationHelper.php +++ b/application/ship-simu/class_ApplicationHelper.php @@ -20,10 +20,26 @@ * 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.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 . */ -class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication { +class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable { /** * The version number of this application */ @@ -39,49 +55,45 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica */ private $shortName = ""; + /** + * An instance of a controller + */ + private $controllerInstance = null; + /** * An instance of this class */ - private static $thisInstance = null; + private static $selfInstance = 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__); } /** * 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; } /** * 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,13 +154,107 @@ class ApplicationHelper extends BaseFrameworkSystem implements ManageableApplica } /** - * Launches the ship-simulator game + * 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 */ public final function entryPoint () { - // Must still be implemented! - trigger_error(__METHOD__.": Not implemented yet!"); + // 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(ucfirst($type) . 'Request'); + + // Remember request instance here + $this->setRequestInstance($requestInstance); + + // Default response is HTTP (HTML page) and type is 'Web' + $response = $type; + $responseType = $classType; + + // 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", $this->convertToClassName($response)); + $responseInstance = ObjectFactory::createObjectByName($responseClass, array($this)); + + // Remember response instance here + $this->setResponseInstance($responseInstance); + + // Get the parameter from the request + $commandName = $requestInstance->getRequestElement('page'); + + // 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 + $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); + } + + /** + * 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."
\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'); } }