X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=68511ad143380df67820e706012fa5178d4a1edf;hp=207d53eb4f5ce1d1c8bb8a2070156e042f5deed2;hb=b1683de32141e80fb17d5ff1a6f460186e22d961;hpb=81d28b14f65e35ece6524eee9ae0b74d6c6117d8 diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php index 207d53eb..68511ad1 100644 --- a/inc/classes/main/template/class_BaseTemplateEngine.php +++ b/inc/classes/main/template/class_BaseTemplateEngine.php @@ -2,11 +2,11 @@ /** * A generic template engine * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @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 @@ -27,42 +27,47 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * templates are stored. We will internally determine the language plus * "html" for web templates or "emails" for email templates */ - private $basePath = ""; + private $templateBasePath = ''; /** * Template type */ - private $templateType = "html"; + private $templateType = 'html'; /** * The extension for web and email templates (not compiled templates) */ - private $templateExtension = ".tpl"; + private $templateExtension = '.tpl'; /** * The extension for code templates (not compiled templates) */ - private $codeExtension = ".ctp"; + private $codeExtension = '.ctp'; /** - * Path relative to $basePath and language code for compiled code-templates + * Path relative to $templateBasePath and language code for compiled code-templates */ - private $compileOutputPath = "templates/_compiled"; + private $compileOutputPath = 'templates/_compiled/'; + + /** + * The path name for all templates + */ + private $genericBasePath = 'templates/'; /** * The raw (maybe uncompiled) template */ - private $rawTemplateData = ""; + private $rawTemplateData = ''; /** * Template data with compiled-in variables */ - private $compiledData = ""; + private $compiledData = ''; /** * The last loaded template's FQFN for debugging the engine */ - private $lastTemplate = ""; + private $lastTemplate = ''; /** * The variable stack for the templates @@ -82,12 +87,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * 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 @@ -101,6 +106,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/'; + /** + * A regular expression to find template comments like + */ + private $regExpComments = '//'; + /** * Loaded helpers */ @@ -114,12 +124,33 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * All template groups except "general" */ - private $varGroups = array(); + private $variableGroups = array(); + + /** + * Code begin + */ + private $codeBegin = ''; + + /** + * 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 @@ -131,31 +162,44 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // 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 $variableName The variable we are looking for + * @param $variableGroup Optional variable group to look in + * @return $index FALSE means not found, >=0 means found on a specific index */ - private function isVariableAlreadySet ($var) { + private function getVariableIndex ($variableName, $variableGroup = NULL) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // First everything is not found - $found = false; + $found = FALSE; + + // If the stack is NULL, use the current group + if (is_null($variableGroup)) { + // Use current group + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + $variableGroup = $this->currGroup; + } // END - if // Is the group there? - if (isset($this->varStack[$this->currGroup])) { + if ($this->isVarStackSet($variableGroup)) { // 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}
\n"; + foreach ($this->getVarStack($variableGroup) as $index => $currEntry) { + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName); // Is the entry found? - if ($currEntry['name'] == $var) { + if ($currEntry['name'] == $variableName) { // Found! - //* DEBUG: */ echo __METHOD__.":FOUND!
\n"; - $found = $idx; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!'); + $found = $index; break; } // END - if } // END - foreach @@ -165,59 +209,104 @@ class BaseTemplateEngine extends BaseFrameworkSystem { return $found; } + /** + * Checks whether the given variable group is set + * + * @param $variableGroup Variable group to check + * @return $isSet Whether the given variable group is set + */ + protected final function isVarStackSet ($variableGroup) { + // Check it + $isSet = isset($this->varStack[$variableGroup]); + + // Return result + return $isSet; + } + + /** + * Getter for given variable group + * + * @param $variableGroup Variable group to check + * @return $varStack Found variable group + */ + public final function getVarStack ($variableGroup) { + return $this->varStack[$variableGroup]; + } + + /** + * Setter for given variable group + * + * @param $variableGroup Variable group to check + * @param $varStack Variable stack to check + * @return void + */ + protected final function setVarStack ($variableGroup, array $varStack) { + $this->varStack[$variableGroup] = $varStack; + } + /** * Return a content of a variable or null if not found * - * @param $var The variable we are looking for - * @return $content Content of the variable or null if not found + * @param $variableName The variable we are looking for + * @param $variableGroup Optional variable group to look in + * @return $content Content of the variable or null if not found */ - protected function readVariable ($var) { + protected function readVariable ($variableName, $variableGroup = NULL) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // First everything is not found - $content = null; + $content = NULL; + + // 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!'); + $variableGroup = $this->currGroup; + } // END - if // Get variable index - $found = $this->isVariableAlreadySet($var); + $found = $this->getVariableIndex($variableName, $variableGroup); // Is the variable found? - if ($found !== false) { + if ($found !== FALSE) { // Read it - $found = $this->varStack[$this->currGroup][$found]['value']; + $content = $this->getVariableValue($variableGroup, $found); } // END - if - //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."
\n"; - // Return the current position - return $found; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content); + return $content; } /** * Add a variable to the stack * - * @param $var The variable we are looking for - * @param $value The value we want to store in the variable + * @param $variableName Name of variable to add + * @param $value Value we want to store in the variable * @return void */ - private function addVariable ($var, $value) { + private function addVariable ($variableName, $value) { // Set general variable group $this->setVariableGroup('general'); // Add it to the stack - $this->addGroupVariable($var, $value); + $this->addGroupVariable($variableName, $value); } /** * 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 @@ -228,17 +317,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * 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) { + public function setVariableGroup ($groupName, $add = TRUE) { // Set group name - //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."
\n"; + //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName); $this->currGroup = $groupName; // Skip group 'general' - if (($groupName != 'general') && ($add === true)) { - $this->varGroups[$groupName] = 'OK'; + if (($groupName != 'general') && ($add === TRUE)) { + $this->variableGroups[$groupName] = 'OK'; } // END - if } @@ -246,55 +335,151 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Adds a variable to current group * - * @param $var Variable to set - * @param $value Value to store in variable + * @param $variableName Variable to set + * @param $value Value to store in variable * @return void */ - public function addGroupVariable ($var, $value) { - //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."
\n"; + public function addGroupVariable ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value); // Get current variables in group $currVars = $this->readCurrentGroup(); // Append our variable - $currVars[] = array( - 'name' => $var, - 'value' => $value - ); + array_push($currVars, $this->generateVariableArray($variableName, $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 $variableGroup Variable group to use + * @param $index Index in variable array + * @return $value Value to set + */ + private function getVariableValue ($variableGroup, $index) { + // Return it + return $this->varStack[$variableGroup][$index]['value']; } /** * Modify an entry on the stack * - * @param $var The variable we are looking for - * @param $value The value we want to store in the variable + * @param $variableName The variable we are looking for + * @param $value The value we want to store in the variable * @return void + * @throws NoVariableException If the given variable is not found */ - private function modifyVariable ($var, $value) { + private function modifyVariable ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Get index for variable - $idx = $this->isVariableAlreadySet($var); + $index = $this->getVariableIndex($variableName); // 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, $variableName, $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 $variableGroup Variable group to use + * @param $index Index in variable array + * @param $value Value to set + * @return void + */ + private function setVariableValue ($variableGroup, $index, $value) { + $this->varStack[$variableGroup][$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 $variableGroup Variable group to use + * @param $variableName Variable to set + * @param $value Value to set + * @return void + */ + protected function setVariable ($variableGroup, $variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + + // Get index for variable + $index = $this->getVariableIndex($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 + array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value)); + } else { + // Then modify it + $this->setVariableValue($this->currGroup, $index, $value); + } } /** - * Setter for template type. Only "html", "emails" and "compiled" should + * "Generates" (better returns) an array for all variables for given + * variable/value pay. + * + * @param $variableName Variable to set + * @param $value Value to set + * @return $varData Variable data array + */ + private function generateVariableArray ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + + // Generate the temporary array + $varData = array( + 'name' => $variableName, + 'value' => $value + ); + + // And return it + return $varData; + } + + /** + * Setter for template type. Only 'html', 'emails' and 'compiled' should * be sent here * * @param $templateType The current template's type * @return void */ - private final function setTemplateType ($templateType) { + protected final function setTemplateType ($templateType) { $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 * @@ -317,22 +502,32 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Setter for base path * - * @param $basePath The local base path for all templates + * @param $templateBasePath The relative base path for all templates * @return void */ - public final function setBasePath ($basePath) { + protected final function setTemplateBasePath ($templateBasePath) { // And set it - $this->basePath = (string) $basePath; + $this->templateBasePath = (string) $templateBasePath; } /** * Getter for base path * - * @return $basePath The local base path for all templates + * @return $templateBasePath The relative base path for all templates + */ + public final function getTemplateBasePath () { + // And set it + return $this->templateBasePath; + } + + /** + * Getter for generic base path + * + * @return $templateBasePath The relative base path for all templates */ - public final function getBasePath () { + public final function getGenericBasePath () { // And set it - return $this->basePath; + return $this->genericBasePath; } /** @@ -342,7 +537,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * templates * @return void */ - public final function setRawTemplateExtension ($templateExtension) { + protected final function setRawTemplateExtension ($templateExtension) { // And set it $this->templateExtension = (string) $templateExtension; } @@ -354,7 +549,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * templates * @return void */ - public final function setCodeTemplateExtension ($codeExtension) { + protected final function setCodeTemplateExtension ($codeExtension) { // And set it $this->codeExtension = (string) $codeExtension; } @@ -388,68 +583,33 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * 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 + * Unsets the given offset in the variable group * - * @param $var The variable we are looking for - * @param $value The value we want to store in the variable + * @param $index Index to unset + * @param $variableGroup Variable group (default: currGroup) * @return void - * @throws EmptyVariableException If the variable name is left empty */ - public final function assignVariable ($var, $value) { - // Trim spaces of variable name - $var = trim($var); - - // Empty variable found? - if (empty($var)) { - // Throw an exception - throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); + protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) { + // Is the variable group not set? + if (is_null($variableGroup)) { + // Then set it to current + $variableGroup = $this->currGroup; } // END - if - // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); - - // Was it found? - if ($idx === false) { - // Add it to the stack - //* DEBUG: */ echo "ADD: ".$var."
\n"; - $this->addVariable($var, $value); - } elseif (!empty($value)) { - // Modify the stack entry - //* DEBUG: */ echo "MOD: ".$var."
\n"; - $this->modifyVariable($var, $value); - } - } - - /** - * Removes a given variable - * - * @param $var The variable we are looking for - * @return void - */ - public final function removeVariable ($var) { - // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); + // Is the entry there? + if (!isset($this->varStack[$variableGroup][$index])) { + // Abort here, we need fixing! + $this->debugInstance(); + } // END - if - // Was it found? - if ($idx !== false) { - // Remove this variable - $this->varStack->offsetUnset($idx); - } + // Remove it + unset($this->varStack[$variableGroup][$index]); } /** @@ -460,8 +620,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ protected final function setRawTemplateData ($rawTemplateData) { // And store it in this class - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($rawTemplateData)." Bytes set.
\n"; - //* DEBUG: */ echo $this->currGroup." variables: ".count($this->varStack[$this->currGroup]).", groups=".count($this->varStack)."
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack)); $this->rawTemplateData = (string) $rawTemplateData; } @@ -471,7 +631,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $rawTemplateData The raw data from the template */ public final function getRawTemplateData () { - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->rawTemplateData)." Bytes read.
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.'); return $this->rawTemplateData; } @@ -482,17 +642,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private final function setCompiledData ($compiledData) { // And store it in this class - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($compiledData)." Bytes set.
\n"; + //* 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: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->compiledData)." Bytes read.
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.'); return $this->compiledData; } @@ -500,29 +660,62 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Private loader for all template types * * @param $template The template we shall load + * @param $extOther An other extension to use * @return void + * @throws FileIoException If the template was not found */ - private function loadTemplate ($template) { - // Get extension for the template - $ext = $this->getRawTemplateExtension(); + protected function loadTemplate ($template, $extOther = '') { + // Get extension for the template if empty + if (empty($extOther)) { + // None provided, so get the raw one + $ext = $this->getRawTemplateExtension(); + } else { + // Then use it! + $ext = (string) $extOther; + } - // If we shall load a code-template we need to switch the file extension - if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) { - // Switch over to the code-template extension - $ext = $this->getCodeTemplateExtension(); - } // END - if + // 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 + ); + } - // Construct the FQFN for the template by honoring the current language - $fqfn = sprintf("%s%s/%s/%s%s", - $this->getBasePath(), - $this->getLanguageInstance()->getLanguageCode(), - $this->getTemplateType(), - (string) $template, - $ext - ); + // First try this + try { + // Load the raw template data + $this->loadRawTemplateData($fqfn); + } catch (FileNotFoundException $e) { + // If we shall load a code-template we need to switch the file extension + 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(); + + // Try it again... + $this->loadTemplate($template, $ext); + } else { + // Throw it again + throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_FOUND); + } + } - // Load the raw template data - $this->loadRawTemplateData($fqfn); } /** @@ -532,14 +725,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @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: */ echo __METHOD__.": FQFN=".$fqfn."
\n"; + //* 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); @@ -552,15 +742,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Try to assign an extracted template variable as a "content" or 'config' * variable. * - * @param $varName The variable's name (shall be content orconfig) by - * default - * @param $var The variable we want to assign + * @param $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)); + + // Debug message + //* 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($var, ""); + $this->assignVariable($variableName, ''); } else { // Configuration variables $this->assignConfigVariable($var); @@ -578,19 +775,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $rawData = (string) $rawData; // Search for variables - @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches); + preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches); + + // Debug message + //* 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 @@ -606,38 +806,36 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Structure of $templateMatches: *--------------------------------- * [0] => Array - An array with all full matches - * [1] => Array - An array with left part (before the ":") of a match - * [2] => Array - An array with right part of a match including ":" - * [3] => Array - An array with right part of a match excluding ":" + * [1] => Array - An array with left part (before the ':') of a match + * [2] => Array - An array with right part of a match including ':' + * [3] => Array - An array with right part of a match excluding ':' */ private function analyzeTemplate (array $templateMatches) { // Backup raw template data $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: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template); // Template not found, but maybe variable assigned? - //* DEBUG: */ echo __METHOD__.":template={$template}
\n"; - if ($this->isVariableAlreadySet($template) !== false) { + if ($this->getVariableIndex($template) !== FALSE) { // Use that content here $this->loadedRawData[$template] = $this->readVariable($template); // Recursive protection: - $this->loadedTemplates[] = $template; - } elseif (isset($this->varStack['config'][$template])) { - // Use that content here - $this->loadedRawData[$template] = $this->varStack['config'][$template]; - - // Recursive protection: - $this->loadedTemplates[] = $template; + array_push($this->loadedTemplates, $template); } else { // Then try to search for code-templates try { @@ -647,13 +845,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Remember this template for recursion detection // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; + array_push($this->loadedTemplates, $template); } catch (FileNotFoundException $e) { // Even this is not done... :/ - $this->rawTemplates[] = $template; - } catch (FilePointerNotOpenedException $e) { - // Even this is not done... :/ - $this->rawTemplates[] = $template; + array_push($this->rawTemplates, $template); } } } // END - if @@ -678,7 +873,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // Remember this template being compiled - $this->compiledTemplates[] = $template; + array_push($this->compiledTemplates, $template); // Compile the loaded code in five steps: // @@ -713,7 +908,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $foundIndex = array_search($template, $templateMatches[1]); // Lookup the matching template replacement - if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) { + if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) { // Get the current raw template $rawData = $this->getRawTemplateData(); @@ -739,7 +934,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { 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(); @@ -749,13 +944,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Remember this template for recursion detection // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; + array_push($this->loadedTemplates, $template); } catch (FileNotFoundException $e) { // This template was never found. We silently ignore it unset($this->rawTemplates[$key]); - } catch (FilePointerNotOpenedException $e) { - // This template was never found. We silently ignore it - unset($this->rawTemplates[$key]); } } // END - foreach } // END - if @@ -769,67 +961,77 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @todo Unfinished work or don't die here. */ private function assignAllVariables (array $varMatches) { + // Debug message + //* 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)); + + // Debug message + self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var); // Detect leading equals - if (substr($varMatches[2][$key], 0, 1) == "=") { + if (substr($varMatches[2][$key], 0, 1) == '=') { // Remove and cast it $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1); - } + } // END - if // Do we have some quotes left and right side? Then it is free text - if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) { + if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) { // Free string detected! Which we can assign directly $this->assignVariable($var, $varMatches[3][$key]); } elseif (!empty($varMatches[2][$key])) { - // Non-string found so we need some deeper analysis... - die("Deeper analysis not yet implemented!"); + // @TODO Non-string found so we need some deeper analysis... + ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!'); } - - } // for ($varMatches ... + } // END - foreach } + /** * Compiles all loaded raw templates * - * @param $templateMatches See method analyzeTemplate() for details + * @param $templateMatches See method analyzeTemplate() for details * @return void */ private function compileRawTemplateData (array $templateMatches) { + // Debug message + //* 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('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('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: 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]))) { - + 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('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: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) ... } @@ -854,85 +1056,241 @@ class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ echo __METHOD__.": content before=".strlen($content)." (".md5($content).")
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: 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=
".htmlentities($currEntry['value'])."
\n"; + foreach ($this->getVarStack('general') as $currEntry) { + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currEntry['name'] . ', value=
' . htmlentities($currEntry['value']) . '
'); // Replace all [$var] or {?$var?} with the content - // Old behaviour, will become obsolete! - $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content); + // @TODO Old behaviour, will become obsolete! + $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content); - // Yet another old way - $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content); + // @TODO Yet another old way + $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).")
\n"; + //* 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 + * 'html' by default * @return void */ - public function loadWebTemplate ($template) { + public function loadHtmlTemplate ($template) { // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('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($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('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 * - * @param $var The configuration variable we want to assign + * @param $variableName The configuration variable we want to assign * @return void */ - public function assignConfigVariable ($var) { + public function assignConfigVariable ($variableName) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Sweet and simple... - //* DEBUG: */ echo __METHOD__.":var={$var}
\n"; - $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName)); + $this->assignVariable($variableName, $this->getConfigInstance()->getConfigEntry($variableName)); } /** - * Load a specified email template into the engine + * 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 $template The email template we shall load which is located in - * "emails" by default + * @param $variables An array with variables to be assigned * @return void */ - public function loadEmailTemplate ($template) { - // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type')); + 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 + } - // Load the special template - $this->loadTemplate($template); + /** + * 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); } /** * Load a specified code template into the engine * * @param $template The code template we shall load which is - * located in "code" by default + * located in 'code' by default * @return void */ public function loadCodeTemplate ($template) { // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type')); + $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_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); } + /** + * Compiles configuration place-holders in all variables. This 'walks' + * through the variable group 'general'. It interprets all values from that + * variables as configuration entries after compiling them. + * + * @return void + */ + public final function compileConfigInVariables () { + // Do we have the stack? + if (!$this->isVarStackSet('general')) { + // Abort here silently + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!'); + return; + } // END - if + + // 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: */ 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('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); + + // Is it a configuration key? + if ($this->getConfigInstance()->isConfigurationEntrySet($value)) { + // The value itself is a configuration entry + $this->assignConfigVariable($value); + } else { + // Re-assign the value directly + $this->assignVariable($currVariable['name'], $value); + } + } // END - foreach + } + /** * Compile all variables by inserting their respective values * @@ -941,74 +1299,70 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ 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']."=
".htmlentities($currVariable['value'])."
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=
' . htmlentities($currVariable['value']).'
'); $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 twice to get content from helper classes in + // Run the compilation three times to get content from helper classes in $cnt = 0; while ($cnt < 3) { // Finalize the compilation of template variables $this->finalizeVariableCompilation(); // Prepare the eval() command for comiling the template - $eval = sprintf("\$result = \"%s\";", + $eval = sprintf('$result = "%s";', addslashes($this->getRawTemplateData()) ); // This loop does remove the backslashes (\) in PHP parameters - while (strpos($eval, "codeBegin) !== FALSE) { // Get left part before "codeBegin)); // Get all from right of "codeBegin) + 5)); // Cut middle part out and remove escapes - $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>"))); + $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd))); $evalMiddle = stripslashes($evalMiddle); // Remove the middle part from right one - $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2)); + $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 + '%>', + "\n\$result .= \"", + $eval ) ); // Run the constructed command. This will "compile" all variables in - @eval($eval); + eval($eval); // Goes something wrong? - if (!isset($result)) { + if ((!isset($result)) || (empty($result))) { // Output eval command - $this->debugOutput(sprintf("Failed eval() code: 
%s
", $this->markupCode($eval, true)), true); + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('Failed eval() code: 
%s
', $this->markupCode($eval, TRUE)), TRUE); // Output backtrace here $this->debugBackTrace(); @@ -1036,17 +1390,20 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * 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. $rawData = $this->getRawTemplateData(); // Remove double spaces and trim leading/trailing spaces - $rawData = trim(str_replace(" ", " ", $rawData)); + $rawData = trim(str_replace(' ', ' ', $rawData)); // Search for raw variables $this->extractVariablesFromRawData($rawData); @@ -1054,6 +1411,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Search for code-tags which are {? ?} preg_match_all($this->regExpCodeTags, $rawData, $templateMatches); + // Debug message + //* 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)) { // Entries are found: @@ -1069,102 +1429,35 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // 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(""); - + $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 %s detected.", - $this->__toString(), - __FUNCTION__, - $this->getTemplateType() - ); - - // Write the problem to the world... - $this->debugOutput($msg); - break; - } - } - /** * Loads a given view helper (by name) * * @param $helperName The helper's name * @return void - * @throws ViewHelperNotFoundException If the given view helper was not found */ 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"; - - // Does this class exists? - if (!class_exists($className)) { - // Abort here! - throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER); - } // END - if + $className = $this->convertToClassName($helperName) . 'ViewHelper'; // Generate new instance - $eval = sprintf("\$this->helpers[%s] = %s::create%s();", - $helperName, - $className, - $className - ); - - // Run the code - eval($eval); + $this->helpers[$helperName] = ObjectFactory::createObjectByName($className); } // END - if // Return the requested instance 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 * @@ -1176,62 +1469,58 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $responseInstance->writeToBody($this->getCompiledData()); } - /** - * Assigns all the application data with template variables - * - * @param $appInstance A manageable application instance - * @return void - */ - public function assignApplicationData (ManageableApplication $appInstance) { - // Get long name and assign it - $this->assignVariable('app_full_name' , $appInstance->getAppName()); - - // Get short name and assign it - $this->assignVariable('app_short_name', $appInstance->getAppShortName()); - - // Get version number and assign it - $this->assignVariable('app_version' , $appInstance->getAppVersion()); - - // Assign extra application-depending data - $appInstance->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=
".htmlentities($rawCode)."
\n"; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=
' . htmlentities($rawCode) . '
'); preg_match_all($this->regExpVarValue, $rawCode, $varMatches); // Compile all variables - //* DEBUG: */ echo "
".print_r($varMatches, true)."
"; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:
' . print_r($varMatches, TRUE) . '
'); foreach ($varMatches[0] as $match) { // Add variable tags around it - $varCode = "{?".$match."?}"; + $varCode = '{?' . $match . '?}'; + + // Debug message + //* 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) { - // Replace the variable with it's value, if found - //* DEBUG: */ echo __METHOD__.": match=".$match."
\n"; - $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode); + if (strpos($rawCode, $varCode) !== FALSE) { + // Debug message + //* 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) { + // 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: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=
' . htmlentities($rawCode) . '
'); 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; } /** @@ -1242,7 +1531,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function renameVariable ($oldName, $newName) { - //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName); // Get raw template code $rawData = $this->getRawTemplateData(); @@ -1260,38 +1549,91 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @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 - $content = recode("html..utf8", $content); + // Get a XmlParser instance + $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this)); + + // 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)); + } // END - if + + // Parse the XML document + $parserInstance->parseXmlContent($content); + } - // Get an XML parser - $xmlParser = xml_parser_create(); + /** + * 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("
".htmlentities($content)."
"); - 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($this->regExpComments, $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; } }