X-Git-Url: https://git.mxchange.org/?p=shipsimu.git;a=blobdiff_plain;f=application%2Fselector%2Fclass_ApplicationSelector.php;h=f52b50a8fe16b3debf369defca694a9318e0fbc5;hp=b0866dcb8e97d37b00fa69def9d9ce0eaa822e0a;hb=21a25cc77b1108c7e33d4ce55b1a85970b355de2;hpb=42b66268af2c7d8872aca3e2fffb76d60954e9f5 diff --git a/application/selector/class_ApplicationSelector.php b/application/selector/class_ApplicationSelector.php index b0866dc..f52b50a 100644 --- a/application/selector/class_ApplicationSelector.php +++ b/application/selector/class_ApplicationSelector.php @@ -7,9 +7,9 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @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 @@ -22,7 +22,7 @@ * 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 . + * along with this program. If not, see . */ class ApplicationSelector extends BaseFrameworkSystem { /** @@ -46,23 +46,18 @@ class ApplicationSelector extends BaseFrameworkSystem { private $dirIgnoreList = array( ".", "..", - ".htaccess" + ".htaccess", + ".svn" ); /** - * The private constructor. No direct instances can be created from this. + * The protected constructor. No direct instances can be created from this. * * @return void */ - private function __construct() { + protected function __construct() { // Call parent constructor - parent::constructor(__CLASS__); - - // Set description - $this->setPartDescr("Applikationswechsler"); - - // Create unique ID number - $this->createUniqueID(); + parent::__construct(__CLASS__); // Remove system array and thousand seperator $this->removeSystemArray(); @@ -76,11 +71,11 @@ class ApplicationSelector extends BaseFrameworkSystem { /** * Create a prepared instance of ApplicationSelector * - * @param $langInstance The language sub-system: LanguageSystem - * @param $fileIOInstance The file I/O instance - * @return $selInstance An instance of ApplicationSelector + * @param $langInstance The language sub-system: LanguageSystem + * @param $fileIOInstance The file I/O instance + * @return $selInstance An instance of ApplicationSelector */ - public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIOHandler $fileIOInstance) { + public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIoHandler $fileIOInstance) { // Get a new instance $selInstance = new ApplicationSelector(); @@ -89,7 +84,7 @@ class ApplicationSelector extends BaseFrameworkSystem { // Set language and file I/O instances $selInstance->setLanguageInstance($langInstance); - $selInstance->setFileIOInstance($fileIOInstance); + $selInstance->setFileIoInstance($fileIOInstance); // Return the prepared instance return $selInstance; @@ -101,7 +96,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return void */ private function initializeAppsList () { - $this->foundApps = new FrameworkArrayObject(); + $this->foundApps = new FrameworkArrayObject("FakedFoundApplications"); } /** @@ -110,41 +105,22 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return void */ private function initializeTemplatesList () { - $this->loadedTemplates = new FrameworkArrayObject(); + $this->loadedTemplates = new FrameworkArrayObject("FakedLoadedTemplates"); } /** - * Load the init.php script of an application and append the application + * Load the data.php script of an application and append the application * instance to $foundApps * - * @param $initScript The FQFN of init.php - * @param $appName The application's Uni* name + * @param $appData The FQFN of data.php + * @param $appName The application's Uni* name * @return void - * @throws AppVarIsNotSetException If 'app' is not set - * @throws NullPointerException If 'app' is null - * @throws NoObjectException If 'app' is not an object - * @throws MissingMethodException If a required method is missing */ - private function loadInitScript ($initScript, $appName) { + private function loadApplicationData ($appData, $appName) { // Is it a file and readable? - if ((is_file($initScript)) && (is_readable($initScript))) { + if ((is_file($appData)) && (is_readable($appData))) { // Then include it - include ($initScript); - - // We now should have $app re-defined! - if (!isset($app)) { - // This application shall not be loaded - return; - } elseif (is_null($app)) { - // The class instance is null - throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); - } elseif (!is_object($app)) { - // Not an object - throw new NoObjectException($app, self::EXCEPTION_IS_NO_OBJECT); - } elseif (!method_exists($app, $this->getConfigInstance()->readConfig("entry_method"))) { - // Method not found! - throw new MissingMethodException(array($app, $this->getConfigInstance()->readConfig("entry_method")), self::EXCEPTION_MISSING_METHOD); - } + include ($appData); // Add the current instance to the list $this->foundApps->append($app); @@ -155,10 +131,11 @@ class ApplicationSelector extends BaseFrameworkSystem { /** * Setter for the selector's template engine instance * - * @param $tplEngine An instance of TemplateEngine + * @param $templateInstance An instance of TemplateEngine + * @return void */ - private function setSelectorTemplateEngine (CompileableTemplate $tplEngine) { - $this->selectorTplEngine = $tplEngine; + private final function setSelectorTemplateEngine (CompileableTemplate $templateInstance) { + $this->selectorTplEngine = $templateInstance; } /** @@ -166,7 +143,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @return $selectTplEngine The selector's template engine */ - private function getSelectorTemplateEngine () { + private final function getSelectorTemplateEngine () { return $this->selectorTplEngine; } @@ -176,17 +153,17 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return $loadedTemplates An array object holding all loaded * application templates */ - private function getLoadedTemplates () { + private final function getLoadedTemplates () { return $this->loadedTemplates; } /** - * Method for compatiblity with prepareTemplateEngine() + * Method for compatiblity with prepareTemplateInstance() * * @return $shortName This selector's short name */ public function getAppShortName() { - $shortName = $this->getConfigInstance()->readConfig("selector_path"); + $shortName = $this->getConfigInstance()->readConfig('selector_path'); return $shortName; } @@ -210,18 +187,15 @@ class ApplicationSelector extends BaseFrameworkSystem { */ public function readApplicationDirectory () { // Generate the base path for all applications - $appBasePath = sprintf("%s%s/", - PATH, - $this->getConfigInstance()->readConfig("application_path") - ); + $appBasePath = $this->getConfigInstance()->readConfig('application_path'); // Add the selector path to the ignore list - $this->addDirIgnoreList($this->getConfigInstance()->readConfig("selector_path")); + $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path')); // Get a directory pointer for the application path $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath); - // Backup and remove the 'app' from global name space + // Backup and remove the 'app' from local name space /*$appBackup = $app; unset($app);*/ @@ -232,15 +206,13 @@ class ApplicationSelector extends BaseFrameworkSystem { // Is this a readable directory? (files will be ignored silently) if ((is_dir($fqfn)) && (is_readable($fqfn))) { - // Then get the init.php script for analyzing - $initScript = sprintf("%s/init%s", $fqfn, $this->getConfigInstance()->readConfig("php_extension")); + // Then get the data.php script for analyzing + $appData = sprintf("%s/data.php", $fqfn); - // Load the application's init.php script and append the + // Load the application's data.php script and append the // application to the ArrayObject - $this->loadInitScript($initScript, $appName); - - } // END - if ((is_dir(... - + $this->loadApplicationData($appData, $appName); + } // END - if } // END - while // Close directory pointer @@ -262,17 +234,17 @@ class ApplicationSelector extends BaseFrameworkSystem { $appInstance = $idx->current(); // Prepare the template engine for the current template - $tplEngine = $this->prepareTemplateEngine($appInstance); + $templateInstance = $this->prepareTemplateInstance($appInstance); // Try to load the web template - $tplEngine->loadWebTemplate(sprintf("%s_%s", - $this->getConfigInstance()->readConfig("tpl_selector_prefix"), + $templateInstance->loadWebTemplate(sprintf("%s_%s", + $this->getConfigInstance()->readConfig('tpl_selector_prefix'), strtolower($appInstance->getAppShortName()) )); // Remember this template and the application for later usage $this->loadedTemplates->append(array( - 'tpl_engine' => $tplEngine, + 'template_class' => $templateInstance, 'app_instance' => $appInstance )); } @@ -286,7 +258,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @return void */ - public function removeDirIgnoreList () { + public final function removeDirIgnoreList () { unset($this->dirIgnoreList); } @@ -298,13 +270,13 @@ class ApplicationSelector extends BaseFrameworkSystem { */ public function loadSelectorTemplate () { // Prepare the template engine - $tplEngine = $this->prepareTemplateEngine($this); + $templateInstance = $this->prepareTemplateInstance($this); // Load the selector's template - $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig("selector_main_tpl")); + $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl')); // Now store it in the class - $this->setSelectorTemplateEngine($tplEngine); + $this->setSelectorTemplateEngine($templateInstance); } /** @@ -314,16 +286,16 @@ class ApplicationSelector extends BaseFrameworkSystem { * @throws NullPointerException If $curr is null * @throws NoArrayException If $curr is not an array * @throws InvalidArrayCountException If $curr contains an - * unexpected count of elements + * unexpected count of elements * @throws MissingArrayElementsException If $curr is missing expected - * array elements + * array elements */ public function insertApplicationTemplates () { // First prepare the instance - $tplEngine = $this->prepareTemplateEngine($this); + $templateInstance = $this->prepareTemplateInstance($this); // Load template which shall later hold all application templates - $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig("selector_apps_tpl")); + $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl')); // Add all loaded application templates together $dummy = ""; @@ -341,24 +313,14 @@ class ApplicationSelector extends BaseFrameworkSystem { } elseif (count($curr) != 2) { // Not expected count of entries throw new InvalidArrayCountException(array($this, "curr", count($curr), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT); - } elseif (!isset($curr['tpl_engine']) || (!isset($curr['app_instance']))) { + } elseif (!isset($curr['template_class']) || (!isset($curr['app_instance']))) { // Expected entries missing - throw new MissingArrayElementsException(array($this, "curr", array('tpl_engine', 'app_instance')), self::EXCEPTION_ARRAY_ELEMENTS_MISSING); + throw new MissingArrayElementsException(array($this, "curr", array("template_class", "app_instance")), self::EXCEPTION_ARRAY_ELEMENTS_MISSING); } die("
".print_r($curr, true)."
"); } // END - for } - - /** - * Stub! - */ - public function saveObjectToDatabase () { - $this->getDebugInstance()->output(sprintf("[%s:] Stub %s erreicht.", - $this->__toString(), - __FUNCTION__ - )); - } } // [EOF]