7bbf2e1750b1025a6678e539e9209b7e594cefb0
[shipsimu.git] / inc / classes / main / template / class_TemplateEngine.php
1 <?php
2 /**
3  * The own template engine for loading caching and sending out the web pages
4  * and emails.
5  *
6  * @author              Roland Haeder <webmaster@ship-simu.org>
7  * @version             0.0.0
8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
9  * @license             GNU GPL 3.0 or any newer version
10  * @link                http://www.ship-simu.org
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate {
26         /**
27          * The local path name where all templates and sub folders for special
28          * templates are stored. We will internally determine the language plus
29          * "html" for web templates or "emails" for email templates
30          */
31         private $basePath = "";
32
33         /**
34          * The extension for web and email templates (not compiled templates)
35          */
36         private $templateExtension = ".tpl";
37
38         /**
39          * The extension for code templates (not compiled templates)
40          */
41         private $codeExtension = ".ctp";
42
43         /**
44          * Path relative to $basePath and language code for compiled code-templates
45          */
46         private $compileOutputPath = "templates/_compiled";
47
48         /**
49          * The raw (maybe uncompiled) template
50          */
51         private $rawTemplateData = "";
52
53         /**
54          * Template data with compiled-in variables
55          */
56         private $compiledData = "";
57
58         /**
59          * The last loaded template's FQFN for debugging the engine
60          */
61         private $lastTemplate = "";
62
63         /**
64          * The variable stack for the templates. This must be initialized and
65          * shall become an instance of FrameworkArrayObject.
66          */
67         private $varStack = null;
68
69         /**
70          * Configuration variables in a simple array
71          */
72         private $configVariables = array();
73
74         /**
75          * Loaded templates for recursive protection and detection
76          */
77         private $loadedTemplates = array();
78
79         /**
80          * Compiled templates for recursive protection and detection
81          */
82         private $compiledTemplates = array();
83
84         /**
85          * Loaded raw template data
86          */
87         private $loadedRawData = null;
88
89         /**
90          * Raw templates which are linked in code templates
91          */
92         private $rawTemplates = null;
93
94         /**
95          * A regular expression for variable=value pairs
96          */
97         private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
98
99         /**
100          * A regular expression for filtering out code tags
101          *
102          * E.g.: {?template:variable=value;var2=value2;[...]?}
103          */
104         private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
105
106         /**
107          * Loaded helpers
108          */
109         private $helpers = array();
110
111         // Exception codes for the template engine
112         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x020;
113         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x021;
114         const EXCEPTION_INVALID_VIEW_HELPER           = 0x022;
115
116         /**
117          * Protected constructor
118          *
119          * @return      void
120          */
121         protected function __construct () {
122                 // Call parent constructor
123                 parent::__construct(__CLASS__);
124
125                 // Set part description
126                 $this->setObjectDescription("Web template engine");
127
128                 // Create unique ID number
129                 $this->generateUniqueId();
130
131                 // Clean up a little
132                 $this->removeNumberFormaters();
133                 $this->removeSystemArray();
134         }
135
136         /**
137          * Creates an instance of the class TemplateEngine and prepares it for usage
138          *
139          * @param       $basePath               The local base path for all templates
140          * @param       $langInstance   An instance of LanguageSystem (default)
141          * @param       $ioInstance             An instance of FileIoHandler (default, middleware!)
142          * @return      $tplInstance    An instance of TemplateEngine
143          * @throws      BasePathIsEmptyException                If the provided $basePath is empty
144          * @throws      InvalidBasePathStringException  If $basePath is no string
145          * @throws      BasePathIsNoDirectoryException  If $basePath is no
146          *                                                                                      directory or not found
147          * @throws      BasePathReadProtectedException  If $basePath is
148          *                                                                                      read-protected
149          */
150         public final static function createTemplateEngine ($basePath, ManageableLanguage  $langInstance, FileIoHandler $ioInstance) {
151                 // Get a new instance
152                 $tplInstance = new TemplateEngine();
153
154                 // Is the base path valid?
155                 if (empty($basePath)) {
156                         // Base path is empty
157                         throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
158                 } elseif (!is_string($basePath)) {
159                         // Is not a string
160                         throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
161                 } elseif (!is_dir($basePath)) {
162                         // Is not a path
163                         throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
164                 } elseif (!is_readable($basePath)) {
165                         // Is not readable
166                         throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
167                 }
168
169                 // Get configuration instance
170                 $cfgInstance = FrameworkConfiguration::getInstance();
171
172                 // Set the base path
173                 $tplInstance->setBasePath($basePath);
174
175                 // Initialize the variable stack
176                 $tplInstance->initVariableStack();
177
178                 // Set the language and IO instances
179                 $tplInstance->setLanguageInstance($langInstance);
180                 $tplInstance->setFileIoInstance($ioInstance);
181
182                 // Set template extensions
183                 $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
184                 $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
185
186                 // Absolute output path for compiled templates
187                 $tplInstance->setCompileOutputPath(PATH . $cfgInstance->readConfig('compile_output_path'));
188
189                 // Return the prepared instance
190                 return $tplInstance;
191         }
192
193         /**
194          * Search for a variable in the stack
195          *
196          * @param               $var            The variable we are looking for
197          * @return      $idx            FALSE means not found, >=0 means found on a specific index
198          */
199         private function isVariableAlreadySet ($var) {
200                 // First everything is not found
201                 $found = false;
202
203                 // Now search for it
204                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
205                         // Get current item
206                         $currEntry = $idx->current();
207
208                         // Is the entry found?
209                         if ($currEntry['name'] == $var) {
210                                 // Found!
211                                 $found = $idx->key();
212                                 break;
213                         }
214                 }
215
216                 // Return the current position
217                 return $found;
218         }
219
220         /**
221          * Return a content of a variable or null if not found
222          *
223          * @param       $var            The variable we are looking for
224          * @return      $content        Content of the variable or null if not found
225          */
226         private function readVariable ($var) {
227                 // First everything is not found
228                 $content = null;
229
230                 // Now search for it
231                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
232                         // Get current item
233                         $currEntry = $idx->current();
234
235                         // Is the entry found?
236                         if ($currEntry['name'] == $var) {
237                                 // Found!
238                                 $content = $currEntry['value'];
239                                 break;
240                         }
241                 }
242
243                 // Return the current position
244                 return $content;
245         }
246
247         /**
248          * Add a variable to the stack
249          *
250          * @param               $var            The variable we are looking for
251          * @param               $value  The value we want to store in the variable
252          * @return      void
253          */
254         private function addVariable ($var, $value) {
255                 // Add it to the stack
256                 $this->varStack->append(array(
257                         'name'  => trim($var),
258                         'value' => trim($value)
259                 ));
260         }
261
262         /**
263          * Modify an entry on the stack
264          *
265          * @param               $var            The variable we are looking for
266          * @param               $value  The value we want to store in the variable
267          * @return      void
268          */
269         private function modifyVariable ($var, $value) {
270                 // It should be there so let's look again...
271                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
272                         // Get current entry
273                         $currEntry = $idx->current();
274
275                         // Is this the requested variable?
276                         if ($currEntry['name'] == $var) {
277                                 // Change it to the other value
278                                 $this->varStack->offsetSet($idx->key(), array(
279                                         'name'  => $var,
280                                         'value' => $value
281                                 ));
282                         }
283                 }
284         }
285
286         /**
287          * Setter for template type. Only "html", "emails" and "compiled" should
288          * be sent here
289          *
290          * @param       $templateType   The current template's type
291          * @return      void
292          */
293         private final function setTemplateType ($templateType) {
294                 // Cast it
295                 $templateType = (string) $templateType;
296
297                 // And set it (only 2 letters)
298                 $this->templateType = $templateType;
299         }
300
301         /**
302          * Setter for the last loaded template's FQFN
303          *
304          * @param       $template       The last loaded template
305          * @return      void
306          */
307         private final function setLastTemplate ($template) {
308                 // Cast it to string
309                 $template = (string) $template;
310                 $this->lastTemplate = $template;
311         }
312
313         /**
314          * Getter for the last loaded template's FQFN
315          *
316          * @return      $template       The last loaded template
317          */
318         private final function getLastTemplate () {
319                 return $this->lastTemplate;
320         }
321
322         /**
323          * Initialize the variable stack. This holds all variables for later
324          * compilation.
325          *
326          * @return      void
327          */
328         public final function initVariableStack () {
329                 $this->varStack = new FrameworkArrayObject("FakedVariableStack");
330         }
331
332         /**
333          * Setter for base path
334          *
335          * @param               $basePath               The local base path for all templates
336          * @return      void
337          */
338         public final function setBasePath ($basePath) {
339                 // Cast it
340                 $basePath = (string) $basePath;
341
342                 // And set it
343                 $this->basePath = $basePath;
344         }
345
346         /**
347          * Getter for base path
348          *
349          * @return      $basePath               The local base path for all templates
350          */
351         public final function getBasePath () {
352                 // And set it
353                 return $this->basePath;
354         }
355
356         /**
357          * Setter for template extension
358          *
359          * @param               $templateExtension      The file extension for all uncompiled
360          *                                                      templates
361          * @return      void
362          */
363         public final function setRawTemplateExtension ($templateExtension) {
364                 // Cast it
365                 $templateExtension = (string) $templateExtension;
366
367                 // And set it
368                 $this->templateExtension = $templateExtension;
369         }
370
371         /**
372          * Setter for code template extension
373          *
374          * @param               $codeExtension          The file extension for all uncompiled
375          *                                                      templates
376          * @return      void
377          */
378         public final function setCodeTemplateExtension ($codeExtension) {
379                 // Cast it
380                 $codeExtension = (string) $codeExtension;
381
382                 // And set it
383                 $this->codeExtension = $codeExtension;
384         }
385
386         /**
387          * Getter for template extension
388          *
389          * @return      $templateExtension      The file extension for all uncompiled
390          *                                                      templates
391          */
392         public final function getRawTemplateExtension () {
393                 // And set it
394                 return $this->templateExtension;
395         }
396
397         /**
398          * Getter for code-template extension
399          *
400          * @return      $codeExtension          The file extension for all code-
401          *                                                      templates
402          */
403         public final function getCodeTemplateExtension () {
404                 // And set it
405                 return $this->codeExtension;
406         }
407
408         /**
409          * Setter for path of compiled templates
410          *
411          * @param       $compileOutputPath      The local base path for all compiled
412          *                                                              templates
413          * @return      void
414          */
415         public final function setCompileOutputPath ($compileOutputPath) {
416                 // Cast it
417                 $compileOutputPath = (string) $compileOutputPath;
418
419                 // And set it
420                 $this->compileOutputPath = $compileOutputPath;
421         }
422
423         /**
424          * Getter for template type
425          *
426          * @return      $templateType   The current template's type
427          */
428         public final function getTemplateType () {
429                 return $this->templateType;
430         }
431
432         /**
433          * Assign (add) a given variable with a value
434          *
435          * @param       $var    The variable we are looking for
436          * @param       $value  The value we want to store in the variable
437          * @return      void
438          */
439         public final function assignVariable ($var, $value) {
440                 // First search for the variable if it was already added
441                 $idx = $this->isVariableAlreadySet($var);
442
443                 // Was it found?
444                 if ($idx === false) {
445                         // Add it to the stack
446                         $this->addVariable($var, $value);
447                 } elseif (!empty($value)) {
448                         // Modify the stack entry
449                         $this->modifyVariable($var, $value);
450                 }
451         }
452
453         /**
454          * Removes a given variable
455          *
456          * @param       $var    The variable we are looking for
457          * @return      void
458          */
459         public final function removeVariable ($var) {
460                 // First search for the variable if it was already added
461                 $idx = $this->isVariableAlreadySet($var);
462
463                 // Was it found?
464                 if ($idx !== false) {
465                         // Remove this variable
466                         $this->varStack->offsetUnset($idx);
467                 }
468         }
469
470         /**
471          * Private setter for raw template data
472          *
473          * @param       $rawTemplateData        The raw data from the template
474          * @return      void
475          */
476         private final function setRawTemplateData ($rawTemplateData) {
477                 // Cast it to string
478                 $rawTemplateData = (string) $rawTemplateData;
479
480                 // And store it in this class
481                 $this->rawTemplateData = $rawTemplateData;
482         }
483
484         /**
485          * Private setter for compiled templates
486          *
487          * @return      void
488          */
489         private final function setCompiledData ($compiledData) {
490                 // Cast it to string
491                 $compiledData = (string) $compiledData;
492
493                 // And store it in this class
494                 $this->compiledData = $compiledData;
495         }
496
497         /**
498          * Private loader for all template types
499          *
500          * @param       $template       The template we shall load
501          * @return      void
502          */
503         private function loadTemplate ($template) {
504                 // Cast it to string
505                 $template = (string) $template;
506
507                 // Get extension for the template
508                 $ext = $this->getRawTemplateExtension();
509
510                 // If we shall load a code-template we need to switch the file extension
511                 if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) {
512                         // Switch over to the code-template extension
513                         $ext = $this->getCodeTemplateExtension();
514                 }
515
516                 // Construct the FQFN for the template by honoring the current language
517                 $fqfn = sprintf("%s%s/%s/%s%s",
518                         $this->getBasePath(),
519                         $this->getLanguageInstance()->getLanguageCode(),
520                         $this->getTemplateType(),
521                         $template,
522                         $ext
523                 );
524
525                 // Load the raw template data
526                 $this->loadRawTemplateData($fqfn);
527         }
528
529         /**
530          * A private loader for raw template names
531          *
532          * @param       $fqfn   The full-qualified file name for a template
533          * @return      void
534          * @throws      NullPointerException    If $inputInstance is null
535          * @throws      NoObjectException               If $inputInstance is not an object
536          * @throws      MissingMethodException  If $inputInstance is missing a
537          *                                                                      required method
538          */
539         private function loadRawTemplateData ($fqfn) {
540                 // Get a input/output instance from the middleware
541                 $ioInstance = $this->getFileIoInstance();
542
543                 // Validate the instance
544                 if (is_null($ioInstance)) {
545                         // Throw exception
546                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
547                 } elseif (!is_object($ioInstance)) {
548                         // Throw another exception
549                         throw new NoObjectException($ioInstance, self::EXCEPTION_IS_NO_OBJECT);
550                 } elseif (!method_exists($ioInstance, 'loadFileContents')) {
551                         // Throw yet another exception
552                         throw new MissingMethodException(array($ioInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
553                 }
554
555                 // Load the raw template
556                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
557
558                 // Store the template's contents into this class
559                 $this->setRawTemplateData($rawTemplateData);
560
561                 // Remember the template's FQFN
562                 $this->setLastTemplate($fqfn);
563         }
564
565         /**
566          * Try to assign an extracted template variable as a "content" or "config"
567          * variable.
568          *
569          * @param       $varName        The variable's name (shall be content orconfig) by
570          *                                              default
571          * @param       $var            The variable we want to assign
572          */
573         private function assignTemplateVariable ($varName, $var) {
574                 // Is it not a config variable?
575                 if ($varName != "config") {
576                         // Regular template variables
577                         $this->assignVariable($var, "");
578                 } else {
579                         // Configuration variables
580                         $this->assignConfigVariable($var);
581                 }
582         }
583
584         /**
585          * Extract variables from a given raw data stream
586          *
587          * @param       $rawData        The raw template data we shall analyze
588          * @return      void
589          */
590         private function extractVariablesFromRawData ($rawData) {
591                 // Cast to string
592                 $rawData = (string) $rawData;
593
594                 // Search for variables
595                 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
596
597                 // Did we find some variables?
598                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
599                         // Initialize all missing variables
600                         foreach ($variableMatches[3] as $key=>$var) {
601                                 // Try to assign it, empty strings are being ignored
602                                 $this->assignTemplateVariable($variableMatches[1][$key], $var);
603                         }
604                 }
605         }
606
607         /**
608          * Main analysis of the loaded template
609          *
610          * @param       $templateMatches        Found template place-holders, see below
611          * @return      void
612          *
613          *---------------------------------
614          * Structure of $templateMatches:
615          *---------------------------------
616          * [0] => Array - An array with all full matches
617          * [1] => Array - An array with left part (before the ":") of a match
618          * [2] => Array - An array with right part of a match including ":"
619          * [3] => Array - An array with right part of a match excluding ":"
620          */
621         private function analyzeTemplate (array $templateMatches) {
622                 // Backup raw template data
623                 $backup = $this->getRawTemplateData();
624
625                 // Initialize some arrays
626                 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
627
628                 // Load all requested templates
629                 foreach ($templateMatches[1] as $template) {
630
631                         // Load and compile only templates which we have not yet loaded
632                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
633                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
634
635                                 // Template not found, but maybe variable assigned?
636                                 if ($this->isVariableAlreadySet($template) !== false) {
637                                         // Use that content here
638                                         $this->loadedRawData[$template] = $this->readVariable($template);
639
640                                         // Recursive protection:
641                                         $this->loadedTemplates[] = $template;
642                                 } else {
643                                         // Then try to search for code-templates
644                                         try {
645                                                 // Load the code template and remember it's contents
646                                                 $this->loadCodeTemplate($template);
647                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
648
649                                                 // Remember this template for recursion detection
650                                                 // RECURSIVE PROTECTION!
651                                                 $this->loadedTemplates[] = $template;
652                                         } catch (FilePointerNotOpenedException $e) {
653                                                 // Even this is not done... :/
654                                                 $this->rawTemplates[] = $template;
655                                         }
656                                 }
657
658                         } // if ((!isset( ...
659
660                 } // for ($templateMatches ...
661
662                 // Restore the raw template data
663                 $this->setRawTemplateData($backup);
664         }
665
666         /**
667          * Compile a given raw template code and remember it for later usage
668          *
669          * @param       $code           The raw template code
670          * @param       $template       The template's name
671          * @return      void
672          */
673         private function compileCode ($code, $template) {
674                 // Is this template already compiled?
675                 if (in_array($template, $this->compiledTemplates)) {
676                         // Abort here...
677                         return;
678                 }
679
680                 // Remember this template being compiled
681                 $this->compiledTemplates[] = $template;
682
683                 // Compile the loaded code in five steps:
684                 //
685                 // 1. Backup current template data
686                 $backup = $this->getRawTemplateData();
687
688                 // 2. Set the current template's raw data as the new content
689                 $this->setRawTemplateData($code);
690
691                 // 3. Compile the template data
692                 $this->compileTemplate();
693
694                 // 4. Remember it's contents
695                 $this->loadedRawData[$template] = $this->getRawTemplateData();
696
697                 // 5. Restore the previous raw content from backup variable
698                 $this->setRawTemplateData($backup);
699         }
700
701         /**
702          * Insert all given and loaded templates by running through all loaded
703          * codes and searching for their place-holder in the main template
704          *
705          * @param       $templateMatches        See method analyzeTemplate()
706          * @return      void
707          */
708         private function insertAllTemplates (array $templateMatches) {
709                 // Run through all loaded codes
710                 foreach ($this->loadedRawData as $template=>$code) {
711
712                         // Search for the template
713                         $foundIndex = array_search($template, $templateMatches[1]);
714
715                         // Lookup the matching template replacement
716                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
717
718                                 // Get the current raw template
719                                 $rawData = $this->getRawTemplateData();
720
721                                 // Replace the space holder with the template code
722                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
723
724                                 // Set the new raw data
725                                 $this->setRawTemplateData($rawData);
726
727                         } // END - if
728
729                 } // END - foreach
730         }
731
732         /**
733          * Load all extra raw templates
734          *
735          * @return      void
736          */
737         private function loadExtraRawTemplates () {
738                 // Are there some raw templates we need to load?
739                 if (count($this->rawTemplates) > 0) {
740                         // Try to load all raw templates
741                         foreach ($this->rawTemplates as $key => $template) {
742                                 try {
743                                         // Load the template
744                                         $this->loadWebTemplate($template);
745
746                                         // Remember it's contents
747                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
748
749                                         // Remove it from the loader list
750                                         unset($this->rawTemplates[$key]);
751
752                                         // Remember this template for recursion detection
753                                         // RECURSIVE PROTECTION!
754                                         $this->loadedTemplates[] = $template;
755                                 } catch (FilePointerNotOpenedException $e) {
756                                         // This template was never found. We silently ignore it
757                                         unset($this->rawTemplates[$key]);
758                                 }
759                         }
760                 }
761         }
762
763         /**
764          * Assign all found template variables
765          *
766          * @param               $varMatches     An array full of variable/value pairs.
767          * @return      void
768          */
769         private function assignAllVariables (array $varMatches) {
770                 // Search for all variables
771                 foreach ($varMatches[1] as $key=>$var) {
772
773                         // Detect leading equals
774                         if (substr($varMatches[2][$key], 0, 1) == "=") {
775                                 // Remove and cast it
776                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
777                         }
778
779                         // Do we have some quotes left and right side? Then it is free text
780                         if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
781                                 // Free string detected! Which we can assign directly
782                                 $this->assignVariable($var, $varMatches[3][$key]);
783                         } elseif (!empty($varMatches[2][$key])) {
784                                 // Non-string found so we need some deeper analysis...
785                                 /* @TODO Unfinished work or don't die here. */
786                                 die("Deeper analysis not yet implemented!");
787                         }
788
789                 } // for ($varMatches ...
790         }
791         /**
792          * Compiles all loaded raw templates
793          *
794          * @param               $templateMatches        See method analyzeTemplate() for details
795          * @return      void
796          */
797         private function compileRawTemplateData (array $templateMatches) {
798                 // Are some code-templates found which we need to compile?
799                 if (count($this->loadedRawData) > 0) {
800
801                         // Then compile all!
802                         foreach ($this->loadedRawData as $template=>$code) {
803
804                                 // Is this template already compiled?
805                                 if (in_array($template, $this->compiledTemplates)) {
806                                         // Then skip it
807                                         continue;
808                                 }
809
810                                 // Search for the template
811                                 $foundIndex = array_search($template, $templateMatches[1]);
812
813                                 // Lookup the matching variable data
814                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
815
816                                         // Split it up with another reg. exp. into variable=value pairs
817                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
818
819                                         // Assign all variables
820                                         $this->assignAllVariables($varMatches);
821
822                                 } // END - if (isset($templateMatches ...
823
824                                 // Compile the loaded template
825                                 $this->compileCode($code, $template);
826
827                         } // END - foreach ($this->loadedRawData ...
828
829                         // Insert all templates
830                         $this->insertAllTemplates($templateMatches);
831
832                 } // END - if (count($this->loadedRawData) ...
833         }
834
835         /**
836          * Inserts all raw templates into their respective variables
837          *
838          * @return      void
839          */
840         private function insertRawTemplates () {
841                 // Load all templates
842                 foreach ($this->rawTemplates as $template=>$content) {
843                         // Set the template as a variable with the content
844                         $this->assignVariable($template, $content);
845                 }
846         }
847
848         /**
849          * Finalizes the compilation of all template variables
850          *
851          * @return      void
852          */
853         private function finalizeVariableCompilation () {
854                 // Get the content
855                 $content = $this->getRawTemplateData();
856
857                 // Walk through all variables
858                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
859                         // Get current entry
860                         $currEntry = $idx->current();
861
862                         // Replace all [$var] or {?$var?} with the content
863                         //* DEBUG: */ echo "name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
864                         $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content);
865                         $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content);
866                         $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content);
867                 } // END - for
868
869                 // Set the content back
870                 $this->setRawTemplateData($content);
871         }
872
873         /**
874          * Getter for raw template data
875          *
876          * @return      $rawTemplateData        The raw data from the template
877          */
878         public final function getRawTemplateData () {
879                 return $this->rawTemplateData;
880         }
881
882         /**
883          * Getter for compiled templates
884          */
885         public final function getCompiledData () {
886                 return $this->compiledData;
887         }
888
889         /**
890          * Load a specified web template into the engine
891          *
892          * @param               $template               The web template we shall load which is
893          *                                              located in "html" by default
894          * @return      void
895          */
896         public function loadWebTemplate ($template) {
897                 // Set template type
898                 $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
899
900                 // Load the special template
901                 $this->loadTemplate($template);
902         }
903
904         /**
905          * Assign a given congfiguration variable with a value
906          *
907          * @param       $var    The configuration variable we want to assign
908          * @return      void
909          */
910         public function assignConfigVariable ($var) {
911                 // Sweet and simple...
912                 $this->configVariables[$var] = $this->getConfigInstance()->readConfig($var);
913         }
914
915         /**
916          * Load a specified email template into the engine
917          *
918          * @param               $template               The email template we shall load which is
919          *                                              located in "emails" by default
920          * @return      void
921          */
922         public function loadEmailTemplate ($template) {
923                 // Set template type
924                 $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
925
926                 // Load the special template
927                 $this->loadTemplate($template);
928         }
929
930         /**
931          * Load a specified code template into the engine
932          *
933          * @param               $template               The code template we shall load which is
934          *                                              located in "code" by default
935          * @return      void
936          */
937         public function loadCodeTemplate ($template) {
938                 // Set template type
939                 $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
940
941                 // Load the special template
942                 $this->loadTemplate($template);
943         }
944
945         /**
946          * Compile all variables by inserting their respective values
947          *
948          * @return      void
949          */
950         public final function compileVariables () {
951                 // Initialize the $content array
952                 $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
953                 $dummy = array();
954
955                 // Iterate through all variables
956                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
957
958                         // Get current variable from the stack
959                         $currVariable = $idx->current();
960
961                         // Transfer it's name/value combination to the $content array
962                         //* DEBUG: */ echo $currVariable['name']."=<pre>".htmlentities($currVariable['value'])."</pre>\n";
963                         $dummy[$currVariable['name']] = $currVariable['value'];
964
965                 }// END - if
966
967                 // Set the new variable (don't remove the second dollar !)
968                 $$validVar = $dummy;
969
970                 // Prepare all configuration variables
971                 $config = $this->configVariables;
972
973                 // Remove some variables
974                 unset($idx);
975                 unset($currVariable);
976
977                 // Run the compilation twice to get content from helper classes in
978                 $cnt = 0;
979                 while ($cnt < 3) {
980                         // Finalize the compilation of template variables
981                         $this->finalizeVariableCompilation();
982
983                         // Prepare the eval() command for comiling the template
984                         $eval = sprintf("\$result = \"%s\";",
985                                 addslashes($this->getRawTemplateData())
986                         );
987
988                         // This loop does remove the backslashes (\) in PHP parameters
989                         /* @TODO Make this some nicer... */
990                         while (strpos($eval, "<?") !== false) {
991                                 // Get left part before "<?"
992                                 $evalLeft = substr($eval, 0, strpos($eval, "<?"));
993
994                                 // Get all from right of "<?"
995                                 $evalRight = substr($eval, (strpos($eval, "<?") + 2));
996
997                                 // Is this a full PHP tag?
998                                 if (substr(strtolower($evalRight), 0, 3) == "php") {
999                                         // Remove "php" string from full PHP tag
1000                                         $evalRight = substr($evalRight, 3);
1001                                 } // END - if
1002
1003                                 // Cut middle part out and remove escapes
1004                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>")));
1005                                 $evalMiddle = stripslashes($evalMiddle);
1006
1007                                 // Remove the middle part from right one
1008                                 $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2));
1009
1010                                 // And put all together
1011                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1012                         } // END - while
1013
1014                         // Prepare PHP code for eval() command
1015                         $eval = str_replace(
1016                                 "<%php", "\";",
1017                                 str_replace(
1018                                         "%>", "\$result .= \"", $eval
1019                                 )
1020                         );
1021
1022                         // Debug message
1023                         if ((defined('DEBUG_EVAL')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
1024                                 $this->__toString(),
1025                                 htmlentities($eval)
1026                         ));
1027
1028                         // Run the constructed command. This will "compile" all variables in
1029                         eval($eval);
1030
1031                         // Set raw template data
1032                         $this->setRawTemplateData($result);
1033                         $cnt++;
1034                 }
1035
1036                 // Set the new content
1037                 $this->setCompiledData($result);
1038         }
1039
1040         /**
1041          * Compile all required templates into the current loaded one
1042          *
1043          * @return      void
1044          * @throws      UnexpectedTemplateTypeException If the template type is
1045          *                                                                                      not "code"
1046          * @throws      InvalidArrayCountException              If an unexpected array
1047          *                                                                                      count has been found
1048          */
1049         public final function compileTemplate () {
1050                 // We will only work with template type "code" from configuration
1051                 if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
1052                         // Abort here
1053                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1054                 } // END - if
1055
1056                 // Get the raw data.
1057                 $rawData = $this->getRawTemplateData();
1058
1059                 // Remove double spaces and trim leading/trailing spaces
1060                 $rawData = trim(str_replace("  ", " ", $rawData));
1061
1062                 // Search for raw variables
1063                 $this->extractVariablesFromRawData($rawData);
1064
1065                 // Search for code-tags which are {? ?}
1066                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1067
1068                 // Analyze the matches array
1069                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1070                         // Entries are found:
1071                         //
1072                         // The main analysis
1073                         $this->analyzeTemplate($templateMatches);
1074
1075                         // Compile raw template data
1076                         $this->compileRawTemplateData($templateMatches);
1077
1078                         // Are there some raw templates left for loading?
1079                         $this->loadExtraRawTemplates();
1080
1081                         // Are some raw templates found and loaded?
1082                         if (count($this->rawTemplates) > 0) {
1083
1084                                 // Insert all raw templates
1085                                 $this->insertRawTemplates();
1086
1087                                 // Remove the raw template content as well
1088                                 $this->setRawTemplateData("");
1089
1090                         } // END - if
1091
1092                 } // END - if($templateMatches ...
1093         }
1094
1095         /**
1096          * Output the compiled page to the outside world. In case of web templates
1097          * this would be vaild (X)HTML code. And in case of email templates this
1098          * would store a prepared email body inside the template engine.
1099          *
1100          * @return      void
1101          */
1102         public final function output () {
1103                 // Check which type of template we have
1104                 switch ($this->getTemplateType()) {
1105                 case "html": // Raw HTML templates can be send to the output buffer
1106                         // Quick-N-Dirty:
1107                         $this->getWebOutputInstance()->output($this->getCompiledData());
1108                         break;
1109
1110                 default: // Unknown type found
1111                         // Construct message
1112                         $msg = sprintf("[%s:] Unknown/unsupported template type <strong>%s</strong> detected.",
1113                                 $this->__toString(),
1114                                 $this->getTemplateType()
1115                         );
1116
1117                         if ((is_object($this->getDebugInstance())) && (method_exists($this->getDebugInstance(), 'output'))) {
1118                                 // Use debug output handler
1119                                 $this->getDebugInstance()->output($msg);
1120                                 die();
1121                         } else {
1122                                 // Put directly out
1123                                 // DO NOT REWRITE THIS TO app_die() !!!
1124                                 die($msg);
1125                         }
1126                         break;
1127                 }
1128         }
1129
1130         /**
1131          * Loads a given view helper (by name)
1132          *
1133          * @param       $helperName     The helper's name
1134          * @return      void
1135          * @throws      ViewHelperNotFoundException     If the given view helper was not found
1136          */
1137         protected function loadViewHelper ($helperName) {
1138                 // Make first character upper case, rest low
1139                 $helperName = ucfirst($helperName);
1140
1141                 // Is this view helper loaded?
1142                 if (!isset($this->helpers[$helperName])) {
1143                         // Create a class name
1144                         $className = "{$helperName}ViewHelper";
1145
1146                         // Does this class exists?
1147                         if (!class_exists($className)) {
1148                                 // Abort here!
1149                                 throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER);
1150                         }
1151
1152                         // Generate new instance
1153                         $eval = sprintf("\$this->helpers[%s] = %s::create%s();",
1154                                 $helperName,
1155                                 $className,
1156                                 $className
1157                         );
1158
1159                         // Run the code
1160                         eval($eval);
1161                 }
1162
1163                 // Return the requested instance
1164                 return $this->helpers[$helperName];
1165         }
1166
1167         /**
1168          * Assigns the last loaded raw template content with a given variable
1169          *
1170          * @param       $templateName   Name of the template we want to assign
1171          * @param       $variableName   Name of the variable we want to assign
1172          * @return      void
1173          */
1174         public function assignTemplateWithVariable ($templateName, $variableName) {
1175                 // Get the content from last loaded raw template
1176                 $content = $this->getRawTemplateData();
1177
1178                 // Assign the variable
1179                 $this->assignVariable($variableName, $content);
1180
1181                 // Purge raw content
1182                 $this->setRawTemplateData("");
1183         }
1184
1185         /**
1186          * Transfers the content of this template engine to a given response instance
1187          *
1188          * @param       $responseInstance       An instance of a response class
1189          * @return      void
1190          */
1191         public function transferToResponse (Responseable $responseInstance) {
1192                 // Get the content and set it in the response class
1193                 $responseInstance->writeToBody($this->getCompiledData());
1194         }
1195
1196         /**
1197          * Assigns all the application data with template variables
1198          *
1199          * @param       $appInstance    A manageable application instance
1200          * @return      void
1201          */
1202         public function assignApplicationData (ManageableApplication $appInstance) {
1203                 // Get long name and assign it
1204                 $this->assignVariable("app_full_name" , $appInstance->getAppName());
1205
1206                 // Get short name and assign it
1207                 $this->assignVariable("app_short_name", $appInstance->getAppShortName());
1208
1209                 // Get version number and assign it
1210                 $this->assignVariable("app_version"   , $appInstance->getAppVersion());
1211         }
1212 }
1213
1214 // [EOF]
1215 ?>