Renamed variables, removeVariable() does not expect indexes

[core.git] / inc / classes / interfaces / template / class_CompileableTemplate.php

diff --git a/inc/classes/interfaces/template/class_CompileableTemplate.php b/inc/classes/interfaces/template/class_CompileableTemplate.php
index c6b1a1a8a87d5a9b3fe5f6596844773a03720f6b..41791914ee5581de90d9de32d04206018624081f 100644 (file)
--- a/inc/classes/interfaces/template/class_CompileableTemplate.php
+++ b/inc/classes/interfaces/template/class_CompileableTemplate.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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,27 @@ 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
         * @return      void
         */
-       function removeVariable ($var);
+       function removeVariable ($variableName);
 
        /**
         * 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'
@@ -119,10 +119,10 @@ interface CompileableTemplate extends FrameworkInterface {
        /**
         * Assigns all the application data with template variables
         *
-        * @param       $appInstance    A manageable application instance
+        * @param       $applicationInstance    A manageable application instance
         * @return      void
         */
-       function assignApplicationData (ManageableApplication $appInstance);
+       function assignApplicationData (ManageableApplication $applicationInstance);
 
        /**
         * "Compiles" a variable by replacing {?var?} with it's content
@@ -149,7 +149,7 @@ interface CompileableTemplate extends FrameworkInterface {
         * @return      void
         * @throws      XmlParserException      If an XML error was found
         */
-       function renderXmlContent ($content = null);
+       function renderXmlContent ($content = NULL);
 
        /**
         * Enables or disables language support
@@ -160,9 +160,9 @@ interface CompileableTemplate extends FrameworkInterface {
        function enableLanguageSupport ($languageSupport = true);
 
        /**
-        * Checks wether language support is enabled
+        * Checks whether language support is enabled
         *
-        * @return      $languageSupport        Wether language support is enabled or disabled
+        * @return      $languageSupport        Whether language support is enabled or disabled
         */
        function isLanguageSupportEnabled ();
 
@@ -175,19 +175,19 @@ interface CompileableTemplate extends FrameworkInterface {
        function enableXmlCompacting ($xmlCompacting = true);
 
        /**
-        * Checks wether XML compacting is enabled
+        * Checks whether XML compacting is enabled
         *
-        * @return      $xmlCompacting  Wether XML compacting is enabled or disabled
+        * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
         */
        function isXmlCompactingEnabled ();
 
        /**
         * Removes all comments, tabs and new-line charcters to compact the content
         *
-        * @param       $content        The uncompacted content
-        * @return      $content        The compacted content
+        * @param       $uncompactedContent             The uncompacted content
+        * @return      $compactedContent               The compacted content
         */
-       function compactContent ($content);
+       function compactContent ($uncompactedContent);
 }
 
 // [EOF]