X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=11e3acc63fe8a13d11576371e5969b52a91bd45b;hp=1b1d8e136526e608f3e7eb307f99860f88c5c651;hb=9e13d89bcd07f84ff5f9761d4662a750b225201b;hpb=66e68715d3d5a5e7fd5a3046471914ef3f9dd4b4 diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php index 1b1d8e13..11e3acc6 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 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -106,6 +106,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/'; + /** + * A regular expression to find template comments like + */ + private $regExpComments = '//'; + /** * Loaded helpers */ @@ -119,7 +124,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * All template groups except "general" */ - private $varGroups = array(); + private $variableGroups = array(); /** * Code begin @@ -322,7 +327,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Skip group 'general' if (($groupName != 'general') && ($add === TRUE)) { - $this->varGroups[$groupName] = 'OK'; + $this->variableGroups[$groupName] = 'OK'; } // END - if } @@ -354,13 +359,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Getter for variable value, throws a NoVariableException if the variable is not found * - * @param $varGroup Variable group to use + * @param $variableGroup Variable group to use * @param $index Index in variable array * @return $value Value to set */ - private function getVariableValue ($varGroup, $index) { + private function getVariableValue ($variableGroup, $index) { // Return it - return $this->varStack[$varGroup][$index]['value']; + return $this->varStack[$variableGroup][$index]['value']; } /** @@ -391,13 +396,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Sets a variable value for given variable group and index * - * @param $varGroup Variable group to use + * @param $variableGroup Variable group to use * @param $index Index in variable array * @param $value Value to set * @return void */ - private function setVariableValue ($varGroup, $index, $value) { - $this->varStack[$varGroup][$index]['value'] = $value; + private function setVariableValue ($variableGroup, $index, $value) { + $this->varStack[$variableGroup][$index]['value'] = $value; } /** @@ -405,12 +410,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * variable is already set. If so, the variable got modified, otherwise * added. * - * @param $varGroup Variable group to use + * @param $variableGroup Variable group to use * @param $variableName Variable to set * @param $value Value to set * @return void */ - protected function setVariable ($varGroup, $variableName, $value) { + protected function setVariable ($variableGroup, $variableName, $value) { // Replace all dashes to underscores to match variables with configuration entries $variableName = trim($this->convertDashesToUnderscores($variableName)); @@ -420,13 +425,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Is the variable set? if ($index === FALSE) { // Is the stack there? - if (!isset($this->varStack[$varGroup])) { + if (!isset($this->varStack[$variableGroup])) { // Then initialize it here - $this->varStack[$varGroup] = array(); + $this->varStack[$variableGroup] = array(); } // END - if // Not found, add it - array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value)); + array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value)); } else { // Then modify it $this->setVariableValue($this->currGroup, $index, $value); @@ -466,6 +471,15 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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 * @@ -574,67 +588,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $this->compileOutputPath = (string) $compileOutputPath; } - /** - * Getter for template type - * - * @return $templateType The current template's type - */ - public final function getTemplateType () { - return $this->templateType; - } - - /** - * Assign (add) a given variable with a value - * - * @param $variableName The variable we are looking for - * @param $value The value we want to store in the variable - * @return void - * @throws EmptyVariableException If the variable name is left empty - */ - public final function assignVariable ($variableName, $value) { - // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim($this->convertDashesToUnderscores($variableName)); - - // Empty variable found? - if (empty($variableName)) { - // Throw an exception - throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); - } // END - if - - // First search for the variable if it was already added - $index = $this->getVariableIndex($variableName); - - // Was it found? - if ($index === FALSE) { - // Add it to the stack - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value); - $this->addVariable($variableName, $value); - } elseif (!empty($value)) { - // Modify the stack entry - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value); - $this->modifyVariable($variableName, $value); - } - } - - /** - * Removes a given variable - * - * @param $variableName The variable we are looking for - * @param $variableGroup Name of variable group (default: 'general') - * @return void - */ - public final function removeVariable ($variableName, $variableGroup = 'general') { - // First search for the variable if it was already added - $index = $this->getVariableIndex($variableName, $variableGroup); - - // Was it found? - if ($index !== FALSE) { - // Remove this variable - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index); - $this->unsetVariableStackOffset($index, $variableGroup); - } // END - if - } - /** * Unsets the given offset in the variable group * @@ -678,7 +631,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $rawTemplateData The raw data from the template */ public final function getRawTemplateData () { - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.'); return $this->rawTemplateData; } @@ -689,7 +642,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private final function setCompiledData ($compiledData) { // And store it in this class - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($compiledData) . ' Bytes set.'); $this->compiledData = (string) $compiledData; } @@ -699,7 +652,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return $compiledData Compiled template data */ public final function getCompiledData () { - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.'); return $this->compiledData; } @@ -724,7 +677,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(), @@ -735,7 +688,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(), @@ -759,7 +712,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $this->loadTemplate($template, $ext); } else { // Throw it again - throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND); + throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_FOUND); } } @@ -772,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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: FQFN=' . $fqfn); // Load the raw template - $rawTemplateData = $ioInstance->loadFileContents($fqfn); + $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fqfn); // Store the template's contents into this class $this->setRawTemplateData($rawTemplateData); @@ -792,25 +742,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 or config) + * @param $variableName The variable's name (shall be content or config) * by default * @param $variableName The variable we want to assign * @return void */ - private function assignTemplateVariable ($varName, $var) { + private function assignTemplateVariable ($variableName, $var) { // Replace all dashes to underscores to match variables with configuration entries $variableName = trim($this->convertDashesToUnderscores($variableName)); // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',variableName=' . $variableName); // Is it not a config variable? - if ($varName != 'config') { + if ($variableName != 'config') { // Regular template variables $this->assignVariable($variableName, ''); } else { // Configuration variables - $this->assignConfigVariable($variableName); + $this->assignConfigVariable($var); } } @@ -828,19 +778,19 @@ class BaseTemplateEngine extends BaseFrameworkSystem { preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches); // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE)); // Did we find some variables? if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) { // Initialize all missing variables foreach ($variableMatches[3] as $key => $var) { // Variable name - $varName = $variableMatches[1][$key]; + $variableName = $variableMatches[1][$key]; // Workarround: Do not assign empty variables if (!empty($var)) { // Try to assign it, empty strings are being ignored - $this->assignTemplateVariable($varName, $var); + $this->assignTemplateVariable($variableName, $var); } // END - if } // END - foreach } // END - if @@ -877,7 +827,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // RECURSIVE PROTECTION! BE CAREFUL HERE! if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template); // Template not found, but maybe variable assigned? if ($this->getVariableIndex($template, 'config') !== FALSE) { @@ -1018,7 +968,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private function assignAllVariables (array $varMatches) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches)); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches()=' . count($varMatches)); // Search for all variables foreach ($varMatches[1] as $key => $var) { @@ -1026,7 +976,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $var = trim($this->convertDashesToUnderscores($var)); // Debug message - self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var); + self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var); // Detect leading equals if (substr($varMatches[2][$key], 0, 1) == '=') { @@ -1053,19 +1003,19 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private function compileRawTemplateData (array $templateMatches) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData)); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:loadedRawData()= ' .count($this->loadedRawData)); // Are some code-templates found which we need to compile? if (count($this->loadedRawData) > 0) { // Then compile all! foreach ($this->loadedRawData as $template => $code) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template . ',code(' . strlen($code) . ')=' . $code); // Is this template already compiled? if (in_array($template, $this->compiledTemplates)) { // Then skip it - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Template ' . $template . ' already compiled. SKIPPED!'); continue; } // END - if @@ -1076,7 +1026,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) { // Split it up with another reg. exp. into variable=value pairs preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches); - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches=' . print_r($varMatches, TRUE)); // Assign all variables $this->assignAllVariables($varMatches); @@ -1112,7 +1062,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content before=' . strlen($content) . ' (' . md5($content) . ')'); // Do we have the stack? if (!$this->isVarStackSet('general')) { @@ -1123,7 +1073,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Walk through all variables foreach ($this->getVarStack('general') as $currEntry) { - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=
' . htmlentities($currEntry['value']) . '
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: 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); @@ -1135,7 +1085,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content); } // END - for - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content after=' . strlen($content) . ' (' . md5($content) . ')'); // Set the content back $this->setRawTemplateData($content); @@ -1156,6 +1106,76 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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 * @@ -1167,10 +1187,48 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $variableName = trim($this->convertDashesToUnderscores($variableName)); // Sweet and simple... - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName)); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName)); $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName)); } + /** + * Injects an array of config variables into the stack of currently loaded + * template. This method should only be used in very rare circumstances, + * e.g. when you have to copy a whole set of variables into the template + * engine. Before you use this method, please make sure you have considered + * all other possiblities. + * + * @param $variables An array with variables to be injected + * @return void + */ + public function injectConfigVariables (array $variables) { + // "Inject" all + foreach ($variables as $name => $value) { + // Set variable with name for 'config' group + $this->setVariable('config', $name, $value); + } // END - foreach + } + + /** + * Assigns all the application data with template variables + * + * @param $applicationInstance A manageable application instance + * @return void + */ + public function assignApplicationData (ManageableApplication $applicationInstance) { + // Get long name and assign it + $this->assignVariable('app_full_name' , $applicationInstance->getAppName()); + + // Get short name and assign it + $this->assignVariable('app_short_name', $applicationInstance->getAppShortName()); + + // Get version number and assign it + $this->assignVariable('app_version' , $applicationInstance->getAppVersion()); + + // Assign extra application-depending data + $applicationInstance->assignExtraTemplateData($this); + } + /** * Load a specified code template into the engine * @@ -1197,7 +1255,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Do we have the stack? if (!$this->isVarStackSet('general')) { // Abort here silently - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!'); return; } // END - if @@ -1207,11 +1265,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE); // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currVariable['name'] . ',value=' . $value); // Remove it from stack $this->removeVariable($currVariable['name'], 'general'); - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); // Is it a configuration key? if ($this->getConfigInstance()->isConfigurationEntrySet($value)) { @@ -1238,7 +1296,7 @@ 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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=
' . htmlentities($currVariable['value']).'
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=
' . htmlentities($currVariable['value']).'
'); $dummy[$currVariable['name']] = $currVariable['value']; }// END - if @@ -1256,7 +1314,7 @@ 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()) ); @@ -1276,14 +1334,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 ) @@ -1295,7 +1353,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Goes something wrong? if ((!isset($result)) || (empty($result))) { // Output eval command - self::createDebugInstance(__CLASS__)->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(); @@ -1345,7 +1403,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { preg_match_all($this->regExpCodeTags, $rawData, $templateMatches); // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , TRUE)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:templateMatches=' . print_r($templateMatches , TRUE)); // Analyze the matches array if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) { @@ -1378,13 +1436,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ protected function loadViewHelper ($helperName) { - // Make first character upper case, rest low - $helperName = $this->convertToClassName($helperName); - // Is this view helper loaded? if (!isset($this->helpers[$helperName])) { // Create a class name - $className = $helperName . 'ViewHelper'; + $className = $this->convertToClassName($helperName) . 'ViewHelper'; // Generate new instance $this->helpers[$helperName] = ObjectFactory::createObjectByName($className); @@ -1394,24 +1449,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem { 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 * @@ -1423,26 +1460,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $responseInstance->writeToBody($this->getCompiledData()); } - /** - * Assigns all the application data with template variables - * - * @param $applicationInstance A manageable application instance - * @return void - */ - public function assignApplicationData (ManageableApplication $applicationInstance) { - // Get long name and assign it - $this->assignVariable('app_full_name' , $applicationInstance->getAppName()); - - // Get short name and assign it - $this->assignVariable('app_short_name', $applicationInstance->getAppShortName()); - - // Get version number and assign it - $this->assignVariable('app_version' , $applicationInstance->getAppVersion()); - - // Assign extra application-depending data - $applicationInstance->assignExtraTemplateData($this); - } - /** * "Compiles" a variable by replacing {?var?} with it's content * @@ -1452,22 +1469,22 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) { // Find the variables - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=
' . htmlentities($rawCode) . '
'); preg_match_all($this->regExpVarValue, $rawCode, $varMatches); // Compile all variables - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':
' . 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 . '?}'; // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varCode=' . $varCode); // Is the variable found in code? (safes some calls) if (strpos($rawCode, $varCode) !== FALSE) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode); // Use $match as new value or $value from read variable? if ($setMatchAsCode === TRUE) { @@ -1484,17 +1501,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - foreach // Return the compiled data - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=
' . htmlentities($rawCode) . '
'); + //* 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; } /** @@ -1505,7 +1522,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ public function renameVariable ($oldName, $newName) { - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName); // Get raw template code $rawData = $this->getRawTemplateData(); @@ -1592,7 +1609,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $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); + preg_match_all($this->regExpComments, $compactedContent, $matches); // Do we have entries? if (isset($matches[0][0])) {