CSS classes formed to ids and command LocalHome finished
[shipsimu.git] / inc / classes / main / template / class_TemplateEngine.php
index 4fdb1a34dfb042c17b6adfb31866ca5b4235c0ea..980f56c9426b1e6eab6b451a96240bf46f41f59c 100644 (file)
@@ -4,10 +4,10 @@
  * and emails.
  *
  * @author             Roland Haeder <webmaster@mxchange.org>
- * @version            0.3.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.mxchange.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
@@ -194,7 +194,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * 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
+        * @return      $idx            FALSE means not found, >=0 means found on a specific index
         */
        private function isVariableAlreadySet ($var) {
                // First everything is not found
@@ -217,6 +217,33 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                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
+        */
+       private function readVariable ($var) {
+               // First everything is not found
+               $content = null;
+
+               // Now search for it
+               for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
+                       // Get current item
+                       $currEntry = $idx->current();
+
+                       // Is the entry found?
+                       if ($currEntry['name'] == $var) {
+                               // Found!
+                               $content = $currEntry['value'];
+                               break;
+                       }
+               }
+
+               // Return the current position
+               return $content;
+       }
+
        /**
         * Add a variable to the stack
         *
@@ -623,7 +650,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * [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 ($templateMatches) {
+       private function analyzeTemplate (array $templateMatches) {
                // Backup raw template data
                $backup = $this->getRawTemplateData();
 
@@ -647,8 +674,17 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                                        // RECURSIVE PROTECTION!
                                        $this->loadedTemplates[] = $template;
                                } catch (FilePointerNotOpenedException $e) {
-                                       // Template not found!
-                                       $this->rawTemplates[] = $template;
+                                       // Template not found, but maybe variable assigned?
+                                       if ($this->isVariableAlreadySet($template) !== false) {
+                                               // Use that content here
+                                               $this->loadedRawData[$template] = $this->readVariable($template);
+
+                                               // Recursive protection:
+                                               $this->loadedTemplates[] = $template;
+                                       } else {
+                                               // Even this is not done... :/
+                                               $this->rawTemplates[] = $template;
+                                       }
                                }
 
                        } // if ((!isset( ...
@@ -701,15 +737,15 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * @param               $templateMatches        See method analyzeTemplate()
         * @return      void
         */
-       private function insertAllTemplates ($templateMatches) {
+       private function insertAllTemplates (array $templateMatches) {
                // Run through all loaded codes
-               foreach ($this->loadedRawData as $template => $code) {
+               foreach ($this->loadedRawData as $template=>$code) {
 
                        // Search for the template
                        $foundIndex = array_search($template, $templateMatches[1]);
 
                        // Lookup the matching template replacement
-                       if (isset($templateMatches[0][$foundIndex])) {
+                       if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
 
                                // Get the current raw template
                                $rawData = $this->getRawTemplateData();
@@ -719,8 +755,10 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
 
                                // Set the new raw data
                                $this->setRawTemplateData($rawData);
-                       }
-               }
+
+                       } // END - if
+
+               } // END - foreach
        }
 
        /**
@@ -760,7 +798,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * @param               $varMatches     An array full of variable/value pairs.
         * @return      void
         */
-       private function assignAllVariables ($varMatches) {
+       private function assignAllVariables (array $varMatches) {
                // Search for all variables
                foreach ($varMatches[1] as $key=>$var) {
 
@@ -788,21 +826,27 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
         * @param               $templateMatches        See method analyzeTemplate() for details
         * @return      void
         */
-       private function compileRawTemplateData ($templateMatches) {
+       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) {
+                       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 (isset($templateMatches[3][$foundIndex])) {
+                               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);
+                                       preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
 
                                        // Assign all variables
                                        $this->assignAllVariables($varMatches);
@@ -951,7 +995,7 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                $this->extractVariablesFromRawData($rawData);
 
                // Search for code-tags which are {? ?}
-               @preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
+               preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
 
                // Analyze the matches array
                if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
@@ -1044,6 +1088,35 @@ class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate
                // 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 the response class
+               $responseInstance->writeToBody($this->getCompiledData());
+       }
 }
 
 // [EOF]