X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fdecorator%2Ftemplate%2Fclass_XmlRewriterTemplateDecorator.php;h=f2fcfd48be898767a6729d7de5847775fe6c2746;hp=1d59a952be2e55e9abf86943d762f2c033126c49;hb=1dd3c575552fbec19a613e364bf971cfb50fbc20;hpb=4b88c118b615335d06bd74e444173d21aef4406c diff --git a/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php b/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php index 1d59a952..f2fcfd48 100644 --- a/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php +++ b/inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php @@ -3,11 +3,11 @@ * A decorator for XML template engines which rewrites the XML for compacting * it. * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 @@ -54,10 +54,10 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * Settter for variable group * * @param $groupName Name of variable group - * @param $add Wether add this group + * @param $add Whether add this group * @return void */ - public function setVariableGroup ($groupName, $add = true) { + public function setVariableGroup ($groupName, $add = TRUE) { // Call the inner class' method $this->getTemplateInstance()->setVariableGroup($groupName, $add); } @@ -184,12 +184,13 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT /** * 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 */ - public final function removeVariable ($var) { + public final function removeVariable ($variableName, $variableGroup = 'general') { // Call the inner class' method - $this->getTemplateInstance()->removeVariable($var); + $this->getTemplateInstance()->removeVariable($variableName, $variableGroup); } /** @@ -217,12 +218,12 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT /** * 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 */ - public function assignConfigVariable ($var) { + public function assignConfigVariable ($variableName) { // Call the inner class' method - $this->getTemplateInstance()->assignConfigVariable($var); + $this->getTemplateInstance()->assignConfigVariable($variableName); } /** @@ -295,12 +296,12 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT /** * Assigns all the application data with template variables * - * @param $appInstance A manageable application instance + * @param $applicationInstance A manageable application instance * @return void */ - public function assignApplicationData (ManageableApplication $appInstance) { + public function assignApplicationData (ManageableApplication $applicationInstance) { // Call the inner class' method - $this->getTemplateInstance()->assignApplicationData($appInstance); + $this->getTemplateInstance()->assignApplicationData($applicationInstance); } /** @@ -308,16 +309,16 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * * @param $rawCode Raw code to compile * @param $setMatchAsCode Sets $match if readVariable() returns empty result - * @return $rawCode Compile code with inserted variable value + * @return $rawCode Compile code with inserted variable value */ - public function compileRawCode ($rawCode, $setMatchAsCode=false) { + public function compileRawCode ($rawCode, $setMatchAsCode = FALSE) { return $this->getTemplateInstance()->compileRawCode($rawCode, $setMatchAsCode); } /** * Getter for variable group array * - * @return $vargroups All variable groups + * @return $variableGroups All variable groups */ public final function getVariableGroups () { // Call the inner class' method @@ -343,7 +344,7 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * @return void * @throws XmlParserException If an XML error was found */ - public function renderXmlContent ($content = null) { + public function renderXmlContent ($content = NULL) { // Call the inner class' method $this->getTemplateInstance()->renderXmlContent($content); } @@ -354,15 +355,15 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * @param $languageSupport New language support setting * @return void */ - public final function enableLanguageSupport ($languageSupport = true) { + public final function enableLanguageSupport ($languageSupport = TRUE) { // Call the inner class' method $this->getTemplateInstance()->enableLanguageSupport($languageSupport); } /** - * 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 */ public final function isLanguageSupportEnabled () { // Call the inner class' method @@ -375,15 +376,15 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * @param $xmlCompacting New XML compacting setting * @return void */ - public final function enableXmlCompacting ($xmlCompacting = true) { + public final function enableXmlCompacting ($xmlCompacting = TRUE) { // Call the inner class' method $this->getTemplateInstance()->enableXmlCompacting($xmlCompacting); } /** - * 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 */ public final function isXmlCompactingEnabled () { // Call the inner class' method @@ -412,9 +413,9 @@ class XmlRewriterTemplateDecorator extends BaseDecorator implements CompileableT * @return void * @throws XmlNodeMismatchException If current main node mismatches the closing one */ - public function endElement ($resource, $nodeName) { + public function finishElement ($resource, $nodeName) { // Call the inner class' method - $this->getTemplateInstance()->endElement($resource, $nodeName); + $this->getTemplateInstance()->finishElement($resource, $nodeName); } /**