/**
* 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 $stack Optional variable stack 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, $stack = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $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)) {
// Use current group
- //* DEBUG: */ print __METHOD__.' currGroup=' . $this->currGroup . ' set as stack!<br />' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
$stack = $this->currGroup;
} // END - if
if ($this->isVarStackSet($stack)) {
// Now search for it
foreach ($this->getVarStack($stack) as $index => $currEntry) {
- //* DEBUG: */ print __METHOD__.":currGroup={$stack},idx={$index},currEntry={$currEntry['name']},var={$var}<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
// Is the entry found?
- if ($currEntry['name'] == $var) {
+ if ($currEntry['name'] == $variableName) {
// Found!
- //* DEBUG: */ print __METHOD__.":FOUND!<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
$found = $index;
break;
} // END - if
/**
* 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 $stack Optional variable stack to look in
+ * @return $content Content of the variable or null if not found
*/
- protected function readVariable ($var, $stack = NULL) {
+ protected function readVariable ($variableName, $stack = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $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)) {
// Use current group
- //* DEBUG: */ print __METHOD__.' currGroup=' . $this->currGroup . ' set as stack!<br />' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
$stack = $this->currGroup;
} // END - if
// Get variable index
- $found = $this->getVariableIndex($var, $stack);
+ $found = $this->getVariableIndex($variableName, $stack);
// Is the variable found?
if ($found !== false) {
} // END - if
// Return the current position
- //* DEBUG: */ print __METHOD__.': group='.$stack.',var='.$var.', content['.gettype($content).']='.$content.'<br />' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
return $content;
}
/**
* Add a variable to the stack
*
- * @param $var The variable we are looking for
+ * @param $variableName The variable we are looking for
* @param $value The 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);
}
/**
*/
public function setVariableGroup ($groupName, $add = true) {
// Set group name
- //* DEBIG: */ print __METHOD__.": currGroup=".$groupName."<br />\n";
+ //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
$this->currGroup = $groupName;
// Skip group 'general'
/**
* 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) {
- //* DEBUG: */ print __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."<br />\n";
+ public function addGroupVariable ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Debug message
+ //* DEBUG: */ $this->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);
/**
* 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
+ $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
* 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
+ $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);
* "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
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// Generate the temporary array
$varData = array(
- 'name' => $var,
+ 'name' => $variableName,
'value' => $value
);
/**
* 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) {
- // Trim spaces of variable name
- $var = trim($var);
+ 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($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: */ echo "ADD: ".$var."<br />\n";
- $this->addVariable($var, $value);
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->addVariable($variableName, $value);
} elseif (!empty($value)) {
// Modify the stack entry
- //* DEBUG: */ echo "MOD: ".$var."<br />\n";
- $this->modifyVariable($var, $value);
+ //* DEBUG: */ $this->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
* @return void
*/
- public final function removeVariable ($var) {
+ public final function removeVariable ($variableName) {
// First search for the variable if it was already added
- $index = $this->getVariableIndex($var);
+ $index = $this->getVariableIndex($variableName);
// Was it found?
if ($index !== false) {
*/
protected final function setRawTemplateData ($rawTemplateData) {
// And store it in this class
- //* DEBUG: */ print __METHOD__.': '.strlen($rawTemplateData).' Bytes set.' . chr(10);
- //* DEBUG: */ print $this->currGroup.' variables: '.count($this->getVarStack($this->currGroup)).', groups='.count($this->varStack).'' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
+ //* DEBUG: */ $this->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: */ print __METHOD__.': '.strlen($this->rawTemplateData).' Bytes read.' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
return $this->rawTemplateData;
}
*/
private final function setCompiledData ($compiledData) {
// And store it in this class
- //* DEBUG: */ print __METHOD__.': '.strlen($compiledData).' Bytes set.' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
$this->compiledData = (string) $compiledData;
}
* @return $compiledData Compiled template data
*/
public final function getCompiledData () {
- //* DEBUG: */ print __METHOD__.': '.strlen($this->compiledData).' Bytes read.' . chr(10);
+ //* DEBUG: */ $this->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: */ print __METHOD__.": FQFN=".$fqfn."<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
// Load the raw template
$rawTemplateData = $ioInstance->loadFileContents($fqfn);
* 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
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Debug message
+ //* DEBUG: */ $this->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);
}
}
$rawData = (string) $rawData;
// Search for variables
- @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+ preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+
+ // Debug message
+ //* NOISY-DEBUG: */ $this->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)) {
// Load all requested templates
foreach ($templateMatches[1] as $template) {
-
// Load and compile only templates which we have not yet loaded
// RECURSIVE PROTECTION! BE CAREFUL HERE!
if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template);
// Template not found, but maybe variable assigned?
- //* DEBUG: */ print __METHOD__.":template={$template}<br />\n";
if ($this->getVariableIndex($template, 'config') !== false) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template, 'config');
* @todo Unfinished work or don't die here.
*/
private function assignAllVariables (array $varMatches) {
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
+
// Search for all variables
foreach ($varMatches[1] as $key => $var) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
+ // Debug message
+ $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
// Detect leading equals
if (substr($varMatches[2][$key], 0, 1) == '=') {
} // 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!');
}
-
- } // for ($varMatches ...
+ } // END - foreach
}
/**
* @return void
*/
private function compileRawTemplateData (array $templateMatches) {
+ // Debug message
+ //* DEBUG: */ $this->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);
// Is this template already compiled?
if (in_array($template, $this->compiledTemplates)) {
// Then skip it
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
continue;
} // END - if
// Lookup the matching variable data
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));
// Assign all variables
$this->assignAllVariables($varMatches);
-
} // END - if (isset($templateMatches ...
// Compile the loaded template
$this->compileCode($code, $template);
-
} // END - foreach ($this->loadedRawData ...
// Insert all templates
$this->insertAllTemplates($templateMatches);
-
} // END - if (count($this->loadedRawData) ...
}
private function finalizeVariableCompilation () {
// Get the content
$content = $this->getRawTemplateData();
- //* DEBUG: */ print __METHOD__.': content before='.strlen($content).' ('.md5($content).')' . chr(10);
+ //* DEBUG: */ $this->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: */ print __METHOD__.': name='.$currEntry['name'].', value=<pre>'.htmlentities($currEntry['value']).'</pre>\n';
+ //* DEBUG: */ $this->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: */ print __METHOD__.': content after='.strlen($content).' ('.md5($content).')' . chr(10);
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
// Set the content back
$this->setRawTemplateData($content);
/**
* 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
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// Sweet and simple...
- //* DEBUG: */ print __METHOD__.': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var) . chr(10);
- $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
+ $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
}
/**
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
// Abort here silently
- // @TODO This silent abort should be logged, maybe.
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
return;
} // END - if
// Compile the value
$value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
+ // Debug message
+ //* DEBUG: */ $this->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: */ print __METHOD__.': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index . chr(10);
+ //* DEBUG: */ $this->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: */ echo $currVariable['name'].'=<pre>'.htmlentities($currVariable['value']).'</pre>\n';
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
$dummy[$currVariable['name']] = $currVariable['value'];
}// END - if
// Set the new variable (don't remove the second dollar!)
$$validVar = $dummy;
- // Prepare all configuration variables
- $config = NULL;
- if ($this->isVarStackSet('config')) {
- $config = $this->getVarStack('config');
- } // END - if
-
// Remove some variables
unset($index);
unset($currVariable);
// Search for code-tags which are {? ?}
preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
+ // Debug message
+ //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
+
// Analyze the matches array
if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
// Entries are found:
// Are some raw templates found and loaded?
if (count($this->rawTemplates) > 0) {
-
// Insert all raw templates
$this->insertRawTemplates();
// Remove the raw template content as well
$this->setRawTemplateData('');
-
} // END - if
-
} // END - if($templateMatches ...
}
*/
public function compileRawCode ($rawCode, $setMatchAsCode=false) {
// Find the variables
- //* DEBUG: */ print __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+ //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* DEBUG: */ print __METHOD__.":<pre>".print_r($varMatches, true)."</pre>\n";
+ //* NOISY-DEBUG: */ $this->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);
+
// Is the variable found in code? (safes some calls)
if (strpos($rawCode, $varCode) !== false) {
- // Replace the variable with it's value, if found
- $value = $this->readVariable($match);
- //* DEBUG: */ print __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."<br />\n";
- if (($setMatchAsCode === true) && (is_null($value))) {
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
+
+ // Use $match as new value or $value from read variable?
+ if ($setMatchAsCode === true) {
// Insert match
$rawCode = str_replace($varCode, $match, $rawCode);
} else {
+ // Read the variable
+ $value = $this->readVariable($match);
+
// Insert value
$rawCode = str_replace($varCode, $value, $rawCode);
}
} // END - foreach
// Return the compiled data
- //* DEBUG: */ print __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
return $rawCode;
}
* @return void
*/
public function renameVariable ($oldName, $newName) {
- //* DEBUG: */ print __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
// Get raw template code
$rawData = $this->getRawTemplateData();
projects / core.git / blobdiff