Added missing methods and removed methods that have already protected access level.
authorRoland Haeder <roland@mxchange.org>
Sat, 25 Apr 2015 22:16:11 +0000 (00:16 +0200)
committerRoland Haeder <roland@mxchange.org>
Sat, 25 Apr 2015 22:16:11 +0000 (00:16 +0200)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php

index 9aad65d..e96a111 100644 (file)
@@ -74,17 +74,6 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
                $this->getTemplateInstance()->addGroupVariable($var, $value);
        }
 
-       /**
-        * Setter for base path
-        *
-        * @param       $templateBasePath       The relative base path for all templates
-        * @return      void
-        */
-       public final function setTemplateBasePath ($templateBasePath) {
-               // Call the inner class' method
-               $this->getTemplateInstance()->setTemplateBasePath($templateBasePath);
-       }
-
        /**
         * Getter for base path
         *
@@ -105,28 +94,6 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
                return $this->getTemplateInstance()->getGenericBasePath();
        }
 
-       /**
-        * Setter for template extension
-        *
-        * @param       $templateExtension      The file extension for all uncompiled templates
-        * @return      void
-        */
-       public final function setRawTemplateExtension ($templateExtension) {
-               // Call the inner class' method
-               $this->getTemplateInstance()->setRawTemplateExtension($templateExtension);
-       }
-
-       /**
-        * Setter for code template extension
-        *
-        * @param       $codeExtension  The file extension for all uncompiled templates
-        * @return      void
-        */
-       public final function setCodeTemplateExtension ($codeExtension) {
-               // Call the inner class' method
-               $this->getTemplateInstance()->setCodeTemplateExtension($codeExtension);
-       }
-
        /**
         * Getter for template extension
         *
@@ -138,24 +105,24 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
        }
 
        /**
-        * Getter for code-template extension
+        * Getter for given variable group
         *
-        * @return      $codeExtension  The file extension for all code templates
+        * @param       $variableGroup  Variable group to check
+        * @return      $varStack               Found variable group
         */
-       public final function getCodeTemplateExtension () {
+       public function getVarStack ($variableGroup) {
                // Call the inner class' method
-               return $this->getTemplateInstance()->getCodeTemplateExtension();
+               return $this->getTemplateInstance()->getVarStack($variableGroup);
        }
 
        /**
-        * Setter for path of compiled templates
+        * Getter for code-template extension
         *
-        * @param       $compileOutputPath      The local base path for all compiled templates
-        * @return      void
+        * @return      $codeExtension  The file extension for all code templates
         */
-       public final function setCompileOutputPath ($compileOutputPath) {
+       public final function getCodeTemplateExtension () {
                // Call the inner class' method
-               $this->getTemplateInstance()->setCompileOutputPath($compileOutputPath);
+               return $this->getTemplateInstance()->getCodeTemplateExtension();
        }
 
        /**
@@ -176,7 +143,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @return      void
         * @throws      EmptyVariableException  If the variable name is left empty
         */
-       public final function assignVariable ($var, $value) {
+       public function assignVariable ($var, $value) {
                // Call the inner class' method
                $this->getTemplateInstance()->assignVariable($var, $value);
        }
@@ -188,7 +155,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $variableGroup  Name of variable group (default: 'general')
         * @return      void
         */
-       public final function removeVariable ($variableName, $variableGroup = 'general') {
+       public function removeVariable ($variableName, $variableGroup = 'general') {
                // Call the inner class' method
                $this->getTemplateInstance()->removeVariable($variableName, $variableGroup);
        }
@@ -228,6 +195,19 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
                $this->getTemplateInstance()->loadCodeTemplate($template);
        }
 
+       /**
+        * Load a specified email template into the engine for later compilation
+        * with other code/web/email templates.
+        *
+        * @param       $template       The email template we shall load which is
+        *                                              located in "html" by default
+        * @return      void
+        */
+       public function loadEmailTemplate ($template) {
+               // Call the inner class' method
+               $this->getTemplateInstance()->loadEmailTemplate($template);
+       }
+
        /**
         * Compiles configuration place-holders in all variables. This 'walks'
         * through the variable stack 'general'. It interprets all values from that
@@ -235,7 +215,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         *
         * @return      void
         */
-       public final function compileConfigInVariables () {
+       public function compileConfigInVariables () {
                // Call the inner class' method
                $this->getTemplateInstance()->compileConfigInVariables();
        }
@@ -245,7 +225,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         *
         * @return      void
         */
-       public final function compileVariables () {
+       public function compileVariables () {
                // Call the inner class' method
                $this->getTemplateInstance()->compileVariables();
        }
@@ -315,6 +295,16 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
                return $this->getTemplateInstance()->getVariableGroups();
        }
 
+       /**
+        * Getter for raw template data
+        *
+        * @return      $rawTemplateData        The raw data from the template
+        */
+       public function getRawTemplateData () {
+               // Call the inner class' method
+               return $this->getTemplateInstance()->getRawTemplateData();
+       }
+
        /**
         * Renames a variable in code and in stack
         *
@@ -345,7 +335,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $languageSupport        New language support setting
         * @return      void
         */
-       public final function enableLanguageSupport ($languageSupport = TRUE) {
+       public function enableLanguageSupport ($languageSupport = TRUE) {
                // Call the inner class' method
                $this->getTemplateInstance()->enableLanguageSupport($languageSupport);
        }
@@ -355,7 +345,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         *
         * @return      $languageSupport        Whether language support is enabled or disabled
         */
-       public final function isLanguageSupportEnabled () {
+       public function isLanguageSupportEnabled () {
                // Call the inner class' method
                return $this->getTemplateInstance()->isLanguageSupportEnabled();
        }
@@ -366,7 +356,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $xmlCompacting  New XML compacting setting
         * @return      void
         */
-       public final function enableXmlCompacting ($xmlCompacting = TRUE) {
+       public function enableXmlCompacting ($xmlCompacting = TRUE) {
                // Call the inner class' method
                $this->getTemplateInstance()->enableXmlCompacting($xmlCompacting);
        }
@@ -376,7 +366,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         *
         * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
         */
-       public final function isXmlCompactingEnabled () {
+       public function isXmlCompactingEnabled () {
                // Call the inner class' method
                return $this->getTemplateInstance()->isXmlCompactingEnabled();
        }
@@ -434,6 +424,21 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
                // ... and return it
                return $compactedContent;
        }
+
+       /**
+        * Assigns a lot variables into the stack of currently loaded template.
+        * This method should only be used in very rare circumstances, e.g. when
+        * you have to copy a whole set of variables into the template engine.
+        * Before you use this method, please make sure you have considered all
+        * other possiblities.
+        *
+        * @param       $variables      An array with variables to be assigned
+        * @return      void
+        */
+       public function assignMultipleVariables (array $variables) {
+               // Call the inner class' method but trim the characters before
+               $this->getTemplateInstance()->assignMultipleVariables($variables);
+       }
 }
 
 // [EOF]