3 * A generic template engine
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
110 * A regular expression to find template comments like <!-- Comment here //-->
112 private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
117 private $helpers = array();
120 * Current variable group
122 private $currGroup = 'general';
125 * All template groups except "general"
127 private $variableGroups = array();
132 private $codeBegin = '<?php';
137 private $codeEnd = '?>';
140 * Language support is enabled by default
142 private $languageSupport = TRUE;
145 * XML compacting is disabled by default
147 private $xmlCompacting = FALSE;
149 // Exception codes for the template engine
150 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
151 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
152 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
153 const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
156 * Protected constructor
158 * @param $className Name of the class
161 protected function __construct ($className) {
162 // Call parent constructor
163 parent::__construct($className);
165 // Init file I/O instance
166 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
169 $this->setFileIoInstance($ioInstance);
173 * Search for a variable in the stack
175 * @param $variableName The variable we are looking for
176 * @param $variableGroup Optional variable group to look in
177 * @return $index FALSE means not found, >=0 means found on a specific index
179 private function getVariableIndex ($variableName, $variableGroup = NULL) {
180 // Replace all dashes to underscores to match variables with configuration entries
181 $variableName = trim($this->convertDashesToUnderscores($variableName));
183 // First everything is not found
186 // If the stack is NULL, use the current group
187 if (is_null($variableGroup)) {
189 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
190 $variableGroup = $this->currGroup;
193 // Is the group there?
194 if ($this->isVarStackSet($variableGroup)) {
196 foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
197 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
198 // Is the entry found?
199 if ($currEntry['name'] == $variableName) {
201 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
208 // Return the current position
213 * Checks whether the given variable group is set
215 * @param $variableGroup Variable group to check
216 * @return $isSet Whether the given variable group is set
218 protected final function isVarStackSet ($variableGroup) {
220 $isSet = isset($this->varStack[$variableGroup]);
227 * Getter for given variable group
229 * @param $variableGroup Variable group to check
230 * @return $varStack Found variable group
232 public final function getVarStack ($variableGroup) {
233 return $this->varStack[$variableGroup];
237 * Setter for given variable group
239 * @param $variableGroup Variable group to check
240 * @param $varStack Variable stack to check
243 protected final function setVarStack ($variableGroup, array $varStack) {
244 $this->varStack[$variableGroup] = $varStack;
248 * Return a content of a variable or null if not found
250 * @param $variableName The variable we are looking for
251 * @param $variableGroup Optional variable group to look in
252 * @return $content Content of the variable or null if not found
254 protected function readVariable ($variableName, $variableGroup = NULL) {
255 // Replace all dashes to underscores to match variables with configuration entries
256 $variableName = trim($this->convertDashesToUnderscores($variableName));
258 // First everything is not found
261 // If the stack is NULL, use the current group
262 if (is_null($variableGroup)) {
264 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
265 $variableGroup = $this->currGroup;
268 // Get variable index
269 $found = $this->getVariableIndex($variableName, $variableGroup);
271 // Is the variable found?
272 if ($found !== FALSE) {
274 $content = $this->getVariableValue($variableGroup, $found);
277 // Return the current position
278 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
283 * Add a variable to the stack
285 * @param $variableName Name of variable to add
286 * @param $value Value we want to store in the variable
289 private function addVariable ($variableName, $value) {
290 // Set general variable group
291 $this->setVariableGroup('general');
293 // Add it to the stack
294 $this->addGroupVariable($variableName, $value);
298 * Returns all variables of current group or empty array
300 * @return $result Whether array of found variables or empty array
302 private function readCurrentGroup () {
303 // Default is not found
306 // Is the group there?
307 if ($this->isVarStackSet($this->currGroup)) {
309 $result = $this->getVarStack($this->currGroup);
317 * Settter for variable group
319 * @param $groupName Name of variable group
320 * @param $add Whether add this group
323 public function setVariableGroup ($groupName, $add = TRUE) {
325 //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
326 $this->currGroup = $groupName;
328 // Skip group 'general'
329 if (($groupName != 'general') && ($add === TRUE)) {
330 $this->variableGroups[$groupName] = 'OK';
336 * Adds a variable to current group
338 * @param $variableName Variable to set
339 * @param $value Value to store in variable
342 public function addGroupVariable ($variableName, $value) {
343 // Replace all dashes to underscores to match variables with configuration entries
344 $variableName = trim($this->convertDashesToUnderscores($variableName));
347 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
349 // Get current variables in group
350 $currVars = $this->readCurrentGroup();
352 // Append our variable
353 array_push($currVars, $this->generateVariableArray($variableName, $value));
355 // Add it to the stack
356 $this->setVarStack($this->currGroup, $currVars);
360 * Getter for variable value, throws a NoVariableException if the variable is not found
362 * @param $variableGroup Variable group to use
363 * @param $index Index in variable array
364 * @return $value Value to set
366 private function getVariableValue ($variableGroup, $index) {
368 return $this->varStack[$variableGroup][$index]['value'];
372 * Modify an entry on the stack
374 * @param $variableName The variable we are looking for
375 * @param $value The value we want to store in the variable
377 * @throws NoVariableException If the given variable is not found
379 private function modifyVariable ($variableName, $value) {
380 // Replace all dashes to underscores to match variables with configuration entries
381 $variableName = trim($this->convertDashesToUnderscores($variableName));
383 // Get index for variable
384 $index = $this->getVariableIndex($variableName);
386 // Is the variable set?
387 if ($index === FALSE) {
388 // Unset variables cannot be modified
389 throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
393 $this->setVariableValue($this->currGroup, $index, $value);
397 * Sets a variable value for given variable group and index
399 * @param $variableGroup Variable group to use
400 * @param $index Index in variable array
401 * @param $value Value to set
404 private function setVariableValue ($variableGroup, $index, $value) {
405 $this->varStack[$variableGroup][$index]['value'] = $value;
409 * Sets a variable within given group. This method does detect if the
410 * variable is already set. If so, the variable got modified, otherwise
413 * @param $variableGroup Variable group to use
414 * @param $variableName Variable to set
415 * @param $value Value to set
418 protected function setVariable ($variableGroup, $variableName, $value) {
419 // Replace all dashes to underscores to match variables with configuration entries
420 $variableName = trim($this->convertDashesToUnderscores($variableName));
422 // Get index for variable
423 $index = $this->getVariableIndex($variableName);
425 // Is the variable set?
426 if ($index === FALSE) {
427 // Is the stack there?
428 if (!isset($this->varStack[$variableGroup])) {
429 // Then initialize it here
430 $this->varStack[$variableGroup] = array();
434 array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value));
437 $this->setVariableValue($this->currGroup, $index, $value);
442 * "Generates" (better returns) an array for all variables for given
443 * variable/value pay.
445 * @param $variableName Variable to set
446 * @param $value Value to set
447 * @return $varData Variable data array
449 private function generateVariableArray ($variableName, $value) {
450 // Replace all dashes to underscores to match variables with configuration entries
451 $variableName = trim($this->convertDashesToUnderscores($variableName));
453 // Generate the temporary array
455 'name' => $variableName,
464 * Setter for template type. Only 'html', 'emails' and 'compiled' should
467 * @param $templateType The current template's type
470 protected final function setTemplateType ($templateType) {
471 $this->templateType = (string) $templateType;
475 * Getter for template type
477 * @return $templateType The current template's type
479 public final function getTemplateType () {
480 return $this->templateType;
484 * Setter for the last loaded template's FQFN
486 * @param $template The last loaded template
489 private final function setLastTemplate ($template) {
490 $this->lastTemplate = (string) $template;
494 * Getter for the last loaded template's FQFN
496 * @return $template The last loaded template
498 private final function getLastTemplate () {
499 return $this->lastTemplate;
503 * Setter for base path
505 * @param $templateBasePath The relative base path for all templates
508 public final function setTemplateBasePath ($templateBasePath) {
510 $this->templateBasePath = (string) $templateBasePath;
514 * Getter for base path
516 * @return $templateBasePath The relative base path for all templates
518 public final function getTemplateBasePath () {
520 return $this->templateBasePath;
524 * Getter for generic base path
526 * @return $templateBasePath The relative base path for all templates
528 public final function getGenericBasePath () {
530 return $this->genericBasePath;
534 * Setter for template extension
536 * @param $templateExtension The file extension for all uncompiled
540 public final function setRawTemplateExtension ($templateExtension) {
542 $this->templateExtension = (string) $templateExtension;
546 * Setter for code template extension
548 * @param $codeExtension The file extension for all uncompiled
552 public final function setCodeTemplateExtension ($codeExtension) {
554 $this->codeExtension = (string) $codeExtension;
558 * Getter for template extension
560 * @return $templateExtension The file extension for all uncompiled
563 public final function getRawTemplateExtension () {
565 return $this->templateExtension;
569 * Getter for code-template extension
571 * @return $codeExtension The file extension for all code-
574 public final function getCodeTemplateExtension () {
576 return $this->codeExtension;
580 * Setter for path of compiled templates
582 * @param $compileOutputPath The local base path for all compiled
586 public final function setCompileOutputPath ($compileOutputPath) {
588 $this->compileOutputPath = (string) $compileOutputPath;
592 * Unsets the given offset in the variable group
594 * @param $index Index to unset
595 * @param $variableGroup Variable group (default: currGroup)
598 protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
599 // Is the variable group not set?
600 if (is_null($variableGroup)) {
601 // Then set it to current
602 $variableGroup = $this->currGroup;
605 // Is the entry there?
606 if (!isset($this->varStack[$variableGroup][$index])) {
607 // Abort here, we need fixing!
608 $this->debugInstance();
612 unset($this->varStack[$variableGroup][$index]);
616 * Private setter for raw template data
618 * @param $rawTemplateData The raw data from the template
621 protected final function setRawTemplateData ($rawTemplateData) {
622 // And store it in this class
623 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
624 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
625 $this->rawTemplateData = (string) $rawTemplateData;
629 * Getter for raw template data
631 * @return $rawTemplateData The raw data from the template
633 public final function getRawTemplateData () {
634 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.');
635 return $this->rawTemplateData;
639 * Private setter for compiled templates
643 private final function setCompiledData ($compiledData) {
644 // And store it in this class
645 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($compiledData) . ' Bytes set.');
646 $this->compiledData = (string) $compiledData;
650 * Getter for compiled templates
652 * @return $compiledData Compiled template data
654 public final function getCompiledData () {
655 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.');
656 return $this->compiledData;
660 * Private loader for all template types
662 * @param $template The template we shall load
663 * @param $extOther An other extension to use
665 * @throws FileIoException If the template was not found
667 protected function loadTemplate ($template, $extOther = '') {
668 // Get extension for the template if empty
669 if (empty($extOther)) {
670 // None provided, so get the raw one
671 $ext = $this->getRawTemplateExtension();
674 $ext = (string) $extOther;
677 // Is language support enabled?
678 if ($this->isLanguageSupportEnabled()) {
679 // Construct the FQFN for the template by honoring the current language
680 $fqfn = sprintf('%s%s%s%s/%s/%s%s',
681 $this->getConfigInstance()->getConfigEntry('base_path'),
682 $this->getTemplateBasePath(),
683 $this->getGenericBasePath(),
684 $this->getLanguageInstance()->getLanguageCode(),
685 $this->getTemplateType(),
690 // Construct the FQFN for the template without language
691 $fqfn = sprintf('%s%s%s%s/%s%s',
692 $this->getConfigInstance()->getConfigEntry('base_path'),
693 $this->getTemplateBasePath(),
694 $this->getGenericBasePath(),
695 $this->getTemplateType(),
703 // Load the raw template data
704 $this->loadRawTemplateData($fqfn);
705 } catch (FileIoException $e) {
706 // If we shall load a code-template we need to switch the file extension
707 if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
708 // Switch over to the code-template extension and try it again
709 $ext = $this->getCodeTemplateExtension();
712 $this->loadTemplate($template, $ext);
715 throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_FOUND);
722 * A private loader for raw template names
724 * @param $fqfn The full-qualified file name for a template
727 private function loadRawTemplateData ($fqfn) {
728 // Some debug code to look on the file which is being loaded
729 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: FQFN=' . $fqfn);
731 // Load the raw template
732 $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fqfn);
734 // Store the template's contents into this class
735 $this->setRawTemplateData($rawTemplateData);
737 // Remember the template's FQFN
738 $this->setLastTemplate($fqfn);
742 * Try to assign an extracted template variable as a "content" or 'config'
745 * @param $variableName The variable's name (shall be content or config)
747 * @param $variableName The variable we want to assign
750 private function assignTemplateVariable ($variableName, $var) {
751 // Replace all dashes to underscores to match variables with configuration entries
752 $variableName = trim($this->convertDashesToUnderscores($variableName));
755 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',variableName=' . $variableName);
757 // Is it not a config variable?
758 if ($variableName != 'config') {
759 // Regular template variables
760 $this->assignVariable($variableName, '');
762 // Configuration variables
763 $this->assignConfigVariable($var);
768 * Extract variables from a given raw data stream
770 * @param $rawData The raw template data we shall analyze
773 private function extractVariablesFromRawData ($rawData) {
775 $rawData = (string) $rawData;
777 // Search for variables
778 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
781 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE));
783 // Did we find some variables?
784 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
785 // Initialize all missing variables
786 foreach ($variableMatches[3] as $key => $var) {
788 $variableName = $variableMatches[1][$key];
790 // Workarround: Do not assign empty variables
792 // Try to assign it, empty strings are being ignored
793 $this->assignTemplateVariable($variableName, $var);
800 * Main analysis of the loaded template
802 * @param $templateMatches Found template place-holders, see below
805 *---------------------------------
806 * Structure of $templateMatches:
807 *---------------------------------
808 * [0] => Array - An array with all full matches
809 * [1] => Array - An array with left part (before the ':') of a match
810 * [2] => Array - An array with right part of a match including ':'
811 * [3] => Array - An array with right part of a match excluding ':'
813 private function analyzeTemplate (array $templateMatches) {
814 // Backup raw template data
815 $backup = $this->getRawTemplateData();
817 // Initialize some arrays
818 if (is_null($this->loadedRawData)) {
820 $this->loadedRawData = array();
821 $this->rawTemplates = array();
824 // Load all requested templates
825 foreach ($templateMatches[1] as $template) {
826 // Load and compile only templates which we have not yet loaded
827 // RECURSIVE PROTECTION! BE CAREFUL HERE!
828 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
830 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template);
832 // Template not found, but maybe variable assigned?
833 if ($this->getVariableIndex($template, 'config') !== FALSE) {
834 // Use that content here
835 $this->loadedRawData[$template] = $this->readVariable($template, 'config');
837 // Recursive protection:
838 array_push($this->loadedTemplates, $template);
839 } elseif ($this->getVariableIndex($template) !== FALSE) {
840 // Use that content here
841 $this->loadedRawData[$template] = $this->readVariable($template);
843 // Recursive protection:
844 array_push($this->loadedTemplates, $template);
846 // Then try to search for code-templates
848 // Load the code template and remember it's contents
849 $this->loadCodeTemplate($template);
850 $this->loadedRawData[$template] = $this->getRawTemplateData();
852 // Remember this template for recursion detection
853 // RECURSIVE PROTECTION!
854 array_push($this->loadedTemplates, $template);
855 } catch (FileIoException $e) {
856 // Even this is not done... :/
857 array_push($this->rawTemplates, $template);
863 // Restore the raw template data
864 $this->setRawTemplateData($backup);
868 * Compile a given raw template code and remember it for later usage
870 * @param $code The raw template code
871 * @param $template The template's name
874 private function compileCode ($code, $template) {
875 // Is this template already compiled?
876 if (in_array($template, $this->compiledTemplates)) {
881 // Remember this template being compiled
882 array_push($this->compiledTemplates, $template);
884 // Compile the loaded code in five steps:
886 // 1. Backup current template data
887 $backup = $this->getRawTemplateData();
889 // 2. Set the current template's raw data as the new content
890 $this->setRawTemplateData($code);
892 // 3. Compile the template data
893 $this->compileTemplate();
895 // 4. Remember it's contents
896 $this->loadedRawData[$template] = $this->getRawTemplateData();
898 // 5. Restore the previous raw content from backup variable
899 $this->setRawTemplateData($backup);
903 * Insert all given and loaded templates by running through all loaded
904 * codes and searching for their place-holder in the main template
906 * @param $templateMatches See method analyzeTemplate()
909 private function insertAllTemplates (array $templateMatches) {
910 // Run through all loaded codes
911 foreach ($this->loadedRawData as $template => $code) {
913 // Search for the template
914 $foundIndex = array_search($template, $templateMatches[1]);
916 // Lookup the matching template replacement
917 if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
919 // Get the current raw template
920 $rawData = $this->getRawTemplateData();
922 // Replace the space holder with the template code
923 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
925 // Set the new raw data
926 $this->setRawTemplateData($rawData);
932 * Load all extra raw templates
936 private function loadExtraRawTemplates () {
937 // Are there some raw templates we need to load?
938 if (count($this->rawTemplates) > 0) {
939 // Try to load all raw templates
940 foreach ($this->rawTemplates as $key => $template) {
943 $this->loadWebTemplate($template);
945 // Remember it's contents
946 $this->rawTemplates[$template] = $this->getRawTemplateData();
948 // Remove it from the loader list
949 unset($this->rawTemplates[$key]);
951 // Remember this template for recursion detection
952 // RECURSIVE PROTECTION!
953 array_push($this->loadedTemplates, $template);
954 } catch (FileIoException $e) {
955 // This template was never found. We silently ignore it
956 unset($this->rawTemplates[$key]);
963 * Assign all found template variables
965 * @param $varMatches An array full of variable/value pairs.
967 * @todo Unfinished work or don't die here.
969 private function assignAllVariables (array $varMatches) {
971 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches()=' . count($varMatches));
973 // Search for all variables
974 foreach ($varMatches[1] as $key => $var) {
975 // Replace all dashes to underscores to match variables with configuration entries
976 $var = trim($this->convertDashesToUnderscores($var));
979 self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var);
981 // Detect leading equals
982 if (substr($varMatches[2][$key], 0, 1) == '=') {
983 // Remove and cast it
984 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
987 // Do we have some quotes left and right side? Then it is free text
988 if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
989 // Free string detected! Which we can assign directly
990 $this->assignVariable($var, $varMatches[3][$key]);
991 } elseif (!empty($varMatches[2][$key])) {
992 // @TODO Non-string found so we need some deeper analysis...
993 ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
999 * Compiles all loaded raw templates
1001 * @param $templateMatches See method analyzeTemplate() for details
1004 private function compileRawTemplateData (array $templateMatches) {
1006 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:loadedRawData()= ' .count($this->loadedRawData));
1008 // Are some code-templates found which we need to compile?
1009 if (count($this->loadedRawData) > 0) {
1010 // Then compile all!
1011 foreach ($this->loadedRawData as $template => $code) {
1013 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1015 // Is this template already compiled?
1016 if (in_array($template, $this->compiledTemplates)) {
1018 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Template ' . $template . ' already compiled. SKIPPED!');
1022 // Search for the template
1023 $foundIndex = array_search($template, $templateMatches[1]);
1025 // Lookup the matching variable data
1026 if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
1027 // Split it up with another reg. exp. into variable=value pairs
1028 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1029 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches=' . print_r($varMatches, TRUE));
1031 // Assign all variables
1032 $this->assignAllVariables($varMatches);
1033 } // END - if (isset($templateMatches ...
1035 // Compile the loaded template
1036 $this->compileCode($code, $template);
1037 } // END - foreach ($this->loadedRawData ...
1039 // Insert all templates
1040 $this->insertAllTemplates($templateMatches);
1041 } // END - if (count($this->loadedRawData) ...
1045 * Inserts all raw templates into their respective variables
1049 private function insertRawTemplates () {
1050 // Load all templates
1051 foreach ($this->rawTemplates as $template => $content) {
1052 // Set the template as a variable with the content
1053 $this->assignVariable($template, $content);
1058 * Finalizes the compilation of all template variables
1062 private function finalizeVariableCompilation () {
1064 $content = $this->getRawTemplateData();
1065 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content before=' . strlen($content) . ' (' . md5($content) . ')');
1067 // Do we have the stack?
1068 if (!$this->isVarStackSet('general')) {
1069 // Abort here silently
1070 // @TODO This silent abort should be logged, maybe.
1074 // Walk through all variables
1075 foreach ($this->getVarStack('general') as $currEntry) {
1076 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1077 // Replace all [$var] or {?$var?} with the content
1078 // @TODO Old behaviour, will become obsolete!
1079 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1081 // @TODO Yet another old way
1082 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1084 // The new behaviour
1085 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1088 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content after=' . strlen($content) . ' (' . md5($content) . ')');
1090 // Set the content back
1091 $this->setRawTemplateData($content);
1095 * Load a specified web template into the engine
1097 * @param $template The web template we shall load which is located in
1101 public function loadWebTemplate ($template) {
1102 // Set template type
1103 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1105 // Load the special template
1106 $this->loadTemplate($template);
1110 * Assign (add) a given variable with a value
1112 * @param $variableName The variable we are looking for
1113 * @param $value The value we want to store in the variable
1115 * @throws EmptyVariableException If the variable name is left empty
1117 public final function assignVariable ($variableName, $value) {
1118 // Replace all dashes to underscores to match variables with configuration entries
1119 $variableName = trim($this->convertDashesToUnderscores($variableName));
1121 // Empty variable found?
1122 if (empty($variableName)) {
1123 // Throw an exception
1124 throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
1127 // First search for the variable if it was already added
1128 $index = $this->getVariableIndex($variableName);
1131 if ($index === FALSE) {
1132 // Add it to the stack
1133 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1134 $this->addVariable($variableName, $value);
1135 } elseif (!empty($value)) {
1136 // Modify the stack entry
1137 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1138 $this->modifyVariable($variableName, $value);
1143 * Removes a given variable
1145 * @param $variableName The variable we are looking for
1146 * @param $variableGroup Name of variable group (default: 'general')
1149 public final function removeVariable ($variableName, $variableGroup = 'general') {
1150 // First search for the variable if it was already added
1151 $index = $this->getVariableIndex($variableName, $variableGroup);
1154 if ($index !== FALSE) {
1155 // Remove this variable
1156 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
1157 $this->unsetVariableStackOffset($index, $variableGroup);
1162 * Assigns the last loaded raw template content with a given variable
1164 * @param $templateName Name of the template we want to assign
1165 * @param $variableName Name of the variable we want to assign
1168 public function assignTemplateWithVariable ($templateName, $variableName) {
1169 // Get the content from last loaded raw template
1170 $content = $this->getRawTemplateData();
1172 // Assign the variable
1173 $this->assignVariable($variableName, $content);
1175 // Purge raw content
1176 $this->setRawTemplateData('');
1180 * Assign a given congfiguration variable with a value
1182 * @param $variableName The configuration variable we want to assign
1185 public function assignConfigVariable ($variableName) {
1186 // Replace all dashes to underscores to match variables with configuration entries
1187 $variableName = trim($this->convertDashesToUnderscores($variableName));
1189 // Sweet and simple...
1190 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1191 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1195 * Injects an array of config variables into the stack of currently loaded
1196 * template. This method should only be used in very rare circumstances,
1197 * e.g. when you have to copy a whole set of variables into the template
1198 * engine. Before you use this method, please make sure you have considered
1199 * all other possiblities.
1201 * @param $variables An array with variables to be injected
1204 public function injectConfigVariables (array $variables) {
1206 foreach ($variables as $name => $value) {
1207 // Set variable with name for 'config' group
1208 $this->setVariable('config', $name, $value);
1213 * Assigns all the application data with template variables
1215 * @param $applicationInstance A manageable application instance
1218 public function assignApplicationData (ManageableApplication $applicationInstance) {
1219 // Get long name and assign it
1220 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1222 // Get short name and assign it
1223 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1225 // Get version number and assign it
1226 $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
1228 // Assign extra application-depending data
1229 $applicationInstance->assignExtraTemplateData($this);
1233 * Load a specified code template into the engine
1235 * @param $template The code template we shall load which is
1236 * located in 'code' by default
1239 public function loadCodeTemplate ($template) {
1240 // Set template type
1241 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1243 // Load the special template
1244 $this->loadTemplate($template);
1248 * Compiles configuration place-holders in all variables. This 'walks'
1249 * through the variable group 'general'. It interprets all values from that
1250 * variables as configuration entries after compiling them.
1254 public final function compileConfigInVariables () {
1255 // Do we have the stack?
1256 if (!$this->isVarStackSet('general')) {
1257 // Abort here silently
1258 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!');
1262 // Iterate through all general variables
1263 foreach ($this->getVarStack('general') as $index => $currVariable) {
1264 // Compile the value
1265 $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
1268 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currVariable['name'] . ',value=' . $value);
1270 // Remove it from stack
1271 $this->removeVariable($currVariable['name'], 'general');
1272 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1274 // Is it a configuration key?
1275 if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
1276 // The value itself is a configuration entry
1277 $this->assignConfigVariable($value);
1279 // Re-assign the value directly
1280 $this->setVariable('config', $currVariable['name'], $value);
1286 * Compile all variables by inserting their respective values
1289 * @todo Make this code some nicer...
1291 public final function compileVariables () {
1292 // Initialize the $content array
1293 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1296 // Iterate through all general variables
1297 foreach ($this->getVarStack('general') as $currVariable) {
1298 // Transfer it's name/value combination to the $content array
1299 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1300 $dummy[$currVariable['name']] = $currVariable['value'];
1303 // Set the new variable (don't remove the second dollar!)
1304 $$validVar = $dummy;
1306 // Remove some variables
1308 unset($currVariable);
1310 // Run the compilation three times to get content from helper classes in
1313 // Finalize the compilation of template variables
1314 $this->finalizeVariableCompilation();
1316 // Prepare the eval() command for comiling the template
1317 $eval = sprintf('$result = "%s";',
1318 addslashes($this->getRawTemplateData())
1321 // This loop does remove the backslashes (\) in PHP parameters
1322 while (strpos($eval, $this->codeBegin) !== FALSE) {
1323 // Get left part before "<?"
1324 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1326 // Get all from right of "<?"
1327 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1329 // Cut middle part out and remove escapes
1330 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1331 $evalMiddle = stripslashes($evalMiddle);
1333 // Remove the middle part from right one
1334 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1336 // And put all together
1337 $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
1340 // Prepare PHP code for eval() command
1341 $eval = str_replace(
1350 // Run the constructed command. This will "compile" all variables in
1353 // Goes something wrong?
1354 if ((!isset($result)) || (empty($result))) {
1355 // Output eval command
1356 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, TRUE)), TRUE);
1358 // Output backtrace here
1359 $this->debugBackTrace();
1362 // Set raw template data
1363 $this->setRawTemplateData($result);
1367 // Final variable assignment
1368 $this->finalizeVariableCompilation();
1370 // Set the new content
1371 $this->setCompiledData($this->getRawTemplateData());
1375 * Compile all required templates into the current loaded one
1378 * @throws UnexpectedTemplateTypeException If the template type is
1380 * @throws InvalidArrayCountException If an unexpected array
1381 * count has been found
1383 public function compileTemplate () {
1384 // Get code type to make things shorter
1385 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1387 // We will only work with template type "code" from configuration
1388 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1390 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1393 // Get the raw data.
1394 $rawData = $this->getRawTemplateData();
1396 // Remove double spaces and trim leading/trailing spaces
1397 $rawData = trim(str_replace(' ', ' ', $rawData));
1399 // Search for raw variables
1400 $this->extractVariablesFromRawData($rawData);
1402 // Search for code-tags which are {? ?}
1403 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1406 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:templateMatches=' . print_r($templateMatches , TRUE));
1408 // Analyze the matches array
1409 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1410 // Entries are found:
1412 // The main analysis
1413 $this->analyzeTemplate($templateMatches);
1415 // Compile raw template data
1416 $this->compileRawTemplateData($templateMatches);
1418 // Are there some raw templates left for loading?
1419 $this->loadExtraRawTemplates();
1421 // Are some raw templates found and loaded?
1422 if (count($this->rawTemplates) > 0) {
1423 // Insert all raw templates
1424 $this->insertRawTemplates();
1426 // Remove the raw template content as well
1427 $this->setRawTemplateData('');
1429 } // END - if($templateMatches ...
1433 * Loads a given view helper (by name)
1435 * @param $helperName The helper's name
1438 protected function loadViewHelper ($helperName) {
1439 // Is this view helper loaded?
1440 if (!isset($this->helpers[$helperName])) {
1441 // Create a class name
1442 $className = $this->convertToClassName($helperName) . 'ViewHelper';
1444 // Generate new instance
1445 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1448 // Return the requested instance
1449 return $this->helpers[$helperName];
1453 * Transfers the content of this template engine to a given response instance
1455 * @param $responseInstance An instance of a response class
1458 public function transferToResponse (Responseable $responseInstance) {
1459 // Get the content and set it in response class
1460 $responseInstance->writeToBody($this->getCompiledData());
1464 * "Compiles" a variable by replacing {?var?} with it's content
1466 * @param $rawCode Raw code to compile
1467 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1468 * @return $rawCode Compile code with inserted variable value
1470 public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
1471 // Find the variables
1472 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1473 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1475 // Compile all variables
1476 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:<pre>' . print_r($varMatches, TRUE) . '</pre>');
1477 foreach ($varMatches[0] as $match) {
1478 // Add variable tags around it
1479 $varCode = '{?' . $match . '?}';
1482 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varCode=' . $varCode);
1484 // Is the variable found in code? (safes some calls)
1485 if (strpos($rawCode, $varCode) !== FALSE) {
1487 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1489 // Use $match as new value or $value from read variable?
1490 if ($setMatchAsCode === TRUE) {
1492 $rawCode = str_replace($varCode, $match, $rawCode);
1494 // Read the variable
1495 $value = $this->readVariable($match);
1498 $rawCode = str_replace($varCode, $value, $rawCode);
1503 // Return the compiled data
1504 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1509 * Getter for variable group array
1511 * @return $variableGroups All variable groups
1513 public final function getVariableGroups () {
1514 return $this->variableGroups;
1518 * Renames a variable in code and in stack
1520 * @param $oldName Old name of variable
1521 * @param $newName New name of variable
1524 public function renameVariable ($oldName, $newName) {
1525 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName);
1526 // Get raw template code
1527 $rawData = $this->getRawTemplateData();
1530 $rawData = str_replace($oldName, $newName, $rawData);
1532 // Set the code back
1533 $this->setRawTemplateData($rawData);
1537 * Renders the given XML content
1539 * @param $content Valid XML content or if not set the current loaded raw content
1541 * @throws XmlParserException If an XML error was found
1543 public function renderXmlContent ($content = NULL) {
1544 // Is the content set?
1545 if (is_null($content)) {
1546 // Get current content
1547 $content = $this->getRawTemplateData();
1550 // Get a XmlParser instance
1551 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1553 // Check if XML compacting is enabled
1554 if ($this->isXmlCompactingEnabled()) {
1555 // Yes, so get a decorator class for transparent compacting
1556 $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1559 // Parse the XML document
1560 $parserInstance->parseXmlContent($content);
1564 * Enables or disables language support
1566 * @param $languageSupport New language support setting
1569 public final function enableLanguageSupport ($languageSupport = TRUE) {
1570 $this->languageSupport = (bool) $languageSupport;
1574 * Checks whether language support is enabled
1576 * @return $languageSupport Whether language support is enabled or disabled
1578 public final function isLanguageSupportEnabled () {
1579 return $this->languageSupport;
1583 * Enables or disables XML compacting
1585 * @param $xmlCompacting New XML compacting setting
1588 public final function enableXmlCompacting ($xmlCompacting = TRUE) {
1589 $this->xmlCompacting = (bool) $xmlCompacting;
1593 * Checks whether XML compacting is enabled
1595 * @return $xmlCompacting Whether XML compacting is enabled or disabled
1597 public final function isXmlCompactingEnabled () {
1598 return $this->xmlCompacting;
1602 * Removes all commentd, tabs and new-line characters to compact the content
1604 * @param $uncompactedContent The uncompacted content
1605 * @return $compactedContent The compacted content
1607 public function compactContent ($uncompactedContent) {
1608 // First, remove all tab/new-line/revert characters
1609 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1611 // Then regex all comments like <!-- //--> away
1612 preg_match_all($this->regExpComments, $compactedContent, $matches);
1614 // Do we have entries?
1615 if (isset($matches[0][0])) {
1617 foreach ($matches[0] as $match) {
1619 $compactedContent = str_replace($match, '', $compactedContent);
1623 // Set the content again
1624 $this->setRawTemplateData($compactedContent);
1626 // Return compacted content
1627 return $compactedContent;