3 * A generic template engine
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class BaseTemplateEngine extends BaseFrameworkSystem {
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
30 private $templateBasePath = '';
35 private $templateType = 'html';
38 * The extension for web and email templates (not compiled templates)
40 private $templateExtension = '.tpl';
43 * The extension for code templates (not compiled templates)
45 private $codeExtension = '.ctp';
48 * Path relative to $templateBasePath and language code for compiled code-templates
50 private $compileOutputPath = 'templates/_compiled/';
53 * The path name for all templates
55 private $genericBasePath = 'templates/';
58 * The raw (maybe uncompiled) template
60 private $rawTemplateData = '';
63 * Template data with compiled-in variables
65 private $compiledData = '';
68 * The last loaded template's FQFN for debugging the engine
70 private $lastTemplate = '';
73 * The variable stack for the templates
75 private $varStack = array();
78 * Loaded templates for recursive protection and detection
80 private $loadedTemplates = array();
83 * Compiled templates for recursive protection and detection
85 private $compiledTemplates = array();
88 * Loaded raw template data
90 private $loadedRawData = null;
93 * Raw templates which are linked in code templates
95 private $rawTemplates = null;
98 * A regular expression for variable=value pairs
100 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
103 * A regular expression for filtering out code tags
105 * E.g.: {?template:variable=value;var2=value2;[...]?}
107 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
112 private $helpers = array();
115 * Current variable group
117 private $currGroup = 'general';
120 * All template groups except "general"
122 private $varGroups = array();
127 private $codeBegin = '<?php';
132 private $codeEnd = '?>';
134 // Exception codes for the template engine
135 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
136 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
137 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
140 * Protected constructor
142 * @param $className Name of the class
145 protected function __construct ($className) {
146 // Call parent constructor
147 parent::__construct($className);
150 $this->removeNumberFormaters();
151 $this->removeSystemArray();
155 * Search for a variable in the stack
157 * @param $var The variable we are looking for
158 * @return $idx FALSE means not found, >=0 means found on a specific index
160 private function isVariableAlreadySet ($var) {
161 // First everything is not found
164 // Is the group there?
165 if (isset($this->varStack[$this->currGroup])) {
167 foreach ($this->varStack[$this->currGroup] as $idx => $currEntry) {
168 //* DEBUG: */ echo __METHOD__.":currGroup={$this->currGroup},idx={$idx},currEntry={$currEntry['name']},var={$var}<br />\n";
169 // Is the entry found?
170 if ($currEntry['name'] == $var) {
172 //* DEBUG: */ echo __METHOD__.":FOUND!<br />\n";
179 // Return the current position
184 * Return a content of a variable or null if not found
186 * @param $var The variable we are looking for
187 * @return $content Content of the variable or null if not found
189 protected function readVariable ($var) {
190 // First everything is not found
193 // Get variable index
194 $found = $this->isVariableAlreadySet($var);
196 // Is the variable found?
197 if ($found !== false) {
199 $found = $this->varStack[$this->currGroup][$found]['value'];
202 //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."<br />\n";
204 // Return the current position
209 * Add a variable to the stack
211 * @param $var The variable we are looking for
212 * @param $value The value we want to store in the variable
215 private function addVariable ($var, $value) {
216 // Set general variable group
217 $this->setVariableGroup('general');
219 // Add it to the stack
220 $this->addGroupVariable($var, $value);
224 * Returns all variables of current group or empty array
226 * @return $result Wether array of found variables or empty array
228 private function readCurrentGroup () {
229 // Default is not found
232 // Is the group there?
233 if (isset($this->varStack[$this->currGroup])) {
235 $result = $this->varStack[$this->currGroup];
243 * Settter for variable group
245 * @param $groupName Name of variable group
246 * @param $add Wether add this group
249 public function setVariableGroup ($groupName, $add = true) {
251 //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."<br />\n";
252 $this->currGroup = $groupName;
254 // Skip group 'general'
255 if (($groupName != 'general') && ($add === true)) {
256 $this->varGroups[$groupName] = 'OK';
262 * Adds a variable to current group
264 * @param $var Variable to set
265 * @param $value Value to store in variable
268 public function addGroupVariable ($var, $value) {
269 //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."<br />\n";
271 // Get current variables in group
272 $currVars = $this->readCurrentGroup();
274 // Append our variable
280 // Add it to the stack
281 $this->varStack[$this->currGroup] = $currVars;
285 * Modify an entry on the stack
287 * @param $var The variable we are looking for
288 * @param $value The value we want to store in the variable
291 private function modifyVariable ($var, $value) {
292 // Get index for variable
293 $idx = $this->isVariableAlreadySet($var);
295 // Is the variable set?
296 if ($idx !== false) {
298 $this->varStack[$this->currGroup][$idx]['value'] = $value;
303 * Setter for template type. Only 'html', 'emails' and 'compiled' should
306 * @param $templateType The current template's type
309 protected final function setTemplateType ($templateType) {
310 $this->templateType = (string) $templateType;
314 * Setter for the last loaded template's FQFN
316 * @param $template The last loaded template
319 private final function setLastTemplate ($template) {
320 $this->lastTemplate = (string) $template;
324 * Getter for the last loaded template's FQFN
326 * @return $template The last loaded template
328 private final function getLastTemplate () {
329 return $this->lastTemplate;
333 * Setter for base path
335 * @param $templateBasePath The relative base path for all templates
338 public final function setTemplateBasePath ($templateBasePath) {
340 $this->templateBasePath = (string) $templateBasePath;
344 * Getter for base path
346 * @return $templateBasePath The relative base path for all templates
348 public final function getTemplateBasePath () {
350 return $this->templateBasePath;
354 * Getter for generic base path
356 * @return $templateBasePath The relative base path for all templates
358 public final function getGenericBasePath () {
360 return $this->genericBasePath;
364 * Setter for template extension
366 * @param $templateExtension The file extension for all uncompiled
370 public final function setRawTemplateExtension ($templateExtension) {
372 $this->templateExtension = (string) $templateExtension;
376 * Setter for code template extension
378 * @param $codeExtension The file extension for all uncompiled
382 public final function setCodeTemplateExtension ($codeExtension) {
384 $this->codeExtension = (string) $codeExtension;
388 * Getter for template extension
390 * @return $templateExtension The file extension for all uncompiled
393 public final function getRawTemplateExtension () {
395 return $this->templateExtension;
399 * Getter for code-template extension
401 * @return $codeExtension The file extension for all code-
404 public final function getCodeTemplateExtension () {
406 return $this->codeExtension;
410 * Setter for path of compiled templates
412 * @param $compileOutputPath The local base path for all compiled
416 public final function setCompileOutputPath ($compileOutputPath) {
418 $this->compileOutputPath = (string) $compileOutputPath;
422 * Getter for template type
424 * @return $templateType The current template's type
426 public final function getTemplateType () {
427 return $this->templateType;
431 * Assign (add) a given variable with a value
433 * @param $var The variable we are looking for
434 * @param $value The value we want to store in the variable
436 * @throws EmptyVariableException If the variable name is left empty
438 public final function assignVariable ($var, $value) {
439 // Trim spaces of variable name
442 // Empty variable found?
444 // Throw an exception
445 throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
448 // First search for the variable if it was already added
449 $idx = $this->isVariableAlreadySet($var);
452 if ($idx === false) {
453 // Add it to the stack
454 //* DEBUG: */ echo "ADD: ".$var."<br />\n";
455 $this->addVariable($var, $value);
456 } elseif (!empty($value)) {
457 // Modify the stack entry
458 //* DEBUG: */ echo "MOD: ".$var."<br />\n";
459 $this->modifyVariable($var, $value);
464 * Removes a given variable
466 * @param $var The variable we are looking for
469 public final function removeVariable ($var) {
470 // First search for the variable if it was already added
471 $idx = $this->isVariableAlreadySet($var);
474 if ($idx !== false) {
475 // Remove this variable
476 $this->varStack->offsetUnset($idx);
481 * Private setter for raw template data
483 * @param $rawTemplateData The raw data from the template
486 protected final function setRawTemplateData ($rawTemplateData) {
487 // And store it in this class
488 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($rawTemplateData).' Bytes set.<br />\n';
489 //* DEBUG: */ echo $this->currGroup.' variables: '.count($this->varStack[$this->currGroup]).', groups='.count($this->varStack).'<br />\n';
490 $this->rawTemplateData = (string) $rawTemplateData;
494 * Getter for raw template data
496 * @return $rawTemplateData The raw data from the template
498 public final function getRawTemplateData () {
499 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->rawTemplateData).' Bytes read.<br />\n';
500 return $this->rawTemplateData;
504 * Private setter for compiled templates
508 private final function setCompiledData ($compiledData) {
509 // And store it in this class
510 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($compiledData).' Bytes set.<br />\n';
511 $this->compiledData = (string) $compiledData;
515 * Getter for compiled templates
517 * @return $compiledData Compiled template data
519 public final function getCompiledData () {
520 //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.<br />\n';
521 return $this->compiledData;
525 * Private loader for all template types
527 * @param $template The template we shall load
528 * @param $extOther An other extension to use
530 * @throws FileNotFoundException If the template was not found
532 protected function loadTemplate ($template, $extOther = '') {
533 // Get extension for the template if empty
534 if (empty($extOther)) {
535 // None provided, so get the raw one
536 $ext = $this->getRawTemplateExtension();
539 $ext = (string) $extOther;
542 // Construct the FQFN for the template by honoring the current language
543 $fqfn = sprintf("%s%s%s%s/%s/%s%s",
544 $this->getConfigInstance()->readConfig('base_path'),
545 $this->getTemplateBasePath(),
546 $this->getGenericBasePath(),
547 $this->getLanguageInstance()->getLanguageCode(),
548 $this->getTemplateType(),
555 // Load the raw template data
556 $this->loadRawTemplateData($fqfn);
557 } catch (FileNotFoundException $e) {
558 // If we shall load a code-template we need to switch the file extension
559 if (($this->getTemplateType() != $this->getConfigInstance()->readConfig('web_template_type')) && (empty($extOther))) {
560 // Switch over to the code-template extension and try it again
561 $ext = $this->getCodeTemplateExtension();
564 $this->loadTemplate($template, $ext);
567 throw new FileNotFoundException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
574 * A private loader for raw template names
576 * @param $fqfn The full-qualified file name for a template
579 private function loadRawTemplateData ($fqfn) {
580 // Get a input/output instance from the middleware
581 $ioInstance = $this->getFileIoInstance();
583 // Some debug code to look on the file which is being loaded
584 //* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."<br />\n";
586 // Load the raw template
587 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
589 // Store the template's contents into this class
590 $this->setRawTemplateData($rawTemplateData);
592 // Remember the template's FQFN
593 $this->setLastTemplate($fqfn);
597 * Try to assign an extracted template variable as a "content" or 'config'
600 * @param $varName The variable's name (shall be content orconfig) by
602 * @param $var The variable we want to assign
604 private function assignTemplateVariable ($varName, $var) {
605 // Is it not a config variable?
606 if ($varName != 'config') {
607 // Regular template variables
608 $this->assignVariable($var, '');
610 // Configuration variables
611 $this->assignConfigVariable($var);
616 * Extract variables from a given raw data stream
618 * @param $rawData The raw template data we shall analyze
621 private function extractVariablesFromRawData ($rawData) {
623 $rawData = (string) $rawData;
625 // Search for variables
626 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
628 // Did we find some variables?
629 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
630 // Initialize all missing variables
631 foreach ($variableMatches[3] as $key => $var) {
633 $varName = $variableMatches[1][$key];
635 // Workarround: Do not assign empty variables
637 // Try to assign it, empty strings are being ignored
638 $this->assignTemplateVariable($varName, $var);
645 * Main analysis of the loaded template
647 * @param $templateMatches Found template place-holders, see below
650 *---------------------------------
651 * Structure of $templateMatches:
652 *---------------------------------
653 * [0] => Array - An array with all full matches
654 * [1] => Array - An array with left part (before the ':') of a match
655 * [2] => Array - An array with right part of a match including ':'
656 * [3] => Array - An array with right part of a match excluding ':'
658 private function analyzeTemplate (array $templateMatches) {
659 // Backup raw template data
660 $backup = $this->getRawTemplateData();
662 // Initialize some arrays
663 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
665 // Load all requested templates
666 foreach ($templateMatches[1] as $template) {
668 // Load and compile only templates which we have not yet loaded
669 // RECURSIVE PROTECTION! BE CAREFUL HERE!
670 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
672 // Template not found, but maybe variable assigned?
673 //* DEBUG: */ echo __METHOD__.":template={$template}<br />\n";
674 if ($this->isVariableAlreadySet($template) !== false) {
675 // Use that content here
676 $this->loadedRawData[$template] = $this->readVariable($template);
678 // Recursive protection:
679 $this->loadedTemplates[] = $template;
680 } elseif (isset($this->varStack['config'][$template])) {
681 // Use that content here
682 $this->loadedRawData[$template] = $this->varStack['config'][$template];
684 // Recursive protection:
685 $this->loadedTemplates[] = $template;
687 // Then try to search for code-templates
689 // Load the code template and remember it's contents
690 $this->loadCodeTemplate($template);
691 $this->loadedRawData[$template] = $this->getRawTemplateData();
693 // Remember this template for recursion detection
694 // RECURSIVE PROTECTION!
695 $this->loadedTemplates[] = $template;
696 } catch (FileNotFoundException $e) {
697 // Even this is not done... :/
698 $this->rawTemplates[] = $template;
699 } catch (FilePointerNotOpenedException $e) {
700 // Even this is not done... :/
701 $this->rawTemplates[] = $template;
707 // Restore the raw template data
708 $this->setRawTemplateData($backup);
712 * Compile a given raw template code and remember it for later usage
714 * @param $code The raw template code
715 * @param $template The template's name
718 private function compileCode ($code, $template) {
719 // Is this template already compiled?
720 if (in_array($template, $this->compiledTemplates)) {
725 // Remember this template being compiled
726 $this->compiledTemplates[] = $template;
728 // Compile the loaded code in five steps:
730 // 1. Backup current template data
731 $backup = $this->getRawTemplateData();
733 // 2. Set the current template's raw data as the new content
734 $this->setRawTemplateData($code);
736 // 3. Compile the template data
737 $this->compileTemplate();
739 // 4. Remember it's contents
740 $this->loadedRawData[$template] = $this->getRawTemplateData();
742 // 5. Restore the previous raw content from backup variable
743 $this->setRawTemplateData($backup);
747 * Insert all given and loaded templates by running through all loaded
748 * codes and searching for their place-holder in the main template
750 * @param $templateMatches See method analyzeTemplate()
753 private function insertAllTemplates (array $templateMatches) {
754 // Run through all loaded codes
755 foreach ($this->loadedRawData as $template => $code) {
757 // Search for the template
758 $foundIndex = array_search($template, $templateMatches[1]);
760 // Lookup the matching template replacement
761 if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
763 // Get the current raw template
764 $rawData = $this->getRawTemplateData();
766 // Replace the space holder with the template code
767 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
769 // Set the new raw data
770 $this->setRawTemplateData($rawData);
776 * Load all extra raw templates
780 private function loadExtraRawTemplates () {
781 // Are there some raw templates we need to load?
782 if (count($this->rawTemplates) > 0) {
783 // Try to load all raw templates
784 foreach ($this->rawTemplates as $key => $template) {
787 $this->loadWebTemplate($template);
789 // Remember it's contents
790 $this->rawTemplates[$template] = $this->getRawTemplateData();
792 // Remove it from the loader list
793 unset($this->rawTemplates[$key]);
795 // Remember this template for recursion detection
796 // RECURSIVE PROTECTION!
797 $this->loadedTemplates[] = $template;
798 } catch (FileNotFoundException $e) {
799 // This template was never found. We silently ignore it
800 unset($this->rawTemplates[$key]);
801 } catch (FilePointerNotOpenedException $e) {
802 // This template was never found. We silently ignore it
803 unset($this->rawTemplates[$key]);
810 * Assign all found template variables
812 * @param $varMatches An array full of variable/value pairs.
814 * @todo Unfinished work or don't die here.
816 private function assignAllVariables (array $varMatches) {
817 // Search for all variables
818 foreach ($varMatches[1] as $key => $var) {
820 // Detect leading equals
821 if (substr($varMatches[2][$key], 0, 1) == '=') {
822 // Remove and cast it
823 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
826 // Do we have some quotes left and right side? Then it is free text
827 if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
828 // Free string detected! Which we can assign directly
829 $this->assignVariable($var, $varMatches[3][$key]);
830 } elseif (!empty($varMatches[2][$key])) {
831 // @TODO Non-string found so we need some deeper analysis...
832 ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
835 } // for ($varMatches ...
838 * Compiles all loaded raw templates
840 * @param $templateMatches See method analyzeTemplate() for details
843 private function compileRawTemplateData (array $templateMatches) {
844 // Are some code-templates found which we need to compile?
845 if (count($this->loadedRawData) > 0) {
848 foreach ($this->loadedRawData as $template => $code) {
850 // Is this template already compiled?
851 if (in_array($template, $this->compiledTemplates)) {
856 // Search for the template
857 $foundIndex = array_search($template, $templateMatches[1]);
859 // Lookup the matching variable data
860 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
862 // Split it up with another reg. exp. into variable=value pairs
863 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
865 // Assign all variables
866 $this->assignAllVariables($varMatches);
868 } // END - if (isset($templateMatches ...
870 // Compile the loaded template
871 $this->compileCode($code, $template);
873 } // END - foreach ($this->loadedRawData ...
875 // Insert all templates
876 $this->insertAllTemplates($templateMatches);
878 } // END - if (count($this->loadedRawData) ...
882 * Inserts all raw templates into their respective variables
886 private function insertRawTemplates () {
887 // Load all templates
888 foreach ($this->rawTemplates as $template => $content) {
889 // Set the template as a variable with the content
890 $this->assignVariable($template, $content);
895 * Finalizes the compilation of all template variables
899 private function finalizeVariableCompilation () {
901 $content = $this->getRawTemplateData();
902 //* DEBUG: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')<br />\n';
904 // Walk through all variables
905 foreach ($this->varStack['general'] as $currEntry) {
906 //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=<pre>'.htmlentities($currEntry['value']).'</pre>\n';
907 // Replace all [$var] or {?$var?} with the content
908 // @TODO Old behaviour, will become obsolete!
909 $content = str_replace("\$content[".$currEntry['name'].']', $currEntry['value'], $content);
911 // @TODO Yet another old way
912 $content = str_replace('['.$currEntry['name'].']', $currEntry['value'], $content);
915 $content = str_replace('{?'.$currEntry['name'].'?}', $currEntry['value'], $content);
918 //* DEBUG: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')<br />\n';
920 // Set the content back
921 $this->setRawTemplateData($content);
925 * Load a specified web template into the engine
927 * @param $template The web template we shall load which is located in
931 public function loadWebTemplate ($template) {
933 $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
935 // Load the special template
936 $this->loadTemplate($template);
940 * Assign a given congfiguration variable with a value
942 * @param $var The configuration variable we want to assign
945 public function assignConfigVariable ($var) {
946 // Sweet and simple...
947 //* DEBUG: */ echo __METHOD__.':var={$var}<br />\n';
948 $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var);
952 * Load a specified email template into the engine
954 * @param $template The email template we shall load which is located in
955 * 'emails' by default
958 public function loadEmailTemplate ($template) {
960 $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
962 // Load the special template
963 $this->loadTemplate($template);
967 * Load a specified code template into the engine
969 * @param $template The code template we shall load which is
970 * located in 'code' by default
973 public function loadCodeTemplate ($template) {
975 $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
977 // Load the special template
978 $this->loadTemplate($template);
982 * Compile all variables by inserting their respective values
985 * @todo Make this code some nicer...
987 public final function compileVariables () {
988 // Initialize the $content array
989 $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
992 // Iterate through all general variables
993 foreach ($this->varStack['general'] as $currVariable) {
994 // Transfer it's name/value combination to the $content array
995 //* DEBUG: */ echo $currVariable['name'].'=<pre>'.htmlentities($currVariable['value']).'</pre>\n';
996 $dummy[$currVariable['name']] = $currVariable['value'];
999 // Set the new variable (don't remove the second dollar!)
1000 $$validVar = $dummy;
1002 // Prepare all configuration variables
1004 if (isset($this->varStack['config'])) {
1005 $config = $this->varStack['config'];
1008 // Remove some variables
1010 unset($currVariable);
1012 // Run the compilation three times to get content from helper classes in
1015 // Finalize the compilation of template variables
1016 $this->finalizeVariableCompilation();
1018 // Prepare the eval() command for comiling the template
1019 $eval = sprintf("\$result = \"%s\";",
1020 addslashes($this->getRawTemplateData())
1023 // This loop does remove the backslashes (\) in PHP parameters
1024 while (strpos($eval, $this->codeBegin) !== false) {
1025 // Get left part before "<?"
1026 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1028 // Get all from right of "<?"
1029 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1031 // Cut middle part out and remove escapes
1032 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1033 $evalMiddle = stripslashes($evalMiddle);
1035 // Remove the middle part from right one
1036 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1038 // And put all together
1039 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1042 // Prepare PHP code for eval() command
1043 $eval = str_replace(
1052 // Run the constructed command. This will "compile" all variables in
1055 // Goes something wrong?
1056 if ((!isset($result)) || (empty($result))) {
1057 // Output eval command
1058 $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1060 // Output backtrace here
1061 $this->debugBackTrace();
1064 // Set raw template data
1065 $this->setRawTemplateData($result);
1069 // Final variable assignment
1070 $this->finalizeVariableCompilation();
1072 // Set the new content
1073 $this->setCompiledData($this->getRawTemplateData());
1077 * Compile all required templates into the current loaded one
1080 * @throws UnexpectedTemplateTypeException If the template type is
1082 * @throws InvalidArrayCountException If an unexpected array
1083 * count has been found
1085 public function compileTemplate () {
1086 // We will only work with template type "code" from configuration
1087 if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
1089 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1092 // Get the raw data.
1093 $rawData = $this->getRawTemplateData();
1095 // Remove double spaces and trim leading/trailing spaces
1096 $rawData = trim(str_replace(' ', ' ', $rawData));
1098 // Search for raw variables
1099 $this->extractVariablesFromRawData($rawData);
1101 // Search for code-tags which are {? ?}
1102 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1104 // Analyze the matches array
1105 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1106 // Entries are found:
1108 // The main analysis
1109 $this->analyzeTemplate($templateMatches);
1111 // Compile raw template data
1112 $this->compileRawTemplateData($templateMatches);
1114 // Are there some raw templates left for loading?
1115 $this->loadExtraRawTemplates();
1117 // Are some raw templates found and loaded?
1118 if (count($this->rawTemplates) > 0) {
1120 // Insert all raw templates
1121 $this->insertRawTemplates();
1123 // Remove the raw template content as well
1124 $this->setRawTemplateData('');
1128 } // END - if($templateMatches ...
1132 * A old deprecated method
1136 * @see BaseTemplateEngine::transferToResponse
1138 public function output () {
1139 // Check which type of template we have
1140 switch ($this->getTemplateType()) {
1141 case 'html': // Raw HTML templates can be send to the output buffer
1143 $this->getWebOutputInstance()->output($this->getCompiledData());
1146 default: // Unknown type found
1147 // Construct message
1148 $msg = sprintf("[%s->%s] Unknown/unsupported template type <span class=\"data\">%s</span> detected.",
1149 $this->__toString(),
1151 $this->getTemplateType()
1154 // Write the problem to the world...
1155 $this->debugOutput($msg);
1161 * Loads a given view helper (by name)
1163 * @param $helperName The helper's name
1166 protected function loadViewHelper ($helperName) {
1167 // Make first character upper case, rest low
1168 $helperName = $this->convertToClassName($helperName);
1170 // Is this view helper loaded?
1171 if (!isset($this->helpers[$helperName])) {
1172 // Create a class name
1173 $className = "{$helperName}ViewHelper";
1175 // Generate new instance
1176 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1179 // Return the requested instance
1180 return $this->helpers[$helperName];
1184 * Assigns the last loaded raw template content with a given variable
1186 * @param $templateName Name of the template we want to assign
1187 * @param $variableName Name of the variable we want to assign
1190 public function assignTemplateWithVariable ($templateName, $variableName) {
1191 // Get the content from last loaded raw template
1192 $content = $this->getRawTemplateData();
1194 // Assign the variable
1195 $this->assignVariable($variableName, $content);
1197 // Purge raw content
1198 $this->setRawTemplateData('');
1202 * Transfers the content of this template engine to a given response instance
1204 * @param $responseInstance An instance of a response class
1207 public function transferToResponse (Responseable $responseInstance) {
1208 // Get the content and set it in response class
1209 $responseInstance->writeToBody($this->getCompiledData());
1213 * Assigns all the application data with template variables
1215 * @param $appInstance A manageable application instance
1218 public function assignApplicationData (ManageableApplication $appInstance) {
1219 // Get long name and assign it
1220 $this->assignVariable('app_full_name' , $appInstance->getAppName());
1222 // Get short name and assign it
1223 $this->assignVariable('app_short_name', $appInstance->getAppShortName());
1225 // Get version number and assign it
1226 $this->assignVariable('app_version' , $appInstance->getAppVersion());
1228 // Assign extra application-depending data
1229 $appInstance->assignExtraTemplateData($this);
1233 * "Compiles" a variable by replacing {?var?} with it's content
1235 * @param $rawCode Raw code to compile
1236 * @return $rawCode Compile code with inserted variable value
1238 public function compileRawCode ($rawCode) {
1239 // Find the variables
1240 //* DEBUG: */ echo "rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
1241 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1243 // Compile all variables
1244 //* DEBUG: */ echo "<pre>".print_r($varMatches, true)."</pre>";
1245 foreach ($varMatches[0] as $match) {
1246 // Add variable tags around it
1247 $varCode = '{?' . $match . '?}';
1249 // Is the variable found in code? (safes some calls)
1250 if (strpos($rawCode, $varCode) !== false) {
1251 // Replace the variable with it's value, if found
1252 //* DEBUG: */ echo __METHOD__.": match=".$match."<br />\n";
1253 $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode);
1257 // Return the compiled data
1262 * Getter for variable group array
1264 * @return $vargroups All variable groups
1266 public final function getVariableGroups () {
1267 return $this->varGroups;
1271 * Renames a variable in code and in stack
1273 * @param $oldName Old name of variable
1274 * @param $newName New name of variable
1277 public function renameVariable ($oldName, $newName) {
1278 //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
1279 // Get raw template code
1280 $rawData = $this->getRawTemplateData();
1283 $rawData = str_replace($oldName, $newName, $rawData);
1285 // Set the code back
1286 $this->setRawTemplateData($rawData);
1290 * Renders the given XML content
1292 * @param $content Valid XML content or if not set the current loaded raw content
1294 * @throws XmlParserException If an XML error was found
1296 public final function renderXmlContent ($content = null) {
1297 // Is the content set?
1298 if (is_null($content)) {
1299 // Get current content
1300 $content = $this->getRawTemplateData();
1303 // Convert all to UTF8
1304 if (function_exists('recode')) {
1305 $content = recode("html..utf8", $content);
1307 // @TODO We need to find a fallback solution here
1310 // Get an XML parser
1311 $xmlParser = xml_parser_create();
1313 // Force case-folding to on
1314 xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true);
1317 xml_set_object($xmlParser, $this);
1319 // Set handler call-backs
1320 xml_set_element_handler($xmlParser, 'startElement', 'endElement');
1321 xml_set_character_data_handler($xmlParser, 'characterHandler');
1323 // Now parse the XML tree
1324 if (!xml_parse($xmlParser, $content)) {
1325 // Error found in XML!
1326 //die('<pre>'.htmlentities($content).'</pre>');
1327 throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR);
1331 xml_parser_free($xmlParser);