X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=6b8145f46c629e939e4f9956b9ffa08d0e5998cf;hp=16e50187151acb5193d61320de96ffb5a85712e6;hb=57bbfb3dec01126b0e4e0b2cdebaca155880cc54;hpb=a8184730773f351650c1e1efc3a3344b119dca20 diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php index 16e50187..6b8145f4 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, 2009 - 2011 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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 @@ -134,12 +134,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Language support is enabled by default */ - private $languageSupport = true; + private $languageSupport = TRUE; /** * XML compacting is disabled by default */ - private $xmlCompacting = false; + private $xmlCompacting = FALSE; // Exception codes for the template engine const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110; @@ -167,30 +167,33 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Search for a variable in the stack * - * @param $var The variable we are looking for - * @param $stack Optional variable stack to look in - * @return $index FALSE means not found, >=0 means found on a specific index + * @param $variableName The variable we are looking for + * @param $variableGroup Optional variable group to look in + * @return $index FALSE means not found, >=0 means found on a specific index */ - private function getVariableIndex ($var, $stack = NULL) { + private function getVariableIndex ($variableName, $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($stack)) { + // If the stack is NULL, use the current group + if (is_null($variableGroup)) { // Use current group - //* DEBUG: */ print __METHOD__.' currGroup=' . $this->currGroup . ' set as stack!
' . chr(10); - $stack = $this->currGroup; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + $variableGroup = $this->currGroup; } // END - if // Is the group there? - if ($this->isVarStackSet($stack)) { + if ($this->isVarStackSet($variableGroup)) { // Now search for it - foreach ($this->getVarStack($stack) as $index => $currEntry) { - //* DEBUG: */ print __METHOD__.":currGroup={$stack},idx={$index},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: */ print __METHOD__.":FOUND!
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!'); $found = $index; break; } // END - if @@ -202,85 +205,88 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } /** - * Checks whether the given variable stack is set + * Checks whether the given variable group is set * - * @param $stack Variable stack to check - * @return $isSet Whether the given variable stack is set + * @param $variableGroup Variable group to check + * @return $isSet Whether the given variable group is set */ - protected final function isVarStackSet ($stack) { + protected final function isVarStackSet ($variableGroup) { // Check it - $isSet = isset($this->varStack[$stack]); + $isSet = isset($this->varStack[$variableGroup]); // Return result return $isSet; } /** - * Getter for given variable stack + * Getter for given variable group * - * @param $stack Variable stack to check - * @return $varStack Found variable stack + * @param $variableGroup Variable group to check + * @return $varStack Found variable group */ - public final function getVarStack ($stack) { - return $this->varStack[$stack]; + public final function getVarStack ($variableGroup) { + return $this->varStack[$variableGroup]; } /** - * Setter for given variable stack + * Setter for given variable group * - * @param $stack Variable stack to check - * @param $varStack Variable stack to check + * @param $variableGroup Variable group to check + * @param $varStack Variable stack to check * @return void */ - protected final function setVarStack ($stack, array $varStack) { - $this->varStack[$stack] = $varStack; + 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 - * @param $stack Optional variable stack to look in - * @return $content Content of the variable or null if not found + * @param $variableName The variable we are looking for + * @param $variableGroup Optional variable group to look in + * @return $content Content of the variable or null if not found */ - public function readVariable ($var, $stack = NULL) { + 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; - // If the stack is null, use the current group - if (is_null($stack)) { + // If the stack is NULL, use the current group + if (is_null($variableGroup)) { // Use current group - //* DEBUG: */ print __METHOD__.' currGroup=' . $this->currGroup . ' set as stack!
' . chr(10); - $stack = $this->currGroup; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + $variableGroup = $this->currGroup; } // END - if // Get variable index - $found = $this->getVariableIndex($var, $stack); + $found = $this->getVariableIndex($variableName, $variableGroup); // Is the variable found? - if ($found !== false) { + if ($found !== FALSE) { // Read it - $content = $this->getVariableValue($stack, $found); + $content = $this->getVariableValue($variableGroup, $found); } // END - if // Return the current position - //* DEBUG: */ print __METHOD__.': group='.$stack.',var='.$var.', content['.gettype($content).']='.$content.'
' . chr(10); + //* 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); } /** @@ -309,13 +315,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $add Whether add this group * @return void */ - public function setVariableGroup ($groupName, $add = true) { + public function setVariableGroup ($groupName, $add = TRUE) { // Set group name - //* DEBIG: */ print __METHOD__.": currGroup=".$groupName."
\n"; + //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName); $this->currGroup = $groupName; // Skip group 'general' - if (($groupName != 'general') && ($add === true)) { + if (($groupName != 'general') && ($add === TRUE)) { $this->varGroups[$groupName] = 'OK'; } // END - if } @@ -324,18 +330,22 @@ 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: */ print __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[] = $this->generateVariableArray($var, $value); + array_push($currVars, $this->generateVariableArray($variableName, $value)); // Add it to the stack $this->setVarStack($this->currGroup, $currVars); @@ -356,19 +366,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Modify an entry on the stack * - * @param $var The variable we are looking for - * @param $value The value we want to store in the variable + * @param $variableName The variable we are looking for + * @param $value The value we want to store in the variable * @return void * @throws NoVariableException If the given variable is not found */ - private function modifyVariable ($var, $value) { + private function modifyVariable ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Get index for variable - $index = $this->getVariableIndex($var); + $index = $this->getVariableIndex($variableName); // Is the variable set? - if ($index === false) { + if ($index === FALSE) { // Unset variables cannot be modified - throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING); + throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING); } // END - if // Then modify it @@ -392,19 +405,28 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * variable is already set. If so, the variable got modified, otherwise * added. * - * @param $varGroup Variable group to use - * @param $var Variable to set - * @param $value Value to set + * @param $varGroup Variable group to use + * @param $variableName Variable to set + * @param $value Value to set * @return void */ - protected function setVariable ($varGroup, $var, $value) { + protected function setVariable ($varGroup, $variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Get index for variable - $index = $this->getVariableIndex($var); + $index = $this->getVariableIndex($variableName); // Is the variable set? - if ($index === false) { + if ($index === FALSE) { + // Is the stack there? + if (!isset($this->varStack[$varGroup])) { + // Then initialize it here + $this->varStack[$varGroup] = array(); + } // END - if + // Not found, add it - $this->varStack[$varGroup][] = $this->generateVariableArray($var, $value); + array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value)); } else { // Then modify it $this->setVariableValue($this->currGroup, $index, $value); @@ -415,14 +437,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * "Generates" (better returns) an array for all variables for given * variable/value pay. * - * @param $var Variable to set - * @param $value Value to set - * @return $varData Variable data array + * @param $variableName Variable to set + * @param $value Value to set + * @return $varData Variable data array */ - private function generateVariableArray ($var, $value) { + private function generateVariableArray ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Generate the temporary array $varData = array( - 'name' => $var, + 'name' => $variableName, 'value' => $value ); @@ -561,68 +586,77 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Assign (add) a given variable with a value * - * @param $var The variable we are looking for - * @param $value The value we want to store in the variable + * @param $variableName The variable we are looking for + * @param $value The value we want to store in the variable * @return void * @throws EmptyVariableException If the variable name is left empty */ - public final function assignVariable ($var, $value) { - // Trim spaces of variable name - $var = trim($var); + public final function assignVariable ($variableName, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); // Empty variable found? - if (empty($var)) { + if (empty($variableName)) { // Throw an exception - throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); + throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); } // END - if // First search for the variable if it was already added - $index = $this->getVariableIndex($var); + $index = $this->getVariableIndex($variableName); // Was it found? - if ($index === false) { + if ($index === FALSE) { // Add it to the stack - //* DEBUG: */ echo "ADD: ".$var."
\n"; - $this->addVariable($var, $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value); + $this->addVariable($variableName, $value); } elseif (!empty($value)) { // Modify the stack entry - //* DEBUG: */ echo "MOD: ".$var."
\n"; - $this->modifyVariable($var, $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value); + $this->modifyVariable($variableName, $value); } } /** * Removes a given variable * - * @param $var The variable we are looking for + * @param $variableName The variable we are looking for + * @param $variableGroup Name of variable group (default: 'general') * @return void */ - public final function removeVariable ($var) { + public final function removeVariable ($variableName, $variableGroup = 'general') { // First search for the variable if it was already added - $index = $this->getVariableIndex($var); + $index = $this->getVariableIndex($variableName, $variableGroup); // Was it found? - if ($index !== false) { + if ($index !== FALSE) { // Remove this variable - $this->unsetVariableStackOffset($index); + //* 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 stack + * Unsets the given offset in the variable group * - * @param $index Index to unset + * @param $index Index to unset + * @param $variableGroup Variable group (default: currGroup) * @return void */ - protected final function unsetVariableStackOffset ($index) { + 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 + // Is the entry there? - if (!isset($this->varStack[$this->currGroup][$index])) { + if (!isset($this->varStack[$variableGroup][$index])) { // Abort here, we need fixing! $this->debugInstance(); } // END - if // Remove it - unset($this->varStack[$this->currGroup][$index]); + unset($this->varStack[$variableGroup][$index]); } /** @@ -633,8 +667,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ protected final function setRawTemplateData ($rawTemplateData) { // And store it in this class - //* DEBUG: */ print __METHOD__.': '.strlen($rawTemplateData).' Bytes set.' . chr(10); - //* DEBUG: */ print $this->currGroup.' variables: '.count($this->getVarStack($this->currGroup)).', groups='.count($this->varStack).'' . chr(10); + //* DEBUG: */ 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; } @@ -644,7 +678,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $rawTemplateData The raw data from the template */ public final function getRawTemplateData () { - //* DEBUG: */ print __METHOD__.': '.strlen($this->rawTemplateData).' Bytes read.' . chr(10); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.'); return $this->rawTemplateData; } @@ -655,7 +689,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private final function setCompiledData ($compiledData) { // And store it in this class - //* DEBUG: */ print __METHOD__.': '.strlen($compiledData).' Bytes set.' . chr(10); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.'); $this->compiledData = (string) $compiledData; } @@ -665,7 +699,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $compiledData Compiled template data */ public final function getCompiledData () { - //* DEBUG: */ print __METHOD__.': '.strlen($this->compiledData).' Bytes read.' . chr(10); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.'); return $this->compiledData; } @@ -690,7 +724,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // 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(), @@ -701,7 +735,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { ); } 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(), @@ -742,7 +776,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $ioInstance = $this->getFileIoInstance(); // Some debug code to look on the file which is being loaded - //* DEBUG: */ print __METHOD__.": FQFN=".$fqfn."
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn); // Load the raw template $rawTemplateData = $ioInstance->loadFileContents($fqfn); @@ -758,18 +792,25 @@ 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 $varName The variable's name (shall be content or config) + * by default + * @param $variableName The variable we want to assign + * @return void */ private function assignTemplateVariable ($varName, $var) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName); + // Is it not a config variable? if ($varName != 'config') { // Regular template variables - $this->assignVariable($var, ''); + $this->assignVariable($variableName, ''); } else { // Configuration variables - $this->assignConfigVariable($var); + $this->assignConfigVariable($variableName); } } @@ -784,7 +825,10 @@ 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(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE)); // Did we find some variables? if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) { @@ -829,25 +873,25 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // 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(__METHOD__ . ':template=' . $template); // Template not found, but maybe variable assigned? - //* DEBUG: */ print __METHOD__.":template={$template}
\n"; - if ($this->getVariableIndex($template, 'config') !== false) { + 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) { + array_push($this->loadedTemplates, $template); + } elseif ($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 { @@ -857,10 +901,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Remember this template for recursion detection // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; + array_push($this->loadedTemplates, $template); } catch (FileIoException $e) { // Even this is not done... :/ - $this->rawTemplates[] = $template; + array_push($this->rawTemplates, $template); } } } // END - if @@ -885,7 +929,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: // @@ -920,7 +964,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(); @@ -956,7 +1000,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Remember this template for recursion detection // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; + array_push($this->loadedTemplates, $template); } catch (FileIoException $e) { // This template was never found. We silently ignore it unset($this->rawTemplates[$key]); @@ -973,8 +1017,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @todo Unfinished work or don't die here. */ private function assignAllVariables (array $varMatches) { + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches)); + // Search for all variables foreach ($varMatches[1] as $key => $var) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Debug message + self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var); // Detect leading equals if (substr($varMatches[2][$key], 0, 1) == '=') { @@ -983,15 +1035,14 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // Do we have some quotes left and right side? Then it is free text - if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) { + if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) { // Free string detected! Which we can assign directly $this->assignVariable($var, $varMatches[3][$key]); } elseif (!empty($varMatches[2][$key])) { // @TODO Non-string found so we need some deeper analysis... - ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!'); + ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!'); } - - } // for ($varMatches ... + } // END - foreach } /** @@ -1001,15 +1052,20 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ private function compileRawTemplateData (array $templateMatches) { + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData)); + // Are some code-templates found which we need to compile? if (count($this->loadedRawData) > 0) { - // Then compile all! foreach ($this->loadedRawData as $template => $code) { + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':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!'); continue; } // END - if @@ -1017,24 +1073,21 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE)); // Assign all variables $this->assignAllVariables($varMatches); - } // END - if (isset($templateMatches ... // Compile the loaded template $this->compileCode($code, $template); - } // END - foreach ($this->loadedRawData ... // Insert all templates $this->insertAllTemplates($templateMatches); - } // END - if (count($this->loadedRawData) ... } @@ -1059,7 +1112,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ print __METHOD__.': content before='.strlen($content).' ('.md5($content).')' . chr(10); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')'); // Do we have the stack? if (!$this->isVarStackSet('general')) { @@ -1070,7 +1123,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Walk through all variables foreach ($this->getVarStack('general') as $currEntry) { - //* DEBUG: */ print __METHOD__.': name='.$currEntry['name'].', value=
'.htmlentities($currEntry['value']).'
\n'; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=
' . htmlentities($currEntry['value']) . '
'); // Replace all [$var] or {?$var?} with the content // @TODO Old behaviour, will become obsolete! $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content); @@ -1082,7 +1135,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content); } // END - for - //* DEBUG: */ print __METHOD__.': content after='.strlen($content).' ('.md5($content).')' . chr(10); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')'); // Set the content back $this->setRawTemplateData($content); @@ -1106,13 +1159,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Assign a given congfiguration variable with a value * - * @param $var The configuration variable we want to assign + * @param $variableName The configuration variable we want to assign * @return void */ - public function assignConfigVariable ($var) { + public function assignConfigVariable ($variableName) { + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim($this->convertDashesToUnderscores($variableName)); + // Sweet and simple... - //* DEBUG: */ print __METHOD__.': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var) . chr(10); - $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var)); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName)); + $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName)); } /** @@ -1132,7 +1188,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Compiles configuration place-holders in all variables. This 'walks' - * through the variable stack 'general'. It interprets all values from that + * through the variable group 'general'. It interprets all values from that * variables as configuration entries after compiling them. * * @return void @@ -1141,21 +1197,30 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Do we have the stack? if (!$this->isVarStackSet('general')) { // Abort here silently - // @TODO This silent abort should be logged, maybe. + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': 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); + $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE); + + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value); // Remove it from stack - $this->removeVariable($index, 'general'); + $this->removeVariable($currVariable['name'], 'general'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); - // Re-assign the variable - //* DEBUG: */ print __METHOD__.': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index . chr(10); - $this->assignConfigVariable($value); + // 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->setVariable('config', $currVariable['name'], $value); + } } // END - foreach } @@ -1173,19 +1238,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Iterate through all general variables foreach ($this->getVarStack('general') as $currVariable) { // Transfer it's name/value combination to the $content array - //* DEBUG: */ echo $currVariable['name'].'=
'.htmlentities($currVariable['value']).'
\n'; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $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 ($this->isVarStackSet('config')) { - $config = $this->getVarStack('config'); - } // END - if - // Remove some variables unset($index); unset($currVariable); @@ -1197,12 +1256,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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, $this->codeBegin) !== false) { + while (strpos($eval, $this->codeBegin) !== FALSE) { // Get left part before "codeBegin)); @@ -1217,14 +1276,14 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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 ) @@ -1236,7 +1295,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Goes something wrong? 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(); @@ -1285,6 +1344,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(__METHOD__ . ':templateMatches=' . print_r($templateMatches , TRUE)); + // Analyze the matches array if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) { // Entries are found: @@ -1300,15 +1362,12 @@ 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(''); - } // END - if - } // END - if($templateMatches ... } @@ -1391,26 +1450,33 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $setMatchAsCode Sets $match if readVariable() returns empty result * @return $rawCode Compile code with inserted variable value */ - public function compileRawCode ($rawCode, $setMatchAsCode=false) { + public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) { // Find the variables - //* DEBUG: */ print __METHOD__.":rawCode=
".htmlentities($rawCode)."
\n"; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); preg_match_all($this->regExpVarValue, $rawCode, $varMatches); // Compile all variables - //* DEBUG: */ print __METHOD__.":
".print_r($varMatches, true)."
\n"; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':
' . print_r($varMatches, TRUE) . '
'); foreach ($varMatches[0] as $match) { // Add variable tags around it $varCode = '{?' . $match . '?}'; + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode); + // Is the variable found in code? (safes some calls) - if (strpos($rawCode, $varCode) !== false) { - // Replace the variable with it's value, if found - $value = $this->readVariable($match); - //* DEBUG: */ print __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."
\n"; - if (($setMatchAsCode === true) && (is_null($value))) { + if (strpos($rawCode, $varCode) !== FALSE) { + // Debug message + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode); + + // Use $match as new value or $value from read variable? + if ($setMatchAsCode === TRUE) { // Insert match $rawCode = str_replace($varCode, $match, $rawCode); } else { + // Read the variable + $value = $this->readVariable($match); + // Insert value $rawCode = str_replace($varCode, $value, $rawCode); } @@ -1418,7 +1484,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - foreach // Return the compiled data - //* DEBUG: */ print __METHOD__.":rawCode=
".htmlentities($rawCode)."
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); return $rawCode; } @@ -1439,7 +1505,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function renameVariable ($oldName, $newName) { - //* DEBUG: */ print __METHOD__.": oldName={$oldName}, newName={$newName}
\n"; + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName); // Get raw template code $rawData = $this->getRawTemplateData(); @@ -1483,7 +1549,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $languageSupport New language support setting * @return void */ - public final function enableLanguageSupport ($languageSupport = true) { + public final function enableLanguageSupport ($languageSupport = TRUE) { $this->languageSupport = (bool) $languageSupport; } @@ -1502,7 +1568,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $xmlCompacting New XML compacting setting * @return void */ - public final function enableXmlCompacting ($xmlCompacting = true) { + public final function enableXmlCompacting ($xmlCompacting = TRUE) { $this->xmlCompacting = (bool) $xmlCompacting; }