X-Git-Url: https://git.mxchange.org/?p=shipsimu.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ftemplate%2Fclass_TemplateEngine.php;h=7bbf2e1750b1025a6678e539e9209b7e594cefb0;hp=ee01937a364d75ebae00264c73138131e83a4b19;hb=c983485aaafb177a8dd366a7f7c0fd5db6720d55;hpb=cc6ac14e62a0ba455caffae6870f6264141b0819

diff --git a/inc/classes/main/template/class_TemplateEngine.php b/inc/classes/main/template/class_TemplateEngine.php
index ee01937..7bbf2e1 100644
--- a/inc/classes/main/template/class_TemplateEngine.php
+++ b/inc/classes/main/template/class_TemplateEngine.php
@@ -3,11 +3,11 @@
  * The own template engine for loading caching and sending out the web pages
  * and emails.
  *
- * @author		Roland Haeder <webmaster@mxchange.org>
+ * @author		Roland Haeder <webmaster@ship-simu.org>
  * @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
+ * @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
@@ -109,9 +109,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	private $helpers = array();
 
 	// Exception codes for the template engine
-	const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0xa00;
-	const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0xa01;
-	const EXCEPTION_INVALID_VIEW_HELPER           = 0xa02;
+	const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x020;
+	const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x021;
+	const EXCEPTION_INVALID_VIEW_HELPER           = 0x022;
 
 	/**
 	 * Protected constructor
@@ -123,10 +123,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		parent::__construct(__CLASS__);
 
 		// Set part description
-		$this->setObjectDescription("Template-Engine");
+		$this->setObjectDescription("Web template engine");
 
 		// Create unique ID number
-		$this->createUniqueID();
+		$this->generateUniqueId();
 
 		// Clean up a little
 		$this->removeNumberFormaters();
@@ -180,11 +180,11 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		$tplInstance->setFileIoInstance($ioInstance);
 
 		// Set template extensions
-		$tplInstance->setRawTemplateExtension($cfgInstance->readConfig("raw_template_extension"));
-		$tplInstance->setCodeTemplateExtension($cfgInstance->readConfig("code_template_extension"));
+		$tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
+		$tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
 
 		// Absolute output path for compiled templates
-		$tplInstance->setCompileOutputPath(PATH . $cfgInstance->readConfig("compile_output_path"));
+		$tplInstance->setCompileOutputPath(PATH . $cfgInstance->readConfig('compile_output_path'));
 
 		// Return the prepared instance
 		return $tplInstance;
@@ -283,6 +283,42 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		}
 	}
 
+	/**
+	 * 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) {
+		// Cast it
+		$templateType = (string) $templateType;
+
+		// And set it (only 2 letters)
+		$this->templateType = $templateType;
+	}
+
+	/**
+	 * Setter for the last loaded template's FQFN
+	 *
+	 * @param	$template	The last loaded template
+	 * @return	void
+	 */
+	private final function setLastTemplate ($template) {
+		// Cast it to string
+		$template = (string) $template;
+		$this->lastTemplate = $template;
+	}
+
+	/**
+	 * Getter for the last loaded template's FQFN
+	 *
+	 * @return	$template	The last loaded template
+	 */
+	private final function getLastTemplate () {
+		return $this->lastTemplate;
+	}
+
 	/**
 	 * Initialize the variable stack. This holds all variables for later
 	 * compilation.
@@ -290,7 +326,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 * @return	void
 	 */
 	public final function initVariableStack () {
-		$this->varStack = new FrameworkArrayObject();
+		$this->varStack = new FrameworkArrayObject("FakedVariableStack");
 	}
 
 	/**
@@ -372,8 +408,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * Setter for path of compiled templates
 	 *
-	 * @param		$compileOutputPath		The local base path for all
-	 *								compiled templates
+	 * @param	$compileOutputPath	The local base path for all compiled
+	 *								templates
 	 * @return	void
 	 */
 	public final function setCompileOutputPath ($compileOutputPath) {
@@ -384,21 +420,6 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		$this->compileOutputPath = $compileOutputPath;
 	}
 
