Stacker classes/interface/exceptions (FiFoStacker is not completed, will follow soon...
[core.git] / inc / classes / main / template / menu / class_MenuTemplateEngine.php
index 37dfca2c88383705bc79500e1bab95c159dbee4d..597b0149ef0a2b7cadb84ecd140f2690799fcf76 100644 (file)
@@ -141,6 +141,12 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                // Set the menu instance
                $tplInstance->setMenuInstance($menuInstance);
 
+               // Init a variable stacker
+               $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
+
+               // Set it
+               $tplInstance->setStackerInstance($stackerInstance);
+
                // Return the prepared instance
                return $tplInstance;
        }
@@ -279,8 +285,9 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                        return false;
                } // END - if
 
-               // Unfinished work!
-               $this->partialStub('Handling extra characters is not yet supported! length='.strlen($characters));
+               // Assign the found characters to variable and use the last entry from
+               // stack as the name
+               parent::assignVariable($this->getStackerInstance()->getNamed('current_node'), $characters);
        }
 
        /**
@@ -465,13 +472,164 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                $this->assignVariable('footer_end', $this->getTemplateInstance()->getRawTemplateData());
        }
 
+       /**
+        * Starts the menu property 'block-list'
+        *
+        * @return      void
+        */
+       private function startBlockList () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'block-list');
+       }
+
+       /**
+        * Starts the menu property 'block'
+        *
+        * @return      void
+        */
+       private function startBlock () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'block');
+       }
+
        /**
         * Starts the menu property 'title'
         *
         * @return      void
         */
        private function startTitle () {
-               $this->partialStub('Cleared due to XML rewrite.');
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'title');
+       }
+
+       /**
+        * Starts the menu property 'title-id'
+        *
+        * @return      void
+        */
+       private function startTitleId () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'title-id');
+       }
+
+       /**
+        * Starts the menu property 'title-class'
+        *
+        * @return      void
+        */
+       private function startTitleClass () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'title-class');
+       }
+
+       /**
+        * Starts the menu property 'title-text'
+        *
+        * @return      void
+        */
+       private function startTitleText () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'title-text');
+       }
+
+       /**
+        * Starts the menu property 'entry'
+        *
+        * @return      void
+        */
+       private function startEntry () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'entry');
+       }
+
+       /**
+        * Starts the menu property 'entry-id'
+        *
+        * @return      void
+        */
+       private function startEntryId () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'entry-id');
+       }
+
+       /**
+        * Starts the menu property 'anchor'
+        *
+        * @return      void
+        */
+       private function startAnchor () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'anchor');
+       }
+
+       /**
+        * Starts the menu property 'anchor-id'
+        *
+        * @return      void
+        */
+       private function startAnchorId () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'anchor-id');
+       }
+
+       /**
+        * Starts the menu property 'anchor-text'
+        *
+        * @return      void
+        */
+       private function startAnchorText () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'anchor-text');
+       }
+
+       /**
+        * Starts the menu property 'anchor-title'
+        *
+        * @return      void
+        */
+       private function startAnchorTitle () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'anchor-title');
+       }
+
+       /**
+        * Starts the menu property 'anchor-href'
+        *
+        * @return      void
+        */
+       private function startAnchorHref () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'anchor-href');
+       }
+
+       /**
+        * Starts the menu property 'footer-id'
+        *
+        * @return      void
+        */
+       private function startFooterId () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'footer-id');
+       }
+
+       /**
+        * Starts the menu property 'footer-class'
+        *
+        * @return      void
+        */
+       private function startFooterClass () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'footer-class');
+       }
+
+       /**
+        * Starts the menu property 'footer-text'
+        *
+        * @return      void
+        */
+       private function startFooterText () {
+               // Push the node name on the stacker
+               $this->getStackerInstance()->pushNamed('current_node', 'footer-text');
        }
 
        /**
@@ -480,87 +638,199 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         */
        private function finishTitle () {
-               $this->partialStub('Cleared due to XML rewrite.');
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Starts the menu text
+        * Finishes the title-id node by
         *
         * @return      void
         */
-       private function startText () {
-               // Do we have a template instance?
-               if (is_null($this->getTemplateInstance())) {
-                       // Init template instance for underlaying web templates
-                       $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
+       private function finishTitleId () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-                       // Set it in this template engine
-                       $this->setTemplateInstance($templateInstance);
-               } // END - if
+       /**
+        * Finishes the title-class node
+        *
+        * @return      void
+        */
+       private function finishTitleClass () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-               // Load the text template for this page
-               $this->getTemplateInstance()->loadCodeTemplate('menu_text_start');
+       /**
+        * Finishes the title-class node
+        *
+        * @return      void
+        */
+       private function finishTitleText () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-               // Set the variable group to page
-               $this->setVariableGroup('menu');
+       /**
+        * Finishes the footer-text node
+        *
+        * @return      void
+        */
+       private function finishFooterText () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-               // Set its content in this template instance
-               $this->assignVariable('text', $this->getTemplateInstance()->getRawTemplateData());
+       /**
+        * Finishes the footer-class node
+        *
+        * @return      void
+        */
+       private function finishFooterClass () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Finishes the menu text
+        * Finishes the footer-id node
         *
         * @return      void
         */
-       private function finishText () {
-               // Load the text template for this page
-               $this->getTemplateInstance()->loadCodeTemplate('menu_text_end');
+       private function finishFooterId () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-               // Set the variable group to page
-               $this->setVariableGroup('menu');
+       /**
+        * Finishes the anchor-href node
+        *
+        * @return      void
+        */
+       private function finishAnchorHref () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
 
-               // Set its content in this template instance
-               $this->assignVariable('text_end', $this->getTemplateInstance()->getRawTemplateData());
+       /**
+        * Finishes the anchor-title node
+        *
+        * @return      void
+        */
+       private function finishAnchorTitle () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Starts the menu property 'entry'
+        * Finishes the anchor-text node
         *
         * @return      void
         */
-       private function startEntry () {
-               $this->partialStub('Cleared due to XML rewrite.');
+       private function finishAnchorText () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Finishes the entry node by added another template to the menu
+        * Finishes the anchor-id node
+        *
+        * @return      void
+        */
+       private function finishAnchorId () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
+
+       /**
+        * Finishes the anchor node
+        *
+        * @return      void
+        */
+       private function finishAnchor () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
+
+       /**
+        * Finishes the entry-id node
+        *
+        * @return      void
+        */
+       private function finishEntryId () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
+
+       /**
+        * Finishes the entry node
         *
         * @return      void
         */
        private function finishEntry () {
-               $this->partialStub('Cleared due to XML rewrite.');
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Starts the menu property 'anchor'
+        * Finishes the block node
         *
-        * @param       $id             Id of the anchor
-        * @param       $link   Link text of the anchor
-        * @param       $title  Link title of the anchor
         * @return      void
         */
-       private function startAnchor () {
-               $this->partialStub('Please implement this method.');
+       private function finishBlock () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
        }
 
        /**
-        * Finishes the anchor node by added another template to the menu
+        * Finishes the block-list node
         *
         * @return      void
         */
-       private function finishAnchor () {
-               $this->partialStub('Please implement this method.');
+       private function finishBlockList () {
+               // Pop the last entry
+               $this->getStackerInstance()->popNamed('current_node');
+       }
+
+       /**
+        * Starts the menu text
+        *
+        * @return      void
+        */
+       private function startText () {
+               // Do we have a template instance?
+               if (is_null($this->getTemplateInstance())) {
+                       // Init template instance for underlaying web templates
+                       $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
+
+                       // Set it in this template engine
+                       $this->setTemplateInstance($templateInstance);
+               } // END - if
+
+               // Load the text template for this page
+               $this->getTemplateInstance()->loadCodeTemplate('menu_text_start');
+
+               // Set the variable group to page
+               $this->setVariableGroup('menu');
+
+               // Set its content in this template instance
+               $this->assignVariable('text', $this->getTemplateInstance()->getRawTemplateData());
+       }
+
+       /**
+        * Finishes the menu text
+        *
+        * @return      void
+        */
+       private function finishText () {
+               // Load the text template for this page
+               $this->getTemplateInstance()->loadCodeTemplate('menu_text_end');
+
+               // Set the variable group to page
+               $this->setVariableGroup('menu');
+
+               // Set its content in this template instance
+               $this->assignVariable('text_end', $this->getTemplateInstance()->getRawTemplateData());
        }
 
        /**