]> git.mxchange.org Git - shipsimu.git/blobdiff - application/selector/class_ApplicationSelector.php
Todo tags added to documentation
[shipsimu.git] / application / selector / class_ApplicationSelector.php
index 2af2f708763f7f238eced3b757629faefdad4757..ddae1d49ff7a45a1a90e3342658885c96d3760dd 100644 (file)
@@ -7,9 +7,9 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @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
@@ -46,11 +46,12 @@ 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
         */
@@ -58,12 +59,6 @@ class ApplicationSelector extends BaseFrameworkSystem {
                // Call parent constructor
                parent::__construct(__CLASS__);
 
-               // Set description
-               $this->setObjectDescription("Applikationswechsler");
-
-               // Create unique ID number
-               $this->createUniqueID();
-
                // Remove system array and thousand seperator
                $this->removeSystemArray();
                $this->removeNumberFormaters();
@@ -76,9 +71,9 @@ 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) {
                // Get a new instance
@@ -101,7 +96,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         * @return      void
         */
        private function initializeAppsList () {
-               $this->foundApps = new FrameworkArrayObject();
+               $this->foundApps = new FrameworkArrayObject("FakedFoundApplications");
        }
 
        /**
@@ -110,20 +105,16 @@ 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
         * instance to $foundApps
         *
-        * @param               $initScript     The FQFN of init.php
-        * @param               $appName                The application's Uni* name
+        * @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?
@@ -131,21 +122,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);
 
@@ -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 final function setSelectorTemplateEngine (CompileableTemplate $tplEngine) {
-               $this->selectorTplEngine = $tplEngine;
+       private final function setSelectorTemplateEngine (CompileableTemplate $templateInstance) {
+               $this->selectorTplEngine = $templateInstance;
        }
 
        /**
@@ -181,12 +158,12 @@ class ApplicationSelector extends BaseFrameworkSystem {
        }
 
        /**
-        * 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;
        }
 
@@ -212,11 +189,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);
@@ -233,7 +210,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
@@ -262,17 +239,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
                        ));
                }
@@ -298,13 +275,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 +291,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 +318,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("<pre>".print_r($curr, true)."</pre>");
 
                } // END - for
        }
-
-       /**
-        * Stub!
-        */
-       public function saveObjectToDatabase () {
-               $this->getDebugInstance()->output(sprintf("[%s:] Stub <strong>%s</strong> erreicht.",
-                       $this->__toString(),
-                       __FUNCTION__
-               ));
-       }
 }
 
 // [EOF]