]> git.mxchange.org Git - shipsimu.git/blobdiff - application/selector/class_ApplicationSelector.php
readConfig() is not naming convention, renamed to getConfigEntry()
[shipsimu.git] / application / selector / class_ApplicationSelector.php
index 8d6d914463151236089ab5882313b0bb4d3b2749..ee637f7d1a68705cca9aa2cf7e6642b6007c5e20 100644 (file)
@@ -2,12 +2,9 @@
 /**
  * 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 <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, 2009 Ship-Simu Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -35,11 +32,6 @@ 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
         */
@@ -109,44 +101,24 @@ class ApplicationSelector extends BaseFrameworkSystem {
        }
 
        /**
-        * 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       $appData                The FQFN of data.php
         * @param       $appName                The application's Uni* name
         * @return      void
         */
-       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);
+                       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       $templateInstance       An instance of TemplateEngine
-        * @return      void
-        */
-       private final function setSelectorTemplateEngine (CompileableTemplate $templateInstance) {
-               $this->selectorTplEngine = $templateInstance;
-       }
-
-       /**
-        * Getter for the selector's template engine instance
-        *
-        * @return      $selectTplEngine        The selector's template engine
-        */
-       private final function getSelectorTemplateEngine () {
-               return $this->selectorTplEngine;
-       }
-
        /**
         * Getter for the $loadedTemplates array object
         *
@@ -163,7 +135,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         * @return      $shortName      This selector's short name
         */
        public function getAppShortName() {
-               $shortName = $this->getConfigInstance()->readConfig('selector_path');
+               $shortName = $this->getConfigInstance()->getConfigEntry('selector_path');
                return $shortName;
        }
 
@@ -175,8 +147,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
         */
        public function addDirIgnoreList ($ignoreItem) {
                // Cast and add it
-               $ignoreItem = (string) $ignoreItem;
-               $this->dirIgnoreList[] = $ignoreItem;
+               $this->dirIgnoreList[] = (string) $ignoreItem;
        }
 
        /**
@@ -187,18 +158,14 @@ class ApplicationSelector extends BaseFrameworkSystem {
         */
        public function readApplicationDirectory () {
                // Generate the base path for all applications
-               $appBasePath = $this->getConfigInstance()->readConfig('application_path');
+               $appBasePath = $this->getConfigInstance()->getConfigEntry('application_path');
 
                // Add the selector path to the ignore list
-               $this->addDirIgnoreList($this->getConfigInstance()->readConfig('selector_path'));
+               $this->addDirIgnoreList($this->getConfigInstance()->getConfigEntry('selector_path'));
 
                // Get a directory pointer for the application path
                $dirInstance = FrameworkDirectoryPointer::createFrameworkDirectoryPointer($appBasePath);
 
-               // Backup and remove the 'app' from local 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)
@@ -206,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;
        }
 
        /**
@@ -240,7 +202,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
 
                        // Try to load the web template
                        $templateInstance->loadWebTemplate(sprintf("%s_%s",
-                               $this->getConfigInstance()->readConfig('tpl_selector_prefix'),
+                               $this->getConfigInstance()->getConfigEntry('tpl_selector_prefix'),
                                strtolower($appInstance->getAppShortName())
                        ));
 
@@ -275,29 +237,29 @@ class ApplicationSelector extends BaseFrameworkSystem {
                $templateInstance = $this->prepareTemplateInstance($this);
 
                // Load the selector's template
-               $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_main_tpl'));
+               $templateInstance->loadCodeTemplate($this->getConfigInstance()->getConfigEntry('selector_main_tpl'));
 
-               // Now store it in the class
-               $this->setSelectorTemplateEngine($templateInstance);
+               // Now store it in the class, we need this later on final compilation of available applications
+               $this->setTemplateInstance($templateInstance);
        }
 
        /**
         * Inserts all loaded application templates into the selector's template
         *
         * @return      void
-        * @throws      NullPointerException            If $curr is null
-        * @throws      NoArrayException                        If $curr is not an array
-        * @throws      InvalidArrayCountException      If $curr contains an
-        *                                                                              unexpected count of elements
+        * @throws      NoArrayException                                If $curr is not an array
+        * @throws      InvalidArrayCountException              If $curr contains an
+        *                                                                                      unexpected count of elements
         * @throws      MissingArrayElementsException   If $curr is missing expected
         *                                                                                      array elements
+        * @todo        Finish handling all applications here
         */
        public function insertApplicationTemplates () {
                // First prepare the instance
                $templateInstance = $this->prepareTemplateInstance($this);
 
                // Load template which shall later hold all application templates
-               $templateInstance->loadCodeTemplate($this->getConfigInstance()->readConfig('selector_apps_tpl'));
+               $templateInstance->loadCodeTemplate($this->getConfigInstance()->getConfigEntry('selector_apps_tpl'));
 
                // Add all loaded application templates together
                $dummy = "";
@@ -306,10 +268,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
                        $curr = $idx->current();
 
                        // Do some sanity checks on the loaded item
-                       if (is_null($curr)) {
-                               // $curr is null
-                               throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
-                       } elseif (!is_array($curr)) {
+                       if (!is_array($curr)) {
                                // Not an array
                                throw new NoArrayException($curr, self::EXCEPTION_IS_NO_ARRAY);
                        } elseif (count($curr) != 2) {
@@ -319,8 +278,9 @@ class ApplicationSelector extends BaseFrameworkSystem {
                                // Expected entries missing
                                throw new MissingArrayElementsException(array($this, "curr", array("template_class", "app_instance")), self::EXCEPTION_ARRAY_ELEMENTS_MISSING);
                        }
-                       die("<pre>".print_r($curr, true)."</pre>");
 
+                       // Debug output
+                       die(__METHOD__."()<pre>".print_r($curr, true)."</pre>");
                } // END - for
        }
 }