X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Ftemplate%2Fclass_CompileableTemplate.php;h=b894a295ce90db3b860e20559e6a97f37869fafb;hb=ec670451fafdd675c346232d6580c8f291a23d3e;hp=d0de9ec092fc02c0472d7a93440faf7cc4332f71;hpb=84e2207412d3c6ea9f940a83b2cdd4503509808a;p=core.git

diff --git a/inc/classes/interfaces/template/class_CompileableTemplate.php b/inc/classes/interfaces/template/class_CompileableTemplate.php
index d0de9ec0..b894a295 100644
--- 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, 2010 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
@@ -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'
@@ -119,19 +120,19 @@ 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
 	 *
 	 * @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
@@ -149,7 +150,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
@@ -157,12 +158,12 @@ interface CompileableTemplate extends FrameworkInterface {
 	 * @param	$languageSupport	New language support setting
 	 * @return	void
 	 */
-	function enableLanguageSupport ($languageSupport = true);
+	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 ();
 
@@ -172,14 +173,22 @@ interface CompileableTemplate extends FrameworkInterface {
 	 * @param	$xmlCompacting	New XML compacting setting
 	 * @return	void
 	 */
-	function enableXmlCompacting ($xmlCompacting = true);
+	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	$uncompactedContent		The uncompacted content
+	 * @return	$compactedContent		The compacted content
+	 */
+	function compactContent ($uncompactedContent);
 }
 
 // [EOF]