4c1500625a55fdf0b5d297927517d569997b9308
[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@mxchange.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   = 0xa00;
113         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0xa01;
114         const EXCEPTION_INVALID_VIEW_HELPER           = 0xa02;
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("Template-Engine");
127
128                 // Create unique ID number
129                 $this->createUniqueID();
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          * Initialize the variable stack. This holds all variables for later
288          * compilation.
289          *
290          * @return      void
291          */
292         public final function initVariableStack () {
293                 $this->varStack = new FrameworkArrayObject();
294         }
295
296         /**
297          * Setter for base path
298          *
299          * @param               $basePath               The local base path for all templates
300          * @return      void
301          */
302         public final function setBasePath ($basePath) {
303                 // Cast it
304                 $basePath = (string) $basePath;
305
306                 // And set it
307                 $this->basePath = $basePath;
308         }
309
310         /**
311          * Getter for base path
312          *
313          * @return      $basePath               The local base path for all templates
314          */
315         public final function getBasePath () {
316                 // And set it
317                 return $this->basePath;
318         }
319
320         /**
321          * Setter for template extension
322          *
323          * @param               $templateExtension      The file extension for all uncompiled
324          *                                                      templates
325          * @return      void
326          */
327         public final function setRawTemplateExtension ($templateExtension) {
328                 // Cast it
329                 $templateExtension = (string) $templateExtension;
330
331                 // And set it
332                 $this->templateExtension = $templateExtension;
333         }
334
335         /**
336          * Setter for code template extension
337          *
338          * @param               $codeExtension          The file extension for all uncompiled
339          *                                                      templates
340          * @return      void
341          */
342         public final function setCodeTemplateExtension ($codeExtension) {
343                 // Cast it
344                 $codeExtension = (string) $codeExtension;
345
346                 // And set it
347                 $this->codeExtension = $codeExtension;
348         }
349
350         /**
351          * Getter for template extension
352          *
353          * @return      $templateExtension      The file extension for all uncompiled
354          *                                                      templates
355          */
356         public final function getRawTemplateExtension () {
357                 // And set it
358                 return $this->templateExtension;
359         }
360
361         /**
362          * Getter for code-template extension
363          *
364          * @return      $codeExtension          The file extension for all code-
365          *                                                      templates
366          */
367         public final function getCodeTemplateExtension () {
368                 // And set it
369                 return $this->codeExtension;
370         }
371
372         /**
373          * Setter for path of compiled templates
374          *
375          * @param               $compileOutputPath              The local base path for all
376          *                                                              compiled templates
377          * @return      void
378          */
379         public final function setCompileOutputPath ($compileOutputPath) {
380                 // Cast it
381                 $compileOutputPath = (string) $compileOutputPath;
382
383                 // And set it
384                 $this->compileOutputPath = $compileOutputPath;
385         }
386
387         /**
388          * Setter for template type. Only "html", "emails" and "compiled" should
389          * be sent here
390          *
391          * @param               $templateType   The current template's type
392          * @return      void
393          */
394         private final function setTemplateType ($templateType) {
395                 // Cast it
396                 $templateType = (string) $templateType;
397
398                 // And set it (only 2 letters)
399                 $this->templateType = $templateType;
400         }
401
402         /**
403          * Getter for template type
404          *
405          * @return      $templateType   The current template's type
406          */
407         public final function getTemplateType () {
408                 return $this->templateType;
409         }
410
411         /**
412          * Setter for the last loaded template's FQFN
413          *
414          * @param               $template               The last loaded template
415          * @return      void
416          */
417         private final function setLastTemplate ($template) {
418                 // Cast it to string
419                 $template = (string) $template;
420                 $this->lastTemplate = $template;
421         }
422
423         /**
424          * Getter for the last loaded template's FQFN
425          *
426          * @return      $template               The last loaded template
427          */
428         private final function getLastTemplate () {
429                 return $this->lastTemplate;
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          * Assign a given congfiguration variable with a value
455          *
456          * @param               $var            The configuration variable we are looking for
457          * @param               $value  The value we want to store in the variable
458          * @return      void
459          */
460         public final function assignConfigVariable ($var, $value) {
461                 // Sweet and simple...
462                 $this->configVariables[$var] = $value;
463         }
464
465         /**
466          * Removes a given variable
467          *
468          * @param               $var            The variable we are looking for
469          * @return      void
470          */
471         public final function removeVariable ($var) {
472                 // First search for the variable if it was already added
473                 $idx = $this->isVariableAlreadySet($var);
474
475                 // Was it found?
476                 if ($idx !== false) {
477                         // Remove this variable
478                         $this->varStack->offsetUnset($idx);
479                 }
480         }
481
482         /**
483          * Private setter for raw template data
484          *
485          * @param               $rawTemplateData        The raw data from the template
486          * @return      void
487          */
488         private final function setRawTemplateData ($rawTemplateData) {
489                 // Cast it to string
490                 $rawTemplateData = (string) $rawTemplateData;
491
492                 // And store it in this class
493                 $this->rawTemplateData = $rawTemplateData;
494         }
495
496         /**
497          * Private setter for compiled templates
498          */
499         private final function setCompiledData ($compiledData) {
500                 // Cast it to string
501                 $compiledData = (string) $compiledData;
502
503                 // And store it in this class
504                 $this->compiledData = $compiledData;
505         }
506
507         /**
508          * Private loader for all template types
509          *
510          * @param               $template               The template we shall load
511          * @return      void
512          */
513         private final function loadTemplate ($template) {
514                 // Cast it to string
515                 $template = (string) $template;
516
517                 // Get extension for the template
518                 $ext = $this->getRawTemplateExtension();
519
520                 // If we shall load a code-template we need to switch the file extension
521                 if ($this->getTemplateType() == $this->getConfigInstance()->readConfig("code_template_type")) {
522                         // Switch over to the code-template extension
523                         $ext = $this->getCodeTemplateExtension();
524                 }
525
526                 // Construct the FQFN for the template by honoring the current language
527                 $fqfn = sprintf("%s%s/%s/%s%s",
528                         $this->getBasePath(),
529                         $this->getLanguageInstance()->getLanguageCode(),
530                         $this->getTemplateType(),
531                         $template,
532                         $ext
533                 );
534
535                 // Load the raw template data
536                 $this->loadRawTemplateData($fqfn);
537         }
538
539         /**
540          * A private loader for raw template names
541          *
542          * @param               $fqfn   The full-qualified file name for a template
543          * @return      void
544          * @throws      NullPointerException    If $inputInstance is null
545          * @throws      NoObjectException               If $inputInstance is not an object
546          * @throws      MissingMethodException  If $inputInstance is missing a
547          *                                                              required method
548          */
549         private function loadRawTemplateData ($fqfn) {
550                 // Get a input/output instance from the middleware
551                 $ioInstance = $this->getFileIOInstance();
552
553                 // Validate the instance
554                 if (is_null($ioInstance)) {
555                         // Throw exception
556                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
557                 } elseif (!is_object($ioInstance)) {
558                         // Throw another exception
559                         throw new NoObjectException($ioInstance, self::EXCEPTION_IS_NO_OBJECT);
560                 } elseif (!method_exists($ioInstance, 'loadFileContents')) {
561                         // Throw yet another exception
562                         throw new MissingMethodException(array($ioInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
563                 }
564
565                 // Load the raw template
566                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
567
568                 // Store the template's contents into this class
569                 $this->setRawTemplateData($rawTemplateData);
570
571                 // Remember the template's FQFN
572                 $this->setLastTemplate($fqfn);
573         }
574
575         /**
576          * Try to assign an extracted template variable as a "content" or "config"
577          * variable.
578          *
579          * @param               $varName                The variable's name (shall be content or
580          *                                              config) by default
581          * @param               $var                    The variable we want to assign
582          */
583         private function assignTemplateVariable ($varName, $var) {
584                 // Is it not a config variable?
585                 if ($varName != "config") {
586                         // Regular template variables
587                         $this->assignVariable($var, "");
588                 } else {
589                         // Configuration variables
590                         $this->assignConfigVariable($var, $this->getConfigInstance()->readConfig($var));
591                 }
592         }
593
594         /**
595          * Extract variables from a given raw data stream
596          *
597          * @param       $rawData        The raw template data we shall analyze
598          * @return      void
599          * @throws      InvalidTemplateVariableNameException    If a variable name
600          *                                                                                                      in a template is
601          *                                                                                                      invalid
602          */
603         private function extractVariablesFromRawData ($rawData) {
604                 // Cast to string
605                 $rawData = (string) $rawData;
606
607                 // Search for variables
608                 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
609
610                 // Did we find some variables?
611                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
612                         // Initialize all missing variables
613                         foreach ($variableMatches[3] as $key=>$var) {
614                                 // Is the variable name valid?
615                                 if (($variableMatches[1][$key] != $this->getConfigInstance()->readConfig("tpl_valid_var")) && ($variableMatches[1][$key] != "config")) {
616                                         // Invalid variable name
617                                         throw new InvalidTemplateVariableNameException(array($this, $this->getLastTemplate(), $variableMatches[1][$key], $this->getConfigInstance()), self::EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR);
618                                 }
619
620                                 // Try to assign it, empty strings are being ignored
621                                 $this->assignTemplateVariable($variableMatches[1][$key], $var);
622                         }
623                 }
624         }
625
626         /**
627          * Main analysis of the loaded template
628          *
629          * @param               $templateMatches        Found template place-holders, see below
630          * @return      void
631          *
632          *---------------------------------
633          * Structure of $templateMatches:
634          *---------------------------------
635          * [0] => Array - An array with all full matches
636          * [1] => Array - An array with left part (before the ":") of a match
637          * [2] => Array - An array with right part of a match including ":"
638          * [3] => Array - An array with right part of a match excluding ":"
639          */
640         private function analyzeTemplate (array $templateMatches) {
641                 // Backup raw template data
642                 $backup = $this->getRawTemplateData();
643
644                 // Initialize some arrays
645                 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
646
647                 // Load all requested templates
648                 foreach ($templateMatches[1] as $template) {
649
650                         // Load and compile only templates which we have not yet loaded
651                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
652                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
653
654                                 // Then try to search for code-templates first
655                                 try {
656                                         // Load the code template and remember it's contents
657                                         $this->loadCodeTemplate($template);
658                                         $this->loadedRawData[$template] = $this->getRawTemplateData();
659
660                                         // Remember this template for recursion detection
661                                         // RECURSIVE PROTECTION!
662                                         $this->loadedTemplates[] = $template;
663                                 } catch (FilePointerNotOpenedException $e) {
664                                         // Template not found, but maybe variable assigned?
665                                         if ($this->isVariableAlreadySet($template) !== false) {
666                                                 // Use that content here
667                                                 $this->loadedRawData[$template] = $this->readVariable($template);
668
669                                                 // Recursive protection:
670                                                 $this->loadedTemplates[] = $template;
671                                         } else {
672                                                 // Even this is not done... :/
673                                                 $this->rawTemplates[] = $template;
674                                         }
675                                 }
676
677                         } // if ((!isset( ...
678
679                 } // for ($templateMatches ...
680
681                 // Restore the raw template data
682                 $this->setRawTemplateData($backup);
683         }
684
685         /**
686          * Compile a given raw template code and remember it for later usage
687          *
688          * @param               $code           The raw template code
689          * @param               $template               The template's name
690          * @return      void
691          */
692         private function compileCode ($code, $template) {
693                 // Is this template already compiled?
694                 if (in_array($template, $this->compiledTemplates)) {
695                         // Abort here...
696                         return;
697                 }
698
699                 // Remember this template being compiled
700                 $this->compiledTemplates[] = $template;
701
702                 // Compile the loaded code in five steps:
703                 //
704                 // 1. Backup current template data
705                 $backup = $this->getRawTemplateData();
706
707                 // 2. Set the current template's raw data as the new content
708                 $this->setRawTemplateData($code);
709
710                 // 3. Compile the template data
711                 $this->compileTemplate();
712
713                 // 4. Remember it's contents
714                 $this->loadedRawData[$template] = $this->getRawTemplateData();
715
716                 // 5. Restore the previous raw content from backup variable
717                 $this->setRawTemplateData($backup);
718         }
719
720         /**
721          * Insert all given and loaded templates by running through all loaded
722          * codes and searching for their place-holder in the main template
723          *
724          * @param               $templateMatches        See method analyzeTemplate()
725          * @return      void
726          */
727         private function insertAllTemplates (array $templateMatches) {
728                 // Run through all loaded codes
729                 foreach ($this->loadedRawData as $template=>$code) {
730
731                         // Search for the template
732                         $foundIndex = array_search($template, $templateMatches[1]);
733
734                         // Lookup the matching template replacement
735                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
736
737                                 // Get the current raw template
738                                 $rawData = $this->getRawTemplateData();
739
740                                 // Replace the space holder with the template code
741                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
742
743                                 // Set the new raw data
744                                 $this->setRawTemplateData($rawData);
745
746                         } // END - if
747
748                 } // END - foreach
749         }
750
751         /**
752          * Load all extra raw templates
753          *
754          * @return      void
755          */
756         private function loadExtraRawTemplates () {
757                 // Are there some raw templates we need to load?
758                 if (count($this->rawTemplates) > 0) {
759                         // Try to load all raw templates
760                         foreach ($this->rawTemplates as $key => $template) {
761                                 try {
762                                         // Load the template
763                                         $this->loadWebTemplate($template);
764
765                                         // Remember it's contents
766                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
767
768                                         // Remove it from the loader list
769                                         unset($this->rawTemplates[$key]);
770
771                                         // Remember this template for recursion detection
772                                         // RECURSIVE PROTECTION!
773                                         $this->loadedTemplates[] = $template;
774                                 } catch (FilePointerNotOpenedException $e) {
775                                         // This template was never found. We silently ignore it
776                                         unset($this->rawTemplates[$key]);
777                                 }
778                         }
779                 }
780         }
781
782         /**
783          * Assign all found template variables
784          *
785          * @param               $varMatches     An array full of variable/value pairs.
786          * @return      void
787          */
788         private function assignAllVariables (array $varMatches) {
789                 // Search for all variables
790                 foreach ($varMatches[1] as $key=>$var) {
791
792                         // Detect leading equals
793                         if (substr($varMatches[2][$key], 0, 1) == "=") {
794                                 // Remove and cast it
795                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
796                         }
797
798                         // Do we have some quotes left and right side? Then it is free text
799                         if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
800                                 // Free string detected! Which we can assign directly
801                                 $this->assignVariable($var, $varMatches[3][$key]);
802                         } elseif (!empty($varMatches[2][$key])) {
803                                 // Non-string found so we need some deeper analysis...
804                                 // @TODO Unfinished work or don't die here.
805                                 die("Deeper analysis not yet implemented!");
806                         }
807
808                 } // for ($varMatches ...
809         }
810         /**
811          * Compiles all loaded raw templates
812          *
813          * @param               $templateMatches        See method analyzeTemplate() for details
814          * @return      void
815          */
816         private function compileRawTemplateData (array $templateMatches) {
817                 // Are some code-templates found which we need to compile?
818                 if (count($this->loadedRawData) > 0) {
819
820                         // Then compile all!
821                         foreach ($this->loadedRawData as $template=>$code) {
822
823                                 // Is this template already compiled?
824                                 if (in_array($template, $this->compiledTemplates)) {
825                                         // Then skip it
826                                         continue;
827                                 }
828
829                                 // Search for the template
830                                 $foundIndex = array_search($template, $templateMatches[1]);
831
832                                 // Lookup the matching variable data
833                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
834
835                                         // Split it up with another reg. exp. into variable=value pairs
836                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
837
838                                         // Assign all variables
839                                         $this->assignAllVariables($varMatches);
840
841                                 } // END - if (isset($templateMatches ...
842
843                                 // Compile the loaded template
844                                 $this->compileCode($code, $template);
845
846                         } // END - foreach ($this->loadedRawData ...
847
848                         // Insert all templates
849                         $this->insertAllTemplates($templateMatches);
850
851                 } // END - if (count($this->loadedRawData) ...
852         }
853
854         /**
855          * Inserts all raw templates into their respective variables
856          *
857          * @return      void
858          */
859         private function insertRawTemplates () {
860                 // Load all templates
861                 foreach ($this->rawTemplates as $template=>$content) {
862                         // Set the template as a variable with the content
863                         $this->assignVariable($template, $content);
864                 }
865         }
866
867         /**
868          * Finalizes the compilation of all template variables
869          *
870          * @return      void
871          */
872         private function finalizeVariableCompilation () {
873                 // Get the content
874                 $content = $this->getRawTemplateData();
875
876                 // Walk through all variables
877                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
878                         // Get current entry
879                         $currEntry = $idx->current();
880
881                         // Replace all [$var] or {?$var?} with the content
882                         //* DEBUG: */ echo "name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
883                         $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content);
884                         $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content);
885                         $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content);
886                 } // END - for
887
888                 // Set the content back
889                 $this->setRawTemplateData($content);
890         }
891
892         /**
893          * Getter for raw template data
894          *
895          * @return      $rawTemplateData        The raw data from the template
896          */
897         public final function getRawTemplateData () {
898                 return $this->rawTemplateData;
899         }
900
901         /**
902          * Getter for compiled templates
903          */
904         public final function getCompiledData () {
905                 return $this->compiledData;
906         }
907
908         /**
909          * Load a specified web template into the engine
910          *
911          * @param               $template               The web template we shall load which is
912          *                                              located in "html" by default
913          * @return      void
914          */
915         public final function loadWebTemplate ($template) {
916                 // Set template type
917                 $this->setTemplateType($this->getConfigInstance()->readConfig("web_template_type"));
918
919                 // Load the special template
920                 $this->loadTemplate($template);
921         }
922
923         /**
924          * Load a specified email template into the engine
925          *
926          * @param               $template               The email template we shall load which is
927          *                                              located in "emails" by default
928          * @return      void
929          */
930         public final function loadEmailTemplate ($template) {
931                 // Set template type
932                 $this->setTemplateType($this->getConfigInstance()->readConfig("email_template_type"));
933
934                 // Load the special template
935                 $this->loadTemplate($template);
936         }
937
938         /**
939          * Load a specified code template into the engine
940          *
941          * @param               $template               The code template we shall load which is
942          *                                              located in "code" by default
943          * @return      void
944          */
945         public final function loadCodeTemplate ($template) {
946                 // Set template type
947                 $this->setTemplateType($this->getConfigInstance()->readConfig("code_template_type"));
948
949                 // Load the special template
950                 $this->loadTemplate($template);
951         }
952
953         /**
954          * Compile all variables by inserting their respective values
955          *
956          * @return      void
957          */
958         public final function compileVariables () {
959                 // Initialize the $content array
960                 $validVar = $this->getConfigInstance()->readConfig("tpl_valid_var");
961                 $dummy = array();
962
963                 // Iterate through all variables
964                 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
965
966                         // Get current variable from the stack
967                         $currVariable = $idx->current();
968
969                         // Transfer it's name/value combination to the $content array
970                         //* DEBUG: */ echo $currVariable['name']."=<pre>".htmlentities($currVariable['value'])."</pre>\n";
971                         $dummy[$currVariable['name']] = $currVariable['value'];
972
973                 }// END - if
974
975                 // Set the new variable (don't remove the second dollar !)
976                 $$validVar = $dummy;
977
978                 // Prepare all configuration variables
979                 $config = $this->configVariables;
980
981                 // Remove some variables
982                 unset($idx);
983                 unset($currVariable);
984
985                 // Finalize the compilation of template variables
986                 $this->finalizeVariableCompilation();
987
988                 // Prepare the eval() command for comiling the template
989                 $eval = sprintf("\$result = \"%s\";",
990                         addslashes($this->getRawTemplateData())
991                 );
992
993                 // Debug message
994                 if ((defined('DEBUG_EVAL')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
995                         $this->__toString(),
996                         htmlentities($eval)
997                 ));
998
999                 // Run the constructed command. This will "compile" all variables in
1000                 eval($eval);
1001
1002                 // Set the new content
1003                 $this->setCompiledData($result);
1004         }
1005
1006         /**
1007          * Compile all required templates into the current loaded one
1008          *
1009          * @return      void
1010          * @throws      UnexpectedTemplateTypeException If the template type is
1011          *                                                                              not "code"
1012          * @throws      InvalidArrayCountException              If an unexpected array
1013          *                                                                              count has been found
1014          */
1015         public final function compileTemplate () {
1016                 // We will only work with template type "code" from configuration
1017                 if ($this->getTemplateType() != $this->getConfigInstance()->readConfig("code_template_type")) {
1018                         // Abort here
1019                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig("code_template_type")), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1020                 } // END - if
1021
1022                 // Get the raw data.
1023                 $rawData = $this->getRawTemplateData();
1024
1025                 // Remove double spaces and trim leading/trailing spaces
1026                 $rawData = trim(str_replace("  ", " ", $rawData));
1027
1028                 // Search for raw variables
1029                 $this->extractVariablesFromRawData($rawData);
1030
1031                 // Search for code-tags which are {? ?}
1032                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1033
1034                 // Analyze the matches array
1035                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1036                         // Entries are found:
1037                         //
1038                         // The main analysis
1039                         $this->analyzeTemplate($templateMatches);
1040
1041                         // Compile raw template data
1042                         $this->compileRawTemplateData($templateMatches);
1043
1044                         // Are there some raw templates left for loading?
1045                         $this->loadExtraRawTemplates();
1046
1047                         // Are some raw templates found and loaded?
1048                         if (count($this->rawTemplates) > 0) {
1049
1050                                 // Insert all raw templates
1051                                 $this->insertRawTemplates();
1052
1053                                 // Remove the raw template content as well
1054                                 $this->setRawTemplateData("");
1055
1056                         } // END - if
1057
1058                 } // END - if($templateMatches ...
1059         }
1060
1061         /**
1062          * Output the compiled page to the outside world. In case of web templates
1063          * this would be vaild (X)HTML code. And in case of email templates this
1064          * would store a prepared email body inside the template engine.
1065          *
1066          * @return      void
1067          */
1068         public final function output () {
1069                 // Check which type of template we have
1070                 switch ($this->getTemplateType()) {
1071                 case "html": // Raw HTML templates can be send to the output buffer
1072                         // Quick-N-Dirty:
1073                         $this->getWebOutputInstance()->output($this->getCompiledData());
1074                         break;
1075
1076                 default: // Unknown type found
1077                         // Construct message
1078                         $msg = sprintf("[%s:] Unknown/unsupported template type <strong>%s</strong> detected.",
1079                                 $this->__toString(),
1080                                 $this->getTemplateType()
1081                         );
1082
1083                         if ((is_object($this->getDebugInstance())) && (method_exists($this->getDebugInstance(), 'output'))) {
1084                                 // Use debug output handler
1085                                 $this->getDebugInstance()->output($msg);
1086                                 die();
1087                         } else {
1088                                 // Put directly out
1089                                 // DO NOT REWRITE THIS TO app_die() !!!
1090                                 die($msg);
1091                         }
1092                         break;
1093                 }
1094         }
1095
1096         /**
1097          * Loads a given view helper (by name)
1098          *
1099          * @param       $helperName     The helper's name
1100          * @return      void
1101          * @throws      ViewHelperNotFoundException     If the given view helper was not found
1102          */
1103         protected function loadViewHelper ($helperName) {
1104                 // Make first character upper case, rest low
1105                 $helperName = ucfirst($helperName);
1106
1107                 // Is this view helper loaded?
1108                 if (!isset($this->helpers[$helperName])) {
1109                         // Create a class name
1110                         $className = "{$helperName}ViewHelper";
1111
1112                         // Does this class exists?
1113                         if (!class_exists($className)) {
1114                                 // Abort here!
1115                                 throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER);
1116                         }
1117
1118                         // Generate new instance
1119                         $eval = sprintf("\$this->helpers[%s] = %s::create%s();",
1120                                 $helperName,
1121                                 $className,
1122                                 $className
1123                         );
1124
1125                         // Run the code
1126                         eval($eval);
1127                 }
1128
1129                 // Return the requested instance
1130                 return $this->helpers[$helperName];
1131         }
1132
1133         /**
1134          * Assigns the last loaded raw template content with a given variable
1135          *
1136          * @param       $templateName   Name of the template we want to assign
1137          * @param       $variableName   Name of the variable we want to assign
1138          * @return      void
1139          */
1140         public function assignTemplateWithVariable ($templateName, $variableName) {
1141                 // Get the content from last loaded raw template
1142                 $content = $this->getRawTemplateData();
1143
1144                 // Assign the variable
1145                 $this->assignVariable($variableName, $content);
1146
1147                 // Purge raw content
1148                 $this->setRawTemplateData("");
1149         }
1150
1151         /**
1152          * Transfers the content of this template engine to a given response instance
1153          *
1154          * @param       $responseInstance       An instance of a response class
1155          * @return      void
1156          */
1157         public function transferToResponse (Responseable $responseInstance) {
1158                 // Get the content and set it in the response class
1159                 $responseInstance->writeToBody($this->getCompiledData());
1160         }
1161 }
1162
1163 // [EOF]
1164 ?>