3 namespace Org\Mxchange\CoreFramework\Template\Engine;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint;
8 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
9 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
10 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
11 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
12 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
13 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
14 use Org\Mxchange\CoreFramework\Response\Responseable;
15 use Org\Mxchange\CoreFramework\Traits\Handler\Io\IoHandlerTrait;
16 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
19 use \InvalidArgumentException;
23 * A generic template engine
25 * @author Roland Haeder <webmaster@shipsimu.org>
27 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
28 * @license GNU GPL 3.0 or any newer version
29 * @link http://www.shipsimu.org
31 * This program is free software: you can redistribute it and/or modify
32 * it under the terms of the GNU General Public License as published by
33 * the Free Software Foundation, either version 3 of the License, or
34 * (at your option) any later version.
36 * This program is distributed in the hope that it will be useful,
37 * but WITHOUT ANY WARRANTY; without even the implied warranty of
38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39 * GNU General Public License for more details.
41 * You should have received a copy of the GNU General Public License
42 * along with this program. If not, see <http://www.gnu.org/licenses/>.
44 abstract class BaseTemplateEngine extends BaseFrameworkSystem {
48 // Exception codes for the template engine
49 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
50 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
51 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
52 const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
55 * The local path name where all templates and sub folders for special
56 * templates are stored. We will internally determine the language plus
57 * "html" for web templates or "emails" for email templates
59 private $templateBasePath = '';
64 private $templateType = 'html';
67 * The extension for web and email templates (not compiled templates)
69 private $templateExtension = '.tpl';
72 * The extension for code templates (not compiled templates)
74 private $codeExtension = '.ctp';
77 * Path relative to $templateBasePath and language code for compiled code-templates
79 private $compileOutputPath = 'templates/_compiled/';
82 * The path name for all templates
84 private $genericBasePath = 'templates/';
87 * The raw (maybe uncompiled) template
89 private $rawTemplateData = '';
92 * Template data with compiled-in variables
94 private $compiledData = '';
97 * The last loaded template's file instance (SplFileInfo)
99 private $lastTemplate = NULL;
102 * The variable stack for the templates
104 private $varStack = [];
107 * Loaded templates for recursive protection and detection
109 private $loadedTemplates = [];
112 * Compiled templates for recursive protection and detection
114 private $compiledTemplates = [];
117 * Loaded raw template data
119 private $loadedRawData = NULL;
122 * Raw templates which are linked in code templates
124 private $rawTemplates = NULL;
127 * A regular expression for variable=value pairs
129 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
132 * A regular expression for filtering out code tags
134 * E.g.: {?template:variable=value;var2=value2;[...]?}
136 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
139 * A regular expression to find template comments like <!-- Comment here //-->
141 private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
146 private $helpers = [];
149 * Current variable group
151 private $currGroup = 'general';
154 * All template groups except "general"
156 private $variableGroups = [];
161 private $codeBegin = '<?php';
166 private $codeEnd = '?>';
169 * Language support is enabled by default
171 private $languageSupport = true;
174 * XML compacting is disabled by default
176 private $xmlCompacting = false;
179 * Protected constructor
181 * @param $className Name of the class
184 protected function __construct (string $className) {
185 // Call parent constructor
186 parent::__construct($className);
188 // Init file I/O instance
189 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
192 $this->setFileIoInstance($ioInstance);
196 * Search for a variable in the stack
198 * @param $variableName The variable we are looking for
199 * @param $variableGroup Optional variable group to look in
200 * @return $index false means not found, >=0 means found on a specific index
202 private function getVariableIndex (string $variableName, string $variableGroup = NULL) {
203 // Replace all dashes to underscores to match variables with configuration entries
204 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
206 // First everything is not found
209 // If the stack is NULL, use the current group
210 if (is_null($variableGroup)) {
212 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
213 $variableGroup = $this->currGroup;
216 // Is the group there?
217 if ($this->isVarStackSet($variableGroup)) {
219 foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
220 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
221 // Is the entry found?
222 if ($currEntry['name'] == $variableName) {
224 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':FOUND!');
231 // Return the current position
236 * Checks whether the given variable group is set
238 * @param $variableGroup Variable group to check
239 * @return $isSet Whether the given variable group is set
241 protected final function isVarStackSet (string $variableGroup) {
243 $isSet = isset($this->varStack[$variableGroup]);
250 * Getter for given variable group
252 * @param $variableGroup Variable group to check
253 * @return $varStack Found variable group
255 public final function getVarStack (string $variableGroup) {
256 return $this->varStack[$variableGroup];
260 * Setter for given variable group
262 * @param $variableGroup Variable group to check
263 * @param $varStack Variable stack to check
266 protected final function setVarStack (string $variableGroup, array $varStack) {
267 $this->varStack[$variableGroup] = $varStack;
271 * Return a content of a variable or null if not found
273 * @param $variableName The variable we are looking for
274 * @param $variableGroup Optional variable group to look in
275 * @return $content Content of the variable or null if not found
277 protected function readVariable (string $variableName, string $variableGroup = NULL) {
278 // Replace all dashes to underscores to match variables with configuration entries
279 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
281 // First everything is not found
284 // If the stack is NULL, use the current group
285 if (is_null($variableGroup)) {
287 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
288 $variableGroup = $this->currGroup;
291 // Get variable index
292 $found = $this->getVariableIndex($variableName, $variableGroup);
294 // Is the variable found?
295 if ($found !== false) {
297 $content = $this->getVariableValue($variableGroup, $found);
300 // Return the current position
301 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
306 * Add a variable to the stack
308 * @param $variableName Name of variable to add
309 * @param $value Value we want to store in the variable
312 private function addVariable (string $variableName, $value) {
313 // Set general variable group
314 $this->setVariableGroup('general');
316 // Add it to the stack
317 $this->addGroupVariable($variableName, $value);
321 * Returns all variables of current group or empty array
323 * @return $result Whether array of found variables or empty array
325 private function readCurrentGroup () {
326 // Default is not found
329 // Is the group there?
330 if ($this->isVarStackSet($this->currGroup)) {
332 $result = $this->getVarStack($this->currGroup);
340 * Settter for variable group
342 * @param $groupName Name of variable group
343 * @param $add Whether add this group
346 public function setVariableGroup (string $groupName, bool $add = true) {
348 //* DEBIG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
349 $this->currGroup = $groupName;
351 // Skip group 'general'
352 if (($groupName != 'general') && ($add === true)) {
353 $this->variableGroups[$groupName] = 'OK';
359 * Adds a variable to current group
361 * @param $variableName Variable to set
362 * @param $value Value to store in variable
365 public function addGroupVariable (string $variableName, $value) {
366 // Replace all dashes to underscores to match variables with configuration entries
367 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
370 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
372 // Get current variables in group
373 $currVars = $this->readCurrentGroup();
375 // Append our variable
376 array_push($currVars, $this->generateVariableArray($variableName, $value));
378 // Add it to the stack
379 $this->setVarStack($this->currGroup, $currVars);
383 * Getter for variable value, throws a NoVariableException if the variable is not found
385 * @param $variableGroup Variable group to use
386 * @param $index Index in variable array
387 * @return $value Value to set
389 private function getVariableValue (string $variableGroup, int $index) {
391 return $this->varStack[$variableGroup][$index]['value'];
395 * Modify an entry on the stack
397 * @param $variableName The variable we are looking for
398 * @param $value The value we want to store in the variable
400 * @throws NoVariableException If the given variable is not found
402 private function modifyVariable (string $variableName, $value) {
403 // Replace all dashes to underscores to match variables with configuration entries
404 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
406 // Get index for variable
407 $index = $this->getVariableIndex($variableName);
409 // Is the variable set?
410 if ($index === false) {
411 // Unset variables cannot be modified
412 throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
416 $this->setVariableValue($this->currGroup, $index, $value);
420 * Sets a variable value for given variable group and index
422 * @param $variableGroup Variable group to use
423 * @param $index Index in variable array
424 * @param $value Value to set
427 private function setVariableValue (string $variableGroup, int $index, $value) {
428 $this->varStack[$variableGroup][$index]['value'] = $value;
432 * Sets a variable within given group. This method does detect if the
433 * variable is already set. If so, the variable got modified, otherwise
436 * @param $variableGroup Variable group to use
437 * @param $variableName Variable to set
438 * @param $value Value to set
441 protected function setVariable (string $variableGroup, string $variableName, $value) {
442 // Replace all dashes to underscores to match variables with configuration entries
443 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
445 // Get index for variable
446 $index = $this->getVariableIndex($variableName);
448 // Is the variable set?
449 if ($index === false) {
450 // Is the stack there?
451 if (!isset($this->varStack[$variableGroup])) {
452 // Then initialize it here
453 $this->varStack[$variableGroup] = [];
457 array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value));
460 $this->setVariableValue($this->currGroup, $index, $value);
465 * "Generates" (better returns) an array for all variables for given
466 * variable/value pay.
468 * @param $variableName Variable to set
469 * @param $value Value to set
470 * @return $varData Variable data array
472 private function generateVariableArray (string $variableName, $value) {
473 // Replace all dashes to underscores to match variables with configuration entries
474 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
476 // Generate the temporary array
478 'name' => $variableName,
487 * Setter for template type. Only 'html', 'emails' and 'compiled' should
490 * @param $templateType The current template's type
493 protected final function setTemplateType (string $templateType) {
494 $this->templateType = $templateType;
498 * Getter for template type
500 * @return $templateType The current template's type
502 public final function getTemplateType () {
503 return $this->templateType;
507 * Setter for the last loaded template's file instance
509 * @param $template The last loaded template
512 private final function setLastTemplate (SplFileInfo $fileInstance) {
513 $this->lastTemplate = $fileInstance;
517 * Getter for the last loaded template's file instance
519 * @return $template The last loaded template
521 private final function getLastTemplate () {
522 return $this->lastTemplate;
526 * Setter for base path
528 * @param $templateBasePath The relative base path for all templates
531 protected final function setTemplateBasePath (string $templateBasePath) {
533 $this->templateBasePath = $templateBasePath;
537 * Getter for base path
539 * @return $templateBasePath The relative base path for all templates
541 public final function getTemplateBasePath () {
543 return $this->templateBasePath;
547 * Getter for generic base path
549 * @return $templateBasePath The relative base path for all templates
551 public final function getGenericBasePath () {
553 return $this->genericBasePath;
557 * Setter for template extension
559 * @param $templateExtension The file extension for all uncompiled
563 protected final function setRawTemplateExtension (string $templateExtension) {
565 $this->templateExtension = $templateExtension;
569 * Setter for code template extension
571 * @param $codeExtension The file extension for all uncompiled
575 protected final function setCodeTemplateExtension (string $codeExtension) {
577 $this->codeExtension = $codeExtension;
581 * Getter for template extension
583 * @return $templateExtension The file extension for all uncompiled
586 public final function getRawTemplateExtension () {
588 return $this->templateExtension;
592 * Getter for code-template extension
594 * @return $codeExtension The file extension for all code-
597 public final function getCodeTemplateExtension () {
599 return $this->codeExtension;
603 * Setter for path of compiled templates
605 * @param $compileOutputPath The local base path for all compiled
609 protected final function setCompileOutputPath (string $compileOutputPath) {
611 $this->compileOutputPath = $compileOutputPath;
615 * Unsets the given offset in the variable group
617 * @param $index Index to unset
618 * @param $variableGroup Variable group (default: currGroup)
621 protected final function unsetVariableStackOffset (int $index, string $variableGroup = NULL) {
622 // Is the variable group not set?
623 if (is_null($variableGroup)) {
624 // Then set it to current
625 $variableGroup = $this->currGroup;
628 // Is the entry there?
629 if (!isset($this->varStack[$variableGroup][$index])) {
630 // Abort here, we need fixing!
631 $this->debugInstance();
635 unset($this->varStack[$variableGroup][$index]);
639 * Private setter for raw template data
641 * @param $rawTemplateData The raw data from the template
644 protected final function setRawTemplateData (string $rawTemplateData) {
645 // And store it in this class
646 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
647 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
648 $this->rawTemplateData = $rawTemplateData;
652 * Getter for raw template data
654 * @return $rawTemplateData The raw data from the template
656 public final function getRawTemplateData () {
657 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($this->rawTemplateData) . ' Bytes read.');
658 return $this->rawTemplateData;
662 * Private setter for compiled templates
664 * @param $compiledData Compiled template data
667 private final function setCompiledData (string $compiledData) {
668 // And store it in this class
669 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($compiledData) . ' Bytes set.');
670 $this->compiledData = $compiledData;
674 * Getter for compiled templates, must be public for e.g. Mailer classes.
676 * @return $compiledData Compiled template data
678 public final function getCompiledData () {
679 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($this->compiledData) . ' Bytes read.');
680 return $this->compiledData;
684 * Private loader for all template types
686 * @param $templateName The template we shall load
687 * @param $extOther An other extension to use
689 * @throws FileNotFoundException If the template was not found
691 protected function loadTemplate (string $templateName, string $extOther = '') {
692 // Get extension for the template if empty
693 if (empty($extOther)) {
694 // None provided, so get the raw one
695 $ext = $this->getRawTemplateExtension();
702 * Construct the FQFN for the template without language as language is
703 * now entirely done by php_intl. These old thing with language-based
704 * template paths comes from an older time.
706 $fileInstance = new SplFileInfo(sprintf('%s%s%s%s%s%s',
707 $this->getTemplateBasePath(),
708 $this->getGenericBasePath(),
709 $this->getTemplateType(),
711 (string) $templateName,
717 // Load the raw template data
718 $this->loadRawTemplateData($fileInstance);
719 } catch (FileNotFoundException $e) {
720 // If we shall load a code-template we need to switch the file extension
721 if (($this->getTemplateType() != FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('html_template_type')) && (empty($extOther))) {
722 // Switch over to the code-template extension and try it again
723 $ext = $this->getCodeTemplateExtension();
726 $this->loadTemplate($templateName, $ext);
729 throw new FileNotFoundException($fileInstance, self::EXCEPTION_FILE_NOT_FOUND);
736 * A private loader for raw template names
738 * @param $fileInstance An instance of a SplFileInfo class
741 private function loadRawTemplateData (SplFileInfo $fileInstance) {
742 // Load the raw template
743 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: fileInstance=' . $fileInstance);
744 $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fileInstance);
746 // Store the template's contents into this class
747 $this->setRawTemplateData($rawTemplateData);
749 // Remember the template's file instance
750 $this->setLastTemplate($fileInstance);
754 * Try to assign an extracted template variable as a "content" or 'config'
757 * @param $variableName The variable's name (shall be content or config)
759 * @param $variableName The variable we want to assign
762 private function assignTemplateVariable (string $variableName, $var) {
763 // Replace all dashes to underscores to match variables with configuration entries
764 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: variableName=' . $variableName . ',var=' . $var);
765 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
767 // Is it not a config variable?
768 if ($variableName != 'config') {
769 // Regular template variables
770 $this->assignVariable($variableName, '');
772 // Configuration variables
773 $this->assignConfigVariable($var);
778 * Extract variables from a given raw data stream
780 * @param $rawData The raw template data we shall analyze
783 private function extractVariablesFromRawData (string $rawData) {
784 // Search for variables
785 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
786 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
788 // Did we find some variables?
789 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
790 // Initialize all missing variables
791 foreach ($variableMatches[3] as $key => $var) {
793 $variableName = $variableMatches[1][$key];
795 // Workarround: Do not assign empty variables
797 // Try to assign it, empty strings are being ignored
798 $this->assignTemplateVariable($variableName, $var);
805 * Main analysis of the loaded template
807 * @param $templateMatches Found template place-holders, see below
810 *---------------------------------
811 * Structure of $templateMatches:
812 *---------------------------------
813 * [0] => Array - An array with all full matches
814 * [1] => Array - An array with left part (before the ':') of a match
815 * [2] => Array - An array with right part of a match including ':'
816 * [3] => Array - An array with right part of a match excluding ':'
818 private function analyzeTemplate (array $templateMatches) {
819 // Backup raw template data
820 $backup = $this->getRawTemplateData();
822 // Initialize some arrays
823 if (is_null($this->loadedRawData)) {
825 $this->loadedRawData = [];
826 $this->rawTemplates = [];
829 // Load all requested templates
830 foreach ($templateMatches[1] as $template) {
831 // Load and compile only templates which we have not yet loaded
832 // RECURSIVE PROTECTION! BE CAREFUL HERE!
833 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
835 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:template=' . $template);
837 // Template not found, but maybe variable assigned?
838 if ($this->getVariableIndex($template) !== false) {
839 // Use that content here
840 $this->loadedRawData[$template] = $this->readVariable($template);
842 // Recursive protection:
843 array_push($this->loadedTemplates, $template);
845 // Then try to search for code-templates
847 // Load the code template and remember it's contents
848 $this->loadCodeTemplate($template);
849 $this->loadedRawData[$template] = $this->getRawTemplateData();
851 // Remember this template for recursion detection
852 // RECURSIVE PROTECTION!
853 array_push($this->loadedTemplates, $template);
854 } catch (FileNotFoundException $e) {
855 // Even this is not done... :/
856 array_push($this->rawTemplates, $template);
862 // Restore the raw template data
863 $this->setRawTemplateData($backup);
867 * Compile a given raw template code and remember it for later usage
869 * @param $code The raw template code
870 * @param $template The template's name
873 private function compileCode (string $code, string $template) {
874 // Is this template already compiled?
875 if (in_array($template, $this->compiledTemplates)) {
880 // Remember this template being compiled
881 array_push($this->compiledTemplates, $template);
883 // Compile the loaded code in five steps:
885 // 1. Backup current template data
886 $backup = $this->getRawTemplateData();
888 // 2. Set the current template's raw data as the new content
889 $this->setRawTemplateData($code);
891 // 3. Compile the template data
892 $this->compileTemplate();
894 // 4. Remember it's contents
895 $this->loadedRawData[$template] = $this->getRawTemplateData();
897 // 5. Restore the previous raw content from backup variable
898 $this->setRawTemplateData($backup);
902 * Insert all given and loaded templates by running through all loaded
903 * codes and searching for their place-holder in the main template
905 * @param $templateMatches See method analyzeTemplate()
908 private function insertAllTemplates (array $templateMatches) {
909 // Run through all loaded codes
910 foreach ($this->loadedRawData as $template => $code) {
912 // Search for the template
913 $foundIndex = array_search($template, $templateMatches[1]);
915 // Lookup the matching template replacement
916 if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
918 // Get the current raw template
919 $rawData = $this->getRawTemplateData();
921 // Replace the space holder with the template code
922 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
924 // Set the new raw data
925 $this->setRawTemplateData($rawData);
931 * Load all extra raw templates
935 private function loadExtraRawTemplates () {
936 // Are there some raw templates we need to load?
937 if (count($this->rawTemplates) > 0) {
938 // Try to load all raw templates
939 foreach ($this->rawTemplates as $key => $template) {
942 $this->loadHtmlTemplate($template);
944 // Remember it's contents
945 $this->rawTemplates[$template] = $this->getRawTemplateData();
947 // Remove it from the loader list
948 unset($this->rawTemplates[$key]);
950 // Remember this template for recursion detection
951 // RECURSIVE PROTECTION!
952 array_push($this->loadedTemplates, $template);
953 } catch (FileNotFoundException $e) {
954 // This template was never found. We silently ignore it
955 unset($this->rawTemplates[$key]);
962 * Assign all found template variables
964 * @param $varMatches An array full of variable/value pairs.
966 * @todo Unfinished work or don't die here.
968 private function assignAllVariables (array $varMatches) {
970 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varMatches()=' . count($varMatches));
972 // Search for all variables
973 foreach ($varMatches[1] as $key => $var) {
974 // Replace all dashes to underscores to match variables with configuration entries
975 $var = trim(StringUtils::convertDashesToUnderscores($var));
978 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:key=' . $key . ',var=' . $var);
980 // Detect leading equals
981 if (substr($varMatches[2][$key], 0, 1) == '=') {
982 // Remove and cast it
983 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
986 // Do we have some quotes left and right side? Then it is free text
987 if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
988 // Free string detected! Which we can assign directly
989 $this->assignVariable($var, $varMatches[3][$key]);
990 } elseif (!empty($varMatches[2][$key])) {
991 // @TODO Non-string found so we need some deeper analysis...
992 ApplicationEntryPoint::exitApplication('Deeper analysis not yet implemented!');
998 * Compiles all loaded raw templates
1000 * @param $templateMatches See method analyzeTemplate() for details
1003 private function compileRawTemplateData (array $templateMatches) {
1005 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:loadedRawData()= ' .count($this->loadedRawData));
1007 // Are some code-templates found which we need to compile?
1008 if (count($this->loadedRawData) > 0) {
1009 // Then compile all!
1010 foreach ($this->loadedRawData as $template => $code) {
1012 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1014 // Is this template already compiled?
1015 if (in_array($template, $this->compiledTemplates)) {
1017 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Template ' . $template . ' already compiled. SKIPPED!');
1021 // Search for the template
1022 $foundIndex = array_search($template, $templateMatches[1]);
1024 // Lookup the matching variable data
1025 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1026 // Split it up with another reg. exp. into variable=value pairs
1027 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1028 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varMatches=' . print_r($varMatches, true));
1030 // Assign all variables
1031 $this->assignAllVariables($varMatches);
1034 // Compile the loaded template
1035 $this->compileCode($code, $template);
1038 // Insert all templates
1039 $this->insertAllTemplates($templateMatches);
1044 * Inserts all raw templates into their respective variables
1048 private function insertRawTemplates () {
1049 // Load all templates
1050 foreach ($this->rawTemplates as $template => $content) {
1051 // Set the template as a variable with the content
1052 $this->assignVariable($template, $content);
1057 * Finalizes the compilation of all template variables
1061 private function finalizeVariableCompilation () {
1063 $content = $this->getRawTemplateData();
1064 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content before=' . strlen($content) . ' (' . md5($content) . ')');
1066 // Do we have the stack?
1067 if (!$this->isVarStackSet('general')) {
1068 // Abort here silently
1069 // @TODO This silent abort should be logged, maybe.
1073 // Walk through all variables
1074 foreach ($this->getVarStack('general') as $currEntry) {
1075 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1076 // Replace all [$var] or {?$var?} with the content
1077 // @TODO Old behaviour, will become obsolete!
1078 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1080 // @TODO Yet another old way
1081 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1083 // The new behaviour
1084 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1087 // Set the content back
1088 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content after=' . strlen($content) . ' (' . md5($content) . ')');
1089 $this->setRawTemplateData($content);
1093 * Load a specified HTML template into the engine
1095 * @param $template The web template we shall load which is located in
1099 public function loadHtmlTemplate (string $template) {
1100 // Set template type
1101 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('html_template_type'));
1103 // Load the special template
1104 $this->loadTemplate($template);
1108 * Assign (add) a given variable with a value
1110 * @param $variableName The variable we are looking for
1111 * @param $value The value we want to store in the variable
1113 * @throws InvalidArgumentException If the variable name is left empty
1115 public final function assignVariable (string $variableName, $value) {
1116 // Validate parameter
1117 if (empty($variableName)) {
1118 // Throw an exception
1119 throw new InvalidArgumentException('Parameter "variableName" is empty');
1122 // Replace all dashes to underscores to match variables with configuration entries
1123 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
1125 // First search for the variable if it was already added
1126 $index = $this->getVariableIndex($variableName);
1129 if ($index === false) {
1130 // Add it to the stack
1131 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1132 $this->addVariable($variableName, $value);
1133 } elseif (!empty($value)) {
1134 // Modify the stack entry
1135 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1136 $this->modifyVariable($variableName, $value);
1141 * Removes a given variable
1143 * @param $variableName The variable we are looking for
1144 * @param $variableGroup Name of variable group (default: 'general')
1147 public final function removeVariable (string $variableName, string $variableGroup = 'general') {
1148 // First search for the variable if it was already added
1149 $index = $this->getVariableIndex($variableName, $variableGroup);
1152 if ($index !== false) {
1153 // Remove this variable
1154 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
1155 $this->unsetVariableStackOffset($index, $variableGroup);
1160 * Assigns the last loaded raw template content with a given variable
1162 * @param $templateName Name of the template we want to assign
1163 * @param $variableName Name of the variable we want to assign
1166 public function assignTemplateWithVariable (string $templateName, string $variableName) {
1167 // Get the content from last loaded raw template
1168 $content = $this->getRawTemplateData();
1170 // Assign the variable
1171 $this->assignVariable($variableName, $content);
1173 // Purge raw content
1174 $this->setRawTemplateData('');
1178 * Assign a given congfiguration variable with a value
1180 * @param $variableName The configuration variable we want to assign
1183 public function assignConfigVariable (string $variableName) {
1184 // Replace all dashes to underscores to match variables with configuration entries
1185 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
1187 // Sweet and simple...
1188 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: variableName=' . $variableName . ',getConfigEntry()=' . FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName));
1189 $this->assignVariable($variableName, FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName));
1193 * Assigns a lot variables into the stack of currently loaded template.
1194 * This method should only be used in very rare circumstances, e.g. when
1195 * you have to copy a whole set of variables into the template engine.
1196 * Before you use this method, please make sure you have considered all
1197 * other possiblities.
1199 * @param $variables An array with variables to be assigned
1202 public function assignMultipleVariables (array $variables) {
1204 foreach ($variables as $name => $value) {
1205 // Set variable with name for 'config' group
1206 $this->assignVariable($name, $value);
1211 * Assigns all the application data with template variables
1215 public function assignApplicationData () {
1216 // Get application instance
1217 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
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 (string $template) {
1240 // Set template type
1241 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type'));
1243 // Load the special template
1244 $this->loadTemplate($template);
1248 * Load a specified email template into the engine
1250 * @param $template The email template we shall load which is
1251 * located in 'emails' by default
1254 public function loadEmailTemplate (string $template) {
1255 // Set template type
1256 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('email_template_type'));
1258 // Load the special template
1259 $this->loadTemplate($template);
1263 * Compiles configuration place-holders in all variables. This 'walks'
1264 * through the variable group 'general'. It interprets all values from that
1265 * variables as configuration entries after compiling them.
1269 public final function compileConfigInVariables () {
1270 // Do we have the stack?
1271 if (!$this->isVarStackSet('general')) {
1272 // Abort here silently
1273 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Aborted, variable stack general not found!');
1277 // Iterate through all general variables
1278 foreach ($this->getVarStack('general') as $index => $currVariable) {
1279 // Compile the value
1280 $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1283 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currVariable['name'] . ',value=' . $value);
1285 // Remove it from stack
1286 $this->removeVariable($currVariable['name'], 'general');
1287 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1289 // Is it a configuration key?
1290 if (FrameworkBootstrap::getConfigurationInstance()->isConfigurationEntrySet($value)) {
1291 // The value itself is a configuration entry
1292 $this->assignConfigVariable($value);
1294 // Re-assign the value directly
1295 $this->assignVariable($currVariable['name'], $value);
1301 * Compile all variables by inserting their respective values
1304 * @todo Make this code some nicer...
1306 public final function compileVariables () {
1307 // Initialize the $content array
1308 $validVar = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('tpl_valid_var');
1311 // Iterate through all general variables
1312 foreach ($this->getVarStack('general') as $currVariable) {
1313 // Transfer it's name/value combination to the $content array
1314 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1315 $dummy[$currVariable['name']] = $currVariable['value'];
1318 // Set the new variable (don't remove the second dollar!)
1319 $$validVar = $dummy;
1321 // Remove some variables
1323 unset($currVariable);
1325 // Run the compilation three times to get content from helper classes in
1328 // Finalize the compilation of template variables
1329 $this->finalizeVariableCompilation();
1331 // Prepare the eval() command for comiling the template
1332 $eval = sprintf('$result = "%s";',
1333 addslashes($this->getRawTemplateData())
1336 // This loop does remove the backslashes (\) in PHP parameters
1337 while (strpos($eval, $this->codeBegin) !== false) {
1338 // Get left part before "<?"
1339 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1341 // Get all from right of "<?"
1342 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1344 // Cut middle part out and remove escapes
1345 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1346 $evalMiddle = stripslashes($evalMiddle);
1348 // Remove the middle part from right one
1349 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1351 // And put all together
1352 $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
1355 // Prepare PHP code for eval() command
1356 $eval = str_replace(
1365 // Run the constructed command. This will "compile" all variables in
1368 // Goes something wrong?
1369 if ((!isset($result)) || (empty($result))) {
1370 // Output eval command
1371 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, true)), true);
1373 // Output backtrace here
1374 $this->debugBackTrace();
1377 // Set raw template data
1378 $this->setRawTemplateData($result);
1382 // Final variable assignment
1383 $this->finalizeVariableCompilation();
1385 // Set the new content
1386 $this->setCompiledData($this->getRawTemplateData());
1390 * Compile all required templates into the current loaded one
1393 * @throws UnexpectedTemplateTypeException If the template type is
1395 * @throws InvalidArrayCountException If an unexpected array
1396 * count has been found
1398 public function compileTemplate () {
1399 // Get code type to make things shorter
1400 $codeType = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type');
1402 // We will only work with template type "code" from configuration
1403 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1405 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1408 // Get the raw data.
1409 $rawData = $this->getRawTemplateData();
1411 // Remove double spaces and trim leading/trailing spaces
1412 $rawData = trim(str_replace(' ', ' ', $rawData));
1414 // Search for raw variables
1415 $this->extractVariablesFromRawData($rawData);
1417 // Search for code-tags which are {? ?}
1418 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1421 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:templateMatches=' . print_r($templateMatches , true));
1423 // Analyze the matches array
1424 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1425 // Entries are found:
1427 // The main analysis
1428 $this->analyzeTemplate($templateMatches);
1430 // Compile raw template data
1431 $this->compileRawTemplateData($templateMatches);
1433 // Are there some raw templates left for loading?
1434 $this->loadExtraRawTemplates();
1436 // Are some raw templates found and loaded?
1437 if (count($this->rawTemplates) > 0) {
1438 // Insert all raw templates
1439 $this->insertRawTemplates();
1441 // Remove the raw template content as well
1442 $this->setRawTemplateData('');
1448 * Loads a given view helper (by name)
1450 * @param $helperName The helper's name
1453 protected function loadViewHelper (string $helperName) {
1454 // Is this view helper loaded?
1455 if (!isset($this->helpers[$helperName])) {
1456 // Create a class name
1457 $className = StringUtils::convertToClassName($helperName) . 'ViewHelper';
1459 // Generate new instance
1460 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1463 // Return the requested instance
1464 return $this->helpers[$helperName];
1468 * Transfers the content of this template engine to a given response instance
1470 * @param $responseInstance An instance of a Responseable class
1473 public function transferToResponse (Responseable $responseInstance) {
1474 // Get the content and set it in response class
1475 $responseInstance->writeToBody($this->getCompiledData());
1479 * "Compiles" a variable by replacing {?var?} with it's content
1481 * @param $rawCode Raw code to compile
1482 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1483 * @return $rawCode Compile code with inserted variable value
1485 public function compileRawCode (string $rawCode, bool $setMatchAsCode = false) {
1486 // Find the variables
1487 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1488 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1490 // Compile all variables
1491 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:<pre>' . print_r($varMatches, true) . '</pre>');
1492 foreach ($varMatches[0] as $match) {
1493 // Add variable tags around it
1494 $varCode = '{?' . $match . '?}';
1497 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varCode=' . $varCode);
1499 // Is the variable found in code? (safes some calls)
1500 if (strpos($rawCode, $varCode) !== false) {
1502 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1504 // Use $match as new value or $value from read variable?
1505 if ($setMatchAsCode === true) {
1507 $rawCode = str_replace($varCode, $match, $rawCode);
1509 // Read the variable
1510 $value = $this->readVariable($match);
1513 $rawCode = str_replace($varCode, $value, $rawCode);
1518 // Return the compiled data
1519 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1524 * Getter for variable group array
1526 * @return $variableGroups All variable groups
1528 public final function getVariableGroups () {
1529 return $this->variableGroups;
1533 * Renames a variable in code and in stack
1535 * @param $oldName Old name of variable
1536 * @param $newName New name of variable
1539 public function renameVariable (string $oldName, string $newName) {
1540 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: oldName=' . $oldName . ', newName=' . $newName);
1541 // Get raw template code
1542 $rawData = $this->getRawTemplateData();
1545 $rawData = str_replace($oldName, $newName, $rawData);
1547 // Set the code back
1548 $this->setRawTemplateData($rawData);
1552 * Renders the given XML content
1554 * @param $content Valid XML content or if not set the current loaded raw content
1556 * @throws XmlParserException If an XML error was found
1558 public function renderXmlContent (string $content = NULL) {
1559 // Is the content set?
1560 if (is_null($content)) {
1561 // Get current content
1562 $content = $this->getRawTemplateData();
1565 // Get a XmlParser instance
1566 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1568 // Check if XML compacting is enabled
1569 if ($this->isXmlCompactingEnabled()) {
1570 // Yes, so get a decorator class for transparent compacting
1571 $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1574 // Parse the XML document
1575 $parserInstance->parseXmlContent($content);
1579 * Enables or disables language support
1581 * @param $languageSupport New language support setting
1584 public final function enableLanguageSupport (bool $languageSupport = true) {
1585 $this->languageSupport = $languageSupport;
1589 * Checks whether language support is enabled
1591 * @return $languageSupport Whether language support is enabled or disabled
1593 public final function isLanguageSupportEnabled () {
1594 return $this->languageSupport;
1598 * Enables or disables XML compacting
1600 * @param $xmlCompacting New XML compacting setting
1603 public final function enableXmlCompacting (bool $xmlCompacting = true) {
1604 $this->xmlCompacting = $xmlCompacting;
1608 * Checks whether XML compacting is enabled
1610 * @return $xmlCompacting Whether XML compacting is enabled or disabled
1612 public final function isXmlCompactingEnabled () {
1613 return $this->xmlCompacting;
1617 * Removes all commentd, tabs and new-line characters to compact the content
1619 * @param $uncompactedContent The uncompacted content
1620 * @return $compactedContent The compacted content
1622 public function compactContent (string $uncompactedContent) {
1623 // First, remove all tab/new-line/revert characters
1624 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1626 // Then regex all comments like <!-- //--> away
1627 preg_match_all($this->regExpComments, $compactedContent, $matches);
1629 // Do we have entries?
1630 if (isset($matches[0][0])) {
1632 foreach ($matches[0] as $match) {
1634 $compactedContent = str_replace($match, '', $compactedContent);
1638 // Set the content again
1639 $this->setRawTemplateData($compactedContent);
1641 // Return compacted content
1642 return $compactedContent;