/**
* A generic template engine
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
+ /**
+ * A regular expression to find template comments like <!-- Comment here //-->
+ */
+ private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
+
/**
* Loaded helpers
*/
/**
* All template groups except "general"
*/
- private $varGroups = array();
+ private $variableGroups = array();
/**
* Code begin
*/
private function getVariableIndex ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// First everything is not found
$found = FALSE;
- // If the stack is null, use the current group
+ // If the stack is NULL, use the current group
if (is_null($variableGroup)) {
// Use current group
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
*/
protected function readVariable ($variableName, $variableGroup = NULL) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// First everything is not found
$content = NULL;
- // If the stack is null, use the current group
+ // If the stack is NULL, use the current group
if (is_null($variableGroup)) {
// Use current group
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
// Skip group 'general'
if (($groupName != 'general') && ($add === TRUE)) {
- $this->varGroups[$groupName] = 'OK';
+ $this->variableGroups[$groupName] = 'OK';
} // END - if
}
*/
public function addGroupVariable ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Debug message
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
$currVars = $this->readCurrentGroup();
// Append our variable
- $currVars[] = $this->generateVariableArray($variableName, $value);
+ array_push($currVars, $this->generateVariableArray($variableName, $value));
// Add it to the stack
$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 $variableGroup Variable group to use
* @param $index Index in variable array
* @return $value Value to set
*/
- private function getVariableValue ($varGroup, $index) {
+ private function getVariableValue ($variableGroup, $index) {
// Return it
- return $this->varStack[$varGroup][$index]['value'];
+ return $this->varStack[$variableGroup][$index]['value'];
}
/**
*/
private function modifyVariable ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Get index for variable
$index = $this->getVariableIndex($variableName);
/**
* Sets a variable value for given variable group and index
*
- * @param $varGroup Variable group to use
+ * @param $variableGroup 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;
+ private function setVariableValue ($variableGroup, $index, $value) {
+ $this->varStack[$variableGroup][$index]['value'] = $value;
}
/**
* variable is already set. If so, the variable got modified, otherwise
* added.
*
- * @param $varGroup Variable group to use
+ * @param $variableGroup Variable group to use
* @param $variableName Variable to set
* @param $value Value to set
* @return void
*/
- protected function setVariable ($varGroup, $variableName, $value) {
+ protected function setVariable ($variableGroup, $variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Get index for variable
$index = $this->getVariableIndex($variableName);
// Is the variable set?
if ($index === FALSE) {
+ // Is the stack there?
+ if (!isset($this->varStack[$variableGroup])) {
+ // Then initialize it here
+ $this->varStack[$variableGroup] = array();
+ } // END - if
+
// Not found, add it
- $this->varStack[$varGroup][] = $this->generateVariableArray($variableName, $value);
+ array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value));
} else {
// Then modify it
$this->setVariableValue($this->currGroup, $index, $value);
*/
private function generateVariableArray ($variableName, $value) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Generate the temporary array
$varData = array(
$this->templateType = (string) $templateType;
}
+ /**
+ * Getter for template type
+ *
+ * @return $templateType The current template's type
+ */
+ public final function getTemplateType () {
+ return $this->templateType;
+ }
+
/**
* Setter for the last loaded template's FQFN
*
* @param $templateBasePath The relative base path for all templates
* @return void
*/
- public final function setTemplateBasePath ($templateBasePath) {
+ protected final function setTemplateBasePath ($templateBasePath) {
// And set it
$this->templateBasePath = (string) $templateBasePath;
}
* templates
* @return void
*/
- public final function setRawTemplateExtension ($templateExtension) {
+ protected final function setRawTemplateExtension ($templateExtension) {
// And set it
$this->templateExtension = (string) $templateExtension;
}
* templates
* @return void
*/
- public final function setCodeTemplateExtension ($codeExtension) {
+ protected final function setCodeTemplateExtension ($codeExtension) {
// And set it
$this->codeExtension = (string) $codeExtension;
}
* templates
* @return void
*/
- public final function setCompileOutputPath ($compileOutputPath) {
+ protected final function setCompileOutputPath ($compileOutputPath) {
// And set it
$this->compileOutputPath = (string) $compileOutputPath;
}
- /**
- * Getter for template type
- *
- * @return $templateType The current template's type
- */
- public final function getTemplateType () {
- return $this->templateType;
- }
-
- /**
- * Assign (add) a given variable with a value
- *
- * @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 ($variableName, $value) {
- // Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
-
- // Empty variable found?
- if (empty($variableName)) {
- // Throw an exception
- 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($variableName);
-
- // Was it found?
- if ($index === FALSE) {
- // Add it to the stack
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
- $this->addVariable($variableName, $value);
- } elseif (!empty($value)) {
- // Modify the stack entry
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
- $this->modifyVariable($variableName, $value);
- }
- }
-
- /**
- * Removes a given variable
- *
- * @param $variableName The variable we are looking for
- * @param $variableGroup Name of variable group (default: 'general')
- * @return void
- */
- public final function removeVariable ($variableName, $variableGroup = 'general') {
- // First search for the variable if it was already added
- $index = $this->getVariableIndex($variableName, $variableGroup);
-
- // Was it found?
- if ($index !== FALSE) {
- // Remove this variable
- //* 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 group
*
* @return $rawTemplateData The raw data from the template
*/
public final function getRawTemplateData () {
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.');
return $this->rawTemplateData;
}
*/
private final function setCompiledData ($compiledData) {
// And store it in this class
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($compiledData) . ' Bytes set.');
$this->compiledData = (string) $compiledData;
}
/**
- * Getter for compiled templates
+ * Getter for compiled templates, must be public for e.g. Mailer classes.
*
* @return $compiledData Compiled template data
*/
public final function getCompiledData () {
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.');
return $this->compiledData;
}
* @param $template The template we shall load
* @param $extOther An other extension to use
* @return void
- * @throws FileIoException If the template was not found
+ * @throws FileNotFoundException If the template was not found
*/
protected function loadTemplate ($template, $extOther = '') {
// Get extension for the template if empty
// 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",
+ $fqfn = sprintf('%s%s%s%s/%s/%s%s',
$this->getConfigInstance()->getConfigEntry('base_path'),
$this->getTemplateBasePath(),
$this->getGenericBasePath(),
);
} else {
// Construct the FQFN for the template without language
- $fqfn = sprintf("%s%s%s%s/%s%s",
+ $fqfn = sprintf('%s%s%s%s/%s%s',
$this->getConfigInstance()->getConfigEntry('base_path'),
$this->getTemplateBasePath(),
$this->getGenericBasePath(),
try {
// Load the raw template data
$this->loadRawTemplateData($fqfn);
- } catch (FileIoException $e) {
+ } catch (FileNotFoundException $e) {
// If we shall load a code-template we need to switch the file extension
- if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
+ if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('html_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 FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
+ throw new FileNotFoundException($fqfn, self::EXCEPTION_FILE_NOT_FOUND);
}
}
* @return void
*/
private function loadRawTemplateData ($fqfn) {
- // Get a input/output instance from the middleware
- $ioInstance = $this->getFileIoInstance();
-
// Some debug code to look on the file which is being loaded
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: FQFN=' . $fqfn);
// Load the raw template
- $rawTemplateData = $ioInstance->loadFileContents($fqfn);
+ $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fqfn);
// Store the template's contents into this class
$this->setRawTemplateData($rawTemplateData);
* Try to assign an extracted template variable as a "content" or 'config'
* variable.
*
- * @param $varName The variable's name (shall be content or config)
+ * @param $variableName 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) {
+ private function assignTemplateVariable ($variableName, $var) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',variableName=' . $variableName);
// Is it not a config variable?
- if ($varName != 'config') {
+ if ($variableName != 'config') {
// Regular template variables
$this->assignVariable($variableName, '');
} else {
// Configuration variables
- $this->assignConfigVariable($variableName);
+ $this->assignConfigVariable($var);
}
}
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('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: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)) {
// Initialize all missing variables
foreach ($variableMatches[3] as $key => $var) {
// Variable name
- $varName = $variableMatches[1][$key];
+ $variableName = $variableMatches[1][$key];
// Workarround: Do not assign empty variables
if (!empty($var)) {
// Try to assign it, empty strings are being ignored
- $this->assignTemplateVariable($varName, $var);
+ $this->assignTemplateVariable($variableName, $var);
} // END - if
} // END - foreach
} // END - if
// RECURSIVE PROTECTION! BE CAREFUL HERE!
if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template);
// Template not found, but maybe variable assigned?
- 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) {
+ if ($this->getVariableIndex($template) !== FALSE) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template);
// Recursive protection:
- $this->loadedTemplates[] = $template;
+ array_push($this->loadedTemplates, $template);
} else {
// Then try to search for code-templates
try {
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
- $this->loadedTemplates[] = $template;
- } catch (FileIoException $e) {
+ array_push($this->loadedTemplates, $template);
+ } catch (FileNotFoundException $e) {
// Even this is not done... :/
- $this->rawTemplates[] = $template;
+ array_push($this->rawTemplates, $template);
}
}
} // END - if
} // END - if
// Remember this template being compiled
- $this->compiledTemplates[] = $template;
+ array_push($this->compiledTemplates, $template);
// Compile the loaded code in five steps:
//
foreach ($this->rawTemplates as $key => $template) {
try {
// Load the template
- $this->loadWebTemplate($template);
+ $this->loadHtmlTemplate($template);
// Remember it's contents
$this->rawTemplates[$template] = $this->getRawTemplateData();
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
- $this->loadedTemplates[] = $template;
- } catch (FileIoException $e) {
+ array_push($this->loadedTemplates, $template);
+ } catch (FileNotFoundException $e) {
// This template was never found. We silently ignore it
unset($this->rawTemplates[$key]);
}
*/
private function assignAllVariables (array $varMatches) {
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: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));
+ $var = trim(self::convertDashesToUnderscores($var));
// Debug message
- self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
+ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var);
// Detect leading equals
if (substr($varMatches[2][$key], 0, 1) == '=') {
*/
private function compileRawTemplateData (array $templateMatches) {
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template . ',code(' . strlen($code) . ')=' . $code);
// Is this template already compiled?
if (in_array($template, $this->compiledTemplates)) {
// Then skip it
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Template ' . $template . ' already compiled. SKIPPED!');
continue;
} // END - if
if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
// Split it up with another reg. exp. into variable=value pairs
preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE));
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches=' . print_r($varMatches, TRUE));
// Assign all variables
$this->assignAllVariables($varMatches);
private function finalizeVariableCompilation () {
// Get the content
$content = $this->getRawTemplateData();
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: 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: */ self::createDebugInstance(__CLASS__)->debugOutput(
__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
'BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: 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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content after=' . strlen($content) . ' (' . md5($content) . ')');
// Set the content back
$this->setRawTemplateData($content);
}
/**
- * Load a specified web template into the engine
+ * Load a specified HTML template into the engine
*
* @param $template The web template we shall load which is located in
* 'html' by default
* @return void
*/
- public function loadWebTemplate ($template) {
+ public function loadHtmlTemplate ($template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('html_template_type'));
// Load the special template
$this->loadTemplate($template);
}
+ /**
+ * Assign (add) a given variable with a value
+ *
+ * @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 ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
+
+ // Empty variable found?
+ if (empty($variableName)) {
+ // Throw an exception
+ 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($variableName);
+
+ // Was it found?
+ if ($index === FALSE) {
+ // Add it to the stack
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->addVariable($variableName, $value);
+ } elseif (!empty($value)) {
+ // Modify the stack entry
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->modifyVariable($variableName, $value);
+ }
+ }
+
+ /**
+ * Removes a given variable
+ *
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Name of variable group (default: 'general')
+ * @return void
+ */
+ public final function removeVariable ($variableName, $variableGroup = 'general') {
+ // First search for the variable if it was already added
+ $index = $this->getVariableIndex($variableName, $variableGroup);
+
+ // Was it found?
+ if ($index !== FALSE) {
+ // Remove this variable
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
+ $this->unsetVariableStackOffset($index, $variableGroup);
+ } // END - if
+ }
+
+ /**
+ * Assigns the last loaded raw template content with a given variable
+ *
+ * @param $templateName Name of the template we want to assign
+ * @param $variableName Name of the variable we want to assign
+ * @return void
+ */
+ public function assignTemplateWithVariable ($templateName, $variableName) {
+ // Get the content from last loaded raw template
+ $content = $this->getRawTemplateData();
+
+ // Assign the variable
+ $this->assignVariable($variableName, $content);
+
+ // Purge raw content
+ $this->setRawTemplateData('');
+ }
+
/**
* Assign a given congfiguration variable with a value
*
*/
public function assignConfigVariable ($variableName) {
// Replace all dashes to underscores to match variables with configuration entries
- $variableName = trim($this->convertDashesToUnderscores($variableName));
+ $variableName = trim(self::convertDashesToUnderscores($variableName));
// Sweet and simple...
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
- $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
+ $this->assignVariable($variableName, $this->getConfigInstance()->getConfigEntry($variableName));
+ }
+
+ /**
+ * Assigns a lot variables into the stack of currently loaded template.
+ * This method should only be used in very rare circumstances, e.g. when
+ * you have to copy a whole set of variables into the template engine.
+ * Before you use this method, please make sure you have considered all
+ * other possiblities.
+ *
+ * @param $variables An array with variables to be assigned
+ * @return void
+ */
+ public function assignMultipleVariables (array $variables) {
+ // "Inject" all
+ foreach ($variables as $name => $value) {
+ // Set variable with name for 'config' group
+ $this->assignVariable($name, $value);
+ } // END - foreach
+ }
+
+ /**
+ * Assigns all the application data with template variables
+ *
+ * @param $applicationInstance A manageable application instance
+ * @return void
+ */
+ public function assignApplicationData (ManageableApplication $applicationInstance) {
+ // Get long name and assign it
+ $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
+
+ // Get short name and assign it
+ $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
+
+ // Get version number and assign it
+ $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
+
+ // Assign extra application-depending data
+ $applicationInstance->assignExtraTemplateData($this);
}
/**
*/
public function loadCodeTemplate ($template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_' . self::getResponseTypeFromSystem() . '_template_type'));
+
+ // Load the special template
+ $this->loadTemplate($template);
+ }
+
+ /**
+ * Load a specified email template into the engine
+ *
+ * @param $template The email template we shall load which is
+ * located in 'emails' by default
+ * @return void
+ */
+ public function loadEmailTemplate ($template) {
+ // Set template type
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('email_template_type'));
// Load the special template
$this->loadTemplate($template);
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
// Abort here silently
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!');
return;
} // END - if
$value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currVariable['name'] . ',value=' . $value);
// Remove it from stack
$this->removeVariable($currVariable['name'], 'general');
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
// Is it a configuration key?
if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
$this->assignConfigVariable($value);
} else {
// Re-assign the value directly
- $this->setVariable('config', $currVariable['name'], $value);
+ $this->assignVariable($currVariable['name'], $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: */ self::createDebugInstance(__CLASS__)->debugOutput(
__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
'BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
$dummy[$currVariable['name']] = $currVariable['value'];
}// END - if
$this->finalizeVariableCompilation();
// Prepare the eval() command for comiling the template
- $eval = sprintf("\$result = \"%s\";",
+ $eval = sprintf('$result = "%s";',
addslashes($this->getRawTemplateData())
);
$evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
// And put all together
- $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
+ $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
} // END - while
// Prepare PHP code for eval() command
$eval = str_replace(
- "<%php", "\";",
+ '<%php', '";',
str_replace(
- "%>",
+ '%>',
"\n\$result .= \"",
$eval
)
// 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();
*/
public function compileTemplate () {
// Get code type to make things shorter
- $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
+ $codeType = $this->getConfigInstance()->getConfigEntry('code_' . self::getResponseTypeFromSystem() . '_template_type');
// We will only work with template type "code" from configuration
if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
// Abort here
- throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
+ throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_' . self::getResponseTypeFromSystem() . '_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
} // END - if
// Get the raw data.
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('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:templateMatches=' . print_r($templateMatches , TRUE));
// Analyze the matches array
if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
* @return void
*/
protected function loadViewHelper ($helperName) {
- // Make first character upper case, rest low
- $helperName = $this->convertToClassName($helperName);
-
// Is this view helper loaded?
if (!isset($this->helpers[$helperName])) {
// Create a class name
- $className = $helperName . 'ViewHelper';
+ $className = self::convertToClassName($helperName) . 'ViewHelper';
// Generate new instance
$this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
return $this->helpers[$helperName];
}
- /**
- * Assigns the last loaded raw template content with a given variable
- *
- * @param $templateName Name of the template we want to assign
- * @param $variableName Name of the variable we want to assign
- * @return void
- */
- public function assignTemplateWithVariable ($templateName, $variableName) {
- // Get the content from last loaded raw template
- $content = $this->getRawTemplateData();
-
- // Assign the variable
- $this->assignVariable($variableName, $content);
-
- // Purge raw content
- $this->setRawTemplateData('');
- }
-
/**
* Transfers the content of this template engine to a given response instance
*
$responseInstance->writeToBody($this->getCompiledData());
}
- /**
- * Assigns all the application data with template variables
- *
- * @param $applicationInstance A manageable application instance
- * @return void
- */
- public function assignApplicationData (ManageableApplication $applicationInstance) {
- // Get long name and assign it
- $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
-
- // Get short name and assign it
- $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
-
- // Get version number and assign it
- $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
-
- // Assign extra application-depending data
- $applicationInstance->assignExtraTemplateData($this);
- }
-
/**
* "Compiles" a variable by replacing {?var?} with it's content
*
*/
public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
// Find the variables
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
'BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: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(
'BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:<pre>' . print_r($varMatches, TRUE) . '</pre>');
foreach ($varMatches[0] as $match) {
// Add variable tags around it
$varCode = '{?' . $match . '?}';
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varCode=' . $varCode);
// Is the variable found in code? (safes some calls)
if (strpos($rawCode, $varCode) !== FALSE) {
// Debug message
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
// Use $match as new value or $value from read variable?
if ($setMatchAsCode === TRUE) {
} // END - foreach
// Return the compiled data
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(
'BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
return $rawCode;
}
/**
* Getter for variable group array
*
- * @return $vargroups All variable groups
+ * @return $variableGroups All variable groups
*/
public final function getVariableGroups () {
- return $this->varGroups;
+ return $this->variableGroups;
}
/**
* @return void
*/
public function renameVariable ($oldName, $newName) {
- //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName);
// Get raw template code
$rawData = $this->getRawTemplateData();
// Get a XmlParser instance
$parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
- // Check if we have XML compacting enabled
+ // Check if XML compacting is enabled
if ($this->isXmlCompactingEnabled()) {
// Yes, so get a decorator class for transparent compacting
$parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
$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);
+ preg_match_all($this->regExpComments, $compactedContent, $matches);
// Do we have entries?
if (isset($matches[0][0])) {
projects / core.git / blobdiff