* Search for a variable in the stack
*
* @param $variableName The variable we are looking for
- * @param $stack Optional variable stack to look in
+ * @param $variableGroup Optional variable group to look in
* @return $index FALSE means not found, >=0 means found on a specific index
*/
- private function getVariableIndex ($variableName, $stack = NULL) {
+ private function getVariableIndex ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
$variableName = trim($this->convertDashesToUnderscores($variableName));
$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'] . ',variableName=' . $variableName);
+ 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'] == $variableName) {
// Found!
- //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
$found = $index;
break;
} // END - if
}
/**
- * 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 $variableName The variable we are looking for
- * @param $stack Optional variable stack to look in
+ * @param $variableGroup Optional variable group to look in
* @return $content Content of the variable or null if not found
*/
- protected function readVariable ($variableName, $stack = NULL) {
+ protected function readVariable ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
$variableName = trim($this->convertDashesToUnderscores($variableName));
$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($variableName, $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 . ',variableName=' . $variableName . ', 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 $variableName 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 ($variableName, $value) {
*/
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'
$variableName = trim($this->convertDashesToUnderscores($variableName));
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
// Get current variables in group
$currVars = $this->readCurrentGroup();
// Was it found?
if ($index === false) {
// Add it to the stack
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $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: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ //* 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) {
+ public final function removeVariable ($variableName, $variableGroup = 'general') {
// First search for the variable if it was already added
- $index = $this->getVariableIndex($variableName);
+ $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]);
}
/**
*/
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;
}
* @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;
}
*/
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;
}
* @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;
}
$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);
$variableName = trim($this->convertDashesToUnderscores($variableName));
// Debug message
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
// Is it not a config variable?
if ($varName != 'config') {
preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
// Debug message
- //* NOISY-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)) {
// 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) {
*/
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) {
$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) == '=') {
$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
}
*/
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
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);
- //* NOISY-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);
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')) {
// Walk through all variables
foreach ($this->getVarStack('general') as $currEntry) {
- //* DEBUG: */
$this->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
+ //* DEBUG: */
self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
// Replace all [$var] or {?$var?} with the content
// @TODO Old behaviour, will become obsolete!
$content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
$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);
$variableName = trim($this->convertDashesToUnderscores($variableName));
// Sweet and simple...
- //* DEBUG: */ $this->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
$this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
}
/**
* 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
// 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
$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($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
}
// 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'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
+ //* DEBUG: */
self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
$dummy[$currVariable['name']] = $currVariable['value'];
}// END - if
// Goes something wrong?
if ((!isset($result)) || (empty($result))) {
// Output eval command
-
$this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
+
self::createDebugInstance(__CLASS__)->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
// Output backtrace here
$this->debugBackTrace();
preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
// Debug message
- //* NOISY-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)) {
*/
public function compileRawCode ($rawCode, $setMatchAsCode=false) {
// Find the variables
- //* NOISY-DEBUG: */
$this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
+ //* NOISY-DEBUG: */
self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* NOISY-DEBUG: */
$this->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
+ //* NOISY-DEBUG: */
self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
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 . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
+ //* 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) {
} // END - foreach
// Return the compiled data
- //* DEBUG: */
$this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
+ //* DEBUG: */
self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
return $rawCode;
}
* @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();
projects / core.git / blobdiff