X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fselector%2Fclass_ApplicationSelector.php;h=071da88440a24b8a69b6c2369f5b59836ba8cdfc;hb=7a44bb20ca579fb79bba71d65f5f7a834665f80f;hp=bd3a86b78133de509c6d7cbc1d73a56d9045cfb7;hpb=ff66822b5fb6a92f5dc8af55290ecb89ec7f1aaf;p=shipsimu.git diff --git a/application/selector/class_ApplicationSelector.php b/application/selector/class_ApplicationSelector.php index bd3a86b..071da88 100644 --- a/application/selector/class_ApplicationSelector.php +++ b/application/selector/class_ApplicationSelector.php @@ -2,13 +2,24 @@ /** * The application selector class. * - * 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.0.0 + * @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 * - * @todo Extend a later BaseFrameworkApplication class + * 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. * - * @author Roland Haeder - * @version 0.1 + * 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 ApplicationSelector extends BaseFrameworkSystem { /** @@ -21,44 +32,24 @@ class ApplicationSelector extends BaseFrameworkSystem { */ private $loadedTemplates = null; - /** - * The application selector's own template engine handler - */ - private $selectorTplEngine = null; - /** * A list of items we shall ignore while reading from directories */ private $dirIgnoreList = array( ".", "..", - ".htaccess" + ".htaccess", + ".svn" ); /** - * The language instance for the template loader - */ - private $langInstance = null; - - /** - * The file I/O instance for the template loader - */ - private $fileIOInstance = null; - - /** - * 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(); @@ -72,11 +63,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 static function createApplicationSelector (ManageableLanguage $langInstance, FileIOHandler $fileIOInstance) { + public final static function createApplicationSelector (ManageableLanguage $langInstance, FileIoHandler $fileIOInstance) { // Get a new instance $selInstance = new ApplicationSelector(); @@ -85,7 +76,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; @@ -97,7 +88,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return void */ private function initializeAppsList () { - $this->foundApps = new FrameworkArrayObject(); + $this->foundApps = new FrameworkArrayObject("FakedFoundApplications"); } /** @@ -106,161 +97,45 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return void */ private function initializeTemplatesList () { - $this->loadedTemplates = new FrameworkArrayObject(); - } - - /** - * Private getter for language instance - * - * @return $langInstance An instance to the language sub-system - */ - private function getLanguageInstance () { - return $this->langInstance; - } - - /** - * Private getter for file IO instance - * - * @return $fileIOInstance An instance to the file I/O sub-system - */ - private function getFileIOInstance () { - return $this->fileIOInstance; - } - - /** - * Prepare the template engine (TemplateEngine by default) for a give - * application helper instance (ApplicationHelper by default). - * - * @param $appInstance An application helper instance - * @return $tplEngine The template engine instance - * @throws NullPointerException If the template engine could not - * be initialized - * @throws NoObjectException If $tplEngine is not an object - * @throws MissingMethodException If $tplEngine misses a required - * method 'loadWebTemplate()' - */ - private function prepareTemplateEngine (BaseFrameworkSystem $appInstance) { - // Generate FQFN for all application templates - $fqfn = sprintf("%s%s/%s/%s", - PATH, - $this->getConfigInstance()->readConfig("application_path"), - strtolower($appInstance->getAppShortName()), - $this->getConfigInstance()->readConfig("tpl_base_path") - ); - - // Initialize the template engine - $tplEngine = null; - $eval = sprintf("\$tplEngine = %s::create%s( - \"%s\", - \$this->getLanguageInstance(), - \$this->getFileIOInstance() -);", - $this->getConfigInstance()->readConfig("tpl_engine"), - $this->getConfigInstance()->readConfig("tpl_engine"), - $fqfn - ); - - // Debug message - if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) { - $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: 
%s

\n", - $this->__toString(), - htmlentities($eval) - )); - } - - // Run the command - @eval($eval); - - // Is it a valid instance? - if (is_null($tplEngine)) { - // No class returned - throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); - } elseif (!is_object($tplEngine)) { - // Not an object! ;-( - throw new NoObjectException($tplEngine, self::EXCEPTION_IS_NO_OBJECT); - } elseif (!method_exists($tplEngine, 'loadWebTemplate')) { - // Nope, so throw exception - throw new MissingMethodException(array($tplEngine, 'loadWebTemplate'), self::EXCEPTION_MISSING_METHOD); - } - - // Return the prepared instance - return $tplEngine; + $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); - } // END - if ((is_file(... } - /** - * Setter for the selector's template engine instance - * - * @param $tplEngine An instance of TemplateEngine - */ - private function setSelectorTemplateEngine (CompileableTemplate $tplEngine) { - $this->selectorTplEngine = $tplEngine; - } - - /** - * Getter for the selector's template engine instance - * - * @return $selectTplEngine The selector's template engine - */ - private function getSelectorTemplateEngine () { - return $this->selectorTplEngine; - } - /** * Getter for the $loadedTemplates array object * * @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 */ - private function getAppShortName() { - $shortName = $this->getConfigInstance()->readConfig("selector_path"); + public function getAppShortName() { + $shortName = $this->getConfigInstance()->readConfig('selector_path'); return $shortName; } @@ -272,29 +147,7 @@ class ApplicationSelector extends BaseFrameworkSystem { */ public function addDirIgnoreList ($ignoreItem) { // Cast and add it - $ignoreItem = (string) $ignoreItem; - $this->dirIgnoreList[] = $ignoreItem; - } - - /** - * Setter for language instance - * - * @param $langInstance An instance to the language sub-system - * @return void - * @see LanguageSystem - */ - public function setLanguageInstance (ManageableLanguage $langInstance) { - $this->langInstance = $langInstance; - } - - /** - * Setter for file I/O instance - * - * @param $fileIOInstance An instance to the file I/O sub-system - * @return void - */ - public function setFileIOInstance (FileIOHandler $fileIOInstance) { - $this->fileIOInstance = $fileIOInstance; + $this->dirIgnoreList[] = (string) $ignoreItem; } /** @@ -305,21 +158,14 @@ 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 - /*$appBackup = $app; - unset($app);*/ - // Read all directories&files except some parts while ($appName = $dirInstance->readDirectoryExcept($this->dirIgnoreList)) { // Generate FQFN for the application name (or better directory name) @@ -327,22 +173,17 @@ 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 $dirInstance->closeDirectory(); - - // Restore old 'app' from backup - //$app = $appBackup; } /** @@ -357,17 +198,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 )); } @@ -381,7 +222,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @return void */ - public function removeDirIgnoreList () { + public final function removeDirIgnoreList () { unset($this->dirIgnoreList); } @@ -393,13 +234,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); + // Now store it in the class, we need this later on final compilation of available applications + $this->setTemplateInstance($templateInstance); } /** @@ -409,16 +250,17 @@ 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 + * @todo Finish handling all applications here */ 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 = ""; @@ -436,24 +278,15 @@ 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)."
"); + // Debug output + die(__METHOD__."()
".print_r($curr, true)."
"); } // END - for } - - /** - * Stub! - */ - public function saveObjectToDatabase () { - $this->getDebugInstance()->output(sprintf("[%s:] Stub %s erreicht.", - $this->__toString(), - __FUNCTION__ - )); - } } // [EOF]