*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 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
*
/**
* Loaded raw template data
*/
- private $loadedRawData = null;
+ private $loadedRawData = NULL;
/**
* Raw templates which are linked in code templates
*/
- private $rawTemplates = null;
+ private $rawTemplates = NULL;
/**
* A regular expression for variable=value pairs
*/
private $codeEnd = '?>';
+ /**
+ * Language support is enabled by default
+ */
+ private $languageSupport = true;
+
+ /**
+ * XML compacting is disabled by default
+ */
+ private $xmlCompacting = false;
+
// Exception codes for the template engine
const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
+ const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
/**
* Protected constructor
// Call parent constructor
parent::__construct($className);
- // Clean up a little
- $this->removeNumberFormaters();
- $this->removeSystemArray();
+ // Init file I/O instance
+ $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
+
+ // Set it
+ $this->setFileIoInstance($ioInstance);
}
/**
* Search for a variable in the stack
*
* @param $var The variable we are looking for
- * @return $idx FALSE means not found, >=0 means found on a specific index
+ * @param $stack Optional variable stack to look in
+ * @return $index FALSE means not found, >=0 means found on a specific index
*/
- private function isVariableAlreadySet ($var) {
+ 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)) {
+ // Use current group
+ //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $stack = $this->currGroup;
+ } // END - if
+
// Is the group there?
- if (isset($this->varStack[$this->currGroup])) {
+ if ($this->isVarStackSet($stack)) {
// Now search for it
- foreach ($this->varStack[$this->currGroup] as $idx => $currEntry) {
- //* DEBUG: */ echo __METHOD__.":currGroup={$this->currGroup},idx={$idx},currEntry={$currEntry['name']},var={$var}<br />\n";
+ foreach ($this->getVarStack($stack) as $index => $currEntry) {
+ //* 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";
- $found = $idx;
+ //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
+ $found = $index;
break;
} // END - if
} // END - foreach
return $found;
}
+ /**
+ * Checks whether the given variable stack is set
+ *
+ * @param $stack Variable stack to check
+ * @return $isSet Whether the given variable stack is set
+ */
+ protected final function isVarStackSet ($stack) {
+ // Check it
+ $isSet = isset($this->varStack[$stack]);
+
+ // Return result
+ return $isSet;
+ }
+
+ /**
+ * Getter for given variable stack
+ *
+ * @param $stack Variable stack to check
+ * @return $varStack Found variable stack
+ */
+ public final function getVarStack ($stack) {
+ return $this->varStack[$stack];
+ }
+
+ /**
+ * Setter for given variable stack
+ *
+ * @param $stack Variable stack to check
+ * @param $varStack Variable stack to check
+ * @return void
+ */
+ protected final function setVarStack ($stack, array $varStack) {
+ $this->varStack[$stack] = $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
*/
- protected function readVariable ($var) {
+ 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;
+ $content = NULL;
+
+ // If the stack is null, use the current group
+ 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->isVariableAlreadySet($var);
+ $found = $this->getVariableIndex($var, $stack);
// Is the variable found?
if ($found !== false) {
// Read it
- $found = $this->varStack[$this->currGroup][$found]['value'];
+ $content = $this->getVariableValue($stack, $found);
} // END - if
- //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."<br />\n";
-
// Return the current position
- return $found;
+ //* 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
$result = array();
// Is the group there?
- if (isset($this->varStack[$this->currGroup])) {
+ if ($this->isVarStackSet($this->currGroup)) {
// Then use it
- $result = $this->varStack[$this->currGroup];
+ $result = $this->getVarStack($this->currGroup);
} // END - if
// Return result
* Settter for variable group
*
* @param $groupName Name of variable group
- * @param $add Wether add this group
- * @retur4n void
+ * @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();
// Append our variable
- $currVars[] = array(
- 'name' => $var,
- 'value' => $value
- );
+ $currVars[] = $this->generateVariableArray($var, $value);
// Add it to the stack
- $this->varStack[$this->currGroup] = $currVars;
+ $this->setVarStack($this->currGroup, $currVars);
+ }
+
+ /**
+ * Getter for variable value, throws a NoVariableException if the variable is not found
+ *
+ * @param $varGroup Variable group to use
+ * @param $index Index in variable array
+ * @return $value Value to set
+ */
+ private function getVariableValue ($varGroup, $index) {
+ // Return it
+ return $this->varStack[$varGroup][$index]['value'];
}
/**
* @param $var 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) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
// Get index for variable
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($var);
// Is the variable set?
- if ($idx !== false) {
- // Then modify it
- $this->varStack[$this->currGroup][$idx]['value'] = $value;
+ if ($index === false) {
+ // Unset variables cannot be modified
+ throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
} // END - if
+
+ // Then modify it
+ $this->setVariableValue($this->currGroup, $index, $value);
+ }
+
+ /**
+ * Sets a variable value for given variable group and index
+ *
+ * @param $varGroup Variable group to use
+ * @param $index Index in variable array
+ * @param $value Value to set
+ * @return void
+ */
+ private function setVariableValue ($varGroup, $index, $value) {
+ $this->varStack[$varGroup][$index]['value'] = $value;
+ }
+
+ /**
+ * Sets a variable within given group. This method does detect if the
+ * 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
+ * @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);
+
+ // Is the variable set?
+ if ($index === false) {
+ // Not found, add it
+ $this->varStack[$varGroup][] = $this->generateVariableArray($var, $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
+ */
+ 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,
+ 'value' => $value
+ );
+
+ // And return it
+ return $varData;
}
/**
* @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)) {
} // END - if
// First search for the variable if it was already added
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($var);
// Was it found?
- if ($idx === false) {
+ 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);
}
}
*/
public final function removeVariable ($var) {
// First search for the variable if it was already added
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($var);
// Was it found?
- if ($idx !== false) {
+ if ($index !== false) {
// Remove this variable
- $this->varStack->offsetUnset($idx);
- }
+ $this->unsetVariableStackOffset($index);
+ } // END - if
+ }
+
+ /**
+ * Unsets the given offset in the variable stack
+ *
+ * @param $index Index to unset
+ * @return void
+ */
+ protected final function unsetVariableStackOffset ($index) {
+ // Is the entry there?
+ if (!isset($this->varStack[$this->currGroup][$index])) {
+ // Abort here, we need fixing!
+ $this->debugInstance();
+ } // END - if
+
+ // Remove it
+ unset($this->varStack[$this->currGroup][$index]);
}
/**
*/
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->varStack[$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;
}
* Private loader for all template types
*
* @param $template The template we shall load
+ * @param $extOther An other extension to use
* @return void
- * @throws FileNotFoundException If the template was not found
+ * @throws FileIoException If the template was not found
*/
- protected function loadTemplate ($template, $ext = '') {
+ protected function loadTemplate ($template, $extOther = '') {
// Get extension for the template if empty
- if (empty($ext)) {
+ if (empty($extOther)) {
// None provided, so get the raw one
$ext = $this->getRawTemplateExtension();
- } // END - if
+ } else {
+ // Then use it!
+ $ext = (string) $extOther;
+ }
- // Construct the FQFN for the template by honoring the current language
- $fqfn = sprintf("%s%s%s%s/%s/%s%s",
- $this->getConfigInstance()->readConfig('base_path'),
- $this->getTemplateBasePath(),
- $this->getGenericBasePath(),
- $this->getLanguageInstance()->getLanguageCode(),
- $this->getTemplateType(),
- (string) $template,
- $ext
- );
+ // Is language support enabled?
+ if ($this->isLanguageSupportEnabled()) {
+ // Construct the FQFN for the template by honoring the current language
+ $fqfn = sprintf("%s%s%s%s/%s/%s%s",
+ $this->getConfigInstance()->getConfigEntry('base_path'),
+ $this->getTemplateBasePath(),
+ $this->getGenericBasePath(),
+ $this->getLanguageInstance()->getLanguageCode(),
+ $this->getTemplateType(),
+ (string) $template,
+ $ext
+ );
+ } else {
+ // Construct the FQFN for the template without language
+ $fqfn = sprintf("%s%s%s%s/%s%s",
+ $this->getConfigInstance()->getConfigEntry('base_path'),
+ $this->getTemplateBasePath(),
+ $this->getGenericBasePath(),
+ $this->getTemplateType(),
+ (string) $template,
+ $ext
+ );
+ }
// First try this
try {
// Load the raw template data
$this->loadRawTemplateData($fqfn);
- } catch (FileNotFoundException $e) {
+ } catch (FileIoException $e) {
// If we shall load a code-template we need to switch the file extension
- if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('web_template_type')) {
+ if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
// Switch over to the code-template extension and try it again
$ext = $this->getCodeTemplateExtension();
$this->loadTemplate($template, $ext);
} else {
// Throw it again
- throw new FileNotFoundException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
+ throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
}
}
$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
+ //* 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)) {
$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->isVariableAlreadySet($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 (isset($this->varStack['config'][$template])) {
+ } elseif ($this->getVariableIndex($template) !== false) {
// Use that content here
- $this->loadedRawData[$template] = $this->varStack['config'][$template];
+ $this->loadedRawData[$template] = $this->readVariable($template);
// Recursive protection:
$this->loadedTemplates[] = $template;
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
$this->loadedTemplates[] = $template;
- } catch (FileNotFoundException $e) {
- // Even this is not done... :/
- $this->rawTemplates[] = $template;
- } catch (FilePointerNotOpenedException $e) {
+ } catch (FileIoException $e) {
// Even this is not done... :/
$this->rawTemplates[] = $template;
}
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
$this->loadedTemplates[] = $template;
- } catch (FileNotFoundException $e) {
- // This template was never found. We silently ignore it
- unset($this->rawTemplates[$key]);
- } catch (FilePointerNotOpenedException $e) {
+ } catch (FileIoException $e) {
// This template was never found. We silently ignore it
unset($this->rawTemplates[$key]);
}
* @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
}
+
/**
* Compiles all loaded raw templates
*
* @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);
+ //* 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: */ 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')) {
+ // Abort here silently
+ // @TODO This silent abort should be logged, maybe.
+ return;
+ } // END - if
// Walk through all variables
- foreach ($this->varStack['general'] as $currEntry) {
- //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=<pre>'.htmlentities($currEntry['value']).'</pre>\n';
+ foreach ($this->getVarStack('general') as $currEntry) {
+ //* 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('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
// @TODO Yet another old way
- $content = str_replace('['.$currEntry['name'].']', $currEntry['value'], $content);
+ $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
// The new behaviour
- $content = str_replace('{?'.$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);
*/
public function loadWebTemplate ($template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
// Load the special template
$this->loadTemplate($template);
* @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';
- $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var);
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var));
+ $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
}
/**
- * Load a specified email template into the engine
+ * Load a specified code template into the engine
*
- * @param $template The email template we shall load which is located in
- * 'emails' by default
+ * @param $template The code template we shall load which is
+ * located in 'code' by default
* @return void
*/
- public function loadEmailTemplate ($template) {
+ public function loadCodeTemplate ($template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
// Load the special template
$this->loadTemplate($template);
}
/**
- * Load a specified code template into the engine
+ * Compiles configuration place-holders in all variables. This 'walks'
+ * through the variable stack 'general'. It interprets all values from that
+ * variables as configuration entries after compiling them.
*
- * @param $template The code template we shall load which is
- * located in 'code' by default
* @return void
*/
- public function loadCodeTemplate ($template) {
- // Set template type
- $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
+ public final function compileConfigInVariables () {
+ // Do we have the stack?
+ if (!$this->isVarStackSet('general')) {
+ // Abort here silently
+ //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
+ return;
+ } // END - if
- // Load the special template
- $this->loadTemplate($template);
+ // Iterate through all general variables
+ 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
}
/**
*/
public final function compileVariables () {
// Initialize the $content array
- $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
+ $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
$dummy = array();
// Iterate through all general variables
- foreach ($this->varStack['general'] as $currVariable) {
+ 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 (isset($this->varStack['config'])) {
- $config = $this->varStack['config'];
- } // END - if
-
// Remove some variables
- unset($idx);
+ unset($index);
unset($currVariable);
// Run the compilation three times to get content from helper classes in
);
// Run the constructed command. This will "compile" all variables in
- @eval($eval);
+ eval($eval);
// Goes something wrong?
if ((!isset($result)) || (empty($result))) {
* count has been found
*/
public function compileTemplate () {
+ // Get code type to make things shorter
+ $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
+
// We will only work with template type "code" from configuration
- if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
+ if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
// Abort here
- throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
+ throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
} // END - if
// Get the raw data.
// 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 ...
}
- /**
- * A old deprecated method
- *
- * @return void
- * @deprecated
- * @see BaseTemplateEngine::transferToResponse
- */
- public function output () {
- // Check which type of template we have
- switch ($this->getTemplateType()) {
- case 'html': // Raw HTML templates can be send to the output buffer
- // Quick-N-Dirty:
- $this->getWebOutputInstance()->output($this->getCompiledData());
- break;
-
- default: // Unknown type found
- // Construct message
- $msg = sprintf("[%s->%s] Unknown/unsupported template type <span class=\"data\">%s</span> detected.",
- $this->__toString(),
- __FUNCTION__,
- $this->getTemplateType()
- );
-
- // Write the problem to the world...
- $this->debugOutput($msg);
- break;
- } // END - switch
- }
-
/**
* Loads a given view helper (by name)
*
// 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);
/**
* Assigns all the application data with template variables
*
- * @param $appInstance A manageable application instance
+ * @param $applicationInstance A manageable application instance
* @return void
*/
- public function assignApplicationData (ManageableApplication $appInstance) {
+ public function assignApplicationData (ManageableApplication $applicationInstance) {
// Get long name and assign it
- $this->assignVariable('app_full_name' , $appInstance->getAppName());
+ $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
// Get short name and assign it
- $this->assignVariable('app_short_name', $appInstance->getAppShortName());
+ $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
// Get version number and assign it
- $this->assignVariable('app_version' , $appInstance->getAppVersion());
+ $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
// Assign extra application-depending data
- $appInstance->assignExtraTemplateData($this);
+ $applicationInstance->assignExtraTemplateData($this);
}
/**
* "Compiles" a variable by replacing {?var?} with it's content
*
- * @param $rawCode Raw code to compile
+ * @param $rawCode Raw code to compile
+ * @param $setMatchAsCode Sets $match if readVariable() returns empty result
* @return $rawCode Compile code with inserted variable value
*/
- public function compileRawCode ($rawCode) {
+ public function compileRawCode ($rawCode, $setMatchAsCode=false) {
// Find the variables
- //* DEBUG: */ echo "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: */ echo "<pre>".print_r($varMatches, true)."</pre>";
+ //* 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
- //* DEBUG: */ echo __METHOD__.": match=".$match."<br />\n";
- $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode);
+ // 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 - if
} // END - foreach
// Return the compiled data
+ //* 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();
* @return void
* @throws XmlParserException If an XML error was found
*/
- public final function renderXmlContent ($content = null) {
+ public function renderXmlContent ($content = NULL) {
// Is the content set?
if (is_null($content)) {
// Get current content
$content = $this->getRawTemplateData();
} // END - if
- // Convert all to UTF8
- if (function_exists('recode')) {
- $content = recode("html..utf8", $content);
- } else {
- // @TODO We need to find a fallback solution here
+ // Get a XmlParser instance
+ $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
+
+ // Check if we have XML compacting enabled
+ if ($this->isXmlCompactingEnabled()) {
+ // Yes, so get a decorator class for transparent compacting
+ $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
} // END - if
- // Get an XML parser
- $xmlParser = xml_parser_create();
+ // Parse the XML document
+ $parserInstance->parseXmlContent($content);
+ }
+
+ /**
+ * Enables or disables language support
+ *
+ * @param $languageSupport New language support setting
+ * @return void
+ */
+ public final function enableLanguageSupport ($languageSupport = true) {
+ $this->languageSupport = (bool) $languageSupport;
+ }
- // Force case-folding to on
- xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true);
+ /**
+ * Checks whether language support is enabled
+ *
+ * @return $languageSupport Whether language support is enabled or disabled
+ */
+ public final function isLanguageSupportEnabled () {
+ return $this->languageSupport;
+ }
- // Set object
- xml_set_object($xmlParser, $this);
+ /**
+ * Enables or disables XML compacting
+ *
+ * @param $xmlCompacting New XML compacting setting
+ * @return void
+ */
+ public final function enableXmlCompacting ($xmlCompacting = true) {
+ $this->xmlCompacting = (bool) $xmlCompacting;
+ }
- // Set handler call-backs
- xml_set_element_handler($xmlParser, 'startElement', 'endElement');
- xml_set_character_data_handler($xmlParser, 'characterHandler');
+ /**
+ * Checks whether XML compacting is enabled
+ *
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
+ */
+ public final function isXmlCompactingEnabled () {
+ return $this->xmlCompacting;
+ }
- // Now parse the XML tree
- if (!xml_parse($xmlParser, $content)) {
- // Error found in XML!
- //die('<pre>'.htmlentities($content).'</pre>');
- throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR);
+ /**
+ * Removes all commentd, tabs and new-line characters to compact the content
+ *
+ * @param $uncompactedContent The uncompacted content
+ * @return $compactedContent The compacted content
+ */
+ public function compactContent ($uncompactedContent) {
+ // First, remove all tab/new-line/revert characters
+ $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);
+
+ // Do we have entries?
+ if (isset($matches[0][0])) {
+ // Remove all
+ foreach ($matches[0] as $match) {
+ // Remove the match
+ $compactedContent = str_replace($match, '', $compactedContent);
+ } // END - foreach
} // END - if
- // Free the parser
- xml_parser_free($xmlParser);
+ // Set the content again
+ $this->setRawTemplateData($compactedContent);
+
+ // Return compacted content
+ return $compactedContent;
}
}
projects / core.git / blobdiff