/**
* Language support is enabled by default
*/
- private $languageSupport = true;
+ private $languageSupport = TRUE;
/**
* XML compacting is disabled by default
*/
- private $xmlCompacting = false;
+ private $xmlCompacting = FALSE;
// Exception codes for the template engine
const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
* 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));
// First everything is not found
- $found = false;
+ $found = FALSE;
// If the stack is null, use the current group
- if (is_null($stack)) {
+ if (is_null($variableGroup)) {
// Use current group
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
- $stack = $this->currGroup;
+ $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: */ self::createDebugInstance(__CLASS__)->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!
}
/**
- * 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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
- $stack = $this->currGroup;
+ $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) {
+ if ($found !== FALSE) {
// Read it
- $content = $this->getVariableValue($stack, $found);
+ $content = $this->getVariableValue($variableGroup, $found);
} // END - if
// Return the current position
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->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) {
* @param $add Whether add this group
* @return void
*/
- public function setVariableGroup ($groupName, $add = true) {
+ public function setVariableGroup ($groupName, $add = TRUE) {
// Set group name
//* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
$this->currGroup = $groupName;
// Skip group 'general'
- if (($groupName != 'general') && ($add === true)) {
+ if (($groupName != 'general') && ($add === TRUE)) {
$this->varGroups[$groupName] = 'OK';
} // END - if
}
$index = $this->getVariableIndex($variableName);
// Is the variable set?
- if ($index === false) {
+ if ($index === FALSE) {
// Unset variables cannot be modified
throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
} // END - if
$index = $this->getVariableIndex($variableName);
// Is the variable set?
- if ($index === false) {
+ if ($index === FALSE) {
// Not found, add it
$this->varStack[$varGroup][] = $this->generateVariableArray($variableName, $value);
} else {
$index = $this->getVariableIndex($variableName);
// Was it found?
- if ($index === false) {
+ if ($index === FALSE) {
// Add it to the stack
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
$this->addVariable($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) {
+ if ($index !== FALSE) {
// Remove this variable
- $this->unsetVariableStackOffset($index);
+ //* 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 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]);
}
/**
preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
// Debug message
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->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)) {
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
// Template not found, but maybe variable assigned?
- if ($this->getVariableIndex($template, 'config') !== false) {
+ if ($this->getVariableIndex($template, 'config') !== FALSE) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template, 'config');
// Recursive protection:
$this->loadedTemplates[] = $template;
- } elseif ($this->getVariableIndex($template) !== false) {
+ } elseif ($this->getVariableIndex($template) !== FALSE) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template);
$foundIndex = array_search($template, $templateMatches[1]);
// Lookup the matching template replacement
- if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
+ if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
// Get the current raw template
$rawData = $this->getRawTemplateData();
$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
}
$foundIndex = array_search($template, $templateMatches[1]);
// Lookup the matching variable data
- if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
+ 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: */ self::createDebugInstance(__CLASS__)->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);
/**
* 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
// Iterate through all general variables
foreach ($this->getVarStack('general') as $index => $currVariable) {
// Compile the value
- $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
+ $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
// Debug message
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
// Re-assign the variable
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
- $this->assignConfigVariable($value);
+ $this->setVariable('config', $currVariable['name'], $value);
} // END - foreach
}
);
// This loop does remove the backslashes (\) in PHP parameters
- while (strpos($eval, $this->codeBegin) !== false) {
+ while (strpos($eval, $this->codeBegin) !== FALSE) {
// Get left part before "<?"
$evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
// Goes something wrong?
if ((!isset($result)) || (empty($result))) {
// Output eval command
- self::createDebugInstance(__CLASS__)->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: */ self::createDebugInstance(__CLASS__)->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)) {
* @param $setMatchAsCode Sets $match if readVariable() returns empty result
* @return $rawCode Compile code with inserted variable value
*/
- public function compileRawCode ($rawCode, $setMatchAsCode=false) {
+ public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
// Find the variables
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
// Is the variable found in code? (safes some calls)
- if (strpos($rawCode, $varCode) !== false) {
+ if (strpos($rawCode, $varCode) !== FALSE) {
// Debug message
//* 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) {
+ if ($setMatchAsCode === TRUE) {
// Insert match
$rawCode = str_replace($varCode, $match, $rawCode);
} else {
* @param $languageSupport New language support setting
* @return void
*/
- public final function enableLanguageSupport ($languageSupport = true) {
+ public final function enableLanguageSupport ($languageSupport = TRUE) {
$this->languageSupport = (bool) $languageSupport;
}
* @param $xmlCompacting New XML compacting setting
* @return void
*/
- public final function enableXmlCompacting ($xmlCompacting = true) {
+ public final function enableXmlCompacting ($xmlCompacting = TRUE) {
$this->xmlCompacting = (bool) $xmlCompacting;
}
projects / core.git / blobdiff