*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
* @return $index FALSE means not found, >=0 means found on a specific index
*/
private function getVariableIndex ($var, $stack = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// First everything is not found
$found = false;
// If the stack is null, use the current group
- if (is_null($stack)) $stack = $this->currGroup;
+ if (is_null($stack)) {
+ // Use current group
+ //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $stack = $this->currGroup;
+ } // END - if
// Is the group there?
if ($this->isVarStackSet($stack)) {
// Now search for it
foreach ($this->getVarStack($stack) as $index => $currEntry) {
- //* DEBUG: */ echo __METHOD__.":currGroup={$stack},idx={$index},currEntry={$currEntry['name']},var={$var}<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',var=' . $var);
// Is the entry found?
if ($currEntry['name'] == $var) {
// Found!
- //* DEBUG: */ echo __METHOD__.":FOUND!<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
$found = $index;
break;
} // END - if
}
/**
- * Checks wether the given variable stack is set
+ * Checks whether the given variable stack is set
*
* @param $stack Variable stack to check
- * @return $isSet Wether the given variable stack is set
+ * @return $isSet Whether the given variable stack is set
*/
protected final function isVarStackSet ($stack) {
// Check it
* @return $content Content of the variable or null if not found
*/
protected function readVariable ($var, $stack = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// First everything is not found
$content = NULL;
// If the stack is null, use the current group
- if (is_null($stack)) $stack = $this->currGroup;
+ if (is_null($stack)) {
+ // Use current group
+ //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $stack = $this->currGroup;
+ } // END - if
// Get variable index
$found = $this->getVariableIndex($var, $stack);
} // END - if
// Return the current position
- //* DEBUG: */ echo __METHOD__.": group=".$stack.",var=".$var.", content[".gettype($content)."]=".$content."<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',var=' . $var . ', content[' . gettype($content) . ']=' . $content);
return $content;
}
/**
* Returns all variables of current group or empty array
*
- * @return $result Wether array of found variables or empty array
+ * @return $result Whether array of found variables or empty array
*/
private function readCurrentGroup () {
// Default is not found
* Settter for variable group
*
* @param $groupName Name of variable group
- * @param $add Wether add this group
+ * @param $add Whether add this group
* @return void
*/
public function setVariableGroup ($groupName, $add = true) {
// Set group name
- //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."<br />\n";
+ //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
$this->currGroup = $groupName;
// Skip group 'general'
* @return void
*/
public function addGroupVariable ($var, $value) {
- //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."<br />\n";
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', var=' . $var . ', value=' . $value);
// Get current variables in group
$currVars = $this->readCurrentGroup();
* @throws NoVariableException If the given variable is not found
*/
private function modifyVariable ($var, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// Get index for variable
$index = $this->getVariableIndex($var);
* @return void
*/
protected function setVariable ($varGroup, $var, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// Get index for variable
$index = $this->getVariableIndex($var);
* @return $varData Variable data array
*/
private function generateVariableArray ($var, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// Generate the temporary array
$varData = array(
'name' => $var,
* @throws EmptyVariableException If the variable name is left empty
*/
public final function assignVariable ($var, $value) {
- // Trim spaces of variable name
- $var = trim($var);
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
// Empty variable found?
if (empty($var)) {
// Was it found?
if ($index === false) {
// Add it to the stack
- //* DEBUG: */ echo "ADD: ".$var."<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $var . '[' . gettype($value) . ']=' . $value);
$this->addVariable($var, $value);
} elseif (!empty($value)) {
// Modify the stack entry
- //* DEBUG: */ echo "MOD: ".$var."<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $var . '[' . gettype($value) . ']=' . $value);
$this->modifyVariable($var, $value);
}
}
*/
protected final function setRawTemplateData ($rawTemplateData) {
// And store it in this class
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($rawTemplateData).' Bytes set.<br />\n';
- //* DEBUG: */ echo $this->currGroup.' variables: '.count($this->getVarStack($this->currGroup)).', groups='.count($this->varStack).'<br />\n';
+ //* 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: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->rawTemplateData).' Bytes read.<br />\n';
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
return $this->rawTemplateData;
}
*/
private final function setCompiledData ($compiledData) {
// And store it in this class
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($compiledData).' Bytes set.<br />\n';
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
$this->compiledData = (string) $compiledData;
}
* @return $compiledData Compiled template data
*/
public final function getCompiledData () {
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.<br />\n';
+ //* 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: */ echo __METHOD__.": FQFN=".$fqfn."<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
// Load the raw template
$rawTemplateData = $ioInstance->loadFileContents($fqfn);
* @param $var The variable we want to assign
*/
private function assignTemplateVariable ($varName, $var) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',var=' . $var);
+
// Is it not a config variable?
if ($varName != 'config') {
// Regular template variables
$rawData = (string) $rawData;
// Search for variables
- @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+ preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+
+ // Debug message
+ //* 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)) {
$backup = $this->getRawTemplateData();
// Initialize some arrays
- if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
+ if (is_null($this->loadedRawData)) {
+ // Initialize both
+ $this->loadedRawData = array();
+ $this->rawTemplates = array();
+ } // END - if
// 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: */ echo __METHOD__.":template={$template}<br />\n";
- if ($this->getVariableIndex($template) !== false) {
+ if ($this->getVariableIndex($template, 'config') !== false) {
// Use that content here
- $this->loadedRawData[$template] = $this->readVariable($template);
+ $this->loadedRawData[$template] = $this->readVariable($template, 'config');
// Recursive protection:
$this->loadedTemplates[] = $template;
- } elseif ($this->getVariableIndex($template, 'config')) {
+ } elseif ($this->getVariableIndex($template) !== false) {
// Use that content here
- $this->loadedRawData[$template] = $this->readVariable($template, 'config');
+ $this->loadedRawData[$template] = $this->readVariable($template);
// Recursive protection:
$this->loadedTemplates[] = $template;
* @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) == '=') {
// @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
// Search for the template
$foundIndex = array_search($template, $templateMatches[1]);
// 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);
+ ///* 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: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')<br />\n';
+ //* 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: */ echo __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: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')<br />\n';
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
// Set the content back
$this->setRawTemplateData($content);
* @return void
*/
public function assignConfigVariable ($var) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// Sweet and simple...
- //* DEBUG: */ echo __METHOD__.':var={$var}<br />\n';
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var));
$this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
}
// 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
// Iterate through all general variables
- foreach ($this->getVarStack('general') as $index=>$currVariable) {
+ foreach ($this->getVarStack('general') as $index => $currVariable) {
// 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');
// Re-assign the variable
+ //* 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
+ //* 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 ...
}
// Is this view helper loaded?
if (!isset($this->helpers[$helperName])) {
// Create a class name
- $className = "{$helperName}ViewHelper";
+ $className = $helperName . 'ViewHelper';
// Generate new instance
$this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
*/
public function compileRawCode ($rawCode, $setMatchAsCode=false) {
// Find the variables
- //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* DEBUG: */ echo __METHOD__.":<pre>".print_r($varMatches, true)."</pre>\n";
+ //* 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: */ echo __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."<br />\n";
- if (($setMatchAsCode === true) && (is_null($value))) {
+ // Debug message
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',value[' . gettype($value) . ']=' . $value);
+
+ // 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: */ echo __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: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
// Get raw template code
$rawData = $this->getRawTemplateData();
}
/**
- * Checks wether language support is enabled
+ * Checks whether language support is enabled
*
- * @return $languageSupport Wether language support is enabled or disabled
+ * @return $languageSupport Whether language support is enabled or disabled
*/
public final function isLanguageSupportEnabled () {
return $this->languageSupport;
}
/**
- * Checks wether XML compacting is enabled
+ * Checks whether XML compacting is enabled
*
- * @return $xmlCompacting Wether XML compacting is enabled or disabled
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
*/
public final function isXmlCompactingEnabled () {
return $this->xmlCompacting;
*/
public function compactContent ($uncompactedContent) {
// First, remove all tab/new-line/revert characters
- $compactedContent = str_replace("\t", '', str_replace("\n", '', str_replace("\r", '', $uncompactedContent)));
+ $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
// Then regex all comments like <!-- //--> away
preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
projects / core.git / blobdiff