Continued:

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

diff --git a/framework/main/classes/template/menu/class_MenuTemplateEngine.php b/framework/main/classes/template/menu/class_MenuTemplateEngine.php
index 777412745014f0538be020d2209812c03b37bbf9..943b6a85c95f199e60254671337904145038001b 100644 (file)
--- a/framework/main/classes/template/menu/class_MenuTemplateEngine.php
+++ b/framework/main/classes/template/menu/class_MenuTemplateEngine.php
@@ -9,8 +9,9 @@ use Org\Mxchange\CoreFramework\Filesystem\InvalidDirectoryException;
 use Org\Mxchange\CoreFramework\Menu\RenderableMenu;
 use Org\Mxchange\CoreFramework\Parser\Parseable;
 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
-use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
 use Org\Mxchange\CoreFramework\Template\Engine\BaseTemplateEngine;
+use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
+use Org\Mxchange\CoreFramework\Traits\Stacker\StackableTrait;
 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
 
 // Import SPL stuff
@@ -40,6 +41,9 @@ use \UnexpectedValueException;
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
+       // Load traits
+       use StackableTrait;
+
        /**
         * Main nodes in the XML tree ('menu' is ignored)
         */
@@ -128,11 +132,6 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         */
        private $menuInstance = NULL;
 
-       /**
-        * Template engine instance
-        */
-       private $templateInstance = NULL;
-
        /**
         * Protected constructor
         *
@@ -223,25 +222,6 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                return $this->menuInstance;
        }
 
-       /**
-        * Setter for template engine instances
-        *
-        * @param       $templateInstance       An instance of a CompileableTemplate class
-        * @return      void
-        */
-       protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
-               $this->templateInstance = $templateInstance;
-       }
-
-       /**
-        * Getter for template engine instances
-        *
-        * @return      $templateInstance       An instance of a CompileableTemplate class
-        */
-       public final function getTemplateInstance () {
-               return $this->templateInstance;
-       }
-
        /**
         * Load a specified menu template into the engine
         *
@@ -249,7 +229,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         *                                              located in 'menu' by default
         * @return      void
         */
-       public function loadMenuTemplate ($template) {
+       public function loadMenuTemplate (string $template) {
                // Set template type
                $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('menu_template_type'));
 
@@ -272,8 +252,8 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @param       $element                Element name to set as current main node
         * @return      $currMainNode   Current main node
         */
-       private final function setCurrMainNode ($element) {
-               $this->curr['main_node'] = (string) $element;
+       private final function setCurrMainNode (string $element) {
+               $this->curr['main_node'] = $element;
        }
 
        /**
@@ -303,7 +283,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
         */
-       public function startElement ($resource, $element, array $attributes) {
+       public function startElement ($resource, string $element, array $attributes) {
                // Initial method name which will never be called...
                $methodName = 'initMenu';
 
@@ -339,16 +319,13 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
         */
-       public function finishElement ($resource, $nodeName) {
-               // Make all lower-case
-               $nodeName = strtolower($nodeName);
-
+       public function finishElement ($resource, string $nodeName) {
                // Does this match with current main node?
                //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
                if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
                        // Did not match!
                        throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), Parseable::EXCEPTION_XML_NODE_MISMATCH);
-               } // END - if
+               }
 
                // Construct method name
                $methodName = 'finish' . StringUtils::convertToClassName($nodeName);
@@ -366,7 +343,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         * @todo        Find something useful with this!
         */
-       public function characterHandler ($resource, $characters) {
+       public function characterHandler ($resource, string $characters) {
                // Trim all spaces away
                $characters = trim($characters);
 
@@ -374,7 +351,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                if (empty($characters)) {
                        // Then skip it silently
                        return;
-               } // END - if
+               }
 
                // Assign the found characters to variable and use the last entry from
                // stack as the name
@@ -388,7 +365,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @param       $templateDependency             A template to load to satisfy dependencies
         * @return      void
         */
-       private function handleTemplateDependency ($node, $templateDependency) {
+       private function handleTemplateDependency (string $node, string $templateDependency) {
                // Is the template dependency set?
                if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
                        // Get a temporay menu template instance
@@ -402,7 +379,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
 
                        // Save the parsed raw content in our dependency array
                        $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
-               } // END - if
+               }
        }
 
        /**
@@ -412,7 +389,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
         * @return      void
         * @todo        Add cache creation here
         */
-       private function initMenu ($templateDependency = '') {
+       private function initMenu (string $templateDependency = '') {
                // Get web template engine
                $this->setTemplateInstance(ObjectFactory::createObjectByConfiguredName('html_template_class', array(GenericRegistry::getRegistry()->getInstance('application'))));
 
@@ -839,11 +816,11 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                        if ($variableName == 'anchor-href') {
                                // Expand variable with URL then
                                $variableValue = '{?base_url?}/' . $variableValue;
-                       } // END - if
+                       }
 
                        // ... into the instance
                        $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
-               } // END - foreach
+               }
 
                // Compile template + variables
                $this->getTemplateInstance()->compileTemplate();
@@ -873,7 +850,7 @@ class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTempla
 
                        // ... into the instance
                        $this->getTemplateInstance()->assignVariable($variableName, $variableValue);
-               } // END - foreach
+               }
 
                // Assign block content
                $this->getTemplateInstance()->assignVariable('block_content', $blockContent);