Renamed variables, removeVariable() does not expect indexes
[core.git] / inc / classes / main / template / class_BaseTemplateEngine.php
1 <?php
2 /**
3  * A generic template engine
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 class BaseTemplateEngine extends BaseFrameworkSystem {
25         /**
26          * The local path name where all templates and sub folders for special
27          * templates are stored. We will internally determine the language plus
28          * "html" for web templates or "emails" for email templates
29          */
30         private $templateBasePath = '';
31
32         /**
33          * Template type
34          */
35         private $templateType = 'html';
36
37         /**
38          * The extension for web and email templates (not compiled templates)
39          */
40         private $templateExtension = '.tpl';
41
42         /**
43          * The extension for code templates (not compiled templates)
44          */
45         private $codeExtension = '.ctp';
46
47         /**
48          * Path relative to $templateBasePath and language code for compiled code-templates
49          */
50         private $compileOutputPath = 'templates/_compiled/';
51
52         /**
53          * The path name for all templates
54          */
55         private $genericBasePath = 'templates/';
56
57         /**
58          * The raw (maybe uncompiled) template
59          */
60         private $rawTemplateData = '';
61
62         /**
63          * Template data with compiled-in variables
64          */
65         private $compiledData = '';
66
67         /**
68          * The last loaded template's FQFN for debugging the engine
69          */
70         private $lastTemplate = '';
71
72         /**
73          * The variable stack for the templates
74          */
75         private $varStack = array();
76
77         /**
78          * Loaded templates for recursive protection and detection
79          */
80         private $loadedTemplates = array();
81
82         /**
83          * Compiled templates for recursive protection and detection
84          */
85         private $compiledTemplates = array();
86
87         /**
88          * Loaded raw template data
89          */
90         private $loadedRawData = NULL;
91
92         /**
93          * Raw templates which are linked in code templates
94          */
95         private $rawTemplates = NULL;
96
97         /**
98          * A regular expression for variable=value pairs
99          */
100         private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
101
102         /**
103          * A regular expression for filtering out code tags
104          *
105          * E.g.: {?template:variable=value;var2=value2;[...]?}
106          */
107         private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
108
109         /**
110          * Loaded helpers
111          */
112         private $helpers = array();
113
114         /**
115          * Current variable group
116          */
117         private $currGroup = 'general';
118
119         /**
120          * All template groups except "general"
121          */
122         private $varGroups = array();
123
124         /**
125          * Code begin
126          */
127         private $codeBegin = '<?php';
128
129         /**
130          * Code end
131          */
132         private $codeEnd = '?>';
133
134         /**
135          * Language support is enabled by default
136          */
137         private $languageSupport = true;
138
139         /**
140          * XML compacting is disabled by default
141          */
142         private $xmlCompacting = false;
143
144         // Exception codes for the template engine
145         const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x110;
146         const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
147         const EXCEPTION_INVALID_VIEW_HELPER           = 0x112;
148         const EXCEPTION_VARIABLE_IS_MISSING           = 0x113;
149
150         /**
151          * Protected constructor
152          *
153          * @param       $className      Name of the class
154          * @return      void
155          */
156         protected function __construct ($className) {
157                 // Call parent constructor
158                 parent::__construct($className);
159
160                 // Init file I/O instance
161                 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
162
163                 // Set it
164                 $this->setFileIoInstance($ioInstance);
165         }
166
167         /**
168          * Search for a variable in the stack
169          *
170          * @param       $variableName   The variable we are looking for
171          * @param       $stack                  Optional variable stack to look in
172          * @return      $index                  FALSE means not found, >=0 means found on a specific index
173          */
174         private function getVariableIndex ($variableName, $stack = NULL) {
175                 // Replace all dashes to underscores to match variables with configuration entries
176                 $variableName = trim($this->convertDashesToUnderscores($variableName));
177
178                 // First everything is not found
179                 $found = false;
180
181                 // If the stack is null, use the current group
182                 if (is_null($stack)) {
183                         // Use current group
184                         //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
185                         $stack = $this->currGroup;
186                 } // END - if
187
188                 // Is the group there?
189                 if ($this->isVarStackSet($stack)) {
190                         // Now search for it
191                         foreach ($this->getVarStack($stack) as $index => $currEntry) {
192                                 //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
193                                 // Is the entry found?
194                                 if ($currEntry['name'] == $variableName) {
195                                         // Found!
196                                         //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
197                                         $found = $index;
198                                         break;
199                                 } // END - if
200                         } // END - foreach
201                 } // END - if
202
203                 // Return the current position
204                 return $found;
205         }
206
207         /**
208          * Checks whether the given variable stack is set
209          *
210          * @param       $stack  Variable stack to check
211          * @return      $isSet  Whether the given variable stack is set
212          */
213         protected final function isVarStackSet ($stack) {
214                 // Check it
215                 $isSet = isset($this->varStack[$stack]);
216
217                 // Return result
218                 return $isSet;
219         }
220
221         /**
222          * Getter for given variable stack
223          *
224          * @param       $stack          Variable stack to check
225          * @return      $varStack       Found variable stack
226          */
227         public final function getVarStack ($stack) {
228                 return $this->varStack[$stack];
229         }
230
231         /**
232          * Setter for given variable stack
233          *
234          * @param       $stack          Variable stack to check
235          * @param       $varStack       Variable stack to check
236          * @return      void
237          */
238         protected final function setVarStack ($stack, array $varStack) {
239                 $this->varStack[$stack]  = $varStack;
240         }
241
242         /**
243          * Return a content of a variable or null if not found
244          *
245          * @param       $variableName   The variable we are looking for
246          * @param       $stack                  Optional variable stack to look in
247          * @return      $content                Content of the variable or null if not found
248          */
249         protected function readVariable ($variableName, $stack = NULL) {
250                 // Replace all dashes to underscores to match variables with configuration entries
251                 $variableName = trim($this->convertDashesToUnderscores($variableName));
252
253                 // First everything is not found
254                 $content = NULL;
255
256                 // If the stack is null, use the current group
257                 if (is_null($stack)) {
258                         // Use current group
259                         //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
260                         $stack = $this->currGroup;
261                 } // END - if
262
263                 // Get variable index
264                 $found = $this->getVariableIndex($variableName, $stack);
265
266                 // Is the variable found?
267                 if ($found !== false) {
268                         // Read it
269                         $content = $this->getVariableValue($stack, $found);
270                 } // END - if
271
272                 // Return the current position
273                 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
274                 return $content;
275         }
276
277         /**
278          * Add a variable to the stack
279          *
280          * @param       $variableName   The variable we are looking for
281          * @param       $value  The value we want to store in the variable
282          * @return      void
283          */
284         private function addVariable ($variableName, $value) {
285                 // Set general variable group
286                 $this->setVariableGroup('general');
287
288                 // Add it to the stack
289                 $this->addGroupVariable($variableName, $value);
290         }
291
292         /**
293          * Returns all variables of current group or empty array
294          *
295          * @return      $result         Whether array of found variables or empty array
296          */
297         private function readCurrentGroup () {
298                 // Default is not found
299                 $result = array();
300
301                 // Is the group there?
302                 if ($this->isVarStackSet($this->currGroup)) {
303                         // Then use it
304                         $result = $this->getVarStack($this->currGroup);
305                 } // END - if
306
307                 // Return result
308                 return $result;
309         }
310
311         /**
312          * Settter for variable group
313          *
314          * @param       $groupName      Name of variable group
315          * @param       $add            Whether add this group
316          * @return      void
317          */
318         public function setVariableGroup ($groupName, $add = true) {
319                 // Set group name
320                 //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
321                 $this->currGroup = $groupName;
322
323                 // Skip group 'general'
324                 if (($groupName != 'general') && ($add === true)) {
325                         $this->varGroups[$groupName] = 'OK';
326                 } // END - if
327         }
328
329
330         /**
331          * Adds a variable to current group
332          *
333          * @param       $variableName   Variable to set
334          * @param       $value                  Value to store in variable
335          * @return      void
336          */
337         public function addGroupVariable ($variableName, $value) {
338                 // Replace all dashes to underscores to match variables with configuration entries
339                 $variableName = trim($this->convertDashesToUnderscores($variableName));
340
341                 // Debug message
342                 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
343
344                 // Get current variables in group
345                 $currVars = $this->readCurrentGroup();
346
347                 // Append our variable
348                 $currVars[] = $this->generateVariableArray($variableName, $value);
349
350                 // Add it to the stack
351                 $this->setVarStack($this->currGroup, $currVars);
352         }
353
354         /**
355          * Getter for variable value, throws a NoVariableException if the variable is not found
356          *
357          * @param       $varGroup       Variable group to use
358          * @param       $index          Index in variable array
359          * @return      $value          Value to set
360          */
361         private function getVariableValue ($varGroup, $index) {
362                 // Return it
363                 return $this->varStack[$varGroup][$index]['value'];
364         }
365
366         /**
367          * Modify an entry on the stack
368          *
369          * @param       $variableName   The variable we are looking for
370          * @param       $value                  The value we want to store in the variable
371          * @return      void
372          * @throws      NoVariableException     If the given variable is not found
373          */
374         private function modifyVariable ($variableName, $value) {
375                 // Replace all dashes to underscores to match variables with configuration entries
376                 $variableName = trim($this->convertDashesToUnderscores($variableName));
377
378                 // Get index for variable
379                 $index = $this->getVariableIndex($variableName);
380
381                 // Is the variable set?
382                 if ($index === false) {
383                         // Unset variables cannot be modified
384                         throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
385                 } // END - if
386
387                 // Then modify it
388                 $this->setVariableValue($this->currGroup, $index, $value);
389         }
390
391         /**
392          * Sets a variable value for given variable group and index
393          *
394          * @param       $varGroup       Variable group to use
395          * @param       $index          Index in variable array
396          * @param       $value          Value to set
397          * @return      void
398          */
399         private function setVariableValue ($varGroup, $index, $value) {
400                 $this->varStack[$varGroup][$index]['value'] = $value;
401         }
402
403         /**
404          * Sets a variable within given group. This method does detect if the
405          * variable is already set. If so, the variable got modified, otherwise
406          * added.
407          *
408          * @param       $varGroup               Variable group to use
409          * @param       $variableName   Variable to set
410          * @param       $value                  Value to set
411          * @return      void
412          */
413         protected function setVariable ($varGroup, $variableName, $value) {
414                 // Replace all dashes to underscores to match variables with configuration entries
415                 $variableName = trim($this->convertDashesToUnderscores($variableName));
416
417                 // Get index for variable
418                 $index = $this->getVariableIndex($variableName);
419
420                 // Is the variable set?
421                 if ($index === false) {
422                         // Not found, add it
423                         $this->varStack[$varGroup][] = $this->generateVariableArray($variableName, $value);
424                 } else {
425                         // Then modify it
426                         $this->setVariableValue($this->currGroup, $index, $value);
427                 }
428         }
429
430         /**
431          * "Generates" (better returns) an array for all variables for given
432          * variable/value pay.
433          *
434          * @param       $variableName   Variable to set
435          * @param       $value                  Value to set
436          * @return      $varData                Variable data array
437          */
438         private function generateVariableArray ($variableName, $value) {
439                 // Replace all dashes to underscores to match variables with configuration entries
440                 $variableName = trim($this->convertDashesToUnderscores($variableName));
441
442                 // Generate the temporary array
443                 $varData = array(
444                         'name'  => $variableName,
445                         'value' => $value
446                 );
447
448                 // And return it
449                 return $varData;
450         }
451
452         /**
453          * Setter for template type. Only 'html', 'emails' and 'compiled' should
454          * be sent here
455          *
456          * @param       $templateType   The current template's type
457          * @return      void
458          */
459         protected final function setTemplateType ($templateType) {
460                 $this->templateType = (string) $templateType;
461         }
462
463         /**
464          * Setter for the last loaded template's FQFN
465          *
466          * @param       $template       The last loaded template
467          * @return      void
468          */
469         private final function setLastTemplate ($template) {
470                 $this->lastTemplate = (string) $template;
471         }
472
473         /**
474          * Getter for the last loaded template's FQFN
475          *
476          * @return      $template       The last loaded template
477          */
478         private final function getLastTemplate () {
479                 return $this->lastTemplate;
480         }
481
482         /**
483          * Setter for base path
484          *
485          * @param               $templateBasePath               The relative base path for all templates
486          * @return      void
487          */
488         public final function setTemplateBasePath ($templateBasePath) {
489                 // And set it
490                 $this->templateBasePath = (string) $templateBasePath;
491         }
492
493         /**
494          * Getter for base path
495          *
496          * @return      $templateBasePath               The relative base path for all templates
497          */
498         public final function getTemplateBasePath () {
499                 // And set it
500                 return $this->templateBasePath;
501         }
502
503         /**
504          * Getter for generic base path
505          *
506          * @return      $templateBasePath               The relative base path for all templates
507          */
508         public final function getGenericBasePath () {
509                 // And set it
510                 return $this->genericBasePath;
511         }
512
513         /**
514          * Setter for template extension
515          *
516          * @param               $templateExtension      The file extension for all uncompiled
517          *                                                      templates
518          * @return      void
519          */
520         public final function setRawTemplateExtension ($templateExtension) {
521                 // And set it
522                 $this->templateExtension = (string) $templateExtension;
523         }
524
525         /**
526          * Setter for code template extension
527          *
528          * @param               $codeExtension          The file extension for all uncompiled
529          *                                                      templates
530          * @return      void
531          */
532         public final function setCodeTemplateExtension ($codeExtension) {
533                 // And set it
534                 $this->codeExtension = (string) $codeExtension;
535         }
536
537         /**
538          * Getter for template extension
539          *
540          * @return      $templateExtension      The file extension for all uncompiled
541          *                                                      templates
542          */
543         public final function getRawTemplateExtension () {
544                 // And set it
545                 return $this->templateExtension;
546         }
547
548         /**
549          * Getter for code-template extension
550          *
551          * @return      $codeExtension          The file extension for all code-
552          *                                                      templates
553          */
554         public final function getCodeTemplateExtension () {
555                 // And set it
556                 return $this->codeExtension;
557         }
558
559         /**
560          * Setter for path of compiled templates
561          *
562          * @param       $compileOutputPath      The local base path for all compiled
563          *                                                              templates
564          * @return      void
565          */
566         public final function setCompileOutputPath ($compileOutputPath) {
567                 // And set it
568                 $this->compileOutputPath = (string) $compileOutputPath;
569         }
570
571         /**
572          * Getter for template type
573          *
574          * @return      $templateType   The current template's type
575          */
576         public final function getTemplateType () {
577                 return $this->templateType;
578         }
579
580         /**
581          * Assign (add) a given variable with a value
582          *
583          * @param       $variableName   The variable we are looking for
584          * @param       $value                  The value we want to store in the variable
585          * @return      void
586          * @throws      EmptyVariableException  If the variable name is left empty
587          */
588         public final function assignVariable ($variableName, $value) {
589                 // Replace all dashes to underscores to match variables with configuration entries
590                 $variableName = trim($this->convertDashesToUnderscores($variableName));
591
592                 // Empty variable found?
593                 if (empty($variableName)) {
594                         // Throw an exception
595                         throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
596                 } // END - if
597
598                 // First search for the variable if it was already added
599                 $index = $this->getVariableIndex($variableName);
600
601                 // Was it found?
602                 if ($index === false) {
603                         // Add it to the stack
604                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
605                         $this->addVariable($variableName, $value);
606                 } elseif (!empty($value)) {
607                         // Modify the stack entry
608                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
609                         $this->modifyVariable($variableName, $value);
610                 }
611         }
612
613         /**
614          * Removes a given variable
615          *
616          * @param       $variableName   The variable we are looking for
617          * @return      void
618          */
619         public final function removeVariable ($variableName) {
620                 // First search for the variable if it was already added
621                 $index = $this->getVariableIndex($variableName);
622
623                 // Was it found?
624                 if ($index !== false) {
625                         // Remove this variable
626                         $this->unsetVariableStackOffset($index);
627                 } // END - if
628         }
629
630         /**
631          * Unsets the given offset in the variable stack
632          *
633          * @param       $index  Index to unset
634          * @return      void
635          */
636         protected final function unsetVariableStackOffset ($index) {
637                 // Is the entry there?
638                 if (!isset($this->varStack[$this->currGroup][$index])) {
639                         // Abort here, we need fixing!
640                         $this->debugInstance();
641                 } // END - if
642
643                 // Remove it
644                 unset($this->varStack[$this->currGroup][$index]);
645         }
646
647         /**
648          * Private setter for raw template data
649          *
650          * @param       $rawTemplateData        The raw data from the template
651          * @return      void
652          */
653         protected final function setRawTemplateData ($rawTemplateData) {
654                 // And store it in this class
655                 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
656                 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
657                 $this->rawTemplateData = (string) $rawTemplateData;
658         }
659
660         /**
661          * Getter for raw template data
662          *
663          * @return      $rawTemplateData        The raw data from the template
664          */
665         public final function getRawTemplateData () {
666                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
667                 return $this->rawTemplateData;
668         }
669
670         /**
671          * Private setter for compiled templates
672          *
673          * @return      void
674          */
675         private final function setCompiledData ($compiledData) {
676                 // And store it in this class
677                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
678                 $this->compiledData = (string) $compiledData;
679         }
680
681         /**
682          * Getter for compiled templates
683          *
684          * @return      $compiledData   Compiled template data
685          */
686         public final function getCompiledData () {
687                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
688                 return $this->compiledData;
689         }
690
691         /**
692          * Private loader for all template types
693          *
694          * @param       $template       The template we shall load
695          * @param       $extOther       An other extension to use
696          * @return      void
697          * @throws      FileIoException If the template was not found
698          */
699         protected function loadTemplate ($template, $extOther = '') {
700                 // Get extension for the template if empty
701                 if (empty($extOther)) {
702                         // None provided, so get the raw one
703                         $ext = $this->getRawTemplateExtension();
704                 } else {
705                         // Then use it!
706                         $ext = (string) $extOther;
707                 }
708
709                 // Is language support enabled?
710                 if ($this->isLanguageSupportEnabled()) {
711                         // Construct the FQFN for the template by honoring the current language
712                         $fqfn = sprintf("%s%s%s%s/%s/%s%s",
713                                 $this->getConfigInstance()->getConfigEntry('base_path'),
714                                 $this->getTemplateBasePath(),
715                                 $this->getGenericBasePath(),
716                                 $this->getLanguageInstance()->getLanguageCode(),
717                                 $this->getTemplateType(),
718                                 (string) $template,
719                                 $ext
720                         );
721                 } else {
722                         // Construct the FQFN for the template without language
723                         $fqfn = sprintf("%s%s%s%s/%s%s",
724                                 $this->getConfigInstance()->getConfigEntry('base_path'),
725                                 $this->getTemplateBasePath(),
726                                 $this->getGenericBasePath(),
727                                 $this->getTemplateType(),
728                                 (string) $template,
729                                 $ext
730                         );
731                 }
732
733                 // First try this
734                 try {
735                         // Load the raw template data
736                         $this->loadRawTemplateData($fqfn);
737                 } catch (FileIoException $e) {
738                         // If we shall load a code-template we need to switch the file extension
739                         if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
740                                 // Switch over to the code-template extension and try it again
741                                 $ext = $this->getCodeTemplateExtension();
742
743                                 // Try it again...
744                                 $this->loadTemplate($template, $ext);
745                         } else {
746                                 // Throw it again
747                                 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
748                         }
749                 }
750
751         }
752
753         /**
754          * A private loader for raw template names
755          *
756          * @param       $fqfn   The full-qualified file name for a template
757          * @return      void
758          */
759         private function loadRawTemplateData ($fqfn) {
760                 // Get a input/output instance from the middleware
761                 $ioInstance = $this->getFileIoInstance();
762
763                 // Some debug code to look on the file which is being loaded
764                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
765
766                 // Load the raw template
767                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
768
769                 // Store the template's contents into this class
770                 $this->setRawTemplateData($rawTemplateData);
771
772                 // Remember the template's FQFN
773                 $this->setLastTemplate($fqfn);
774         }
775
776         /**
777          * Try to assign an extracted template variable as a "content" or 'config'
778          * variable.
779          *
780          * @param       $varName                The variable's name (shall be content or config)
781          *                                                      by default
782          * @param       $variableName   The variable we want to assign
783          * @return      void
784          */
785         private function assignTemplateVariable ($varName, $var) {
786                 // Replace all dashes to underscores to match variables with configuration entries
787                 $variableName = trim($this->convertDashesToUnderscores($variableName));
788
789                 // Debug message
790                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
791
792                 // Is it not a config variable?
793                 if ($varName != 'config') {
794                         // Regular template variables
795                         $this->assignVariable($variableName, '');
796                 } else {
797                         // Configuration variables
798                         $this->assignConfigVariable($variableName);
799                 }
800         }
801
802         /**
803          * Extract variables from a given raw data stream
804          *
805          * @param       $rawData        The raw template data we shall analyze
806          * @return      void
807          */
808         private function extractVariablesFromRawData ($rawData) {
809                 // Cast to string
810                 $rawData = (string) $rawData;
811
812                 // Search for variables
813                 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
814
815                 // Debug message
816                 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
817
818                 // Did we find some variables?
819                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
820                         // Initialize all missing variables
821                         foreach ($variableMatches[3] as $key => $var) {
822                                 // Variable name
823                                 $varName = $variableMatches[1][$key];
824
825                                 // Workarround: Do not assign empty variables
826                                 if (!empty($var)) {
827                                         // Try to assign it, empty strings are being ignored
828                                         $this->assignTemplateVariable($varName, $var);
829                                 } // END - if
830                         } // END - foreach
831                 } // END - if
832         }
833
834         /**
835          * Main analysis of the loaded template
836          *
837          * @param       $templateMatches        Found template place-holders, see below
838          * @return      void
839          *
840          *---------------------------------
841          * Structure of $templateMatches:
842          *---------------------------------
843          * [0] => Array - An array with all full matches
844          * [1] => Array - An array with left part (before the ':') of a match
845          * [2] => Array - An array with right part of a match including ':'
846          * [3] => Array - An array with right part of a match excluding ':'
847          */
848         private function analyzeTemplate (array $templateMatches) {
849                 // Backup raw template data
850                 $backup = $this->getRawTemplateData();
851
852                 // Initialize some arrays
853                 if (is_null($this->loadedRawData)) {
854                         // Initialize both
855                         $this->loadedRawData = array();
856                         $this->rawTemplates = array();
857                 } // END - if
858
859                 // Load all requested templates
860                 foreach ($templateMatches[1] as $template) {
861                         // Load and compile only templates which we have not yet loaded
862                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
863                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
864                                 // Debug message
865                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template);
866
867                                 // Template not found, but maybe variable assigned?
868                                 if ($this->getVariableIndex($template, 'config') !== false) {
869                                         // Use that content here
870                                         $this->loadedRawData[$template] = $this->readVariable($template, 'config');
871
872                                         // Recursive protection:
873                                         $this->loadedTemplates[] = $template;
874                                 } elseif ($this->getVariableIndex($template) !== false) {
875                                         // Use that content here
876                                         $this->loadedRawData[$template] = $this->readVariable($template);
877
878                                         // Recursive protection:
879                                         $this->loadedTemplates[] = $template;
880                                 } else {
881                                         // Then try to search for code-templates
882                                         try {
883                                                 // Load the code template and remember it's contents
884                                                 $this->loadCodeTemplate($template);
885                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
886
887                                                 // Remember this template for recursion detection
888                                                 // RECURSIVE PROTECTION!
889                                                 $this->loadedTemplates[] = $template;
890                                         } catch (FileIoException $e) {
891                                                 // Even this is not done... :/
892                                                 $this->rawTemplates[] = $template;
893                                         }
894                                 }
895                         } // END - if
896                 } // END - foreach
897
898                 // Restore the raw template data
899                 $this->setRawTemplateData($backup);
900         }
901
902         /**
903          * Compile a given raw template code and remember it for later usage
904          *
905          * @param       $code           The raw template code
906          * @param       $template       The template's name
907          * @return      void
908          */
909         private function compileCode ($code, $template) {
910                 // Is this template already compiled?
911                 if (in_array($template, $this->compiledTemplates)) {
912                         // Abort here...
913                         return;
914                 } // END - if
915
916                 // Remember this template being compiled
917                 $this->compiledTemplates[] = $template;
918
919                 // Compile the loaded code in five steps:
920                 //
921                 // 1. Backup current template data
922                 $backup = $this->getRawTemplateData();
923
924                 // 2. Set the current template's raw data as the new content
925                 $this->setRawTemplateData($code);
926
927                 // 3. Compile the template data
928                 $this->compileTemplate();
929
930                 // 4. Remember it's contents
931                 $this->loadedRawData[$template] = $this->getRawTemplateData();
932
933                 // 5. Restore the previous raw content from backup variable
934                 $this->setRawTemplateData($backup);
935         }
936
937         /**
938          * Insert all given and loaded templates by running through all loaded
939          * codes and searching for their place-holder in the main template
940          *
941          * @param       $templateMatches        See method analyzeTemplate()
942          * @return      void
943          */
944         private function insertAllTemplates (array $templateMatches) {
945                 // Run through all loaded codes
946                 foreach ($this->loadedRawData as $template => $code) {
947
948                         // Search for the template
949                         $foundIndex = array_search($template, $templateMatches[1]);
950
951                         // Lookup the matching template replacement
952                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
953
954                                 // Get the current raw template
955                                 $rawData = $this->getRawTemplateData();
956
957                                 // Replace the space holder with the template code
958                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
959
960                                 // Set the new raw data
961                                 $this->setRawTemplateData($rawData);
962                         } // END - if
963                 } // END - foreach
964         }
965
966         /**
967          * Load all extra raw templates
968          *
969          * @return      void
970          */
971         private function loadExtraRawTemplates () {
972                 // Are there some raw templates we need to load?
973                 if (count($this->rawTemplates) > 0) {
974                         // Try to load all raw templates
975                         foreach ($this->rawTemplates as $key => $template) {
976                                 try {
977                                         // Load the template
978                                         $this->loadWebTemplate($template);
979
980                                         // Remember it's contents
981                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
982
983                                         // Remove it from the loader list
984                                         unset($this->rawTemplates[$key]);
985
986                                         // Remember this template for recursion detection
987                                         // RECURSIVE PROTECTION!
988                                         $this->loadedTemplates[] = $template;
989                                 } catch (FileIoException $e) {
990                                         // This template was never found. We silently ignore it
991                                         unset($this->rawTemplates[$key]);
992                                 }
993                         } // END - foreach
994                 } // END - if
995         }
996
997         /**
998          * Assign all found template variables
999          *
1000          * @param       $varMatches             An array full of variable/value pairs.
1001          * @return      void
1002          * @todo        Unfinished work or don't die here.
1003          */
1004         private function assignAllVariables (array $varMatches) {
1005                 // Debug message
1006                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1007
1008                 // Search for all variables
1009                 foreach ($varMatches[1] as $key => $var) {
1010                         // Replace all dashes to underscores to match variables with configuration entries
1011                         $var = trim($this->convertDashesToUnderscores($var));
1012
1013                         // Debug message
1014                         $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1015
1016                         // Detect leading equals
1017                         if (substr($varMatches[2][$key], 0, 1) == '=') {
1018                                 // Remove and cast it
1019                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1020                         } // END - if
1021
1022                         // Do we have some quotes left and right side? Then it is free text
1023                         if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
1024                                 // Free string detected! Which we can assign directly
1025                                 $this->assignVariable($var, $varMatches[3][$key]);
1026                         } elseif (!empty($varMatches[2][$key])) {
1027                                 // @TODO Non-string found so we need some deeper analysis...
1028                                 ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
1029                         }
1030                 } // END - foreach
1031         }
1032
1033         /**
1034          * Compiles all loaded raw templates
1035          *
1036          * @param       $templateMatches        See method analyzeTemplate() for details
1037          * @return      void
1038          */
1039         private function compileRawTemplateData (array $templateMatches) {
1040                 // Debug message
1041                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1042
1043                 // Are some code-templates found which we need to compile?
1044                 if (count($this->loadedRawData) > 0) {
1045                         // Then compile all!
1046                         foreach ($this->loadedRawData as $template => $code) {
1047                                 // Debug message
1048                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1049
1050                                 // Is this template already compiled?
1051                                 if (in_array($template, $this->compiledTemplates)) {
1052                                         // Then skip it
1053                                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1054                                         continue;
1055                                 } // END - if
1056
1057                                 // Search for the template
1058                                 $foundIndex = array_search($template, $templateMatches[1]);
1059
1060                                 // Lookup the matching variable data
1061                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1062                                         // Split it up with another reg. exp. into variable=value pairs
1063                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1064                                         //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, true));
1065
1066                                         // Assign all variables
1067                                         $this->assignAllVariables($varMatches);
1068                                 } // END - if (isset($templateMatches ...
1069
1070                                 // Compile the loaded template
1071                                 $this->compileCode($code, $template);
1072                         } // END - foreach ($this->loadedRawData ...
1073
1074                         // Insert all templates
1075                         $this->insertAllTemplates($templateMatches);
1076                 } // END - if (count($this->loadedRawData) ...
1077         }
1078
1079         /**
1080          * Inserts all raw templates into their respective variables
1081          *
1082          * @return      void
1083          */
1084         private function insertRawTemplates () {
1085                 // Load all templates
1086                 foreach ($this->rawTemplates as $template => $content) {
1087                         // Set the template as a variable with the content
1088                         $this->assignVariable($template, $content);
1089                 }
1090         }
1091
1092         /**
1093          * Finalizes the compilation of all template variables
1094          *
1095          * @return      void
1096          */
1097         private function finalizeVariableCompilation () {
1098                 // Get the content
1099                 $content = $this->getRawTemplateData();
1100                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1101
1102                 // Do we have the stack?
1103                 if (!$this->isVarStackSet('general')) {
1104                         // Abort here silently
1105                         // @TODO This silent abort should be logged, maybe.
1106                         return;
1107                 } // END - if
1108
1109                 // Walk through all variables
1110                 foreach ($this->getVarStack('general') as $currEntry) {
1111                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1112                         // Replace all [$var] or {?$var?} with the content
1113                         // @TODO Old behaviour, will become obsolete!
1114                         $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1115
1116                         // @TODO Yet another old way
1117                         $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1118
1119                         // The new behaviour
1120                         $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1121                 } // END - for
1122
1123                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1124
1125                 // Set the content back
1126                 $this->setRawTemplateData($content);
1127         }
1128
1129         /**
1130          * Load a specified web template into the engine
1131          *
1132          * @param       $template       The web template we shall load which is located in
1133          *                                              'html' by default
1134          * @return      void
1135          */
1136         public function loadWebTemplate ($template) {
1137                 // Set template type
1138                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1139
1140                 // Load the special template
1141                 $this->loadTemplate($template);
1142         }
1143
1144         /**
1145          * Assign a given congfiguration variable with a value
1146          *
1147          * @param       $variableName   The configuration variable we want to assign
1148          * @return      void
1149          */
1150         public function assignConfigVariable ($variableName) {
1151                 // Replace all dashes to underscores to match variables with configuration entries
1152                 $variableName = trim($this->convertDashesToUnderscores($variableName));
1153
1154                 // Sweet and simple...
1155                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1156                 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1157         }
1158
1159         /**
1160          * Load a specified code template into the engine
1161          *
1162          * @param       $template       The code template we shall load which is
1163          *                                              located in 'code' by default
1164          * @return      void
1165          */
1166         public function loadCodeTemplate ($template) {
1167                 // Set template type
1168                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1169
1170                 // Load the special template
1171                 $this->loadTemplate($template);
1172         }
1173
1174         /**
1175          * Compiles configuration place-holders in all variables. This 'walks'
1176          * through the variable stack 'general'. It interprets all values from that
1177          * variables as configuration entries after compiling them.
1178          *
1179          * @return      void
1180          */
1181         public final function compileConfigInVariables () {
1182                 // Do we have the stack?
1183                 if (!$this->isVarStackSet('general')) {
1184                         // Abort here silently
1185                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1186                         return;
1187                 } // END - if
1188
1189                 // Iterate through all general variables
1190                 foreach ($this->getVarStack('general') as $index => $currVariable) {
1191                         // Compile the value
1192                         $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1193
1194                         // Debug message
1195                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1196
1197                         // Remove it from stack
1198                         $this->removeVariable($currVariable['name'], 'general');
1199
1200                         // Re-assign the variable
1201                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1202                         $this->assignConfigVariable($value);
1203                 } // END - foreach
1204         }
1205
1206         /**
1207          * Compile all variables by inserting their respective values
1208          *
1209          * @return      void
1210          * @todo        Make this code some nicer...
1211          */
1212         public final function compileVariables () {
1213                 // Initialize the $content array
1214                 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1215                 $dummy = array();
1216
1217                 // Iterate through all general variables
1218                 foreach ($this->getVarStack('general') as $currVariable) {
1219                         // Transfer it's name/value combination to the $content array
1220                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1221                         $dummy[$currVariable['name']] = $currVariable['value'];
1222                 }// END - if
1223
1224                 // Set the new variable (don't remove the second dollar!)
1225                 $$validVar = $dummy;
1226
1227                 // Remove some variables
1228                 unset($index);
1229                 unset($currVariable);
1230
1231                 // Run the compilation three times to get content from helper classes in
1232                 $cnt = 0;
1233                 while ($cnt < 3) {
1234                         // Finalize the compilation of template variables
1235                         $this->finalizeVariableCompilation();
1236
1237                         // Prepare the eval() command for comiling the template
1238                         $eval = sprintf("\$result = \"%s\";",
1239                                 addslashes($this->getRawTemplateData())
1240                         );
1241
1242                         // This loop does remove the backslashes (\) in PHP parameters
1243                         while (strpos($eval, $this->codeBegin) !== false) {
1244                                 // Get left part before "<?"
1245                                 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1246
1247                                 // Get all from right of "<?"
1248                                 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1249
1250                                 // Cut middle part out and remove escapes
1251                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1252                                 $evalMiddle = stripslashes($evalMiddle);
1253
1254                                 // Remove the middle part from right one
1255                                 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1256
1257                                 // And put all together
1258                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1259                         } // END - while
1260
1261                         // Prepare PHP code for eval() command
1262                         $eval = str_replace(
1263                                 "<%php", "\";",
1264                                 str_replace(
1265                                         "%>",
1266                                         "\n\$result .= \"",
1267                                         $eval
1268                                 )
1269                         );
1270
1271                         // Run the constructed command. This will "compile" all variables in
1272                         eval($eval);
1273
1274                         // Goes something wrong?
1275                         if ((!isset($result)) || (empty($result))) {
1276                                 // Output eval command
1277                                 $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1278
1279                                 // Output backtrace here
1280                                 $this->debugBackTrace();
1281                         } // END - if
1282
1283                         // Set raw template data
1284                         $this->setRawTemplateData($result);
1285                         $cnt++;
1286                 } // END - while
1287
1288                 // Final variable assignment
1289                 $this->finalizeVariableCompilation();
1290
1291                 // Set the new content
1292                 $this->setCompiledData($this->getRawTemplateData());
1293         }
1294
1295         /**
1296          * Compile all required templates into the current loaded one
1297          *
1298          * @return      void
1299          * @throws      UnexpectedTemplateTypeException If the template type is
1300          *                                                                                      not "code"
1301          * @throws      InvalidArrayCountException              If an unexpected array
1302          *                                                                                      count has been found
1303          */
1304         public function compileTemplate () {
1305                 // Get code type to make things shorter
1306                 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1307
1308                 // We will only work with template type "code" from configuration
1309                 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1310                         // Abort here
1311                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1312                 } // END - if
1313
1314                 // Get the raw data.
1315                 $rawData = $this->getRawTemplateData();
1316
1317                 // Remove double spaces and trim leading/trailing spaces
1318                 $rawData = trim(str_replace('  ', ' ', $rawData));
1319
1320                 // Search for raw variables
1321                 $this->extractVariablesFromRawData($rawData);
1322
1323                 // Search for code-tags which are {? ?}
1324                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1325
1326                 // Debug message
1327                 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
1328
1329                 // Analyze the matches array
1330                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1331                         // Entries are found:
1332                         //
1333                         // The main analysis
1334                         $this->analyzeTemplate($templateMatches);
1335
1336                         // Compile raw template data
1337                         $this->compileRawTemplateData($templateMatches);
1338
1339                         // Are there some raw templates left for loading?
1340                         $this->loadExtraRawTemplates();
1341
1342                         // Are some raw templates found and loaded?
1343                         if (count($this->rawTemplates) > 0) {
1344                                 // Insert all raw templates
1345                                 $this->insertRawTemplates();
1346
1347                                 // Remove the raw template content as well
1348                                 $this->setRawTemplateData('');
1349                         } // END - if
1350                 } // END - if($templateMatches ...
1351         }
1352
1353         /**
1354          * Loads a given view helper (by name)
1355          *
1356          * @param       $helperName             The helper's name
1357          * @return      void
1358          */
1359         protected function loadViewHelper ($helperName) {
1360                 // Make first character upper case, rest low
1361                 $helperName = $this->convertToClassName($helperName);
1362
1363                 // Is this view helper loaded?
1364                 if (!isset($this->helpers[$helperName])) {
1365                         // Create a class name
1366                         $className = $helperName . 'ViewHelper';
1367
1368                         // Generate new instance
1369                         $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1370                 } // END - if
1371
1372                 // Return the requested instance
1373                 return $this->helpers[$helperName];
1374         }
1375
1376         /**
1377          * Assigns the last loaded raw template content with a given variable
1378          *
1379          * @param       $templateName   Name of the template we want to assign
1380          * @param       $variableName   Name of the variable we want to assign
1381          * @return      void
1382          */
1383         public function assignTemplateWithVariable ($templateName, $variableName) {
1384                 // Get the content from last loaded raw template
1385                 $content = $this->getRawTemplateData();
1386
1387                 // Assign the variable
1388                 $this->assignVariable($variableName, $content);
1389
1390                 // Purge raw content
1391                 $this->setRawTemplateData('');
1392         }
1393
1394         /**
1395          * Transfers the content of this template engine to a given response instance
1396          *
1397          * @param       $responseInstance       An instance of a response class
1398          * @return      void
1399          */
1400         public function transferToResponse (Responseable $responseInstance) {
1401                 // Get the content and set it in response class
1402                 $responseInstance->writeToBody($this->getCompiledData());
1403         }
1404
1405         /**
1406          * Assigns all the application data with template variables
1407          *
1408          * @param       $applicationInstance    A manageable application instance
1409          * @return      void
1410          */
1411         public function assignApplicationData (ManageableApplication $applicationInstance) {
1412                 // Get long name and assign it
1413                 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1414
1415                 // Get short name and assign it
1416                 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1417
1418                 // Get version number and assign it
1419                 $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
1420
1421                 // Assign extra application-depending data
1422                 $applicationInstance->assignExtraTemplateData($this);
1423         }
1424
1425         /**
1426          * "Compiles" a variable by replacing {?var?} with it's content
1427          *
1428          * @param       $rawCode                        Raw code to compile
1429          * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
1430          * @return      $rawCode        Compile code with inserted variable value
1431          */
1432         public function compileRawCode ($rawCode, $setMatchAsCode=false) {
1433                 // Find the variables
1434                 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1435                 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1436
1437                 // Compile all variables
1438                 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
1439                 foreach ($varMatches[0] as $match) {
1440                         // Add variable tags around it
1441                         $varCode = '{?' . $match . '?}';
1442
1443                         // Debug message
1444                         //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1445
1446                         // Is the variable found in code? (safes some calls)
1447                         if (strpos($rawCode, $varCode) !== false) {
1448                                 // Debug message
1449                                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1450
1451                                 // Use $match as new value or $value from read variable?
1452                                 if ($setMatchAsCode === true) {
1453                                         // Insert match
1454                                         $rawCode = str_replace($varCode, $match, $rawCode);
1455                                 } else {
1456                                         // Read the variable
1457                                         $value = $this->readVariable($match);
1458
1459                                         // Insert value
1460                                         $rawCode = str_replace($varCode, $value, $rawCode);
1461                                 }
1462                         } // END - if
1463                 } // END - foreach
1464
1465                 // Return the compiled data
1466                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1467                 return $rawCode;
1468         }
1469
1470         /**
1471          * Getter for variable group array
1472          *
1473          * @return      $vargroups      All variable groups
1474          */
1475         public final function getVariableGroups () {
1476                 return $this->varGroups;
1477         }
1478
1479         /**
1480          * Renames a variable in code and in stack
1481          *
1482          * @param       $oldName        Old name of variable
1483          * @param       $newName        New name of variable
1484          * @return      void
1485          */
1486         public function renameVariable ($oldName, $newName) {
1487                 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1488                 // Get raw template code
1489                 $rawData = $this->getRawTemplateData();
1490
1491                 // Replace it
1492                 $rawData = str_replace($oldName, $newName, $rawData);
1493
1494                 // Set the code back
1495                 $this->setRawTemplateData($rawData);
1496         }
1497
1498         /**
1499          * Renders the given XML content
1500          *
1501          * @param       $content        Valid XML content or if not set the current loaded raw content
1502          * @return      void
1503          * @throws      XmlParserException      If an XML error was found
1504          */
1505         public function renderXmlContent ($content = NULL) {
1506                 // Is the content set?
1507                 if (is_null($content)) {
1508                         // Get current content
1509                         $content = $this->getRawTemplateData();
1510                 } // END - if
1511
1512                 // Get a XmlParser instance
1513                 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1514
1515                 // Check if we have XML compacting enabled
1516                 if ($this->isXmlCompactingEnabled()) {
1517                         // Yes, so get a decorator class for transparent compacting
1518                         $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1519                 } // END - if
1520
1521                 // Parse the XML document
1522                 $parserInstance->parseXmlContent($content);
1523         }
1524
1525         /**
1526          * Enables or disables language support
1527          *
1528          * @param       $languageSupport        New language support setting
1529          * @return      void
1530          */
1531         public final function enableLanguageSupport ($languageSupport = true) {
1532                 $this->languageSupport = (bool) $languageSupport;
1533         }
1534
1535         /**
1536          * Checks whether language support is enabled
1537          *
1538          * @return      $languageSupport        Whether language support is enabled or disabled
1539          */
1540         public final function isLanguageSupportEnabled () {
1541                 return $this->languageSupport;
1542         }
1543
1544         /**
1545          * Enables or disables XML compacting
1546          *
1547          * @param       $xmlCompacting  New XML compacting setting
1548          * @return      void
1549          */
1550         public final function enableXmlCompacting ($xmlCompacting = true) {
1551                 $this->xmlCompacting = (bool) $xmlCompacting;
1552         }
1553
1554         /**
1555          * Checks whether XML compacting is enabled
1556          *
1557          * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
1558          */
1559         public final function isXmlCompactingEnabled () {
1560                 return $this->xmlCompacting;
1561         }
1562
1563         /**
1564          * Removes all commentd, tabs and new-line characters to compact the content
1565          *
1566          * @param       $uncompactedContent             The uncompacted content
1567          * @return      $compactedContent               The compacted content
1568          */
1569         public function compactContent ($uncompactedContent) {
1570                 // First, remove all tab/new-line/revert characters
1571                 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1572
1573                 // Then regex all comments like <!-- //--> away
1574                 preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
1575
1576                 // Do we have entries?
1577                 if (isset($matches[0][0])) {
1578                         // Remove all
1579                         foreach ($matches[0] as $match) {
1580                                 // Remove the match
1581                                 $compactedContent = str_replace($match, '', $compactedContent);
1582                         } // END - foreach
1583                 } // END - if
1584
1585                 // Set the content again
1586                 $this->setRawTemplateData($compactedContent);
1587
1588                 // Return compacted content
1589                 return $compactedContent;
1590         }
1591 }
1592
1593 // [EOF]
1594 ?>