X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=ed974689a5001031e481f95e56d764037914cdc0;hp=272b9d718ee1db9c99b4659971af8fee6f6afd75;hb=980c7be55e69deb95920b903cbe803423b49e341;hpb=48732bab3b2ca49cf44cfa5d7921c4073a41809c
diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php
index 272b9d71..ed974689 100644
--- a/inc/classes/main/template/class_BaseTemplateEngine.php
+++ b/inc/classes/main/template/class_BaseTemplateEngine.php
@@ -167,33 +167,33 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* Search for a variable in the stack
*
- * @param $var The variable we are looking for
- * @param $stack Optional variable stack to look in
- * @return $index FALSE means not found, >=0 means found on a specific index
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Optional variable group to look in
+ * @return $index FALSE means not found, >=0 means found on a specific index
*/
- private function getVariableIndex ($var, $stack = NULL) {
+ private function getVariableIndex ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// First everything is not found
$found = false;
// If the stack is null, use the current group
- if (is_null($stack)) {
+ if (is_null($variableGroup)) {
// Use current group
- //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
- $stack = $this->currGroup;
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $variableGroup = $this->currGroup;
} // END - if
// Is the group there?
- if ($this->isVarStackSet($stack)) {
+ if ($this->isVarStackSet($variableGroup)) {
// Now search for it
- foreach ($this->getVarStack($stack) as $index => $currEntry) {
- //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',var=' . $var);
+ foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
// Is the entry found?
- if ($currEntry['name'] == $var) {
+ if ($currEntry['name'] == $variableName) {
// Found!
- //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
$found = $index;
break;
} // END - if
@@ -205,88 +205,88 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
}
/**
- * Checks whether the given variable stack is set
+ * Checks whether the given variable group is set
*
- * @param $stack Variable stack to check
- * @return $isSet Whether the given variable stack is set
+ * @param $variableGroup Variable group to check
+ * @return $isSet Whether the given variable group is set
*/
- protected final function isVarStackSet ($stack) {
+ protected final function isVarStackSet ($variableGroup) {
// Check it
- $isSet = isset($this->varStack[$stack]);
+ $isSet = isset($this->varStack[$variableGroup]);
// Return result
return $isSet;
}
/**
- * Getter for given variable stack
+ * Getter for given variable group
*
- * @param $stack Variable stack to check
- * @return $varStack Found variable stack
+ * @param $variableGroup Variable group to check
+ * @return $varStack Found variable group
*/
- public final function getVarStack ($stack) {
- return $this->varStack[$stack];
+ public final function getVarStack ($variableGroup) {
+ return $this->varStack[$variableGroup];
}
/**
- * Setter for given variable stack
+ * Setter for given variable group
*
- * @param $stack Variable stack to check
- * @param $varStack Variable stack to check
+ * @param $variableGroup Variable group to check
+ * @param $varStack Variable stack to check
* @return void
*/
- protected final function setVarStack ($stack, array $varStack) {
- $this->varStack[$stack] = $varStack;
+ protected final function setVarStack ($variableGroup, array $varStack) {
+ $this->varStack[$variableGroup] = $varStack;
}
/**
* Return a content of a variable or null if not found
*
- * @param $var The variable we are looking for
- * @param $stack Optional variable stack to look in
- * @return $content Content of the variable or null if not found
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Optional variable group to look in
+ * @return $content Content of the variable or null if not found
*/
- protected function readVariable ($var, $stack = NULL) {
+ protected function readVariable ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// First everything is not found
$content = NULL;
// If the stack is null, use the current group
- if (is_null($stack)) {
+ if (is_null($variableGroup)) {
// Use current group
- //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
- $stack = $this->currGroup;
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $variableGroup = $this->currGroup;
} // END - if
// Get variable index
- $found = $this->getVariableIndex($var, $stack);
+ $found = $this->getVariableIndex($variableName, $variableGroup);
// Is the variable found?
if ($found !== false) {
// Read it
- $content = $this->getVariableValue($stack, $found);
+ $content = $this->getVariableValue($variableGroup, $found);
} // END - if
// Return the current position
- //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',var=' . $var . ', content[' . gettype($content) . ']=' . $content);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
return $content;
}
/**
* Add a variable to the stack
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @param $variableName Name of variable to add
+ * @param $value Value we want to store in the variable
* @return void
*/
- private function addVariable ($var, $value) {
+ private function addVariable ($variableName, $value) {
// Set general variable group
$this->setVariableGroup('general');
// Add it to the stack
- $this->addGroupVariable($var, $value);
+ $this->addGroupVariable($variableName, $value);
}
/**
@@ -317,7 +317,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
public function setVariableGroup ($groupName, $add = true) {
// Set group name
- //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
+ //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
$this->currGroup = $groupName;
// Skip group 'general'
@@ -330,22 +330,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* 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
*/
- public function addGroupVariable ($var, $value) {
+ public function addGroupVariable ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', var=' . $var . ', value=' . $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
// Get current variables in group
$currVars = $this->readCurrentGroup();
// Append our variable
- $currVars[] = $this->generateVariableArray($var, $value);
+ $currVars[] = $this->generateVariableArray($variableName, $value);
// Add it to the stack
$this->setVarStack($this->currGroup, $currVars);
@@ -366,22 +366,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* Modify an entry on the stack
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @param $variableName The variable we are looking for
+ * @param $value The value we want to store in the variable
* @return void
* @throws NoVariableException If the given variable is not found
*/
- private function modifyVariable ($var, $value) {
+ private function modifyVariable ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Get index for variable
- $index = $this->getVariableIndex($var);
+ $index = $this->getVariableIndex($variableName);
// Is the variable set?
if ($index === false) {
// Unset variables cannot be modified
- throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
+ throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
} // END - if
// Then modify it
@@ -405,22 +405,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* variable is already set. If so, the variable got modified, otherwise
* added.
*
- * @param $varGroup Variable group to use
- * @param $var Variable to set
- * @param $value Value to set
+ * @param $varGroup Variable group to use
+ * @param $variableName Variable to set
+ * @param $value Value to set
* @return void
*/
- protected function setVariable ($varGroup, $var, $value) {
+ protected function setVariable ($varGroup, $variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Get index for variable
- $index = $this->getVariableIndex($var);
+ $index = $this->getVariableIndex($variableName);
// Is the variable set?
if ($index === false) {
// Not found, add it
- $this->varStack[$varGroup][] = $this->generateVariableArray($var, $value);
+ $this->varStack[$varGroup][] = $this->generateVariableArray($variableName, $value);
} else {
// Then modify it
$this->setVariableValue($this->currGroup, $index, $value);
@@ -431,17 +431,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* "Generates" (better returns) an array for all variables for given
* variable/value pay.
*
- * @param $var Variable to set
- * @param $value Value to set
- * @return $varData Variable data array
+ * @param $variableName Variable to set
+ * @param $value Value to set
+ * @return $varData Variable data array
*/
- private function generateVariableArray ($var, $value) {
+ private function generateVariableArray ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Generate the temporary array
$varData = array(
- 'name' => $var,
+ 'name' => $variableName,
'value' => $value
);
@@ -580,68 +580,76 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* Assign (add) a given variable with a value
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @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 ($var, $value) {
+ public final function assignVariable ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Empty variable found?
- if (empty($var)) {
+ if (empty($variableName)) {
// Throw an exception
- throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+ 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($var);
+ $index = $this->getVariableIndex($variableName);
// Was it found?
if ($index === false) {
// Add it to the stack
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $var . '[' . gettype($value) . ']=' . $value);
- $this->addVariable($var, $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->addVariable($variableName, $value);
} elseif (!empty($value)) {
// Modify the stack entry
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $var . '[' . gettype($value) . ']=' . $value);
- $this->modifyVariable($var, $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->modifyVariable($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
*/
- public final function removeVariable ($var) {
+ public final function removeVariable ($variableName, $variableGroup = 'general') {
// First search for the variable if it was already added
- $index = $this->getVariableIndex($var);
+ $index = $this->getVariableIndex($variableName, $variableGroup);
// Was it found?
if ($index !== false) {
// Remove this variable
- $this->unsetVariableStackOffset($index);
+ $this->unsetVariableStackOffset($index, $variableGroup);
} // END - if
}
/**
- * Unsets the given offset in the variable stack
+ * Unsets the given offset in the variable group
*
- * @param $index Index to unset
+ * @param $index Index to unset
+ * @param $variableGroup Variable group (default: currGroup)
* @return void
*/
- protected final function unsetVariableStackOffset ($index) {
+ protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
+ // Is the variable group not set?
+ if (is_null($variableGroup)) {
+ // Then set it to current
+ $variableGroup = $this->currGroup;
+ } // END - if
+
// Is the entry there?
- if (!isset($this->varStack[$this->currGroup][$index])) {
+ if (!isset($this->varStack[$variableGroup][$index])) {
// Abort here, we need fixing!
$this->debugInstance();
} // END - if
// Remove it
- unset($this->varStack[$this->currGroup][$index]);
+ unset($this->varStack[$variableGroup][$index]);
}
/**
@@ -652,8 +660,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
protected final function setRawTemplateData ($rawTemplateData) {
// And store it in this class
- //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
- //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
$this->rawTemplateData = (string) $rawTemplateData;
}
@@ -663,7 +671,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* @return $rawTemplateData The raw data from the template
*/
public final function getRawTemplateData () {
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
return $this->rawTemplateData;
}
@@ -674,7 +682,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
private final function setCompiledData ($compiledData) {
// And store it in this class
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
$this->compiledData = (string) $compiledData;
}
@@ -684,7 +692,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* @return $compiledData Compiled template data
*/
public final function getCompiledData () {
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
return $this->compiledData;
}
@@ -761,7 +769,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
$ioInstance = $this->getFileIoInstance();
// Some debug code to look on the file which is being loaded
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
// Load the raw template
$rawTemplateData = $ioInstance->loadFileContents($fqfn);
@@ -777,24 +785,25 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* Try to assign an extracted template variable as a "content" or 'config'
* variable.
*
- * @param $varName The variable's name (shall be content orconfig) by
- * default
- * @param $var The variable we want to assign
+ * @param $varName The variable's name (shall be content or config)
+ * by default
+ * @param $variableName The variable we want to assign
+ * @return void
*/
private function assignTemplateVariable ($varName, $var) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',var=' . $var);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
// Is it not a config variable?
if ($varName != 'config') {
// Regular template variables
- $this->assignVariable($var, '');
+ $this->assignVariable($variableName, '');
} else {
// Configuration variables
- $this->assignConfigVariable($var);
+ $this->assignConfigVariable($variableName);
}
}
@@ -812,7 +821,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
// Did we find some variables?
if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
@@ -861,7 +870,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
// RECURSIVE PROTECTION! BE CAREFUL HERE!
if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
// Template not found, but maybe variable assigned?
if ($this->getVariableIndex($template, 'config') !== false) {
@@ -1002,7 +1011,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
private function assignAllVariables (array $varMatches) {
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
// Search for all variables
foreach ($varMatches[1] as $key => $var) {
@@ -1010,7 +1019,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
$var = trim($this->convertDashesToUnderscores($var));
// Debug message
- $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
+ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
// Detect leading equals
if (substr($varMatches[2][$key], 0, 1) == '=') {
@@ -1019,12 +1028,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
} // END - if
// Do we have some quotes left and right side? Then it is free text
- if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
+ if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
// Free string detected! Which we can assign directly
$this->assignVariable($var, $varMatches[3][$key]);
} elseif (!empty($varMatches[2][$key])) {
// @TODO Non-string found so we need some deeper analysis...
- ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
+ ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
}
} // END - foreach
}
@@ -1037,19 +1046,19 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
private function compileRawTemplateData (array $templateMatches) {
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
// Are some code-templates found which we need to compile?
if (count($this->loadedRawData) > 0) {
// Then compile all!
foreach ($this->loadedRawData as $template => $code) {
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
// Is this template already compiled?
if (in_array($template, $this->compiledTemplates)) {
// Then skip it
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
continue;
} // END - if
@@ -1060,7 +1069,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
// Split it up with another reg. exp. into variable=value pairs
preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
- ///* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches,true));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, true));
// Assign all variables
$this->assignAllVariables($varMatches);
@@ -1096,7 +1105,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
private function finalizeVariableCompilation () {
// Get the content
$content = $this->getRawTemplateData();
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
@@ -1107,7 +1116,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
// Walk through all variables
foreach ($this->getVarStack('general') as $currEntry) {
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=' . htmlentities($currEntry['value']) . '
');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=' . htmlentities($currEntry['value']) . '
');
// Replace all [$var] or {?$var?} with the content
// @TODO Old behaviour, will become obsolete!
$content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
@@ -1119,7 +1128,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
$content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
} // END - for
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
// Set the content back
$this->setRawTemplateData($content);
@@ -1143,16 +1152,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* 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) {
// Replace all dashes to underscores to match variables with configuration entries
- $var = trim($this->convertDashesToUnderscores($var));
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Sweet and simple...
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var));
- $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
+ $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
}
/**
@@ -1172,7 +1181,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
/**
* Compiles configuration place-holders in all variables. This 'walks'
- * through the variable stack 'general'. It interprets all values from that
+ * through the variable group 'general'. It interprets all values from that
* variables as configuration entries after compiling them.
*
* @return void
@@ -1181,7 +1190,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
// Abort here silently
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
return;
} // END - if
@@ -1191,13 +1200,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
$value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
// Remove it from stack
- $this->removeVariable($index, 'general');
+ $this->removeVariable($currVariable['name'], 'general');
// Re-assign the variable
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
$this->assignConfigVariable($value);
} // END - foreach
}
@@ -1216,7 +1225,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
// Iterate through all general variables
foreach ($this->getVarStack('general') as $currVariable) {
// Transfer it's name/value combination to the $content array
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=' . htmlentities($currVariable['value']).'
');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=' . htmlentities($currVariable['value']).'
');
$dummy[$currVariable['name']] = $currVariable['value'];
}// END - if
@@ -1273,7 +1282,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
// Goes something wrong?
if ((!isset($result)) || (empty($result))) {
// Output eval command
- $this->debugOutput(sprintf("Failed eval() code: %s
", $this->markupCode($eval, true)), true);
+ self::createDebugInstance(__CLASS__)->debugOutput(sprintf("Failed eval() code: %s
", $this->markupCode($eval, true)), true);
// Output backtrace here
$this->debugBackTrace();
@@ -1323,7 +1332,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
// Analyze the matches array
if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
@@ -1430,22 +1439,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
*/
public function compileRawCode ($rawCode, $setMatchAsCode=false) {
// Find the variables
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=' . htmlentities($rawCode) . '
');
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=' . htmlentities($rawCode) . '
');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . print_r($varMatches, true) . '
');
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . print_r($varMatches, true) . '
');
foreach ($varMatches[0] as $match) {
// Add variable tags around it
$varCode = '{?' . $match . '?}';
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varCode=' . $varCode);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
// Is the variable found in code? (safes some calls)
if (strpos($rawCode, $varCode) !== false) {
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',value[' . gettype($value) . ']=' . $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
// Use $match as new value or $value from read variable?
if ($setMatchAsCode === true) {
@@ -1462,7 +1471,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
} // END - foreach
// Return the compiled data
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=' . htmlentities($rawCode) . '
');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=' . htmlentities($rawCode) . '
');
return $rawCode;
}
@@ -1483,7 +1492,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
* @return void
*/
public function renameVariable ($oldName, $newName) {
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
// Get raw template code
$rawData = $this->getRawTemplateData();