Todo tags added to documentation

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

diff --git a/application/selector/class_ApplicationSelector.php b/application/selector/class_ApplicationSelector.php
index 651b2a4c359a68ed9d62f0ec9f8c5ef2852bd715..ddae1d49ff7a45a1a90e3342658885c96d3760dd 100644 (file)
--- a/application/selector/class_ApplicationSelector.php
+++ b/application/selector/class_ApplicationSelector.php
@@ -7,7 +7,7 @@
  *
  * @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
  *
@@ -59,12 +59,6 @@ class ApplicationSelector extends BaseFrameworkSystem {
                // Call parent constructor
                parent::__construct(__CLASS__);
 
-               // Set description
-               $this->setObjectDescription("Applikationswechsler");
-
-               // Create unique ID number
-               $this->generateUniqueId();
-
                // Remove system array and thousand seperator
                $this->removeSystemArray();
                $this->removeNumberFormaters();
@@ -77,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
@@ -118,8 +112,8 @@ class ApplicationSelector extends BaseFrameworkSystem {
         * 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
         */
        private function loadInitScript ($initScript, $appName) {
@@ -137,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;
        }
 
        /**
@@ -163,7 +158,7 @@ class ApplicationSelector extends BaseFrameworkSystem {
        }
 
        /**
-        * Method for compatiblity with prepareTemplateEngine()
+        * Method for compatiblity with prepareTemplateInstance()
         *
         * @return      $shortName      This selector's short name
         */
@@ -244,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",
+                       $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(
-                               'template_class'   => $tplEngine,
+                               'template_class'   => $templateInstance,
                                'app_instance' => $appInstance
                        ));
                }
@@ -280,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);
        }
 
        /**
@@ -302,10 +297,10 @@ class ApplicationSelector extends BaseFrameworkSystem {
         */
        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 = "";