final added, code clean-ups

[shipsimu.git] / application / selector / class_ApplicationSelector.php

diff --git a/application/selector/class_ApplicationSelector.php b/application/selector/class_ApplicationSelector.php
index bf49db4ff188c08ffed2d8a546a19e2726692804..b29414a18b3e0a2d676dcd8560eeae6fb57485a0 100644 (file)
--- a/application/selector/class_ApplicationSelector.php
+++ b/application/selector/class_ApplicationSelector.php
@@ -5,7 +5,6 @@
  * 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 <webmaster@ship-simu.org>
  * @version            0.0.0
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
@@ -50,16 +49,6 @@ class ApplicationSelector extends BaseFrameworkSystem {
                ".htaccess"
        );
 
-       /**
-        * 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.
         *
@@ -91,7 +80,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();
 
@@ -124,80 +113,6 @@ class ApplicationSelector extends BaseFrameworkSystem {
                $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              UnsupportedTemplateEngineException      If $tplEngine is an
-        *                                                                              unsupported template engine
-        */
-       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: <pre><em>%s</em></pre><br />\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 (!$tplEngine instanceof CompileableTemplate) {
-                       // Not an object! ;-(
-                       throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
-               }
-
-               // Return the prepared instance
-               return $tplEngine;
-       }
-
        /**
         * Load the init.php script of an application and append the application
         * instance to $foundApps
@@ -242,7 +157,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;
        }
 
@@ -251,7 +166,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         *
         * @return      $selectTplEngine        The selector's template engine
         */
-       private function getSelectorTemplateEngine () {
+       private final function getSelectorTemplateEngine () {
                return $this->selectorTplEngine;
        }
 
@@ -261,7 +176,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;
        }
 
@@ -270,7 +185,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         *
         * @return      $shortName      This selector's short name
         */
-       private function getAppShortName() {
+       public function getAppShortName() {
                $shortName = $this->getConfigInstance()->readConfig("selector_path");
                return $shortName;
        }
@@ -287,27 +202,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
@@ -392,7 +286,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         *
         * @return      void
         */
-       public function removeDirIgnoreList () {
+       public final function removeDirIgnoreList () {
                unset($this->dirIgnoreList);
        }