-	/**
-	 * 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) {
-		// Cast it
-		$templateType = (string) $templateType;
-
-		// And set it (only 2 letters)
-		$this->templateType = $templateType;
-	}
-
 	/**
 	 * Getter for template type
 	 *
@@ -408,32 +429,11 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		return $this->templateType;
 	}
 
-	/**
-	 * Setter for the last loaded template's FQFN
-	 *
-	 * @param		$template		The last loaded template
-	 * @return	void
-	 */
-	private final function setLastTemplate ($template) {
-		// Cast it to string
-		$template = (string) $template;
-		$this->lastTemplate = $template;
-	}
-
-	/**
-	 * Getter for the last loaded template's FQFN
-	 *
-	 * @return	$template		The last loaded template
-	 */
-	private final function getLastTemplate () {
-		return $this->lastTemplate;
-	}
-
 	/**
 	 * Assign (add) a given variable with a value
 	 *
-	 * @param		$var		The variable we are looking for
-	 * @param		$value	The value we want to store in the variable
+	 * @param	$var	The variable we are looking for
+	 * @param	$value	The value we want to store in the variable
 	 * @return	void
 	 */
 	public final function assignVariable ($var, $value) {
@@ -450,22 +450,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		}
 	}
 
-	/**
-	 * Assign a given congfiguration variable with a value
-	 *
-	 * @param		$var		The configuration variable we are looking for
-	 * @param		$value	The value we want to store in the variable
-	 * @return	void
-	 */
-	public final function assignConfigVariable ($var, $value) {
-		// Sweet and simple...
-		$this->configVariables[$var] = $value;
-	}
-
 	/**
 	 * Removes a given variable
 	 *
-	 * @param		$var		The variable we are looking for
+	 * @param	$var	The variable we are looking for
 	 * @return	void
 	 */
 	public final function removeVariable ($var) {
@@ -482,7 +470,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * Private setter for raw template data
 	 *
-	 * @param		$rawTemplateData	The raw data from the template
+	 * @param	$rawTemplateData	The raw data from the template
 	 * @return	void
 	 */
 	private final function setRawTemplateData ($rawTemplateData) {
@@ -495,6 +483,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 
 	/**
 	 * Private setter for compiled templates
+	 *
+	 * @return	void
 	 */
 	private final function setCompiledData ($compiledData) {
 		// Cast it to string
@@ -507,10 +497,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * Private loader for all template types
 	 *
-	 * @param		$template		The template we shall load
+	 * @param	$template	The template we shall load
 	 * @return	void
 	 */
-	private final function loadTemplate ($template) {
+	private function loadTemplate ($template) {
 		// Cast it to string
 		$template = (string) $template;
 
@@ -518,7 +508,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 		$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")) {
+		if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) {
 			// Switch over to the code-template extension
 			$ext = $this->getCodeTemplateExtension();
 		}
@@ -539,12 +529,12 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * A private loader for raw template names
 	 *
-	 * @param		$fqfn	The full-qualified file name for a template
+	 * @param	$fqfn	The full-qualified file name for a template
 	 * @return	void
 	 * @throws	NullPointerException	If $inputInstance is null
 	 * @throws	NoObjectException		If $inputInstance is not an object
 	 * @throws	MissingMethodException	If $inputInstance is missing a
-	 *								required method
+	 *									required method
 	 */
 	private function loadRawTemplateData ($fqfn) {
 		// Get a input/output instance from the middleware
@@ -576,9 +566,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 * Try to assign an extracted template variable as a "content" or "config"
 	 * variable.
 	 *
-	 * @param		$varName		The variable's name (shall be content or
-	 *						config) by default
-	 * @param		$var			The variable we want to assign
+	 * @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?
@@ -587,7 +577,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 			$this->assignVariable($var, "");
 		} else {
 			// Configuration variables
-			$this->assignConfigVariable($var, $this->getConfigInstance()->readConfig($var));
+			$this->assignConfigVariable($var);
 		}
 	}
 
@@ -617,7 +607,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * Main analysis of the loaded template
 	 *
-	 * @param		$templateMatches	Found template place-holders, see below
+	 * @param	$templateMatches	Found template place-holders, see below
 	 * @return	void
 	 *
 	 *---------------------------------
@@ -642,24 +632,24 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 			// RECURSIVE PROTECTION! BE CAREFUL HERE!
 			if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
 
-				// Then try to search for code-templates first
-				try {
-					// Load the code template and remember it's contents
-					$this->loadCodeTemplate($template);
-					$this->loadedRawData[$template] = $this->getRawTemplateData();
+				// Template not found, but maybe variable assigned?
+				if ($this->isVariableAlreadySet($template) !== false) {
+					// Use that content here
+					$this->loadedRawData[$template] = $this->readVariable($template);
 
-					// Remember this template for recursion detection
-					// RECURSIVE PROTECTION!
+					// Recursive protection:
 					$this->loadedTemplates[] = $template;
-				} catch (FilePointerNotOpenedException $e) {
-					// Template not found, but maybe variable assigned?
-					if ($this->isVariableAlreadySet($template) !== false) {
-						// Use that content here
-						$this->loadedRawData[$template] = $this->readVariable($template);
-
-						// Recursive protection:
+				} 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;
-					} else {
+					} catch (FilePointerNotOpenedException $e) {
 						// Even this is not done... :/
 						$this->rawTemplates[] = $template;
 					}
@@ -676,8 +666,8 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	/**
 	 * Compile a given raw template code and remember it for later usage
 	 *
-	 * @param		$code		The raw template code
-	 * @param		$template		The template's name
+	 * @param	$code		The raw template code
+	 * @param	$template	The template's name
 	 * @return	void
 	 */
 	private function compileCode ($code, $template) {
@@ -712,7 +702,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 * 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()
+	 * @param	$templateMatches	See method analyzeTemplate()
 	 * @return	void
 	 */
 	private function insertAllTemplates (array $templateMatches) {
@@ -792,7 +782,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 				$this->assignVariable($var, $varMatches[3][$key]);
 			} elseif (!empty($varMatches[2][$key])) {
 				// Non-string found so we need some deeper analysis...
-				// @TODO Unfinished work or don't die here.
+				/* @TODO Unfinished work or don't die here. */
 				die("Deeper analysis not yet implemented!");
 			}
 
@@ -903,14 +893,25 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 *						located in "html" by default
 	 * @return	void
 	 */
-	public final function loadWebTemplate ($template) {
+	public function loadWebTemplate ($template) {
 		// Set template type
-		$this->setTemplateType($this->getConfigInstance()->readConfig("web_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...
+		$this->configVariables[$var] = $this->getConfigInstance()->readConfig($var);
+	}
+
 	/**
 	 * Load a specified email template into the engine
 	 *
@@ -918,9 +919,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 *						located in "emails" by default
 	 * @return	void
 	 */
-	public final function loadEmailTemplate ($template) {
+	public function loadEmailTemplate ($template) {
 		// Set template type
-		$this->setTemplateType($this->getConfigInstance()->readConfig("email_template_type"));
+		$this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
 
 		// Load the special template
 		$this->loadTemplate($template);
@@ -933,9 +934,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 *						located in "code" by default
 	 * @return	void
 	 */
-	public final function loadCodeTemplate ($template) {
+	public function loadCodeTemplate ($template) {
 		// Set template type
-		$this->setTemplateType($this->getConfigInstance()->readConfig("code_template_type"));
+		$this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
 
 		// Load the special template
 		$this->loadTemplate($template);
@@ -948,7 +949,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 */
 	public final function compileVariables () {
 		// Initialize the $content array
-		$validVar = $this->getConfigInstance()->readConfig("tpl_valid_var");
+		$validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
 		$dummy = array();
 
 		// Iterate through all variables
@@ -985,7 +986,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 			);
 
 			// This loop does remove the backslashes (\) in PHP parameters
-			// @TODO Make this some nicer...
+			/* @TODO Make this some nicer... */
 			while (strpos($eval, "<?") !== false) {
 				// Get left part before "<?"
 				$evalLeft = substr($eval, 0, strpos($eval, "<?"));
@@ -1047,9 +1048,9 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 	 */
 	public final function compileTemplate () {
 		// We will only work with template type "code" from configuration
-		if ($this->getTemplateType() != $this->getConfigInstance()->readConfig("code_template_type")) {
+		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);
+			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.