X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;fp=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=0000000000000000000000000000000000000000;hb=398f4a89ecb5f6ef538e143d5ea84b569fb9d287;hp=8690db6fe519d8f038307dbe7684e8712eb56d71;hpb=df33e264f3246f80756d7e2da55d7f7c40f9088c;p=shipsimu.git diff --git a/inc/classes/main/template/class_BaseTemplateEngine.php b/inc/classes/main/template/class_BaseTemplateEngine.php deleted file mode 100644 index 8690db6..0000000 --- a/inc/classes/main/template/class_BaseTemplateEngine.php +++ /dev/null @@ -1,1299 +0,0 @@ - - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software - * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.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 - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -class BaseTemplateEngine extends BaseFrameworkSystem { - /** - * The local path name where all templates and sub folders for special - * templates are stored. We will internally determine the language plus - * "html" for web templates or "emails" for email templates - */ - private $basePath = ""; - - /** - * Template type - */ - private $templateType = "html"; - - /** - * The extension for web and email templates (not compiled templates) - */ - private $templateExtension = ".tpl"; - - /** - * The extension for code templates (not compiled templates) - */ - private $codeExtension = ".ctp"; - - /** - * Path relative to $basePath and language code for compiled code-templates - */ - private $compileOutputPath = "templates/_compiled"; - - /** - * The raw (maybe uncompiled) template - */ - private $rawTemplateData = ""; - - /** - * Template data with compiled-in variables - */ - private $compiledData = ""; - - /** - * The last loaded template's FQFN for debugging the engine - */ - private $lastTemplate = ""; - - /** - * The variable stack for the templates - */ - private $varStack = array(); - - /** - * Loaded templates for recursive protection and detection - */ - private $loadedTemplates = array(); - - /** - * Compiled templates for recursive protection and detection - */ - private $compiledTemplates = array(); - - /** - * Loaded raw template data - */ - private $loadedRawData = null; - - /** - * Raw templates which are linked in code templates - */ - private $rawTemplates = null; - - /** - * A regular expression for variable=value pairs - */ - private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/'; - - /** - * A regular expression for filtering out code tags - * - * E.g.: {?template:variable=value;var2=value2;[...]?} - */ - private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/'; - - /** - * Loaded helpers - */ - private $helpers = array(); - - /** - * Current variable group - */ - private $currGroup = 'general'; - - /** - * All template groups except "general" - */ - private $varGroups = array(); - - // Exception codes for the template engine - const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110; - const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111; - const EXCEPTION_INVALID_VIEW_HELPER = 0x112; - - /** - * Protected constructor - * - * @param $className Name of the class - * @return void - */ - protected function __construct ($className) { - // Call parent constructor - parent::__construct($className); - - // Clean up a little - $this->removeNumberFormaters(); - $this->removeSystemArray(); - } - - /** - * Search for a variable in the stack - * - * @param $var The variable we are looking for - * @return $idx FALSE means not found, >=0 means found on a specific index - */ - private function isVariableAlreadySet ($var) { - // First everything is not found - $found = false; - - // Is the group there? - if (isset($this->varStack[$this->currGroup])) { - // Now search for it - foreach ($this->varStack[$this->currGroup] as $idx => $currEntry) { - //* DEBUG: */ echo __METHOD__.":currGroup={$this->currGroup},idx={$idx},currEntry={$currEntry['name']},var={$var}
\n"; - // Is the entry found? - if ($currEntry['name'] == $var) { - // Found! - //* DEBUG: */ echo __METHOD__.":FOUND!
\n"; - $found = $idx; - break; - } // END - if - } // END - foreach - } // END - if - - // Return the current position - return $found; - } - - /** - * Return a content of a variable or null if not found - * - * @param $var The variable we are looking for - * @return $content Content of the variable or null if not found - */ - protected function readVariable ($var) { - // First everything is not found - $content = null; - - // Get variable index - $found = $this->isVariableAlreadySet($var); - - // Is the variable found? - if ($found !== false) { - // Read it - $found = $this->varStack[$this->currGroup][$found]['value']; - } // END - if - - //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."
\n"; - - // Return the current position - return $found; - } - - /** - * 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 - * @return void - */ - private function addVariable ($var, $value) { - // Set general variable group - $this->setVariableGroup('general'); - - // Add it to the stack - $this->addGroupVariable($var, $value); - } - - /** - * Returns all variables of current group or empty array - * - * @return $result Wether array of found variables or empty array - */ - private function readCurrentGroup () { - // Default is not found - $result = array(); - - // Is the group there? - if (isset($this->varStack[$this->currGroup])) { - // Then use it - $result = $this->varStack[$this->currGroup]; - } // END - if - - // Return result - return $result; - } - - /** - * Settter for variable group - * - * @param $groupName Name of variable group - * @param $add Wether add this group - * @retur4n void - */ - public function setVariableGroup ($groupName, $add = true) { - // Set group name - //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."
\n"; - $this->currGroup = $groupName; - - // Skip group 'general' - if (($groupName != 'general') && ($add === true)) { - $this->varGroups[$groupName] = 'OK'; - } // END - if - } - - - /** - * Adds a variable to current group - * - * @param $var Variable to set - * @param $value Value to store in variable - * @return void - */ - public function addGroupVariable ($var, $value) { - //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."
\n"; - - // Get current variables in group - $currVars = $this->readCurrentGroup(); - - // Append our variable - $currVars[] = array( - 'name' => $var, - 'value' => $value - ); - - // Add it to the stack - $this->varStack[$this->currGroup] = $currVars; - } - - /** - * 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 - */ - private function modifyVariable ($var, $value) { - // Get index for variable - $idx = $this->isVariableAlreadySet($var); - - // Is the variable set? - if ($idx !== false) { - // Then modify it - $this->varStack[$this->currGroup][$idx]['value'] = $value; - } // END - if - } - - /** - * Setter for template type. Only "html", "emails" and "compiled" should - * be sent here - * - * @param $templateType The current template's type - * @return void - */ - private final function setTemplateType ($templateType) { - $this->templateType = (string) $templateType; - } - - /** - * Setter for the last loaded template's FQFN - * - * @param $template The last loaded template - * @return void - */ - private final function setLastTemplate ($template) { - $this->lastTemplate = (string) $template; - } - - /** - * Getter for the last loaded template's FQFN - * - * @return $template The last loaded template - */ - private final function getLastTemplate () { - return $this->lastTemplate; - } - - /** - * Setter for base path - * - * @param $basePath The local base path for all templates - * @return void - */ - public final function setBasePath ($basePath) { - // And set it - $this->basePath = (string) $basePath; - } - - /** - * Getter for base path - * - * @return $basePath The local base path for all templates - */ - public final function getBasePath () { - // And set it - return $this->basePath; - } - - /** - * Setter for template extension - * - * @param $templateExtension The file extension for all uncompiled - * templates - * @return void - */ - public final function setRawTemplateExtension ($templateExtension) { - // And set it - $this->templateExtension = (string) $templateExtension; - } - - /** - * Setter for code template extension - * - * @param $codeExtension The file extension for all uncompiled - * templates - * @return void - */ - public final function setCodeTemplateExtension ($codeExtension) { - // And set it - $this->codeExtension = (string) $codeExtension; - } - - /** - * Getter for template extension - * - * @return $templateExtension The file extension for all uncompiled - * templates - */ - public final function getRawTemplateExtension () { - // And set it - return $this->templateExtension; - } - - /** - * Getter for code-template extension - * - * @return $codeExtension The file extension for all code- - * templates - */ - public final function getCodeTemplateExtension () { - // And set it - return $this->codeExtension; - } - - /** - * Setter for path of compiled templates - * - * @param $compileOutputPath The local base path for all compiled - * templates - * @return void - */ - public final function setCompileOutputPath ($compileOutputPath) { - // And set it - $this->compileOutputPath = (string) $compileOutputPath; - } - - /** - * Getter for template type - * - * @return $templateType The current template's type - */ - public final function getTemplateType () { - return $this->templateType; - } - - /** - * Assign (add) a given variable with a value - * - * @param $var 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); - - // Empty variable found? - if (empty($var)) { - // Throw an exception - throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING); - } // END - if - - // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); - - // Was it found? - if ($idx === false) { - // Add it to the stack - //* DEBUG: */ echo "ADD: ".$var."
\n"; - $this->addVariable($var, $value); - } elseif (!empty($value)) { - // Modify the stack entry - //* DEBUG: */ echo "MOD: ".$var."
\n"; - $this->modifyVariable($var, $value); - } - } - - /** - * Removes a given variable - * - * @param $var The variable we are looking for - * @return void - */ - public final function removeVariable ($var) { - // First search for the variable if it was already added - $idx = $this->isVariableAlreadySet($var); - - // Was it found? - if ($idx !== false) { - // Remove this variable - $this->varStack->offsetUnset($idx); - } - } - - /** - * Private setter for raw template data - * - * @param $rawTemplateData The raw data from the template - * @return void - */ - 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"; - $this->rawTemplateData = (string) $rawTemplateData; - } - - /** - * Getter for raw template data - * - * @return $rawTemplateData The raw data from the template - */ - public final function getRawTemplateData () { - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->rawTemplateData)." Bytes read.
\n"; - return $this->rawTemplateData; - } - - /** - * Private setter for compiled templates - * - * @return void - */ - private final function setCompiledData ($compiledData) { - // And store it in this class - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($compiledData)." Bytes set.
\n"; - $this->compiledData = (string) $compiledData; - } - - /** - * Getter for compiled templates - * - * @return $compiledData Compiled template data - */ - public final function getCompiledData () { - //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->compiledData)." Bytes read.
\n"; - return $this->compiledData; - } - - /** - * Private loader for all template types - * - * @param $template The template we shall load - * @return void - */ - private function loadTemplate ($template) { - // Get extension for the template - $ext = $this->getRawTemplateExtension(); - - // If we shall load a code-template we need to switch the file extension - if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) { - // Switch over to the code-template extension - $ext = $this->getCodeTemplateExtension(); - } // END - if - - // Construct the FQFN for the template by honoring the current language - $fqfn = sprintf("%s%s/%s/%s%s", - $this->getBasePath(), - $this->getLanguageInstance()->getLanguageCode(), - $this->getTemplateType(), - (string) $template, - $ext - ); - - // Load the raw template data - $this->loadRawTemplateData($fqfn); - } - - /** - * A private loader for raw template names - * - * @param $fqfn The full-qualified file name for a template - * @return void - */ - private function loadRawTemplateData ($fqfn) { - // Get a input/output instance from the middleware - $ioInstance = $this->getFileIoInstance(); - - // Some debug code to look on the file which is being loaded - //* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."
\n"; - - // Load the raw template - $rawTemplateData = $ioInstance->loadFileContents($fqfn); - - // Store the template's contents into this class - $this->setRawTemplateData($rawTemplateData); - - // Remember the template's FQFN - $this->setLastTemplate($fqfn); - } - - /** - * 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 - */ - private function assignTemplateVariable ($varName, $var) { - // Is it not a config variable? - if ($varName != 'config') { - // Regular template variables - $this->assignVariable($var, ""); - } else { - // Configuration variables - $this->assignConfigVariable($var); - } - } - - /** - * Extract variables from a given raw data stream - * - * @param $rawData The raw template data we shall analyze - * @return void - */ - private function extractVariablesFromRawData ($rawData) { - // Cast to string - $rawData = (string) $rawData; - - // Search for variables - @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches); - - // 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]; - - // Workarround: Do not assign empty variables - if (!empty($var)) { - // Try to assign it, empty strings are being ignored - $this->assignTemplateVariable($varName, $var); - } // END - if - } // END - foreach - } // END - if - } - - /** - * Main analysis of the loaded template - * - * @param $templateMatches Found template place-holders, see below - * @return void - * - *--------------------------------- - * 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 ":" - */ - private function analyzeTemplate (array $templateMatches) { - // Backup raw template data - $backup = $this->getRawTemplateData(); - - // Initialize some arrays - if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); } - - // 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))) { - - // Template not found, but maybe variable assigned? - //* DEBUG: */ echo __METHOD__.":template={$template}
\n"; - if ($this->isVariableAlreadySet($template) !== false) { - // Use that content here - $this->loadedRawData[$template] = $this->readVariable($template); - - // Recursive protection: - $this->loadedTemplates[] = $template; - } elseif (isset($this->varStack['config'][$template])) { - // Use that content here - $this->loadedRawData[$template] = $this->varStack['config'][$template]; - - // Recursive protection: - $this->loadedTemplates[] = $template; - } else { - // Then try to search for code-templates - try { - // Load the code template and remember it's contents - $this->loadCodeTemplate($template); - $this->loadedRawData[$template] = $this->getRawTemplateData(); - - // Remember this template for recursion detection - // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; - } catch (FileNotFoundException $e) { - // Even this is not done... :/ - $this->rawTemplates[] = $template; - } catch (FilePointerNotOpenedException $e) { - // Even this is not done... :/ - $this->rawTemplates[] = $template; - } - } - } // END - if - } // END - foreach - - // Restore the raw template data - $this->setRawTemplateData($backup); - } - - /** - * Compile a given raw template code and remember it for later usage - * - * @param $code The raw template code - * @param $template The template's name - * @return void - */ - private function compileCode ($code, $template) { - // Is this template already compiled? - if (in_array($template, $this->compiledTemplates)) { - // Abort here... - return; - } // END - if - - // Remember this template being compiled - $this->compiledTemplates[] = $template; - - // Compile the loaded code in five steps: - // - // 1. Backup current template data - $backup = $this->getRawTemplateData(); - - // 2. Set the current template's raw data as the new content - $this->setRawTemplateData($code); - - // 3. Compile the template data - $this->compileTemplate(); - - // 4. Remember it's contents - $this->loadedRawData[$template] = $this->getRawTemplateData(); - - // 5. Restore the previous raw content from backup variable - $this->setRawTemplateData($backup); - } - - /** - * Insert all given and loaded templates by running through all loaded - * codes and searching for their place-holder in the main template - * - * @param $templateMatches See method analyzeTemplate() - * @return void - */ - private function insertAllTemplates (array $templateMatches) { - // Run through all loaded codes - foreach ($this->loadedRawData as $template => $code) { - - // Search for the template - $foundIndex = array_search($template, $templateMatches[1]); - - // Lookup the matching template replacement - if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) { - - // Get the current raw template - $rawData = $this->getRawTemplateData(); - - // Replace the space holder with the template code - $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData); - - // Set the new raw data - $this->setRawTemplateData($rawData); - } // END - if - } // END - foreach - } - - /** - * Load all extra raw templates - * - * @return void - */ - private function loadExtraRawTemplates () { - // Are there some raw templates we need to load? - if (count($this->rawTemplates) > 0) { - // Try to load all raw templates - foreach ($this->rawTemplates as $key => $template) { - try { - // Load the template - $this->loadWebTemplate($template); - - // Remember it's contents - $this->rawTemplates[$template] = $this->getRawTemplateData(); - - // Remove it from the loader list - unset($this->rawTemplates[$key]); - - // Remember this template for recursion detection - // RECURSIVE PROTECTION! - $this->loadedTemplates[] = $template; - } catch (FileNotFoundException $e) { - // This template was never found. We silently ignore it - unset($this->rawTemplates[$key]); - } catch (FilePointerNotOpenedException $e) { - // This template was never found. We silently ignore it - unset($this->rawTemplates[$key]); - } - } // END - foreach - } // END - if - } - - /** - * Assign all found template variables - * - * @param $varMatches An array full of variable/value pairs. - * @return void - * @todo Unfinished work or don't die here. - */ - private function assignAllVariables (array $varMatches) { - // Search for all variables - foreach ($varMatches[1] as $key => $var) { - - // Detect leading equals - if (substr($varMatches[2][$key], 0, 1) == "=") { - // Remove and cast it - $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1); - } - - // 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!"); - } - - } // for ($varMatches ... - } - /** - * Compiles all loaded raw templates - * - * @param $templateMatches See method analyzeTemplate() for details - * @return void - */ - private function compileRawTemplateData (array $templateMatches) { - // Are some code-templates found which we need to compile? - if (count($this->loadedRawData) > 0) { - - // Then compile all! - foreach ($this->loadedRawData as $template => $code) { - - // Is this template already compiled? - if (in_array($template, $this->compiledTemplates)) { - // Then skip it - continue; - } - - // 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); - - // 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) ... - } - - /** - * Inserts all raw templates into their respective variables - * - * @return void - */ - private function insertRawTemplates () { - // Load all templates - foreach ($this->rawTemplates as $template => $content) { - // Set the template as a variable with the content - $this->assignVariable($template, $content); - } - } - - /** - * Finalizes the compilation of all template variables - * - * @return void - */ - private function finalizeVariableCompilation () { - // Get the content - $content = $this->getRawTemplateData(); - //* 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"; - // Replace all [$var] or {?$var?} with the content - // 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); - - // The new behaviour - $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content); - } // END - for - - //* DEBUG: */ echo __METHOD__.": content after=".strlen($content)." (".md5($content).")
\n"; - - // Set the content back - $this->setRawTemplateData($content); - } - - /** - * Load a specified web template into the engine - * - * @param $template The web template we shall load which is located in - * "html" by default - * @return void - */ - public function loadWebTemplate ($template) { - // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type')); - - // Load the special template - $this->loadTemplate($template); - } - - /** - * Assign a given congfiguration variable with a value - * - * @param $var The configuration variable we want to assign - * @return void - */ - public function assignConfigVariable ($var) { - // Sweet and simple... - //* DEBUG: */ echo __METHOD__.":var={$var}
\n"; - $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var); - } - - /** - * Load a specified email template into the engine - * - * @param $template The email template we shall load which is located in - * "emails" by default - * @return void - */ - public function loadEmailTemplate ($template) { - // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type')); - - // Load the special template - $this->loadTemplate($template); - } - - /** - * Load a specified code template into the engine - * - * @param $template The code template we shall load which is - * located in "code" by default - * @return void - */ - public function loadCodeTemplate ($template) { - // Set template type - $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type')); - - // Load the special template - $this->loadTemplate($template); - } - - /** - * Compile all variables by inserting their respective values - * - * @return void - * @todo Make this code some nicer... - */ - public final function compileVariables () { - // Initialize the $content array - $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var'); - $dummy = array(); - - // 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"; - $dummy[$currVariable['name']] = $currVariable['value']; - }// END - if - - // Set the new variable (don't remove the second dollar!) - $$validVar = $dummy; - - // Prepare all configuration variables - $config = null; - if (isset($this->varStack['config'])) { - $config = $this->varStack['config']; - } // END - if - - // Remove some variables - unset($idx); - unset($currVariable); - - // Run the compilation twice to get content from helper classes in - $cnt = 0; - while ($cnt < 3) { - // Finalize the compilation of template variables - $this->finalizeVariableCompilation(); - - // Prepare the eval() command for comiling the template - $eval = sprintf("\$result = \"%s\";", - addslashes($this->getRawTemplateData()) - ); - - // This loop does remove the backslashes (\) in PHP parameters - while (strpos($eval, ""))); - $evalMiddle = stripslashes($evalMiddle); - - // Remove the middle part from right one - $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2)); - - // And put all together - $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight); - } // END - while - - // Prepare PHP code for eval() command - $eval = str_replace( - "<%php", "\";", - str_replace( - "%>", "\n\$result .= \"", $eval - ) - ); - - // Run the constructed command. This will "compile" all variables in - @eval($eval); - - // Goes something wrong? - if (!isset($result)) { - // Output eval command - $this->debugOutput(sprintf("Failed eval() code: 
%s
", $this->markupCode($eval, true)), true); - - // Output backtrace here - $this->debugBackTrace(); - } // END - if - - // Set raw template data - $this->setRawTemplateData($result); - $cnt++; - } // END - while - - // Final variable assignment - $this->finalizeVariableCompilation(); - - // Set the new content - $this->setCompiledData($this->getRawTemplateData()); - } - - /** - * Compile all required templates into the current loaded one - * - * @return void - * @throws UnexpectedTemplateTypeException If the template type is - * not "code" - * @throws InvalidArrayCountException If an unexpected array - * count has been found - */ - public function compileTemplate () { - // We will only work with template type "code" from configuration - if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) { - // Abort here - throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED); - } // END - if - - // Get the raw data. - $rawData = $this->getRawTemplateData(); - - // Remove double spaces and trim leading/trailing spaces - $rawData = trim(str_replace(" ", " ", $rawData)); - - // Search for raw variables - $this->extractVariablesFromRawData($rawData); - - // Search for code-tags which are {? ?} - preg_match_all($this->regExpCodeTags, $rawData, $templateMatches); - - // Analyze the matches array - if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) { - // Entries are found: - // - // The main analysis - $this->analyzeTemplate($templateMatches); - - // Compile raw template data - $this->compileRawTemplateData($templateMatches); - - // Are there some raw templates left for loading? - $this->loadExtraRawTemplates(); - - // 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 ... - } - - /** - * A old deprecated method - * - * @return void - * @deprecated - * @see BaseTemplateEngine::transferToResponse - */ - public function output () { - // Check which type of template we have - switch ($this->getTemplateType()) { - case "html": // Raw HTML templates can be send to the output buffer - // Quick-N-Dirty: - $this->getWebOutputInstance()->output($this->getCompiledData()); - break; - - default: // Unknown type found - // Construct message - $msg = sprintf("[%s->%s] Unknown/unsupported template type %s detected.", - $this->__toString(), - __FUNCTION__, - $this->getTemplateType() - ); - - // Write the problem to the world... - $this->debugOutput($msg); - break; - } - } - - /** - * Loads a given view helper (by name) - * - * @param $helperName The helper's name - * @return void - * @throws ViewHelperNotFoundException If the given view helper was not found - */ - protected function loadViewHelper ($helperName) { - // Make first character upper case, rest low - $helperName = ucfirst($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); - } // END - if - - // Return the requested instance - return $this->helpers[$helperName]; - } - - /** - * Assigns the last loaded raw template content with a given variable - * - * @param $templateName Name of the template we want to assign - * @param $variableName Name of the variable we want to assign - * @return void - */ - public function assignTemplateWithVariable ($templateName, $variableName) { - // Get the content from last loaded raw template - $content = $this->getRawTemplateData(); - - // Assign the variable - $this->assignVariable($variableName, $content); - - // Purge raw content - $this->setRawTemplateData(""); - } - - /** - * Transfers the content of this template engine to a given response instance - * - * @param $responseInstance An instance of a response class - * @return void - */ - public function transferToResponse (Responseable $responseInstance) { - // Get the content and set it in response class - $responseInstance->writeToBody($this->getCompiledData()); - } - - /** - * Assigns all the application data with template variables - * - * @param $appInstance A manageable application instance - * @return void - */ - public function assignApplicationData (ManageableApplication $appInstance) { - // Get long name and assign it - $this->assignVariable('app_full_name' , $appInstance->getAppName()); - - // Get short name and assign it - $this->assignVariable('app_short_name', $appInstance->getAppShortName()); - - // Get version number and assign it - $this->assignVariable('app_version' , $appInstance->getAppVersion()); - - // Assign extra application-depending data - $appInstance->assignExtraTemplateData($this); - } - - /** - * "Compiles" a variable by replacing {?var?} with it's content - * - * @param $rawCode Raw code to compile - * @return $rawCode Compile code with inserted variable value - */ - public function compileRawCode ($rawCode) { - // Find the variables - //* DEBUG: */ echo "rawCode=
".htmlentities($rawCode)."
\n"; - preg_match_all($this->regExpVarValue, $rawCode, $varMatches); - - // Compile all variables - //* DEBUG: */ echo "
".print_r($varMatches, true)."
"; - foreach ($varMatches[0] as $match) { - // Add variable tags around it - $varCode = "{?".$match."?}"; - - // Is the variable found in code? (safes some calls) - if (strpos($rawCode, $varCode) !== false) { - // Replace the variable with it's value, if found - //* DEBUG: */ echo __METHOD__.": match=".$match."
\n"; - $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode); - } // END - if - } // END - foreach - - // Return the compiled data - return $rawCode; - } - - /** - * Getter for variable group array - * - * @return $vargroups All variable groups - */ - public final function getVariableGroups () { - return $this->varGroups; - } - - /** - * Renames a variable in code and in stack - * - * @param $oldName Old name of variable - * @param $newName New name of variable - * @return void - */ - public function renameVariable ($oldName, $newName) { - //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}
\n"; - // Get raw template code - $rawData = $this->getRawTemplateData(); - - // Replace it - $rawData = str_replace($oldName, $newName, $rawData); - - // Set the code back - $this->setRawTemplateData($rawData); - } - - /** - * Renders the given XML content - * - * @param $content Valid XML content or if not set the current loaded raw content - * @return void - * @throws XmlParserException If an XML error was found - */ - public final function renderXmlContent ($content = null) { - // Is the content set? - if (is_null($content)) { - // Get current content - $content = $this->getRawTemplateData(); - } // END - if - - // Convert all to UTF8 - $content = recode("html..utf8", $content); - - // Get an XML parser - $xmlParser = xml_parser_create(); - - // Force case-folding to on - xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true); - - // Set object - xml_set_object($xmlParser, $this); - - // Set handler call-backs - xml_set_element_handler($xmlParser, 'startElement', 'endElement'); - xml_set_character_data_handler($xmlParser, 'characterHandler'); - - // Now parse the XML tree - if (!xml_parse($xmlParser, $content)) { - // Error found in XML! - //die("
".htmlentities($content)."
"); - throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR); - } // END - if - - // Free the parser - xml_parser_free($xmlParser); - } -} - -// [EOF] -?>