Fixed variable group handling by unsetting right index
[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       $variableGroup  Optional variable group to look in
172          * @return      $index                  FALSE means not found, >=0 means found on a specific index
173          */
174         private function getVariableIndex ($variableName, $variableGroup = 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($variableGroup)) {
183                         // Use current group
184                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
185                         $variableGroup = $this->currGroup;
186                 } // END - if
187
188                 // Is the group there?
189                 if ($this->isVarStackSet($variableGroup)) {
190                         // Now search for it
191                         foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
192                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
193                                 // Is the entry found?
194                                 if ($currEntry['name'] == $variableName) {
195                                         // Found!
196                                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->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 group is set
209          *
210          * @param       $variableGroup  Variable group to check
211          * @return      $isSet                  Whether the given variable group is set
212          */
213         protected final function isVarStackSet ($variableGroup) {
214                 // Check it
215                 $isSet = isset($this->varStack[$variableGroup]);
216
217                 // Return result
218                 return $isSet;
219         }
220
221         /**
222          * Getter for given variable group
223          *
224          * @param       $variableGroup  Variable group to check
225          * @return      $varStack               Found variable group
226          */
227         public final function getVarStack ($variableGroup) {
228                 return $this->varStack[$variableGroup];
229         }
230
231         /**
232          * Setter for given variable group
233          *
234          * @param       $variableGroup  Variable group to check
235          * @param       $varStack               Variable stack to check
236          * @return      void
237          */
238         protected final function setVarStack ($variableGroup, array $varStack) {
239                 $this->varStack[$variableGroup]  = $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       $variableGroup  Optional variable group to look in
247          * @return      $content                Content of the variable or null if not found
248          */
249         protected function readVariable ($variableName, $variableGroup = 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($variableGroup)) {
258                         // Use current group
259                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
260                         $variableGroup = $this->currGroup;
261                 } // END - if
262
263                 // Get variable index
264                 $found = $this->getVariableIndex($variableName, $variableGroup);
265
266                 // Is the variable found?
267                 if ($found !== false) {
268                         // Read it
269                         $content = $this->getVariableValue($variableGroup, $found);
270                 } // END - if
271
272                 // Return the current position
273                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
274                 return $content;
275         }
276
277         /**
278          * Add a variable to the stack
279          *
280          * @param       $variableName   Name of variable to add
281          * @param       $value                  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: */ self::createDebugInstance(__CLASS__)->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: */ self::createDebugInstance(__CLASS__)->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: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
605                         $this->addVariable($variableName, $value);
606                 } elseif (!empty($value)) {
607                         // Modify the stack entry
608                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->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          * @param       $variableGroup  Name of variable group (default: 'general')
618          * @return      void
619          */
620         public final function removeVariable ($variableName, $variableGroup = 'general') {
621                 // First search for the variable if it was already added
622                 $index = $this->getVariableIndex($variableName, $variableGroup);
623
624                 // Was it found?
625                 if ($index !== false) {
626                         // Remove this variable
627                         $this->unsetVariableStackOffset($index, $variableGroup);
628                 } // END - if
629         }
630
631         /**
632          * Unsets the given offset in the variable group
633          *
634          * @param       $index                  Index to unset
635          * @param       $variableGroup  Variable group (default: currGroup)
636          * @return      void
637          */
638         protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
639                 // Is the variable group not set?
640                 if (is_null($variableGroup)) {
641                         // Then set it to current
642                         $variableGroup = $this->currGroup;
643                 } // END - if
644
645                 // Is the entry there?
646                 if (!isset($this->varStack[$variableGroup][$index])) {
647                         // Abort here, we need fixing!
648                         $this->debugInstance();
649                 } // END - if
650
651                 // Remove it
652                 unset($this->varStack[$variableGroup][$index]);
653         }
654
655         /**
656          * Private setter for raw template data
657          *
658          * @param       $rawTemplateData        The raw data from the template
659          * @return      void
660          */
661         protected final function setRawTemplateData ($rawTemplateData) {
662                 // And store it in this class
663                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
664                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
665                 $this->rawTemplateData = (string) $rawTemplateData;
666         }
667
668         /**
669          * Getter for raw template data
670          *
671          * @return      $rawTemplateData        The raw data from the template
672          */
673         public final function getRawTemplateData () {
674                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
675                 return $this->rawTemplateData;
676         }
677
678         /**
679          * Private setter for compiled templates
680          *
681          * @return      void
682          */
683         private final function setCompiledData ($compiledData) {
684                 // And store it in this class
685                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
686                 $this->compiledData = (string) $compiledData;
687         }
688
689         /**
690          * Getter for compiled templates
691          *
692          * @return      $compiledData   Compiled template data
693          */
694         public final function getCompiledData () {
695                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
696                 return $this->compiledData;
697         }
698
699         /**
700          * Private loader for all template types
701          *
702          * @param       $template       The template we shall load
703          * @param       $extOther       An other extension to use
704          * @return      void
705          * @throws      FileIoException If the template was not found
706          */
707         protected function loadTemplate ($template, $extOther = '') {
708                 // Get extension for the template if empty
709                 if (empty($extOther)) {
710                         // None provided, so get the raw one
711                         $ext = $this->getRawTemplateExtension();
712                 } else {
713                         // Then use it!
714                         $ext = (string) $extOther;
715                 }
716
717                 // Is language support enabled?
718                 if ($this->isLanguageSupportEnabled()) {
719                         // Construct the FQFN for the template by honoring the current language
720                         $fqfn = sprintf("%s%s%s%s/%s/%s%s",
721                                 $this->getConfigInstance()->getConfigEntry('base_path'),
722                                 $this->getTemplateBasePath(),
723                                 $this->getGenericBasePath(),
724                                 $this->getLanguageInstance()->getLanguageCode(),
725                                 $this->getTemplateType(),
726                                 (string) $template,
727                                 $ext
728                         );
729                 } else {
730                         // Construct the FQFN for the template without language
731                         $fqfn = sprintf("%s%s%s%s/%s%s",
732                                 $this->getConfigInstance()->getConfigEntry('base_path'),
733                                 $this->getTemplateBasePath(),
734                                 $this->getGenericBasePath(),
735                                 $this->getTemplateType(),
736                                 (string) $template,
737                                 $ext
738                         );
739                 }
740
741                 // First try this
742                 try {
743                         // Load the raw template data
744                         $this->loadRawTemplateData($fqfn);
745                 } catch (FileIoException $e) {
746                         // If we shall load a code-template we need to switch the file extension
747                         if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
748                                 // Switch over to the code-template extension and try it again
749                                 $ext = $this->getCodeTemplateExtension();
750
751                                 // Try it again...
752                                 $this->loadTemplate($template, $ext);
753                         } else {
754                                 // Throw it again
755                                 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
756                         }
757                 }
758
759         }
760
761         /**
762          * A private loader for raw template names
763          *
764          * @param       $fqfn   The full-qualified file name for a template
765          * @return      void
766          */
767         private function loadRawTemplateData ($fqfn) {
768                 // Get a input/output instance from the middleware
769                 $ioInstance = $this->getFileIoInstance();
770
771                 // Some debug code to look on the file which is being loaded
772                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
773
774                 // Load the raw template
775                 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
776
777                 // Store the template's contents into this class
778                 $this->setRawTemplateData($rawTemplateData);
779
780                 // Remember the template's FQFN
781                 $this->setLastTemplate($fqfn);
782         }
783
784         /**
785          * Try to assign an extracted template variable as a "content" or 'config'
786          * variable.
787          *
788          * @param       $varName                The variable's name (shall be content or config)
789          *                                                      by default
790          * @param       $variableName   The variable we want to assign
791          * @return      void
792          */
793         private function assignTemplateVariable ($varName, $var) {
794                 // Replace all dashes to underscores to match variables with configuration entries
795                 $variableName = trim($this->convertDashesToUnderscores($variableName));
796
797                 // Debug message
798                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
799
800                 // Is it not a config variable?
801                 if ($varName != 'config') {
802                         // Regular template variables
803                         $this->assignVariable($variableName, '');
804                 } else {
805                         // Configuration variables
806                         $this->assignConfigVariable($variableName);
807                 }
808         }
809
810         /**
811          * Extract variables from a given raw data stream
812          *
813          * @param       $rawData        The raw template data we shall analyze
814          * @return      void
815          */
816         private function extractVariablesFromRawData ($rawData) {
817                 // Cast to string
818                 $rawData = (string) $rawData;
819
820                 // Search for variables
821                 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
822
823                 // Debug message
824                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
825
826                 // Did we find some variables?
827                 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
828                         // Initialize all missing variables
829                         foreach ($variableMatches[3] as $key => $var) {
830                                 // Variable name
831                                 $varName = $variableMatches[1][$key];
832
833                                 // Workarround: Do not assign empty variables
834                                 if (!empty($var)) {
835                                         // Try to assign it, empty strings are being ignored
836                                         $this->assignTemplateVariable($varName, $var);
837                                 } // END - if
838                         } // END - foreach
839                 } // END - if
840         }
841
842         /**
843          * Main analysis of the loaded template
844          *
845          * @param       $templateMatches        Found template place-holders, see below
846          * @return      void
847          *
848          *---------------------------------
849          * Structure of $templateMatches:
850          *---------------------------------
851          * [0] => Array - An array with all full matches
852          * [1] => Array - An array with left part (before the ':') of a match
853          * [2] => Array - An array with right part of a match including ':'
854          * [3] => Array - An array with right part of a match excluding ':'
855          */
856         private function analyzeTemplate (array $templateMatches) {
857                 // Backup raw template data
858                 $backup = $this->getRawTemplateData();
859
860                 // Initialize some arrays
861                 if (is_null($this->loadedRawData)) {
862                         // Initialize both
863                         $this->loadedRawData = array();
864                         $this->rawTemplates = array();
865                 } // END - if
866
867                 // Load all requested templates
868                 foreach ($templateMatches[1] as $template) {
869                         // Load and compile only templates which we have not yet loaded
870                         // RECURSIVE PROTECTION! BE CAREFUL HERE!
871                         if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
872                                 // Debug message
873                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
874
875                                 // Template not found, but maybe variable assigned?
876                                 if ($this->getVariableIndex($template, 'config') !== false) {
877                                         // Use that content here
878                                         $this->loadedRawData[$template] = $this->readVariable($template, 'config');
879
880                                         // Recursive protection:
881                                         $this->loadedTemplates[] = $template;
882                                 } elseif ($this->getVariableIndex($template) !== false) {
883                                         // Use that content here
884                                         $this->loadedRawData[$template] = $this->readVariable($template);
885
886                                         // Recursive protection:
887                                         $this->loadedTemplates[] = $template;
888                                 } else {
889                                         // Then try to search for code-templates
890                                         try {
891                                                 // Load the code template and remember it's contents
892                                                 $this->loadCodeTemplate($template);
893                                                 $this->loadedRawData[$template] = $this->getRawTemplateData();
894
895                                                 // Remember this template for recursion detection
896                                                 // RECURSIVE PROTECTION!
897                                                 $this->loadedTemplates[] = $template;
898                                         } catch (FileIoException $e) {
899                                                 // Even this is not done... :/
900                                                 $this->rawTemplates[] = $template;
901                                         }
902                                 }
903                         } // END - if
904                 } // END - foreach
905
906                 // Restore the raw template data
907                 $this->setRawTemplateData($backup);
908         }
909
910         /**
911          * Compile a given raw template code and remember it for later usage
912          *
913          * @param       $code           The raw template code
914          * @param       $template       The template's name
915          * @return      void
916          */
917         private function compileCode ($code, $template) {
918                 // Is this template already compiled?
919                 if (in_array($template, $this->compiledTemplates)) {
920                         // Abort here...
921                         return;
922                 } // END - if
923
924                 // Remember this template being compiled
925                 $this->compiledTemplates[] = $template;
926
927                 // Compile the loaded code in five steps:
928                 //
929                 // 1. Backup current template data
930                 $backup = $this->getRawTemplateData();
931
932                 // 2. Set the current template's raw data as the new content
933                 $this->setRawTemplateData($code);
934
935                 // 3. Compile the template data
936                 $this->compileTemplate();
937
938                 // 4. Remember it's contents
939                 $this->loadedRawData[$template] = $this->getRawTemplateData();
940
941                 // 5. Restore the previous raw content from backup variable
942                 $this->setRawTemplateData($backup);
943         }
944
945         /**
946          * Insert all given and loaded templates by running through all loaded
947          * codes and searching for their place-holder in the main template
948          *
949          * @param       $templateMatches        See method analyzeTemplate()
950          * @return      void
951          */
952         private function insertAllTemplates (array $templateMatches) {
953                 // Run through all loaded codes
954                 foreach ($this->loadedRawData as $template => $code) {
955
956                         // Search for the template
957                         $foundIndex = array_search($template, $templateMatches[1]);
958
959                         // Lookup the matching template replacement
960                         if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
961
962                                 // Get the current raw template
963                                 $rawData = $this->getRawTemplateData();
964
965                                 // Replace the space holder with the template code
966                                 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
967
968                                 // Set the new raw data
969                                 $this->setRawTemplateData($rawData);
970                         } // END - if
971                 } // END - foreach
972         }
973
974         /**
975          * Load all extra raw templates
976          *
977          * @return      void
978          */
979         private function loadExtraRawTemplates () {
980                 // Are there some raw templates we need to load?
981                 if (count($this->rawTemplates) > 0) {
982                         // Try to load all raw templates
983                         foreach ($this->rawTemplates as $key => $template) {
984                                 try {
985                                         // Load the template
986                                         $this->loadWebTemplate($template);
987
988                                         // Remember it's contents
989                                         $this->rawTemplates[$template] = $this->getRawTemplateData();
990
991                                         // Remove it from the loader list
992                                         unset($this->rawTemplates[$key]);
993
994                                         // Remember this template for recursion detection
995                                         // RECURSIVE PROTECTION!
996                                         $this->loadedTemplates[] = $template;
997                                 } catch (FileIoException $e) {
998                                         // This template was never found. We silently ignore it
999                                         unset($this->rawTemplates[$key]);
1000                                 }
1001                         } // END - foreach
1002                 } // END - if
1003         }
1004
1005         /**
1006          * Assign all found template variables
1007          *
1008          * @param       $varMatches             An array full of variable/value pairs.
1009          * @return      void
1010          * @todo        Unfinished work or don't die here.
1011          */
1012         private function assignAllVariables (array $varMatches) {
1013                 // Debug message
1014                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1015
1016                 // Search for all variables
1017                 foreach ($varMatches[1] as $key => $var) {
1018                         // Replace all dashes to underscores to match variables with configuration entries
1019                         $var = trim($this->convertDashesToUnderscores($var));
1020
1021                         // Debug message
1022                         self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1023
1024                         // Detect leading equals
1025                         if (substr($varMatches[2][$key], 0, 1) == '=') {
1026                                 // Remove and cast it
1027                                 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1028                         } // END - if
1029
1030                         // Do we have some quotes left and right side? Then it is free text
1031                         if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
1032                                 // Free string detected! Which we can assign directly
1033                                 $this->assignVariable($var, $varMatches[3][$key]);
1034                         } elseif (!empty($varMatches[2][$key])) {
1035                                 // @TODO Non-string found so we need some deeper analysis...
1036                                 ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
1037                         }
1038                 } // END - foreach
1039         }
1040
1041         /**
1042          * Compiles all loaded raw templates
1043          *
1044          * @param       $templateMatches        See method analyzeTemplate() for details
1045          * @return      void
1046          */
1047         private function compileRawTemplateData (array $templateMatches) {
1048                 // Debug message
1049                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1050
1051                 // Are some code-templates found which we need to compile?
1052                 if (count($this->loadedRawData) > 0) {
1053                         // Then compile all!
1054                         foreach ($this->loadedRawData as $template => $code) {
1055                                 // Debug message
1056                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1057
1058                                 // Is this template already compiled?
1059                                 if (in_array($template, $this->compiledTemplates)) {
1060                                         // Then skip it
1061                                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1062                                         continue;
1063                                 } // END - if
1064
1065                                 // Search for the template
1066                                 $foundIndex = array_search($template, $templateMatches[1]);
1067
1068                                 // Lookup the matching variable data
1069                                 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1070                                         // Split it up with another reg. exp. into variable=value pairs
1071                                         preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1072                                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, true));
1073
1074                                         // Assign all variables
1075                                         $this->assignAllVariables($varMatches);
1076                                 } // END - if (isset($templateMatches ...
1077
1078                                 // Compile the loaded template
1079                                 $this->compileCode($code, $template);
1080                         } // END - foreach ($this->loadedRawData ...
1081
1082                         // Insert all templates
1083                         $this->insertAllTemplates($templateMatches);
1084                 } // END - if (count($this->loadedRawData) ...
1085         }
1086
1087         /**
1088          * Inserts all raw templates into their respective variables
1089          *
1090          * @return      void
1091          */
1092         private function insertRawTemplates () {
1093                 // Load all templates
1094                 foreach ($this->rawTemplates as $template => $content) {
1095                         // Set the template as a variable with the content
1096                         $this->assignVariable($template, $content);
1097                 }
1098         }
1099
1100         /**
1101          * Finalizes the compilation of all template variables
1102          *
1103          * @return      void
1104          */
1105         private function finalizeVariableCompilation () {
1106                 // Get the content
1107                 $content = $this->getRawTemplateData();
1108                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1109
1110                 // Do we have the stack?
1111                 if (!$this->isVarStackSet('general')) {
1112                         // Abort here silently
1113                         // @TODO This silent abort should be logged, maybe.
1114                         return;
1115                 } // END - if
1116
1117                 // Walk through all variables
1118                 foreach ($this->getVarStack('general') as $currEntry) {
1119                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1120                         // Replace all [$var] or {?$var?} with the content
1121                         // @TODO Old behaviour, will become obsolete!
1122                         $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1123
1124                         // @TODO Yet another old way
1125                         $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1126
1127                         // The new behaviour
1128                         $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1129                 } // END - for
1130
1131                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1132
1133                 // Set the content back
1134                 $this->setRawTemplateData($content);
1135         }
1136
1137         /**
1138          * Load a specified web template into the engine
1139          *
1140          * @param       $template       The web template we shall load which is located in
1141          *                                              'html' by default
1142          * @return      void
1143          */
1144         public function loadWebTemplate ($template) {
1145                 // Set template type
1146                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1147
1148                 // Load the special template
1149                 $this->loadTemplate($template);
1150         }
1151
1152         /**
1153          * Assign a given congfiguration variable with a value
1154          *
1155          * @param       $variableName   The configuration variable we want to assign
1156          * @return      void
1157          */
1158         public function assignConfigVariable ($variableName) {
1159                 // Replace all dashes to underscores to match variables with configuration entries
1160                 $variableName = trim($this->convertDashesToUnderscores($variableName));
1161
1162                 // Sweet and simple...
1163                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1164                 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1165         }
1166
1167         /**
1168          * Load a specified code template into the engine
1169          *
1170          * @param       $template       The code template we shall load which is
1171          *                                              located in 'code' by default
1172          * @return      void
1173          */
1174         public function loadCodeTemplate ($template) {
1175                 // Set template type
1176                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1177
1178                 // Load the special template
1179                 $this->loadTemplate($template);
1180         }
1181
1182         /**
1183          * Compiles configuration place-holders in all variables. This 'walks'
1184          * through the variable group 'general'. It interprets all values from that
1185          * variables as configuration entries after compiling them.
1186          *
1187          * @return      void
1188          */
1189         public final function compileConfigInVariables () {
1190                 // Do we have the stack?
1191                 if (!$this->isVarStackSet('general')) {
1192                         // Abort here silently
1193                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1194                         return;
1195                 } // END - if
1196
1197                 // Iterate through all general variables
1198                 foreach ($this->getVarStack('general') as $index => $currVariable) {
1199                         // Compile the value
1200                         $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1201
1202                         // Debug message
1203                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1204
1205                         // Remove it from stack
1206                         $this->removeVariable($currVariable['name'], 'general');
1207
1208                         // Re-assign the variable
1209                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1210                         $this->assignConfigVariable($value);
1211                 } // END - foreach
1212         }
1213
1214         /**
1215          * Compile all variables by inserting their respective values
1216          *
1217          * @return      void
1218          * @todo        Make this code some nicer...
1219          */
1220         public final function compileVariables () {
1221                 // Initialize the $content array
1222                 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1223                 $dummy = array();
1224
1225                 // Iterate through all general variables
1226                 foreach ($this->getVarStack('general') as $currVariable) {
1227                         // Transfer it's name/value combination to the $content array
1228                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1229                         $dummy[$currVariable['name']] = $currVariable['value'];
1230                 }// END - if
1231
1232                 // Set the new variable (don't remove the second dollar!)
1233                 $$validVar = $dummy;
1234
1235                 // Remove some variables
1236                 unset($index);
1237                 unset($currVariable);
1238
1239                 // Run the compilation three times to get content from helper classes in
1240                 $cnt = 0;
1241                 while ($cnt < 3) {
1242                         // Finalize the compilation of template variables
1243                         $this->finalizeVariableCompilation();
1244
1245                         // Prepare the eval() command for comiling the template
1246                         $eval = sprintf("\$result = \"%s\";",
1247                                 addslashes($this->getRawTemplateData())
1248                         );
1249
1250                         // This loop does remove the backslashes (\) in PHP parameters
1251                         while (strpos($eval, $this->codeBegin) !== false) {
1252                                 // Get left part before "<?"
1253                                 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1254
1255                                 // Get all from right of "<?"
1256                                 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1257
1258                                 // Cut middle part out and remove escapes
1259                                 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1260                                 $evalMiddle = stripslashes($evalMiddle);
1261
1262                                 // Remove the middle part from right one
1263                                 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1264
1265                                 // And put all together
1266                                 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1267                         } // END - while
1268
1269                         // Prepare PHP code for eval() command
1270                         $eval = str_replace(
1271                                 "<%php", "\";",
1272                                 str_replace(
1273                                         "%>",
1274                                         "\n\$result .= \"",
1275                                         $eval
1276                                 )
1277                         );
1278
1279                         // Run the constructed command. This will "compile" all variables in
1280                         eval($eval);
1281
1282                         // Goes something wrong?
1283                         if ((!isset($result)) || (empty($result))) {
1284                                 // Output eval command
1285                                 self::createDebugInstance(__CLASS__)->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1286
1287                                 // Output backtrace here
1288                                 $this->debugBackTrace();
1289                         } // END - if
1290
1291                         // Set raw template data
1292                         $this->setRawTemplateData($result);
1293                         $cnt++;
1294                 } // END - while
1295
1296                 // Final variable assignment
1297                 $this->finalizeVariableCompilation();
1298
1299                 // Set the new content
1300                 $this->setCompiledData($this->getRawTemplateData());
1301         }
1302
1303         /**
1304          * Compile all required templates into the current loaded one
1305          *
1306          * @return      void
1307          * @throws      UnexpectedTemplateTypeException If the template type is
1308          *                                                                                      not "code"
1309          * @throws      InvalidArrayCountException              If an unexpected array
1310          *                                                                                      count has been found
1311          */
1312         public function compileTemplate () {
1313                 // Get code type to make things shorter
1314                 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1315
1316                 // We will only work with template type "code" from configuration
1317                 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1318                         // Abort here
1319                         throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1320                 } // END - if
1321
1322                 // Get the raw data.
1323                 $rawData = $this->getRawTemplateData();
1324
1325                 // Remove double spaces and trim leading/trailing spaces
1326                 $rawData = trim(str_replace('  ', ' ', $rawData));
1327
1328                 // Search for raw variables
1329                 $this->extractVariablesFromRawData($rawData);
1330
1331                 // Search for code-tags which are {? ?}
1332                 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1333
1334                 // Debug message
1335                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
1336
1337                 // Analyze the matches array
1338                 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1339                         // Entries are found:
1340                         //
1341                         // The main analysis
1342                         $this->analyzeTemplate($templateMatches);
1343
1344                         // Compile raw template data
1345                         $this->compileRawTemplateData($templateMatches);
1346
1347                         // Are there some raw templates left for loading?
1348                         $this->loadExtraRawTemplates();
1349
1350                         // Are some raw templates found and loaded?
1351                         if (count($this->rawTemplates) > 0) {
1352                                 // Insert all raw templates
1353                                 $this->insertRawTemplates();
1354
1355                                 // Remove the raw template content as well
1356                                 $this->setRawTemplateData('');
1357                         } // END - if
1358                 } // END - if($templateMatches ...
1359         }
1360
1361         /**
1362          * Loads a given view helper (by name)
1363          *
1364          * @param       $helperName             The helper's name
1365          * @return      void
1366          */
1367         protected function loadViewHelper ($helperName) {
1368                 // Make first character upper case, rest low
1369                 $helperName = $this->convertToClassName($helperName);
1370
1371                 // Is this view helper loaded?
1372                 if (!isset($this->helpers[$helperName])) {
1373                         // Create a class name
1374                         $className = $helperName . 'ViewHelper';
1375
1376                         // Generate new instance
1377                         $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1378                 } // END - if
1379
1380                 // Return the requested instance
1381                 return $this->helpers[$helperName];
1382         }
1383
1384         /**
1385          * Assigns the last loaded raw template content with a given variable
1386          *
1387          * @param       $templateName   Name of the template we want to assign
1388          * @param       $variableName   Name of the variable we want to assign
1389          * @return      void
1390          */
1391         public function assignTemplateWithVariable ($templateName, $variableName) {
1392                 // Get the content from last loaded raw template
1393                 $content = $this->getRawTemplateData();
1394
1395                 // Assign the variable
1396                 $this->assignVariable($variableName, $content);
1397
1398                 // Purge raw content
1399                 $this->setRawTemplateData('');
1400         }
1401
1402         /**
1403          * Transfers the content of this template engine to a given response instance
1404          *
1405          * @param       $responseInstance       An instance of a response class
1406          * @return      void
1407          */
1408         public function transferToResponse (Responseable $responseInstance) {
1409                 // Get the content and set it in response class
1410                 $responseInstance->writeToBody($this->getCompiledData());
1411         }
1412
1413         /**
1414          * Assigns all the application data with template variables
1415          *
1416          * @param       $applicationInstance    A manageable application instance
1417          * @return      void
1418          */
1419         public function assignApplicationData (ManageableApplication $applicationInstance) {
1420                 // Get long name and assign it
1421                 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1422
1423                 // Get short name and assign it
1424                 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1425
1426                 // Get version number and assign it
1427                 $this->assignVariable('app_version'   , $applicationInstance->getAppVersion());
1428
1429                 // Assign extra application-depending data
1430                 $applicationInstance->assignExtraTemplateData($this);
1431         }
1432
1433         /**
1434          * "Compiles" a variable by replacing {?var?} with it's content
1435          *
1436          * @param       $rawCode                        Raw code to compile
1437          * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
1438          * @return      $rawCode        Compile code with inserted variable value
1439          */
1440         public function compileRawCode ($rawCode, $setMatchAsCode=false) {
1441                 // Find the variables
1442                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1443                 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1444
1445                 // Compile all variables
1446                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
1447                 foreach ($varMatches[0] as $match) {
1448                         // Add variable tags around it
1449                         $varCode = '{?' . $match . '?}';
1450
1451                         // Debug message
1452                         //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1453
1454                         // Is the variable found in code? (safes some calls)
1455                         if (strpos($rawCode, $varCode) !== false) {
1456                                 // Debug message
1457                                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1458
1459                                 // Use $match as new value or $value from read variable?
1460                                 if ($setMatchAsCode === true) {
1461                                         // Insert match
1462                                         $rawCode = str_replace($varCode, $match, $rawCode);
1463                                 } else {
1464                                         // Read the variable
1465                                         $value = $this->readVariable($match);
1466
1467                                         // Insert value
1468                                         $rawCode = str_replace($varCode, $value, $rawCode);
1469                                 }
1470                         } // END - if
1471                 } // END - foreach
1472
1473                 // Return the compiled data
1474                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1475                 return $rawCode;
1476         }
1477
1478         /**
1479          * Getter for variable group array
1480          *
1481          * @return      $vargroups      All variable groups
1482          */
1483         public final function getVariableGroups () {
1484                 return $this->varGroups;
1485         }
1486
1487         /**
1488          * Renames a variable in code and in stack
1489          *
1490          * @param       $oldName        Old name of variable
1491          * @param       $newName        New name of variable
1492          * @return      void
1493          */
1494         public function renameVariable ($oldName, $newName) {
1495                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1496                 // Get raw template code
1497                 $rawData = $this->getRawTemplateData();
1498
1499                 // Replace it
1500                 $rawData = str_replace($oldName, $newName, $rawData);
1501
1502                 // Set the code back
1503                 $this->setRawTemplateData($rawData);
1504         }
1505
1506         /**
1507          * Renders the given XML content
1508          *
1509          * @param       $content        Valid XML content or if not set the current loaded raw content
1510          * @return      void
1511          * @throws      XmlParserException      If an XML error was found
1512          */
1513         public function renderXmlContent ($content = NULL) {
1514                 // Is the content set?
1515                 if (is_null($content)) {
1516                         // Get current content
1517                         $content = $this->getRawTemplateData();
1518                 } // END - if
1519
1520                 // Get a XmlParser instance
1521                 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1522
1523                 // Check if we have XML compacting enabled
1524                 if ($this->isXmlCompactingEnabled()) {
1525                         // Yes, so get a decorator class for transparent compacting
1526                         $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1527                 } // END - if
1528
1529                 // Parse the XML document
1530                 $parserInstance->parseXmlContent($content);
1531         }
1532
1533         /**
1534          * Enables or disables language support
1535          *
1536          * @param       $languageSupport        New language support setting
1537          * @return      void
1538          */
1539         public final function enableLanguageSupport ($languageSupport = true) {
1540                 $this->languageSupport = (bool) $languageSupport;
1541         }
1542
1543         /**
1544          * Checks whether language support is enabled
1545          *
1546          * @return      $languageSupport        Whether language support is enabled or disabled
1547          */
1548         public final function isLanguageSupportEnabled () {
1549                 return $this->languageSupport;
1550         }
1551
1552         /**
1553          * Enables or disables XML compacting
1554          *
1555          * @param       $xmlCompacting  New XML compacting setting
1556          * @return      void
1557          */
1558         public final function enableXmlCompacting ($xmlCompacting = true) {
1559                 $this->xmlCompacting = (bool) $xmlCompacting;
1560         }
1561
1562         /**
1563          * Checks whether XML compacting is enabled
1564          *
1565          * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
1566          */
1567         public final function isXmlCompactingEnabled () {
1568                 return $this->xmlCompacting;
1569         }
1570
1571         /**
1572          * Removes all commentd, tabs and new-line characters to compact the content
1573          *
1574          * @param       $uncompactedContent             The uncompacted content
1575          * @return      $compactedContent               The compacted content
1576          */
1577         public function compactContent ($uncompactedContent) {
1578                 // First, remove all tab/new-line/revert characters
1579                 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1580
1581                 // Then regex all comments like <!-- //--> away
1582                 preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
1583
1584                 // Do we have entries?
1585                 if (isset($matches[0][0])) {
1586                         // Remove all
1587                         foreach ($matches[0] as $match) {
1588                                 // Remove the match
1589                                 $compactedContent = str_replace($match, '', $compactedContent);
1590                         } // END - foreach
1591                 } // END - if
1592
1593                 // Set the content again
1594                 $this->setRawTemplateData($compactedContent);
1595
1596                 // Return compacted content
1597                 return $compactedContent;
1598         }
1599 }
1600
1601 // [EOF]
1602 ?>