Little resorting of public methods: all variable-related methods on one place.
authorRoland Haeder <roland@mxchange.org>
Sun, 9 Feb 2014 00:36:44 +0000 (01:36 +0100)
committerRoland Haeder <roland@mxchange.org>
Sun, 9 Feb 2014 00:36:44 +0000 (01:36 +0100)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/main/template/class_BaseTemplateEngine.php

index e7592c0..a47ce65 100644 (file)
@@ -589,58 +589,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
-        * Assign (add) a given variable with a value
-        *
-        * @param       $variableName   The variable we are looking for
-        * @param       $value                  The value we want to store in the variable
-        * @return      void
-        * @throws      EmptyVariableException  If the variable name is left empty
-        */
-       public final function assignVariable ($variableName, $value) {
-               // Replace all dashes to underscores to match variables with configuration entries
-               $variableName = trim($this->convertDashesToUnderscores($variableName));
-
-               // Empty variable found?
-               if (empty($variableName)) {
-                       // Throw an exception
-                       throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } // END - if
-
-               // First search for the variable if it was already added
-               $index = $this->getVariableIndex($variableName);
-
-               // Was it found?
-               if ($index === FALSE) {
-                       // Add it to the stack
-                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
-                       $this->addVariable($variableName, $value);
-               } elseif (!empty($value)) {
-                       // Modify the stack entry
-                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
-                       $this->modifyVariable($variableName, $value);
-               }
-       }
-
-       /**
-        * Removes a given variable
-        *
-        * @param       $variableName   The variable we are looking for
-        * @param       $variableGroup  Name of variable group (default: 'general')
-        * @return      void
-        */
-       public final function removeVariable ($variableName, $variableGroup = 'general') {
-               // First search for the variable if it was already added
-               $index = $this->getVariableIndex($variableName, $variableGroup);
-
-               // Was it found?
-               if ($index !== FALSE) {
-                       // Remove this variable
-                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
-                       $this->unsetVariableStackOffset($index, $variableGroup);
-               } // END - if
-       }
-
-       /**
         * Unsets the given offset in the variable group
         *
         * @param       $index                  Index to unset
@@ -1162,6 +1110,76 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
+        * Assign (add) a given variable with a value
+        *
+        * @param       $variableName   The variable we are looking for
+        * @param       $value                  The value we want to store in the variable
+        * @return      void
+        * @throws      EmptyVariableException  If the variable name is left empty
+        */
+       public final function assignVariable ($variableName, $value) {
+               // Replace all dashes to underscores to match variables with configuration entries
+               $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+               // Empty variable found?
+               if (empty($variableName)) {
+                       // Throw an exception
+                       throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+               } // END - if
+
+               // First search for the variable if it was already added
+               $index = $this->getVariableIndex($variableName);
+
+               // Was it found?
+               if ($index === FALSE) {
+                       // Add it to the stack
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+                       $this->addVariable($variableName, $value);
+               } elseif (!empty($value)) {
+                       // Modify the stack entry
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+                       $this->modifyVariable($variableName, $value);
+               }
+       }
+
+       /**
+        * Removes a given variable
+        *
+        * @param       $variableName   The variable we are looking for
+        * @param       $variableGroup  Name of variable group (default: 'general')
+        * @return      void
+        */
+       public final function removeVariable ($variableName, $variableGroup = 'general') {
+               // First search for the variable if it was already added
+               $index = $this->getVariableIndex($variableName, $variableGroup);
+
+               // Was it found?
+               if ($index !== FALSE) {
+                       // Remove this variable
+                       //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
+                       $this->unsetVariableStackOffset($index, $variableGroup);
+               } // END - if
+       }
+
+       /**
+        * Assigns the last loaded raw template content with a given variable
+        *
+        * @param       $templateName   Name of the template we want to assign
+        * @param       $variableName   Name of the variable we want to assign
+        * @return      void
+        */
+       public function assignTemplateWithVariable ($templateName, $variableName) {
+               // Get the content from last loaded raw template
+               $content = $this->getRawTemplateData();
+
+               // Assign the variable
+               $this->assignVariable($variableName, $content);
+
+               // Purge raw content
+               $this->setRawTemplateData('');
+       }
+
+       /**
         * Assign a given congfiguration variable with a value
         *
         * @param       $variableName   The configuration variable we want to assign
@@ -1177,6 +1195,26 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
+        * Assigns all the application data with template variables
+        *
+        * @param       $applicationInstance    A manageable application instance
+        * @return      void
+        */
+       public function assignApplicationData (ManageableApplication $applicationInstance) {
+               // Get long name and assign it
+               $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
+
+               // Get short name and assign it
+               $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
+
+               // Get version number and assign it
+               $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
+
+               // Assign extra application-depending data
+               $applicationInstance->assignExtraTemplateData($this);
+       }
+
+       /**
         * Load a specified code template into the engine
         *
         * @param       $template       The code template we shall load which is
@@ -1400,24 +1438,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
-        * Assigns the last loaded raw template content with a given variable
-        *
-        * @param       $templateName   Name of the template we want to assign
-        * @param       $variableName   Name of the variable we want to assign
-        * @return      void
-        */
-       public function assignTemplateWithVariable ($templateName, $variableName) {
-               // Get the content from last loaded raw template
-               $content = $this->getRawTemplateData();
-
-               // Assign the variable
-               $this->assignVariable($variableName, $content);
-
-               // Purge raw content
-               $this->setRawTemplateData('');
-       }
-
-       /**
         * Transfers the content of this template engine to a given response instance
         *
         * @param       $responseInstance       An instance of a response class
@@ -1429,26 +1449,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
-        * Assigns all the application data with template variables
-        *
-        * @param       $applicationInstance    A manageable application instance
-        * @return      void
-        */
-       public function assignApplicationData (ManageableApplication $applicationInstance) {
-               // Get long name and assign it
-               $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
-
-               // Get short name and assign it
-               $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
-
-               // Get version number and assign it
-               $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
-
-               // Assign extra application-depending data
-               $applicationInstance->assignExtraTemplateData($this);
-       }
-
-       /**
         * "Compiles" a variable by replacing {?var?} with it's content
         *
         * @param       $rawCode                        Raw code to compile