X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fselector%2Fclass_ApplicationSelector.php;h=0e9070a95c283d83e1422418519baeee0d242976;hb=f8aefcf067a68005d6aea9bb636a62ddc3359546;hp=cbfc91daa0c7be5a695017006b46f90d654bf34f;hpb=a76d51b4096b47436e269156547f02713d95af5b;p=shipsimu.git diff --git a/application/selector/class_ApplicationSelector.php b/application/selector/class_ApplicationSelector.php index cbfc91d..0e9070a 100644 --- a/application/selector/class_ApplicationSelector.php +++ b/application/selector/class_ApplicationSelector.php @@ -5,10 +5,24 @@ * Please remember that this include file is being loaded *before* the class * loader is loading classes from "exceptions", "interfaces" and "main"! * - * @todo Extend a later BaseFrameworkApplication class + * @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 * - * @author Roland Haeder - * @version 0.1 + * 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 ApplicationSelector extends BaseFrameworkSystem { /** @@ -32,33 +46,24 @@ class ApplicationSelector extends BaseFrameworkSystem { 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__); + parent::__construct(__CLASS__); // Set description - $this->setPartDescr("Applikationswechsler"); + $this->setObjectDescription("Applikationswechsler"); // Create unique ID number - $this->createUniqueID(); + $this->generateUniqueId(); // Remove system array and thousand seperator $this->removeSystemArray(); @@ -76,7 +81,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * @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 +90,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 +102,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return void */ private function initializeAppsList () { - $this->foundApps = new FrameworkArrayObject(); + $this->foundApps = new FrameworkArrayObject("FakedFoundApplications"); } /** @@ -106,85 +111,7 @@ 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"); } /** @@ -194,10 +121,6 @@ class ApplicationSelector extends BaseFrameworkSystem { * @param $initScript The FQFN of init.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) { // Is it a file and readable? @@ -205,21 +128,6 @@ class ApplicationSelector extends BaseFrameworkSystem { // 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); - } - // Add the current instance to the list $this->foundApps->append($app); @@ -231,7 +139,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @param $tplEngine An instance of TemplateEngine */ - private function setSelectorTemplateEngine (CompileableTemplate $tplEngine) { + private final function setSelectorTemplateEngine (CompileableTemplate $tplEngine) { $this->selectorTplEngine = $tplEngine; } @@ -240,7 +148,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @return $selectTplEngine The selector's template engine */ - private function getSelectorTemplateEngine () { + private final function getSelectorTemplateEngine () { return $this->selectorTplEngine; } @@ -250,7 +158,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * @return $loadedTemplates An array object holding all loaded * application templates */ - private function getLoadedTemplates () { + private final function getLoadedTemplates () { return $this->loadedTemplates; } @@ -259,8 +167,8 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @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; } @@ -276,27 +184,6 @@ class ApplicationSelector extends BaseFrameworkSystem { $this->dirIgnoreList[] = $ignoreItem; } - /** - * Setter for language instance - * - * @param $langInstance An instance to the language sub-system - * @return void - * @see LanguageSystem - */ - public final 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 final function setFileIOInstance (FileIOHandler $fileIOInstance) { - $this->fileIOInstance = $fileIOInstance; - } - /** * Read the base path for all applications (application/) and create a * list of all found applications @@ -307,11 +194,11 @@ class ApplicationSelector extends BaseFrameworkSystem { // Generate the base path for all applications $appBasePath = sprintf("%s%s/", PATH, - $this->getConfigInstance()->readConfig("application_path") + $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); @@ -328,7 +215,7 @@ 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")); + $initScript = sprintf("%s/init%s", $fqfn, $this->getConfigInstance()->readConfig('php_extension')); // Load the application's init.php script and append the // application to the ArrayObject @@ -361,13 +248,13 @@ class ApplicationSelector extends BaseFrameworkSystem { // Try to load the web template $tplEngine->loadWebTemplate(sprintf("%s_%s", - $this->getConfigInstance()->readConfig("tpl_selector_prefix"), + $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' => $tplEngine, 'app_instance' => $appInstance )); } @@ -381,7 +268,7 @@ class ApplicationSelector extends BaseFrameworkSystem { * * @return void */ - public function removeDirIgnoreList () { + public final function removeDirIgnoreList () { unset($this->dirIgnoreList); } @@ -396,7 +283,7 @@ class ApplicationSelector extends BaseFrameworkSystem { $tplEngine = $this->prepareTemplateEngine($this); // Load the selector's template - $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig("selector_main_tpl")); + $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl')); // Now store it in the class $this->setSelectorTemplateEngine($tplEngine); @@ -409,16 +296,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); // Load template which shall later hold all application templates - $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig("selector_apps_tpl")); + $tplEngine->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl')); // Add all loaded application templates together $dummy = ""; @@ -436,24 +323,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]