Renamed a lot more stuff from 'web' to 'html'.

[core.git] / inc / classes / main / decorator / template / class_XmlRewriterTemplateDecorator.php

diff --git a/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php b/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php
index e2d0f4c4717b0e8bfcc6cc69ae8838ac64a6baec..9aad65d8d975888401eba2474adf3ed773e224e5 100644 (file)
--- a/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php
+++ b/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php
@@ -3,11 +3,11 @@
  * A decorator for XML template engines which rewrites the XML for compacting
  * it.
  *
- * @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 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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
@@ -57,7 +57,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $add            Whether add this group
         * @return      void
         */
-       public function setVariableGroup ($groupName, $add = true) {
+       public function setVariableGroup ($groupName, $add = TRUE) {
                // Call the inner class' method
                $this->getTemplateInstance()->setVariableGroup($groupName, $add);
        }
@@ -185,33 +185,24 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * Removes a given variable
         *
         * @param       $variableName   The variable we are looking for
+        * @param       $variableGroup  Name of variable group (default: 'general')
         * @return      void
         */
-       public final function removeVariable ($variableName) {
+       public final function removeVariable ($variableName, $variableGroup = 'general') {
                // Call the inner class' method
-               $this->getTemplateInstance()->removeVariable($variableName);
+               $this->getTemplateInstance()->removeVariable($variableName, $variableGroup);
        }
 
        /**
-        * Getter for compiled templates
-        *
-        * @return      $compiledData   Compiled template data
-        */
-       public final function getCompiledData () {
-               // Call the inner class' method
-               return $this->getTemplateInstance()->getCompiledData();
-       }
-
-       /**
-        * Load a specified web template into the engine
+        * Load a specified HTML template into the engine
         *
         * @param       $template       The web template we shall load which is located in
         *                                              'html' by default
         * @return      void
         */
-       public function loadWebTemplate ($template) {
+       public function loadHtmlTemplate ($template) {
                // Call the inner class' method
-               $this->getTemplateInstance()->loadWebTemplate($template);
+               $this->getTemplateInstance()->loadHtmlTemplate($template);
        }
 
        /**
@@ -308,16 +299,16 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         *
         * @param       $rawCode                        Raw code to compile
         * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
-        * @return      $rawCode        Compile code with inserted variable value
+        * @return      $rawCode                        Compile code with inserted variable value
         */
-       public function compileRawCode ($rawCode, $setMatchAsCode=false) {
+       public function compileRawCode ($rawCode, $setMatchAsCode = FALSE) {
                return $this->getTemplateInstance()->compileRawCode($rawCode, $setMatchAsCode);
        }
 
        /**
         * Getter for variable group array
         *
-        * @return      $vargroups      All variable groups
+        * @return      $variableGroups         All variable groups
         */
        public final function getVariableGroups () {
                // Call the inner class' method
@@ -354,7 +345,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $languageSupport        New language support setting
         * @return      void
         */
-       public final function enableLanguageSupport ($languageSupport = true) {
+       public final function enableLanguageSupport ($languageSupport = TRUE) {
                // Call the inner class' method
                $this->getTemplateInstance()->enableLanguageSupport($languageSupport);
        }
@@ -375,7 +366,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @param       $xmlCompacting  New XML compacting setting
         * @return      void
         */
-       public final function enableXmlCompacting ($xmlCompacting = true) {
+       public final function enableXmlCompacting ($xmlCompacting = TRUE) {
                // Call the inner class' method
                $this->getTemplateInstance()->enableXmlCompacting($xmlCompacting);
        }
@@ -412,9 +403,9 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT
         * @return      void
         * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
         */
-       public function endElement ($resource, $nodeName) {
+       public function finishElement ($resource, $nodeName) {
                // Call the inner class' method
-               $this->getTemplateInstance()->endElement($resource, $nodeName);
+               $this->getTemplateInstance()->finishElement($resource, $nodeName);
        }
 
        /**