Fixed variable group handling by unsetting right index
[core.git] / inc / classes / interfaces / template / class_CompileableTemplate.php
index 3b6671e091691dfac435794d2d5b51b73b25a315..cf982f62b97e86ddff4fff6fd8b3e2f4ba8afde5 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.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 - 2012 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -25,11 +25,11 @@ interface CompileableTemplate extends FrameworkInterface {
        /**
         * Assign variables for templates
         *
-        * @param       $var    The "variable" we want to assign
-        * @param       $value  The value we want to store in the variable
+        * @param       $variableName   The "variable" we want to assign
+        * @param       $value                  The value we want to store in the variable
         * @return      void
         */
-       function assignVariable ($var, $value);
+       function assignVariable ($variableName, $value);
 
        /**
         * Load a specified web template into the engine
@@ -68,27 +68,28 @@ interface CompileableTemplate extends FrameworkInterface {
        /**
         * Adds a variable to current group
         *
-        * @param       $var    Variable to set
-        * @param       $value  Value to store in variable
+        * @param       $variableName   Variable to set
+        * @param       $value                  Value to store in variable
         * @return      void
         */
-       function addGroupVariable ($var, $value);
+       function addGroupVariable ($variableName, $value);
 
        /**
         * Removes a given variable
         *
-        * @param       $var    The variable we are looking for
+        * @param       $variableName   The variable we are looking for
+        * @param       $variableGroup  Name of variable group (default: 'general')
         * @return      void
         */
-       function removeVariable ($var);
+       function removeVariable ($variableName, $variableGroup = 'general');
 
        /**
         * Assign a given congfiguration variable with a value
         *
-        * @param       $var    The configuration variable we want to assign
+        * @param       $variableName   The configuration variable we want to assign
         * @return      void
         */
-       function assignConfigVariable ($var);
+       function assignConfigVariable ($variableName);
 
        /**
         * Compiles configuration place-holders in all variables. This 'walks'