X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Ftemplate%2Fclass_CompileableTemplate.php;h=41791914ee5581de90d9de32d04206018624081f;hp=1e7f82fd68e87c95d0f70d8c867ead1c6eda07a4;hb=8904918d814abf3468d084b8826e4d280b0885e3;hpb=fffe0ef5a4c39831127b1afed64d8ea0e077b09e diff --git a/inc/classes/interfaces/template/class_CompileableTemplate.php b/inc/classes/interfaces/template/class_CompileableTemplate.php index 1e7f82fd..41791914 100644 --- a/inc/classes/interfaces/template/class_CompileableTemplate.php +++ b/inc/classes/interfaces/template/class_CompileableTemplate.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @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,9 +175,9 @@ 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 ();