Some documentary updated

[core.git] / inc / classes / main / template / menu / class_MenuTemplateEngine.php

diff --git a/inc/classes/main/template/menu/class_MenuTemplateEngine.php b/inc/classes/main/template/menu/class_MenuTemplateEngine.php
index 93382f9c8c2a4aa0249bdef3eaaebbd6dfe17121..b67f7207d6bf6da2270ad2a86f41d1b8044b9e76 100644 (file)
--- a/inc/classes/main/template/menu/class_MenuTemplateEngine.php
+++ b/inc/classes/main/template/menu/class_MenuTemplateEngine.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -85,9 +85,9 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Creates an instance of the class TemplateEngine and prepares it for usage
         *
-        * @param       $appInstance    A manageable application
-        * @param       $menuInstance   A RenderableMenu instance
-        * @return      $tplInstance    An instance of TemplateEngine
+        * @param       $applicationInstance    A manageable application
+        * @param       $menuInstance                   A RenderableMenu instance
+        * @return      $templateInstance               An instance of TemplateEngine
         * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
         * @throws      InvalidBasePathStringException  If $templateBasePath is no string
         * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
@@ -95,60 +95,49 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @throws      BasePathReadProtectedException  If $templateBasePath is
         *                                                                                      read-protected
         */
-       public final static function createMenuTemplateEngine (ManageableApplication $appInstance, RenderableMenu $menuInstance) {
+       public static final function createMenuTemplateEngine (ManageableApplication $applicationInstance, RenderableMenu $menuInstance) {
                // Get a new instance
-               $tplInstance = new MenuTemplateEngine();
-
-               // Get language and file I/O instances from application
-               $langInstance = $appInstance->getLanguageInstance();
-               $ioInstance = $appInstance->getFileIoInstance();
+               $templateInstance = new MenuTemplateEngine();
 
                // Determine base path
-               $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
+               $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
 
                // Is the base path valid?
                if (empty($templateBasePath)) {
                        // Base path is empty
-                       throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+                       throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif (!is_string($templateBasePath)) {
                        // Is not a string
-                       throw new InvalidBasePathStringException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
+                       throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
                } elseif (!is_dir($templateBasePath)) {
                        // Is not a path
-                       throw new BasePathIsNoDirectoryException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
+                       throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
                } elseif (!is_readable($templateBasePath)) {
                        // Is not readable
-                       throw new BasePathReadProtectedException(array($tplInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
+                       throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
                }
 
-               // Get configuration instance
-               $configInstance = FrameworkConfiguration::getInstance();
-
                // Set the base path
-               $tplInstance->setTemplateBasePath($templateBasePath);
-
-               // Set the language and IO instances
-               $tplInstance->setLanguageInstance($langInstance);
-               $tplInstance->setFileIoInstance($ioInstance);
+               $templateInstance->setTemplateBasePath($templateBasePath);
 
                // Set template extensions
-               $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
-               $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('menu_template_extension'));
+               $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
+               $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('menu_template_extension'));
 
                // Absolute output path for compiled templates
-               $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
+               $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
 
                // Set the menu instance
-               $tplInstance->setMenuInstance($menuInstance);
+               $templateInstance->setMenuInstance($menuInstance);
 
                // Init a variable stacker
                $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
 
                // Set it
-               $tplInstance->setStackerInstance($stackerInstance);
+               $templateInstance->setStackerInstance($stackerInstance);
 
                // Return the prepared instance
-               return $tplInstance;
+               return $templateInstance;
        }
 
        /**
@@ -306,10 +295,10 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                        // Then load it
                        $templateInstance->loadMenuTemplate($templateDependency);
 
-                       // Get an XmlParser instance
+                       // Parse the XML content
                        $templateInstance->renderXmlContent();
 
-                       // Parse the template's content contents
+                       // Save the parsed raw content in our dependency array
                        $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
                } // END - if
        }
@@ -335,7 +324,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Starts the menu entries
         *
-        * @param       $templateDependency     A template to load to satisfy dependencies
+        * @param       $templateDependency             A template to load to satisfy dependencies
         * @return      void
         */
        private function startEntryList () {