Minor: Descriptions improved

[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 41791914ee5581de90d9de32d04206018624081f..b894a295ce90db3b860e20559e6a97f37869fafb 100644 (file)
--- a/inc/classes/interfaces/template/class_CompileableTemplate.php
+++ b/inc/classes/interfaces/template/class_CompileableTemplate.php
@@ -2,11 +2,11 @@
 /**
  * An interface for template engines
  *
- * @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 - 2014 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
@@ -78,9 +78,10 @@ interface CompileableTemplate extends FrameworkInterface {
         * Removes a given variable
         *
         * @param       $variableName   The variable we are looking for
+        * @param       $variableGroup  Name of variable group (default: 'general')
         * @return      void
         */
-       function removeVariable ($variableName);
+       function removeVariable ($variableName, $variableGroup = 'general');
 
        /**
         * Assign a given congfiguration variable with a value
@@ -128,10 +129,10 @@ interface CompileableTemplate extends FrameworkInterface {
         * "Compiles" a variable by replacing {?var?} with it's content
         *
         * @param       $rawCode                        Raw code to compile
-        * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
-        * @return      $rawCode        Compile code with inserted variable value
+        * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result (default: FALSE)
+        * @return      $rawCode                        Compile code with inserted variable value
         */
-       function compileRawCode ($rawCode, $setMatchAsCode=false);
+       function compileRawCode ($rawCode, $setMatchAsCode = FALSE);
 
        /**
         * Renames a variable in code and in stack
@@ -157,7 +158,7 @@ interface CompileableTemplate extends FrameworkInterface {
         * @param       $languageSupport        New language support setting
         * @return      void
         */
-       function enableLanguageSupport ($languageSupport = true);
+       function enableLanguageSupport ($languageSupport = TRUE);
 
        /**
         * Checks whether language support is enabled
@@ -172,7 +173,7 @@ interface CompileableTemplate extends FrameworkInterface {
         * @param       $xmlCompacting  New XML compacting setting
         * @return      void
         */
-       function enableXmlCompacting ($xmlCompacting = true);
+       function enableXmlCompacting ($xmlCompacting = TRUE);
 
        /**
         * Checks whether XML compacting is enabled