X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=21234b81e8295b2e6eac43680f543a7068202fb8;hp=8690db6fe519d8f038307dbe7684e8712eb56d71;hb=c1d88e5878553a4d812569c22f0b46ef28674e2f;hpb=c6d73b0e3246efc824cb98338d4be7ee5bc9f308 diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php index 8690db6f..21234b81 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, this is free software + * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -27,42 +27,42 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * templates are stored. We will internally determine the language plus * "html" for web templates or "emails" for email templates */ - private $basePath = ""; + private $basePath = ''; /** * Template type */ - private $templateType = "html"; + private $templateType = 'html'; /** * The extension for web and email templates (not compiled templates) */ - private $templateExtension = ".tpl"; + private $templateExtension = '.tpl'; /** * The extension for code templates (not compiled templates) */ - private $codeExtension = ".ctp"; + private $codeExtension = '.ctp'; /** * Path relative to $basePath and language code for compiled code-templates */ - private $compileOutputPath = "templates/_compiled"; + private $compileOutputPath = 'templates/_compiled'; /** * The raw (maybe uncompiled) template */ - private $rawTemplateData = ""; + private $rawTemplateData = ''; /** * Template data with compiled-in variables */ - private $compiledData = ""; + private $compiledData = ''; /** * The last loaded template's FQFN for debugging the engine */ - private $lastTemplate = ""; + private $lastTemplate = ''; /** * The variable stack for the templates @@ -116,6 +116,16 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ private $varGroups = array(); + /** + * Code begin + */ + private $codeBegin = ''; + // Exception codes for the template engine const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110; const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111; @@ -285,7 +295,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } /** - * Setter for template type. Only "html", "emails" and "compiled" should + * Setter for template type. Only 'html', 'emails' and 'compiled' should * be sent here * * @param $templateType The current template's type @@ -460,8 +470,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ protected final function setRawTemplateData ($rawTemplateData) { // And store it in this class - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($rawTemplateData)." Bytes set.
\n"; - //* DEBUG: */ echo $this->currGroup." variables: ".count($this->varStack[$this->currGroup]).", groups=".count($this->varStack)."
\n"; + //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($rawTemplateData).' Bytes set.
\n'; + //* DEBUG: */ echo $this->currGroup.' variables: '.count($this->varStack[$this->currGroup]).', groups='.count($this->varStack).'
\n'; $this->rawTemplateData = (string) $rawTemplateData; } @@ -471,7 +481,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: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->rawTemplateData).' Bytes read.
\n'; return $this->rawTemplateData; } @@ -482,7 +492,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: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($compiledData).' Bytes set.
\n'; $this->compiledData = (string) $compiledData; } @@ -492,7 +502,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: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.
\n'; return $this->compiledData; } @@ -513,7 +523,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // Construct the FQFN for the template by honoring the current language - $fqfn = sprintf("%s%s/%s/%s%s", + $fqfn = sprintf("%s%s/%s%s/%s/%s%s", + $this->getConfigInstance()->readConfig('application_path'), + Registry::getRegistry()->getInstance('application')->getAppShortName(), $this->getBasePath(), $this->getLanguageInstance()->getLanguageCode(), $this->getTemplateType(), @@ -560,7 +572,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Is it not a config variable? if ($varName != 'config') { // Regular template variables - $this->assignVariable($var, ""); + $this->assignVariable($var, ''); } else { // Configuration variables $this->assignConfigVariable($var); @@ -606,9 +618,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Structure of $templateMatches: *--------------------------------- * [0] => Array - An array with all full matches - * [1] => Array - An array with left part (before the ":") of a match - * [2] => Array - An array with right part of a match including ":" - * [3] => Array - An array with right part of a match excluding ":" + * [1] => Array - An array with left part (before the ':') of a match + * [2] => Array - An array with right part of a match including ':' + * [3] => Array - An array with right part of a match excluding ':' */ private function analyzeTemplate (array $templateMatches) { // Backup raw template data @@ -773,18 +785,18 @@ class BaseTemplateEngine extends BaseFrameworkSystem { foreach ($varMatches[1] as $key => $var) { // Detect leading equals - if (substr($varMatches[2][$key], 0, 1) == "=") { + if (substr($varMatches[2][$key], 0, 1) == '=') { // Remove and cast it $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1); - } + } // END - if // Do we have some quotes left and right side? Then it is free text if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) { // Free string detected! Which we can assign directly $this->assignVariable($var, $varMatches[3][$key]); } elseif (!empty($varMatches[2][$key])) { - // Non-string found so we need some deeper analysis... - die("Deeper analysis not yet implemented!"); + // @TODO Non-string found so we need some deeper analysis... + ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!'); } } // for ($varMatches ... @@ -792,7 +804,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { /** * Compiles all loaded raw templates * - * @param $templateMatches See method analyzeTemplate() for details + * @param $templateMatches See method analyzeTemplate() for details * @return void */ private function compileRawTemplateData (array $templateMatches) { @@ -854,23 +866,23 @@ class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ echo __METHOD__.": content before=".strlen($content)." (".md5($content).")
\n"; + //* DEBUG: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')
\n'; // Walk through all variables foreach ($this->varStack['general'] as $currEntry) { - //* DEBUG: */ echo __METHOD__.": name=".$currEntry['name'].", value=
".htmlentities($currEntry['value'])."
\n"; + //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=
'.htmlentities($currEntry['value']).'
\n'; // Replace all [$var] or {?$var?} with the content - // Old behaviour, will become obsolete! - $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content); + // @TODO Old behaviour, will become obsolete! + $content = str_replace("\$content[".$currEntry['name'].']', $currEntry['value'], $content); - // Yet another old way - $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content); + // @TODO Yet another old way + $content = str_replace('['.$currEntry['name'].']', $currEntry['value'], $content); // The new behaviour - $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content); + $content = str_replace('{?'.$currEntry['name'].'?}', $currEntry['value'], $content); } // END - for - //* DEBUG: */ echo __METHOD__.": content after=".strlen($content)." (".md5($content).")
\n"; + //* DEBUG: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')
\n'; // Set the content back $this->setRawTemplateData($content); @@ -880,7 +892,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Load a specified web template into the engine * * @param $template The web template we shall load which is located in - * "html" by default + * 'html' by default * @return void */ public function loadWebTemplate ($template) { @@ -899,7 +911,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { */ public function assignConfigVariable ($var) { // Sweet and simple... - //* DEBUG: */ echo __METHOD__.":var={$var}
\n"; + //* DEBUG: */ echo __METHOD__.':var={$var}
\n'; $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var); } @@ -907,7 +919,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Load a specified email template into the engine * * @param $template The email template we shall load which is located in - * "emails" by default + * 'emails' by default * @return void */ public function loadEmailTemplate ($template) { @@ -922,7 +934,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * Load a specified code template into the engine * * @param $template The code template we shall load which is - * located in "code" by default + * located in 'code' by default * @return void */ public function loadCodeTemplate ($template) { @@ -947,7 +959,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Iterate through all general variables foreach ($this->varStack['general'] as $currVariable) { // Transfer it's name/value combination to the $content array - //* DEBUG: */ echo $currVariable['name']."=
".htmlentities($currVariable['value'])."
\n"; + //* DEBUG: */ echo $currVariable['name'].'=
'.htmlentities($currVariable['value']).'
\n'; $dummy[$currVariable['name']] = $currVariable['value']; }// END - if @@ -964,7 +976,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { unset($idx); unset($currVariable); - // Run the compilation twice to get content from helper classes in + // Run the compilation three times to get content from helper classes in $cnt = 0; while ($cnt < 3) { // Finalize the compilation of template variables @@ -976,19 +988,19 @@ class BaseTemplateEngine extends BaseFrameworkSystem { ); // This loop does remove the backslashes (\) in PHP parameters - while (strpos($eval, "codeBegin) !== false) { // Get left part before "codeBegin)); // Get all from right of "codeBegin) + 5)); // Cut middle part out and remove escapes - $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>"))); + $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd))); $evalMiddle = stripslashes($evalMiddle); // Remove the middle part from right one - $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2)); + $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2)); // And put all together $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight); @@ -998,7 +1010,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $eval = str_replace( "<%php", "\";", str_replace( - "%>", "\n\$result .= \"", $eval + "%>", + "\n\$result .= \"", + $eval ) ); @@ -1006,7 +1020,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { @eval($eval); // Goes something wrong? - if (!isset($result)) { + if ((!isset($result)) || (empty($result))) { // Output eval command $this->debugOutput(sprintf("Failed eval() code: 
%s
", $this->markupCode($eval, true)), true); @@ -1046,7 +1060,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $rawData = $this->getRawTemplateData(); // Remove double spaces and trim leading/trailing spaces - $rawData = trim(str_replace(" ", " ", $rawData)); + $rawData = trim(str_replace(' ', ' ', $rawData)); // Search for raw variables $this->extractVariablesFromRawData($rawData); @@ -1074,7 +1088,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $this->insertRawTemplates(); // Remove the raw template content as well - $this->setRawTemplateData(""); + $this->setRawTemplateData(''); } // END - if @@ -1091,23 +1105,23 @@ class BaseTemplateEngine extends BaseFrameworkSystem { public function output () { // Check which type of template we have switch ($this->getTemplateType()) { - case "html": // Raw HTML templates can be send to the output buffer - // Quick-N-Dirty: - $this->getWebOutputInstance()->output($this->getCompiledData()); - break; - - default: // Unknown type found - // Construct message - $msg = sprintf("[%s->%s] Unknown/unsupported template type %s detected.", - $this->__toString(), - __FUNCTION__, - $this->getTemplateType() - ); - - // Write the problem to the world... - $this->debugOutput($msg); - break; - } + case 'html': // Raw HTML templates can be send to the output buffer + // Quick-N-Dirty: + $this->getWebOutputInstance()->output($this->getCompiledData()); + break; + + default: // Unknown type found + // Construct message + $msg = sprintf("[%s->%s] Unknown/unsupported template type %s detected.", + $this->__toString(), + __FUNCTION__, + $this->getTemplateType() + ); + + // Write the problem to the world... + $this->debugOutput($msg); + break; + } // END - switch } /** @@ -1115,32 +1129,18 @@ class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $helperName The helper's name * @return void - * @throws ViewHelperNotFoundException If the given view helper was not found */ protected function loadViewHelper ($helperName) { // Make first character upper case, rest low - $helperName = ucfirst($helperName); + $helperName = $this->convertToClassName($helperName); // Is this view helper loaded? if (!isset($this->helpers[$helperName])) { // Create a class name $className = "{$helperName}ViewHelper"; - // Does this class exists? - if (!class_exists($className)) { - // Abort here! - throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER); - } // END - if - // Generate new instance - $eval = sprintf("\$this->helpers[%s] = %s::create%s();", - $helperName, - $className, - $className - ); - - // Run the code - eval($eval); + $this->helpers[$helperName] = ObjectFactory::createObjectByName($className); } // END - if // Return the requested instance @@ -1162,7 +1162,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { $this->assignVariable($variableName, $content); // Purge raw content - $this->setRawTemplateData(""); + $this->setRawTemplateData(''); } /** @@ -1211,7 +1211,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { //* DEBUG: */ echo "
".print_r($varMatches, true)."
"; foreach ($varMatches[0] as $match) { // Add variable tags around it - $varCode = "{?".$match."?}"; + $varCode = '{?' . $match . '?}'; // Is the variable found in code? (safes some calls) if (strpos($rawCode, $varCode) !== false) { @@ -1268,7 +1268,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem { } // END - if // Convert all to UTF8 - $content = recode("html..utf8", $content); + if (function_exists('recode')) { + $content = recode("html..utf8", $content); + } else { + // @TODO We need to find a fallback solution here + } // END - if // Get an XML parser $xmlParser = xml_parser_create(); @@ -1286,7 +1290,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem { // Now parse the XML tree if (!xml_parse($xmlParser, $content)) { // Error found in XML! - //die("
".htmlentities($content)."
"); + //die('
'.htmlentities($content).'
'); throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR); } // END - if