Some API changes:
[core.git] / inc / classes / main / template / menu / class_MenuTemplateEngine.php
index b67f7207d6bf6da2270ad2a86f41d1b8044b9e76..1e53e4fa83044ee7e10b24458582c252385fb37a 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * A Menu template engine class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.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
@@ -60,7 +60,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Menu instance
         */
-       private $menuInstance = null;
+       private $menuInstance = NULL;
 
        /**
         * Current main node
@@ -85,7 +85,6 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Creates an instance of the class TemplateEngine and prepares it for usage
         *
-        * @param       $applicationInstance    A manageable application
         * @param       $menuInstance                   A RenderableMenu instance
         * @return      $templateInstance               An instance of TemplateEngine
         * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
@@ -95,10 +94,13 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @throws      BasePathReadProtectedException  If $templateBasePath is
         *                                                                                      read-protected
         */
-       public static final function createMenuTemplateEngine (ManageableApplication $applicationInstance, RenderableMenu $menuInstance) {
+       public static final function createMenuTemplateEngine (RenderableMenu $menuInstance) {
                // Get a new instance
                $templateInstance = new MenuTemplateEngine();
 
+               // Get the application instance from registry
+               $applicationInstance = Registry::getRegistry()->getInstance('app');
+
                // Determine base path
                $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
 
@@ -131,10 +133,10 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                $templateInstance->setMenuInstance($menuInstance);
 
                // Init a variable stacker
-               $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
+               $stackInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
 
                // Set it
-               $templateInstance->setStackerInstance($stackerInstance);
+               $templateInstance->setStackInstance($stackInstance);
 
                // Return the prepared instance
                return $templateInstance;
@@ -237,7 +239,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
         */
-       public function endElement ($resource, $nodeName) {
+       public function finishElement ($resource, $nodeName) {
                // Make all lower-case
                $nodeName = strtolower($nodeName);
 
@@ -271,12 +273,12 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                // Is this string empty?
                if (empty($characters)) {
                        // Then skip it silently
-                       return false;
+                       return;
                } // END - if
 
                // Assign the found characters to variable and use the last entry from
                // stack as the name
-               parent::assignVariable($this->getStackerInstance()->getNamed('current_node'), $characters);
+               parent::assignVariable($this->getStackInstance()->getNamed('current_node'), $characters);
        }
 
        /**
@@ -290,7 +292,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                // Is the template dependency set?
                if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
                        // Get a temporay menu template instance
-                       $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this->getApplicationInstance(), $this->getMenuInstance()));
+                       $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this->getMenuInstance()));
 
                        // Then load it
                        $templateInstance->loadMenuTemplate($templateDependency);
@@ -318,7 +320,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                $this->handleTemplateDependency('menu', $templateDependency);
 
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'menu');
+               $this->getStackInstance()->pushNamed('current_node', 'menu');
        }
 
        /**
@@ -329,7 +331,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startEntryList () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'entry-list');
+               $this->getStackInstance()->pushNamed('current_node', 'entry-list');
        }
 
        /**
@@ -339,7 +341,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startBlockHeader () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'block-header');
+               $this->getStackInstance()->pushNamed('current_node', 'block-header');
        }
 
        /**
@@ -349,7 +351,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startBlockFooter () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'block-footer');
+               $this->getStackInstance()->pushNamed('current_node', 'block-footer');
        }
 
        /**
@@ -359,7 +361,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startBlockList () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'block-list');
+               $this->getStackInstance()->pushNamed('current_node', 'block-list');
        }
 
        /**
@@ -369,7 +371,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startBlock () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'block');
+               $this->getStackInstance()->pushNamed('current_node', 'block');
        }
 
        /**
@@ -379,7 +381,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startTitle () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'title');
+               $this->getStackInstance()->pushNamed('current_node', 'title');
        }
 
        /**
@@ -389,7 +391,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startTitleId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'title-id');
+               $this->getStackInstance()->pushNamed('current_node', 'title-id');
        }
 
        /**
@@ -399,7 +401,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startTitleClass () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'title-class');
+               $this->getStackInstance()->pushNamed('current_node', 'title-class');
        }
 
        /**
@@ -409,7 +411,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startTitleText () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'title-text');
+               $this->getStackInstance()->pushNamed('current_node', 'title-text');
        }
 
        /**
@@ -419,7 +421,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startEntry () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'entry');
+               $this->getStackInstance()->pushNamed('current_node', 'entry');
        }
 
        /**
@@ -429,7 +431,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startEntryId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'entry-id');
+               $this->getStackInstance()->pushNamed('current_node', 'entry-id');
        }
 
        /**
@@ -439,7 +441,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startAnchor () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'anchor');
+               $this->getStackInstance()->pushNamed('current_node', 'anchor');
        }
 
        /**
@@ -449,7 +451,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startAnchorId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'anchor-id');
+               $this->getStackInstance()->pushNamed('current_node', 'anchor-id');
        }
 
        /**
@@ -459,7 +461,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startAnchorText () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'anchor-text');
+               $this->getStackInstance()->pushNamed('current_node', 'anchor-text');
        }
 
        /**
@@ -469,7 +471,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startAnchorTitle () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'anchor-title');
+               $this->getStackInstance()->pushNamed('current_node', 'anchor-title');
        }
 
        /**
@@ -479,7 +481,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startAnchorHref () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'anchor-href');
+               $this->getStackInstance()->pushNamed('current_node', 'anchor-href');
        }
 
        /**
@@ -489,7 +491,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startFooterId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'footer-id');
+               $this->getStackInstance()->pushNamed('current_node', 'footer-id');
        }
 
        /**
@@ -499,7 +501,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startFooterClass () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'footer-class');
+               $this->getStackInstance()->pushNamed('current_node', 'footer-class');
        }
 
        /**
@@ -509,7 +511,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function startFooterText () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('current_node', 'footer-text');
+               $this->getStackInstance()->pushNamed('current_node', 'footer-text');
        }
 
        /**
@@ -519,7 +521,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishTitle () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -529,7 +531,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishTitleId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -539,7 +541,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishTitleClass () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -549,7 +551,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishTitleText () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -559,7 +561,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishFooterText () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -569,7 +571,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishFooterClass () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -579,7 +581,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishFooterId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -589,7 +591,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishAnchorHref () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -599,7 +601,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishAnchorTitle () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -609,7 +611,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishAnchorText () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -619,7 +621,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishAnchorId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -629,7 +631,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishAnchor () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -639,7 +641,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishEntryId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -649,7 +651,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishEntry () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -659,7 +661,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishBlock () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -669,7 +671,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishBlockList () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -679,7 +681,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishEntryList () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -689,7 +691,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishBlockHeader () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -699,7 +701,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishBlockFooter () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -709,7 +711,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private function finishMenu () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('current_node');
+               $this->getStackInstance()->popNamed('current_node');
        }
 
        /**
@@ -719,7 +721,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        public function getMenuCacheFqfn () {
                // Get the FQFN ready
-               $fqfn = sprintf("%s%s%s/%s.%s",
+               $fqfn = sprintf('%s%s%s/%s.%s',
                        $this->getConfigInstance()->getConfigEntry('base_path'),
                        $this->getGenericBasePath(),
                        'menus/_cache',