/**
* 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 - 2011 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
/**
* 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
/**
* 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'
* "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
* @param $languageSupport New language support setting
* @return void
*/
- function enableLanguageSupport ($languageSupport = true);
+ function enableLanguageSupport ($languageSupport = TRUE);
/**
* Checks whether language support is enabled
* @param $xmlCompacting New XML compacting setting
* @return void
*/
- function enableXmlCompacting ($xmlCompacting = true);
+ function enableXmlCompacting ($xmlCompacting = TRUE);
/**
* Checks whether XML compacting is enabled