X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=272b9d718ee1db9c99b4659971af8fee6f6afd75;hp=6530ab0776136d165d2163667663278f8608c2c8;hb=48732bab3b2ca49cf44cfa5d7921c4073a41809c;hpb=84e2207412d3c6ea9f940a83b2cdd4503509808a diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php index 6530ab07..272b9d71 100644 --- a/inc/classes/main/template/class_BaseTemplateEngine.php +++ b/inc/classes/main/template/class_BaseTemplateEngine.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -87,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 @@ -145,6 +145,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { 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 @@ -155,6 +156,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { protected function __construct ($className) { // Call parent constructor parent::__construct($className); + + // Init file I/O instance + $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class'); + + // Set it + $this->setFileIoInstance($ioInstance); } /** @@ -162,25 +169,32 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $var The variable we are looking for * @param $stack Optional variable stack to look in - * @return $idx FALSE means not found, >=0 means found on a specific index + * @return $index FALSE means not found, >=0 means found on a specific index */ - private function isVariableAlreadySet ($var, $stack = null) { + private function getVariableIndex ($var, $stack = NULL) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + // First everything is not found $found = false; // If the stack is null, use the current group - if (is_null($stack)) $stack = $this->currGroup; + if (is_null($stack)) { + // Use current group + //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + $stack = $this->currGroup; + } // END - if // Is the group there? if ($this->isVarStackSet($stack)) { // Now search for it - foreach ($this->getVarStack($stack) as $idx => $currEntry) { - //* DEBUG: */ echo __METHOD__.":currGroup={$stack},idx={$idx},currEntry={$currEntry['name']},var={$var}
\n"; + foreach ($this->getVarStack($stack) as $index => $currEntry) { + //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',var=' . $var); // Is the entry found? if ($currEntry['name'] == $var) { // Found! - //* DEBUG: */ echo __METHOD__.":FOUND!
\n"; - $found = $idx; + //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!'); + $found = $index; break; } // END - if } // END - foreach @@ -191,10 +205,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } /** - * Checks wether the given variable stack is set + * Checks whether the given variable stack is set * * @param $stack Variable stack to check - * @return $isSet Wether the given variable stack is set + * @return $isSet Whether the given variable stack is set */ protected final function isVarStackSet ($stack) { // Check it @@ -214,6 +228,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem { return $this->varStack[$stack]; } + /** + * Setter for given variable stack + * + * @param $stack Variable stack to check + * @param $varStack Variable stack to check + * @return void + */ + protected final function setVarStack ($stack, array $varStack) { + $this->varStack[$stack] = $varStack; + } + /** * Return a content of a variable or null if not found * @@ -221,15 +246,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $stack Optional variable stack to look in * @return $content Content of the variable or null if not found */ - protected function readVariable ($var, $stack = null) { + protected function readVariable ($var, $stack = NULL) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + // First everything is not found - $content = null; + $content = NULL; // If the stack is null, use the current group - if (is_null($stack)) $stack = $this->currGroup; + if (is_null($stack)) { + // Use current group + //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + $stack = $this->currGroup; + } // END - if // Get variable index - $found = $this->isVariableAlreadySet($var, $stack); + $found = $this->getVariableIndex($var, $stack); // Is the variable found? if ($found !== false) { @@ -238,7 +270,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // Return the current position - //* DEBUG: */ echo __METHOD__.": group=".$stack.",var=".$var.", content[".gettype($content)."]=".$content."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',var=' . $var . ', content[' . gettype($content) . ']=' . $content); return $content; } @@ -260,7 +292,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * 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 @@ -280,12 +312,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Settter for variable group * * @param $groupName Name of variable group - * @param $add Wether add this group + * @param $add Whether add this group * @return void */ public function setVariableGroup ($groupName, $add = true) { // Set group name - //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."
\n"; + //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName); $this->currGroup = $groupName; // Skip group 'general' @@ -303,37 +335,118 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function addGroupVariable ($var, $value) { - //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."
\n"; + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', var=' . $var . ', value=' . $value); // Get current variables in group $currVars = $this->readCurrentGroup(); // Append our variable - $currVars[] = array( - 'name' => $var, - 'value' => $value - ); + $currVars[] = $this->generateVariableArray($var, $value); // Add it to the stack $this->setVarStack($this->currGroup, $currVars); } + /** + * Getter for variable value, throws a NoVariableException if the variable is not found + * + * @param $varGroup Variable group to use + * @param $index Index in variable array + * @return $value Value to set + */ + private function getVariableValue ($varGroup, $index) { + // Return it + return $this->varStack[$varGroup][$index]['value']; + } + /** * 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 * @return void + * @throws NoVariableException If the given variable is not found */ private function modifyVariable ($var, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + // Get index for variable - $idx = $this->isVariableAlreadySet($var); + $index = $this->getVariableIndex($var); // Is the variable set? - if ($idx !== false) { - // Then modify it - $this->setVariableValue($this->currGroup, $idx, $value); + if ($index === false) { + // Unset variables cannot be modified + throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING); } // END - if + + // Then modify it + $this->setVariableValue($this->currGroup, $index, $value); + } + + /** + * Sets a variable value for given variable group and index + * + * @param $varGroup Variable group to use + * @param $index Index in variable array + * @param $value Value to set + * @return void + */ + private function setVariableValue ($varGroup, $index, $value) { + $this->varStack[$varGroup][$index]['value'] = $value; + } + + /** + * Sets a variable within given group. This method does detect if the + * variable is already set. If so, the variable got modified, otherwise + * added. + * + * @param $varGroup Variable group to use + * @param $var Variable to set + * @param $value Value to set + * @return void + */ + protected function setVariable ($varGroup, $var, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Get index for variable + $index = $this->getVariableIndex($var); + + // Is the variable set? + if ($index === false) { + // Not found, add it + $this->varStack[$varGroup][] = $this->generateVariableArray($var, $value); + } else { + // Then modify it + $this->setVariableValue($this->currGroup, $index, $value); + } + } + + /** + * "Generates" (better returns) an array for all variables for given + * variable/value pay. + * + * @param $var Variable to set + * @param $value Value to set + * @return $varData Variable data array + */ + private function generateVariableArray ($var, $value) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Generate the temporary array + $varData = array( + 'name' => $var, + 'value' => $value + ); + + // And return it + return $varData; } /** @@ -473,8 +586,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @throws EmptyVariableException If the variable name is left empty */ public final function assignVariable ($var, $value) { - // Trim spaces of variable name - $var = trim($var); + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); // Empty variable found? if (empty($var)) { @@ -483,16 +596,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); + $index = $this->getVariableIndex($var); // Was it found? - if ($idx === false) { + if ($index === false) { // Add it to the stack - //* DEBUG: */ echo "ADD: ".$var."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $var . '[' . gettype($value) . ']=' . $value); $this->addVariable($var, $value); } elseif (!empty($value)) { // Modify the stack entry - //* DEBUG: */ echo "MOD: ".$var."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $var . '[' . gettype($value) . ']=' . $value); $this->modifyVariable($var, $value); } } @@ -505,15 +618,32 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ public final function removeVariable ($var) { // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); + $index = $this->getVariableIndex($var); // Was it found? - if ($idx !== false) { + if ($index !== false) { // Remove this variable - $this->varStack->offsetUnset($idx); + $this->unsetVariableStackOffset($index); } // END - if } + /** + * Unsets the given offset in the variable stack + * + * @param $index Index to unset + * @return void + */ + protected final function unsetVariableStackOffset ($index) { + // Is the entry there? + if (!isset($this->varStack[$this->currGroup][$index])) { + // Abort here, we need fixing! + $this->debugInstance(); + } // END - if + + // Remove it + unset($this->varStack[$this->currGroup][$index]); + } + /** * Private setter for raw template data * @@ -522,8 +652,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->getVarStack($this->currGroup)).', groups='.count($this->varStack).'
\n'; + //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.'); + //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack)); $this->rawTemplateData = (string) $rawTemplateData; } @@ -533,7 +663,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: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.'); return $this->rawTemplateData; } @@ -544,7 +674,7 @@ 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: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.'); $this->compiledData = (string) $compiledData; } @@ -554,7 +684,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $compiledData Compiled template data */ public final function getCompiledData () { - //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.
\n'; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.'); return $this->compiledData; } @@ -631,7 +761,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $ioInstance = $this->getFileIoInstance(); // Some debug code to look on the file which is being loaded - //* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn); // Load the raw template $rawTemplateData = $ioInstance->loadFileContents($fqfn); @@ -652,6 +782,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @param $var The variable we want to assign */ private function assignTemplateVariable ($varName, $var) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',var=' . $var); + // Is it not a config variable? if ($varName != 'config') { // Regular template variables @@ -673,7 +809,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 + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true)); // Did we find some variables? if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) { @@ -710,26 +849,30 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $backup = $this->getRawTemplateData(); // Initialize some arrays - if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); } + if (is_null($this->loadedRawData)) { + // Initialize both + $this->loadedRawData = array(); + $this->rawTemplates = array(); + } // END - if // Load all requested templates foreach ($templateMatches[1] as $template) { - // Load and compile only templates which we have not yet loaded // RECURSIVE PROTECTION! BE CAREFUL HERE! if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) { + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template); // Template not found, but maybe variable assigned? - //* DEBUG: */ echo __METHOD__.":template={$template}
\n"; - if ($this->isVariableAlreadySet($template) !== false) { + if ($this->getVariableIndex($template, 'config') !== false) { // Use that content here - $this->loadedRawData[$template] = $this->readVariable($template); + $this->loadedRawData[$template] = $this->readVariable($template, 'config'); // Recursive protection: $this->loadedTemplates[] = $template; - } elseif ($this->isVariableAlreadySet($template, 'config')) { + } elseif ($this->getVariableIndex($template) !== false) { // Use that content here - $this->loadedRawData[$template] = $this->readVariable($template, 'config'); + $this->loadedRawData[$template] = $this->readVariable($template); // Recursive protection: $this->loadedTemplates[] = $template; @@ -858,8 +1001,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @todo Unfinished work or don't die here. */ private function assignAllVariables (array $varMatches) { + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches)); + // Search for all variables foreach ($varMatches[1] as $key => $var) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + + // Debug message + $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var); // Detect leading equals if (substr($varMatches[2][$key], 0, 1) == '=') { @@ -875,9 +1026,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // @TODO Non-string found so we need some deeper analysis... ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!'); } - - } // for ($varMatches ... + } // END - foreach } + /** * Compiles all loaded raw templates * @@ -885,40 +1036,42 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ private function compileRawTemplateData (array $templateMatches) { + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData)); + // Are some code-templates found which we need to compile? if (count($this->loadedRawData) > 0) { - // Then compile all! foreach ($this->loadedRawData as $template => $code) { + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code); // Is this template already compiled? if (in_array($template, $this->compiledTemplates)) { // Then skip it + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!'); continue; - } + } // END - if // Search for the template $foundIndex = array_search($template, $templateMatches[1]); // Lookup the matching variable data if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) { - // Split it up with another reg. exp. into variable=value pairs preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches); + ///* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches,true)); // Assign all variables $this->assignAllVariables($varMatches); - } // END - if (isset($templateMatches ... // Compile the loaded template $this->compileCode($code, $template); - } // END - foreach ($this->loadedRawData ... // Insert all templates $this->insertAllTemplates($templateMatches); - } // END - if (count($this->loadedRawData) ... } @@ -943,7 +1096,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')
\n'; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')'); // Do we have the stack? if (!$this->isVarStackSet('general')) { @@ -954,7 +1107,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Walk through all variables foreach ($this->getVarStack('general') as $currEntry) { - //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=
'.htmlentities($currEntry['value']).'
\n'; + //* DEBUG: */ $this->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); @@ -966,7 +1119,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content); } // END - for - //* DEBUG: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')
\n'; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')'); // Set the content back $this->setRawTemplateData($content); @@ -994,8 +1147,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function assignConfigVariable ($var) { + // Replace all dashes to underscores to match variables with configuration entries + $var = trim($this->convertDashesToUnderscores($var)); + // Sweet and simple... - //* DEBUG: */ echo __METHOD__.':var={$var}
\n'; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var)); $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var)); } @@ -1025,19 +1181,23 @@ 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: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!'); return; } // END - if // Iterate through all general variables - foreach ($this->getVarStack('general') as $idx=>$currVariable) { + foreach ($this->getVarStack('general') as $index => $currVariable) { // Compile the value $value = $this->compileRawCode($this->readVariable($currVariable['name']), true); + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value); + // Remove it from stack - $this->removeVariable($idx, 'general'); + $this->removeVariable($index, 'general'); // Re-assign the variable + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); $this->assignConfigVariable($value); } // END - foreach } @@ -1056,21 +1216,15 @@ 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: */ $this->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($idx); + unset($index); unset($currVariable); // Run the compilation three times to get content from helper classes in @@ -1147,8 +1301,11 @@ 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()->getConfigEntry('code_template_type')) { + if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) { // Abort here throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED); } // END - if @@ -1165,6 +1322,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Search for code-tags which are {? ?} preg_match_all($this->regExpCodeTags, $rawData, $templateMatches); + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true)); + // Analyze the matches array if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) { // Entries are found: @@ -1180,15 +1340,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 ... } @@ -1205,7 +1362,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Is this view helper loaded? if (!isset($this->helpers[$helperName])) { // Create a class name - $className = "{$helperName}ViewHelper"; + $className = $helperName . 'ViewHelper'; // Generate new instance $this->helpers[$helperName] = ObjectFactory::createObjectByName($className); @@ -1247,21 +1404,21 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Assigns all the application data with template variables * - * @param $appInstance A manageable application instance + * @param $applicationInstance A manageable application instance * @return void */ - public function assignApplicationData (ManageableApplication $appInstance) { + public function assignApplicationData (ManageableApplication $applicationInstance) { // Get long name and assign it - $this->assignVariable('app_full_name' , $appInstance->getAppName()); + $this->assignVariable('app_full_name' , $applicationInstance->getAppName()); // Get short name and assign it - $this->assignVariable('app_short_name', $appInstance->getAppShortName()); + $this->assignVariable('app_short_name', $applicationInstance->getAppShortName()); // Get version number and assign it - $this->assignVariable('app_version' , $appInstance->getAppVersion()); + $this->assignVariable('app_version' , $applicationInstance->getAppVersion()); // Assign extra application-depending data - $appInstance->assignExtraTemplateData($this); + $applicationInstance->assignExtraTemplateData($this); } /** @@ -1273,24 +1430,31 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ public function compileRawCode ($rawCode, $setMatchAsCode=false) { // Find the variables - //* DEBUG: */ echo __METHOD__.":rawCode=
".htmlentities($rawCode)."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); preg_match_all($this->regExpVarValue, $rawCode, $varMatches); // Compile all variables - //* DEBUG: */ echo __METHOD__.":
".print_r($varMatches, true)."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':
' . print_r($varMatches, true) . '
'); foreach ($varMatches[0] as $match) { // Add variable tags around it $varCode = '{?' . $match . '?}'; + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varCode=' . $varCode); + // Is the variable found in code? (safes some calls) if (strpos($rawCode, $varCode) !== false) { - // Replace the variable with it's value, if found - $value = $this->readVariable($match); - //* DEBUG: */ echo __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."
\n"; - if (($setMatchAsCode === true) && (is_null($value))) { + // Debug message + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',value[' . gettype($value) . ']=' . $value); + + // Use $match as new value or $value from read variable? + if ($setMatchAsCode === true) { // Insert match $rawCode = str_replace($varCode, $match, $rawCode); } else { + // Read the variable + $value = $this->readVariable($match); + // Insert value $rawCode = str_replace($varCode, $value, $rawCode); } @@ -1298,7 +1462,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - foreach // Return the compiled data - //* DEBUG: */ echo __METHOD__.":rawCode=
".htmlentities($rawCode)."
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); return $rawCode; } @@ -1319,7 +1483,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function renameVariable ($oldName, $newName) { - //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}
\n"; + //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName); // Get raw template code $rawData = $this->getRawTemplateData(); @@ -1337,7 +1501,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void * @throws XmlParserException If an XML error was found */ - public function renderXmlContent ($content = null) { + public function renderXmlContent ($content = NULL) { // Is the content set? if (is_null($content)) { // Get current content @@ -1368,9 +1532,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } /** - * Checks wether language support is enabled + * Checks whether language support is enabled * - * @return $languageSupport Wether language support is enabled or disabled + * @return $languageSupport Whether language support is enabled or disabled */ public final function isLanguageSupportEnabled () { return $this->languageSupport; @@ -1387,13 +1551,42 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } /** - * Checks wether XML compacting is enabled + * Checks whether XML compacting is enabled * - * @return $xmlCompacting Wether XML compacting is enabled or disabled + * @return $xmlCompacting Whether XML compacting is enabled or disabled */ public final function isXmlCompactingEnabled () { return $this->xmlCompacting; } + + /** + * 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('//', $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 + + // Set the content again + $this->setRawTemplateData($compactedContent); + + // Return compacted content + return $compactedContent; + } } // [EOF]