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\Object\ObjectFactory;
9 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
10 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
11 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
12 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
13 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
14 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
15 use Org\Mxchange\CoreFramework\Response\Responseable;
16 use Org\Mxchange\CoreFramework\Traits\Handler\Io\IoHandlerTrait;
17 use Org\Mxchange\CoreFramework\Utils\String\StringUtils;
20 use \InvalidArgumentException;
24 * A generic template engine
26 * @author Roland Haeder <webmaster@shipsimu.org>
28 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
29 * @license GNU GPL 3.0 or any newer version
30 * @link http://www.shipsimu.org
32 * This program is free software: you can redistribute it and/or modify
33 * it under the terms of the GNU General Public License as published by
34 * the Free Software Foundation, either version 3 of the License, or
35 * (at your option) any later version.
37 * This program is distributed in the hope that it will be useful,
38 * but WITHOUT ANY WARRANTY; without even the implied warranty of
39 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40 * GNU General Public License for more details.
42 * You should have received a copy of the GNU General Public License
43 * along with this program. If not, see <http://www.gnu.org/licenses/>.
45 abstract class BaseTemplateEngine extends BaseFrameworkSystem {
49 // Exception codes for the template engine
50 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
51 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
52 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
53 const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
56 * The local path name where all templates and sub folders for special
57 * templates are stored. We will internally determine the language plus
58 * "html" for web templates or "emails" for email templates
60 private $templateBasePath = '';
65 private $templateType = 'html';
68 * The extension for web and email templates (not compiled templates)
70 private $templateExtension = '.tpl';
73 * The extension for code templates (not compiled templates)
75 private $codeExtension = '.ctp';
78 * Path relative to $templateBasePath and language code for compiled code-templates
80 private $compileOutputPath = 'templates/_compiled/';
83 * The path name for all templates
85 private $genericBasePath = 'templates/';
88 * The raw (maybe uncompiled) template
90 private $rawTemplateData = '';
93 * Template data with compiled-in variables
95 private $compiledData = '';
98 * The last loaded template's file instance (SplFileInfo)
100 private $lastTemplate = NULL;
103 * The variable stack for the templates
105 private $varStack = [];
108 * Loaded templates for recursive protection and detection
110 private $loadedTemplates = [];
113 * Compiled templates for recursive protection and detection
115 private $compiledTemplates = [];
118 * Loaded raw template data
120 private $loadedRawData = NULL;
123 * Raw templates which are linked in code templates
125 private $rawTemplates = NULL;
128 * A regular expression for variable=value pairs
130 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
133 * A regular expression for filtering out code tags
135 * E.g.: {?template:variable=value;var2=value2;[...]?}
137 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
140 * A regular expression to find template comments like <!-- Comment here //-->
142 private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
147 private $helpers = [];
150 * Current variable group
152 private $currGroup = 'general';
155 * All template groups except "general"
157 private $variableGroups = [];
162 private $codeBegin = '<?php';
167 private $codeEnd = '?>';
170 * Language support is enabled by default
172 private $languageSupport = true;
175 * Protected constructor
177 * @param $className Name of the class
180 protected function __construct (string $className) {
181 // Call parent constructor
182 parent::__construct($className);
184 // Init file I/O instance
185 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
188 $this->setFileIoInstance($ioInstance);
192 * Search for a variable in the stack
194 * @param $variableName The variable we are looking for
195 * @param $variableGroup Optional variable group to look in
196 * @return $index false means not found, >=0 means found on a specific index
198 private function getVariableIndex (string $variableName, string $variableGroup = NULL) {
199 // Replace all dashes to underscores to match variables with configuration entries
200 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
202 // First everything is not found
205 // If the stack is NULL, use the current group
206 if (is_null($variableGroup)) {
208 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
209 $variableGroup = $this->currGroup;
212 // Is the group there?
213 if ($this->isVarStackSet($variableGroup)) {
215 foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
216 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
217 // Is the entry found?
218 if ($currEntry['name'] == $variableName) {
220 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':FOUND!');
227 // Return the current position
232 * Checks whether the given variable group is set
234 * @param $variableGroup Variable group to check
235 * @return $isSet Whether the given variable group is set
237 protected final function isVarStackSet (string $variableGroup) {
239 $isSet = isset($this->varStack[$variableGroup]);
246 * Getter for given variable group
248 * @param $variableGroup Variable group to check
249 * @return $varStack Found variable group
251 public final function getVarStack (string $variableGroup) {
252 return $this->varStack[$variableGroup];
256 * Setter for given variable group
258 * @param $variableGroup Variable group to check
259 * @param $varStack Variable stack to check
262 protected final function setVarStack (string $variableGroup, array $varStack) {
263 $this->varStack[$variableGroup] = $varStack;
267 * Return a content of a variable or null if not found
269 * @param $variableName The variable we are looking for
270 * @param $variableGroup Optional variable group to look in
271 * @return $content Content of the variable or null if not found
273 protected function readVariable (string $variableName, string $variableGroup = NULL) {
274 // Replace all dashes to underscores to match variables with configuration entries
275 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
277 // First everything is not found
280 // If the stack is NULL, use the current group
281 if (is_null($variableGroup)) {
283 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
284 $variableGroup = $this->currGroup;
287 // Get variable index
288 $found = $this->getVariableIndex($variableName, $variableGroup);
290 // Is the variable found?
291 if ($found !== false) {
293 $content = $this->getVariableValue($variableGroup, $found);
296 // Return the current position
297 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
302 * Add a variable to the stack
304 * @param $variableName Name of variable to add
305 * @param $value Value we want to store in the variable
308 private function addVariable (string $variableName, $value) {
309 // Set general variable group
310 $this->setVariableGroup('general');
312 // Add it to the stack
313 $this->addGroupVariable($variableName, $value);
317 * Returns all variables of current group or empty array
319 * @return $result Whether array of found variables or empty array
321 private function readCurrentGroup () {
322 // Default is not found
325 // Is the group there?
326 if ($this->isVarStackSet($this->currGroup)) {
328 $result = $this->getVarStack($this->currGroup);
336 * Settter for variable group
338 * @param $groupName Name of variable group
339 * @param $add Whether add this group
342 public function setVariableGroup (string $groupName, bool $add = true) {
344 //* DEBIG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
345 $this->currGroup = $groupName;
347 // Skip group 'general'
348 if (($groupName != 'general') && ($add === true)) {
349 $this->variableGroups[$groupName] = 'OK';
355 * Adds a variable to current group
357 * @param $variableName Variable to set
358 * @param $value Value to store in variable
361 public function addGroupVariable (string $variableName, $value) {
362 // Replace all dashes to underscores to match variables with configuration entries
363 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
366 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
368 // Get current variables in group
369 $currVars = $this->readCurrentGroup();
371 // Append our variable
372 array_push($currVars, $this->generateVariableArray($variableName, $value));
374 // Add it to the stack
375 $this->setVarStack($this->currGroup, $currVars);
379 * Getter for variable value, throws a NoVariableException if the variable is not found
381 * @param $variableGroup Variable group to use
382 * @param $index Index in variable array
383 * @return $value Value to set
385 private function getVariableValue (string $variableGroup, int $index) {
387 return $this->varStack[$variableGroup][$index]['value'];
391 * Modify an entry on the stack
393 * @param $variableName The variable we are looking for
394 * @param $value The value we want to store in the variable
396 * @throws NoVariableException If the given variable is not found
398 private function modifyVariable (string $variableName, $value) {
399 // Replace all dashes to underscores to match variables with configuration entries
400 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
402 // Get index for variable
403 $index = $this->getVariableIndex($variableName);
405 // Is the variable set?
406 if ($index === false) {
407 // Unset variables cannot be modified
408 throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
412 $this->setVariableValue($this->currGroup, $index, $value);
416 * Sets a variable value for given variable group and index
418 * @param $variableGroup Variable group to use
419 * @param $index Index in variable array
420 * @param $value Value to set
423 private function setVariableValue (string $variableGroup, int $index, $value) {
424 $this->varStack[$variableGroup][$index]['value'] = $value;
428 * Sets a variable within given group. This method does detect if the
429 * variable is already set. If so, the variable got modified, otherwise
432 * @param $variableGroup Variable group to use
433 * @param $variableName Variable to set
434 * @param $value Value to set
437 protected function setVariable (string $variableGroup, string $variableName, $value) {
438 // Replace all dashes to underscores to match variables with configuration entries
439 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
441 // Get index for variable
442 $index = $this->getVariableIndex($variableName);
444 // Is the variable set?
445 if ($index === false) {
446 // Is the stack there?
447 if (!isset($this->varStack[$variableGroup])) {
448 // Then initialize it here
449 $this->varStack[$variableGroup] = [];
453 array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value));
456 $this->setVariableValue($this->currGroup, $index, $value);
461 * "Generates" (better returns) an array for all variables for given
462 * variable/value pay.
464 * @param $variableName Variable to set
465 * @param $value Value to set
466 * @return $varData Variable data array
468 private function generateVariableArray (string $variableName, $value) {
469 // Replace all dashes to underscores to match variables with configuration entries
470 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
472 // Generate the temporary array
474 'name' => $variableName,
483 * Setter for template type. Only 'html', 'emails' and 'compiled' should
486 * @param $templateType The current template's type
489 protected final function setTemplateType (string $templateType) {
490 $this->templateType = $templateType;
494 * Getter for template type
496 * @return $templateType The current template's type
498 public final function getTemplateType () {
499 return $this->templateType;
503 * Setter for the last loaded template's file instance
505 * @param $template The last loaded template
508 private final function setLastTemplate (SplFileInfo $fileInstance) {
509 $this->lastTemplate = $fileInstance;
513 * Getter for the last loaded template's file instance
515 * @return $template The last loaded template
517 private final function getLastTemplate () {
518 return $this->lastTemplate;
522 * Setter for base path
524 * @param $templateBasePath The relative base path for all templates
527 protected final function setTemplateBasePath (string $templateBasePath) {
529 $this->templateBasePath = $templateBasePath;
533 * Getter for base path
535 * @return $templateBasePath The relative base path for all templates
537 public final function getTemplateBasePath () {
539 return $this->templateBasePath;
543 * Getter for generic base path
545 * @return $templateBasePath The relative base path for all templates
547 public final function getGenericBasePath () {
549 return $this->genericBasePath;
553 * Setter for template extension
555 * @param $templateExtension The file extension for all uncompiled
559 protected final function setRawTemplateExtension (string $templateExtension) {
561 $this->templateExtension = $templateExtension;
565 * Setter for code template extension
567 * @param $codeExtension The file extension for all uncompiled
571 protected final function setCodeTemplateExtension (string $codeExtension) {
573 $this->codeExtension = $codeExtension;
577 * Getter for template extension
579 * @return $templateExtension The file extension for all uncompiled
582 public final function getRawTemplateExtension () {
584 return $this->templateExtension;
588 * Getter for code-template extension
590 * @return $codeExtension The file extension for all code-
593 public final function getCodeTemplateExtension () {
595 return $this->codeExtension;
599 * Setter for path of compiled templates
601 * @param $compileOutputPath The local base path for all compiled
605 protected final function setCompileOutputPath (string $compileOutputPath) {
607 $this->compileOutputPath = $compileOutputPath;
611 * Unsets the given offset in the variable group
613 * @param $index Index to unset
614 * @param $variableGroup Variable group (default: currGroup)
617 protected final function unsetVariableStackOffset (int $index, string $variableGroup = NULL) {
618 // Is the variable group not set?
619 if (is_null($variableGroup)) {
620 // Then set it to current
621 $variableGroup = $this->currGroup;
624 // Is the entry there?
625 if (!isset($this->varStack[$variableGroup][$index])) {
626 // Abort here, we need fixing!
627 $this->debugInstance();
631 unset($this->varStack[$variableGroup][$index]);
635 * Private setter for raw template data
637 * @param $rawTemplateData The raw data from the template
640 protected final function setRawTemplateData (string $rawTemplateData) {
641 // And store it in this class
642 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
643 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
644 $this->rawTemplateData = $rawTemplateData;
648 * Getter for raw template data
650 * @return $rawTemplateData The raw data from the template
652 public final function getRawTemplateData () {
653 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($this->rawTemplateData) . ' Bytes read.');
654 return $this->rawTemplateData;
658 * Private setter for compiled templates
660 * @param $compiledData Compiled template data
663 private final function setCompiledData (string $compiledData) {
664 // And store it in this class
665 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($compiledData) . ' Bytes set.');
666 $this->compiledData = $compiledData;
670 * Getter for compiled templates, must be public for e.g. Mailer classes.
672 * @return $compiledData Compiled template data
674 public final function getCompiledData () {
675 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: ' . strlen($this->compiledData) . ' Bytes read.');
676 return $this->compiledData;
680 * Private loader for all template types
682 * @param $templateName The template we shall load
683 * @param $extOther An other extension to use
685 * @throws FileNotFoundException If the template was not found
687 protected function loadTemplate (string $templateName, string $extOther = '') {
688 // Get extension for the template if empty
689 if (empty($extOther)) {
690 // None provided, so get the raw one
691 $ext = $this->getRawTemplateExtension();
698 * Construct the FQFN for the template without language as language is
699 * now entirely done by php_intl. These old thing with language-based
700 * template paths comes from an older time.
702 $fileInstance = new SplFileInfo(sprintf('%s%s%s%s%s%s',
703 $this->getTemplateBasePath(),
704 $this->getGenericBasePath(),
705 $this->getTemplateType(),
707 (string) $templateName,
713 // Load the raw template data
714 $this->loadRawTemplateData($fileInstance);
715 } catch (FileNotFoundException $e) {
716 // If we shall load a code-template we need to switch the file extension
717 if (($this->getTemplateType() != FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('html_template_type')) && (empty($extOther))) {
718 // Switch over to the code-template extension and try it again
719 $ext = $this->getCodeTemplateExtension();
722 $this->loadTemplate($templateName, $ext);
725 throw new FileNotFoundException($fileInstance, self::EXCEPTION_FILE_NOT_FOUND);
732 * A private loader for raw template names
734 * @param $fileInstance An instance of a SplFileInfo class
737 private function loadRawTemplateData (SplFileInfo $fileInstance) {
738 // Load the raw template
739 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: fileInstance=' . $fileInstance);
740 $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fileInstance);
742 // Store the template's contents into this class
743 $this->setRawTemplateData($rawTemplateData);
745 // Remember the template's file instance
746 $this->setLastTemplate($fileInstance);
750 * Try to assign an extracted template variable as a "content" or 'config'
753 * @param $variableName The variable's name (shall be content or config)
755 * @param $variableName The variable we want to assign
758 private function assignTemplateVariable (string $variableName, $var) {
759 // Replace all dashes to underscores to match variables with configuration entries
760 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: variableName=' . $variableName . ',var=' . $var);
761 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
763 // Is it not a config variable?
764 if ($variableName != 'config') {
765 // Regular template variables
766 $this->assignVariable($variableName, '');
768 // Configuration variables
769 $this->assignConfigVariable($var);
774 * Extract variables from a given raw data stream
776 * @param $rawData The raw template data we shall analyze
779 private function extractVariablesFromRawData (string $rawData) {
780 // Search for variables
781 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
782 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
784 // Did we find some variables?
785 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
786 // Initialize all missing variables
787 foreach ($variableMatches[3] as $key => $var) {
789 $variableName = $variableMatches[1][$key];
791 // Workarround: Do not assign empty variables
793 // Try to assign it, empty strings are being ignored
794 $this->assignTemplateVariable($variableName, $var);
801 * Main analysis of the loaded template
803 * @param $templateMatches Found template place-holders, see below
806 *---------------------------------
807 * Structure of $templateMatches:
808 *---------------------------------
809 * [0] => Array - An array with all full matches
810 * [1] => Array - An array with left part (before the ':') of a match
811 * [2] => Array - An array with right part of a match including ':'
812 * [3] => Array - An array with right part of a match excluding ':'
814 private function analyzeTemplate (array $templateMatches) {
815 // Backup raw template data
816 $backup = $this->getRawTemplateData();
818 // Initialize some arrays
819 if (is_null($this->loadedRawData)) {
821 $this->loadedRawData = [];
822 $this->rawTemplates = [];
825 // Load all requested templates
826 foreach ($templateMatches[1] as $template) {
827 // Load and compile only templates which we have not yet loaded
828 // RECURSIVE PROTECTION! BE CAREFUL HERE!
829 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
831 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:template=' . $template);
833 // Template not found, but maybe variable assigned?
834 if ($this->getVariableIndex($template) !== false) {
835 // Use that content here
836 $this->loadedRawData[$template] = $this->readVariable($template);
838 // Recursive protection:
839 array_push($this->loadedTemplates, $template);
841 // Then try to search for code-templates
843 // Load the code template and remember it's contents
844 $this->loadCodeTemplate($template);
845 $this->loadedRawData[$template] = $this->getRawTemplateData();
847 // Remember this template for recursion detection
848 // RECURSIVE PROTECTION!
849 array_push($this->loadedTemplates, $template);
850 } catch (FileNotFoundException $e) {
851 // Even this is not done... :/
852 array_push($this->rawTemplates, $template);
858 // Restore the raw template data
859 $this->setRawTemplateData($backup);
863 * Compile a given raw template code and remember it for later usage
865 * @param $code The raw template code
866 * @param $template The template's name
869 private function compileCode (string $code, string $template) {
870 // Is this template already compiled?
871 if (in_array($template, $this->compiledTemplates)) {
876 // Remember this template being compiled
877 array_push($this->compiledTemplates, $template);
879 // Compile the loaded code in five steps:
881 // 1. Backup current template data
882 $backup = $this->getRawTemplateData();
884 // 2. Set the current template's raw data as the new content
885 $this->setRawTemplateData($code);
887 // 3. Compile the template data
888 $this->compileTemplate();
890 // 4. Remember it's contents
891 $this->loadedRawData[$template] = $this->getRawTemplateData();
893 // 5. Restore the previous raw content from backup variable
894 $this->setRawTemplateData($backup);
898 * Insert all given and loaded templates by running through all loaded
899 * codes and searching for their place-holder in the main template
901 * @param $templateMatches See method analyzeTemplate()
904 private function insertAllTemplates (array $templateMatches) {
905 // Run through all loaded codes
906 foreach ($this->loadedRawData as $template => $code) {
908 // Search for the template
909 $foundIndex = array_search($template, $templateMatches[1]);
911 // Lookup the matching template replacement
912 if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
914 // Get the current raw template
915 $rawData = $this->getRawTemplateData();
917 // Replace the space holder with the template code
918 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
920 // Set the new raw data
921 $this->setRawTemplateData($rawData);
927 * Load all extra raw templates
931 private function loadExtraRawTemplates () {
932 // Are there some raw templates we need to load?
933 if (count($this->rawTemplates) > 0) {
934 // Try to load all raw templates
935 foreach ($this->rawTemplates as $key => $template) {
938 $this->loadHtmlTemplate($template);
940 // Remember it's contents
941 $this->rawTemplates[$template] = $this->getRawTemplateData();
943 // Remove it from the loader list
944 unset($this->rawTemplates[$key]);
946 // Remember this template for recursion detection
947 // RECURSIVE PROTECTION!
948 array_push($this->loadedTemplates, $template);
949 } catch (FileNotFoundException $e) {
950 // This template was never found. We silently ignore it
951 unset($this->rawTemplates[$key]);
958 * Assign all found template variables
960 * @param $varMatches An array full of variable/value pairs.
962 * @todo Unfinished work or don't die here.
964 private function assignAllVariables (array $varMatches) {
966 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varMatches()=' . count($varMatches));
968 // Search for all variables
969 foreach ($varMatches[1] as $key => $var) {
970 // Replace all dashes to underscores to match variables with configuration entries
971 $var = trim(StringUtils::convertDashesToUnderscores($var));
974 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:key=' . $key . ',var=' . $var);
976 // Detect leading equals
977 if (substr($varMatches[2][$key], 0, 1) == '=') {
978 // Remove and cast it
979 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
982 // Do we have some quotes left and right side? Then it is free text
983 if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
984 // Free string detected! Which we can assign directly
985 $this->assignVariable($var, $varMatches[3][$key]);
986 } elseif (!empty($varMatches[2][$key])) {
987 // @TODO Non-string found so we need some deeper analysis...
988 ApplicationEntryPoint::exitApplication('Deeper analysis not yet implemented!');
994 * Compiles all loaded raw templates
996 * @param $templateMatches See method analyzeTemplate() for details
999 private function compileRawTemplateData (array $templateMatches) {
1001 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:loadedRawData()= ' .count($this->loadedRawData));
1003 // Are some code-templates found which we need to compile?
1004 if (count($this->loadedRawData) > 0) {
1005 // Then compile all!
1006 foreach ($this->loadedRawData as $template => $code) {
1008 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1010 // Is this template already compiled?
1011 if (in_array($template, $this->compiledTemplates)) {
1013 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Template ' . $template . ' already compiled. SKIPPED!');
1017 // Search for the template
1018 $foundIndex = array_search($template, $templateMatches[1]);
1020 // Lookup the matching variable data
1021 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1022 // Split it up with another reg. exp. into variable=value pairs
1023 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1024 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varMatches=' . print_r($varMatches, true));
1026 // Assign all variables
1027 $this->assignAllVariables($varMatches);
1030 // Compile the loaded template
1031 $this->compileCode($code, $template);
1034 // Insert all templates
1035 $this->insertAllTemplates($templateMatches);
1040 * Inserts all raw templates into their respective variables
1044 private function insertRawTemplates () {
1045 // Load all templates
1046 foreach ($this->rawTemplates as $template => $content) {
1047 // Set the template as a variable with the content
1048 $this->assignVariable($template, $content);
1053 * Finalizes the compilation of all template variables
1057 private function finalizeVariableCompilation () {
1059 $content = $this->getRawTemplateData();
1060 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content before=' . strlen($content) . ' (' . md5($content) . ')');
1062 // Do we have the stack?
1063 if (!$this->isVarStackSet('general')) {
1064 // Abort here silently
1065 // @TODO This silent abort should be logged, maybe.
1069 // Walk through all variables
1070 foreach ($this->getVarStack('general') as $currEntry) {
1071 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1072 // Replace all [$var] or {?$var?} with the content
1073 // @TODO Old behaviour, will become obsolete!
1074 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1076 // @TODO Yet another old way
1077 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1079 // The new behaviour
1080 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1083 // Set the content back
1084 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content after=' . strlen($content) . ' (' . md5($content) . ')');
1085 $this->setRawTemplateData($content);
1089 * Load a specified HTML template into the engine
1091 * @param $template The web template we shall load which is located in
1095 public function loadHtmlTemplate (string $template) {
1096 // Set template type
1097 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('html_template_type'));
1099 // Load the special template
1100 $this->loadTemplate($template);
1104 * Assign (add) a given variable with a value
1106 * @param $variableName The variable we are looking for
1107 * @param $value The value we want to store in the variable
1109 * @throws InvalidArgumentException If the variable name is left empty
1111 public final function assignVariable (string $variableName, $value) {
1112 // Validate parameter
1113 if (empty($variableName)) {
1114 // Throw an exception
1115 throw new InvalidArgumentException('Parameter "variableName" is empty');
1118 // Replace all dashes to underscores to match variables with configuration entries
1119 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
1121 // First search for the variable if it was already added
1122 $index = $this->getVariableIndex($variableName);
1125 if ($index === false) {
1126 // Add it to the stack
1127 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1128 $this->addVariable($variableName, $value);
1129 } elseif (!empty($value)) {
1130 // Modify the stack entry
1131 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
1132 $this->modifyVariable($variableName, $value);
1137 * Removes a given variable
1139 * @param $variableName The variable we are looking for
1140 * @param $variableGroup Name of variable group (default: 'general')
1143 public final function removeVariable (string $variableName, string $variableGroup = 'general') {
1144 // First search for the variable if it was already added
1145 $index = $this->getVariableIndex($variableName, $variableGroup);
1148 if ($index !== false) {
1149 // Remove this variable
1150 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
1151 $this->unsetVariableStackOffset($index, $variableGroup);
1156 * Assigns the last loaded raw template content with a given variable
1158 * @param $templateName Name of the template we want to assign
1159 * @param $variableName Name of the variable we want to assign
1162 public function assignTemplateWithVariable (string $templateName, string $variableName) {
1163 // Get the content from last loaded raw template
1164 $content = $this->getRawTemplateData();
1166 // Assign the variable
1167 $this->assignVariable($variableName, $content);
1169 // Purge raw content
1170 $this->setRawTemplateData('');
1174 * Assign a given congfiguration variable with a value
1176 * @param $variableName The configuration variable we want to assign
1179 public function assignConfigVariable (string $variableName) {
1180 // Replace all dashes to underscores to match variables with configuration entries
1181 $variableName = trim(StringUtils::convertDashesToUnderscores($variableName));
1183 // Sweet and simple...
1184 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: variableName=' . $variableName . ',getConfigEntry()=' . FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName));
1185 $this->assignVariable($variableName, FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName));
1189 * Assigns a lot variables into the stack of currently loaded template.
1190 * This method should only be used in very rare circumstances, e.g. when
1191 * you have to copy a whole set of variables into the template engine.
1192 * Before you use this method, please make sure you have considered all
1193 * other possiblities.
1195 * @param $variables An array with variables to be assigned
1198 public function assignMultipleVariables (array $variables) {
1200 foreach ($variables as $name => $value) {
1201 // Set variable with name for 'config' group
1202 $this->assignVariable($name, $value);
1207 * Assigns all the application data with template variables
1211 public function assignApplicationData () {
1212 // Get application instance
1213 $applicationInstance = ApplicationHelper::getSelfInstance();
1215 // Get long name and assign it
1216 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1218 // Get short name and assign it
1219 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1221 // Get version number and assign it
1222 $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
1224 // Assign extra application-depending data
1225 $applicationInstance->assignExtraTemplateData($this);
1229 * Load a specified code template into the engine
1231 * @param $template The code template we shall load which is
1232 * located in 'code' by default
1235 public function loadCodeTemplate (string $template) {
1236 // Set template type
1237 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type'));
1239 // Load the special template
1240 $this->loadTemplate($template);
1244 * Load a specified email template into the engine
1246 * @param $template The email template we shall load which is
1247 * located in 'emails' by default
1250 public function loadEmailTemplate (string $template) {
1251 // Set template type
1252 $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('email_template_type'));
1254 // Load the special template
1255 $this->loadTemplate($template);
1259 * Compiles configuration place-holders in all variables. This 'walks'
1260 * through the variable group 'general'. It interprets all values from that
1261 * variables as configuration entries after compiling them.
1265 public final function compileConfigInVariables () {
1266 // Do we have the stack?
1267 if (!$this->isVarStackSet('general')) {
1268 // Abort here silently
1269 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Aborted, variable stack general not found!');
1273 // Iterate through all general variables
1274 foreach ($this->getVarStack('general') as $index => $currVariable) {
1275 // Compile the value
1276 $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1279 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currVariable['name'] . ',value=' . $value);
1281 // Remove it from stack
1282 $this->removeVariable($currVariable['name'], 'general');
1283 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1285 // Is it a configuration key?
1286 if (FrameworkBootstrap::getConfigurationInstance()->isConfigurationEntrySet($value)) {
1287 // The value itself is a configuration entry
1288 $this->assignConfigVariable($value);
1290 // Re-assign the value directly
1291 $this->assignVariable($currVariable['name'], $value);
1297 * Compile all variables by inserting their respective values
1300 * @todo Make this code some nicer...
1302 public final function compileVariables () {
1303 // Initialize the $content array
1304 $validVar = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('tpl_valid_var');
1307 // Iterate through all general variables
1308 foreach ($this->getVarStack('general') as $currVariable) {
1309 // Transfer it's name/value combination to the $content array
1310 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1311 $dummy[$currVariable['name']] = $currVariable['value'];
1314 // Set the new variable (don't remove the second dollar!)
1315 $$validVar = $dummy;
1317 // Remove some variables
1319 unset($currVariable);
1321 // Run the compilation three times to get content from helper classes in
1324 // Finalize the compilation of template variables
1325 $this->finalizeVariableCompilation();
1327 // Prepare the eval() command for comiling the template
1328 $eval = sprintf('$result = "%s";',
1329 addslashes($this->getRawTemplateData())
1332 // This loop does remove the backslashes (\) in PHP parameters
1333 while (strpos($eval, $this->codeBegin) !== false) {
1334 // Get left part before "<?"
1335 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1337 // Get all from right of "<?"
1338 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1340 // Cut middle part out and remove escapes
1341 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1342 $evalMiddle = stripslashes($evalMiddle);
1344 // Remove the middle part from right one
1345 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1347 // And put all together
1348 $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
1351 // Prepare PHP code for eval() command
1352 $eval = str_replace(
1361 // Run the constructed command. This will "compile" all variables in
1364 // Goes something wrong?
1365 if ((!isset($result)) || (empty($result))) {
1366 // Output eval command
1367 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, true)), true);
1369 // Output backtrace here
1370 $this->debugBackTrace();
1373 // Set raw template data
1374 $this->setRawTemplateData($result);
1378 // Final variable assignment
1379 $this->finalizeVariableCompilation();
1381 // Set the new content
1382 $this->setCompiledData($this->getRawTemplateData());
1386 * Compile all required templates into the current loaded one
1389 * @throws UnexpectedTemplateTypeException If the template type is
1391 * @throws InvalidArrayCountException If an unexpected array
1392 * count has been found
1394 public function compileTemplate () {
1395 // Get code type to make things shorter
1396 $codeType = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type');
1398 // We will only work with template type "code" from configuration
1399 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1401 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1404 // Get the raw data.
1405 $rawData = $this->getRawTemplateData();
1407 // Remove double spaces and trim leading/trailing spaces
1408 $rawData = trim(str_replace(' ', ' ', $rawData));
1410 // Search for raw variables
1411 $this->extractVariablesFromRawData($rawData);
1413 // Search for code-tags which are {? ?}
1414 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1417 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:templateMatches=' . print_r($templateMatches , true));
1419 // Analyze the matches array
1420 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1421 // Entries are found:
1423 // The main analysis
1424 $this->analyzeTemplate($templateMatches);
1426 // Compile raw template data
1427 $this->compileRawTemplateData($templateMatches);
1429 // Are there some raw templates left for loading?
1430 $this->loadExtraRawTemplates();
1432 // Are some raw templates found and loaded?
1433 if (count($this->rawTemplates) > 0) {
1434 // Insert all raw templates
1435 $this->insertRawTemplates();
1437 // Remove the raw template content as well
1438 $this->setRawTemplateData('');
1444 * Loads a given view helper (by name)
1446 * @param $helperName The helper's name
1449 protected function loadViewHelper (string $helperName) {
1450 // Is this view helper loaded?
1451 if (!isset($this->helpers[$helperName])) {
1452 // Create a class name
1453 $className = StringUtils::convertToClassName($helperName) . 'ViewHelper';
1455 // Generate new instance
1456 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1459 // Return the requested instance
1460 return $this->helpers[$helperName];
1464 * Transfers the content of this template engine to a given response instance
1466 * @param $responseInstance An instance of a Responseable class
1469 public function transferToResponse (Responseable $responseInstance) {
1470 // Get the content and set it in response class
1471 $responseInstance->writeToBody($this->getCompiledData());
1475 * "Compiles" a variable by replacing {?var?} with it's content
1477 * @param $rawCode Raw code to compile
1478 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1479 * @return $rawCode Compile code with inserted variable value
1481 public function compileRawCode (string $rawCode, bool $setMatchAsCode = false) {
1482 // Find the variables
1483 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1484 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1486 // Compile all variables
1487 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:<pre>' . print_r($varMatches, true) . '</pre>');
1488 foreach ($varMatches[0] as $match) {
1489 // Add variable tags around it
1490 $varCode = '{?' . $match . '?}';
1493 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varCode=' . $varCode);
1495 // Is the variable found in code? (safes some calls)
1496 if (strpos($rawCode, $varCode) !== false) {
1498 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1500 // Use $match as new value or $value from read variable?
1501 if ($setMatchAsCode === true) {
1503 $rawCode = str_replace($varCode, $match, $rawCode);
1505 // Read the variable
1506 $value = $this->readVariable($match);
1509 $rawCode = str_replace($varCode, $value, $rawCode);
1514 // Return the compiled data
1515 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1520 * Getter for variable group array
1522 * @return $variableGroups All variable groups
1524 public final function getVariableGroups () {
1525 return $this->variableGroups;
1529 * Renames a variable in code and in stack
1531 * @param $oldName Old name of variable
1532 * @param $newName New name of variable
1535 public function renameVariable (string $oldName, string $newName) {
1536 //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: oldName=' . $oldName . ', newName=' . $newName);
1537 // Get raw template code
1538 $rawData = $this->getRawTemplateData();
1541 $rawData = str_replace($oldName, $newName, $rawData);
1543 // Set the code back
1544 $this->setRawTemplateData($rawData);
1548 * Enables or disables language support
1550 * @param $languageSupport New language support setting
1553 public final function enableLanguageSupport (bool $languageSupport = true) {
1554 $this->languageSupport = $languageSupport;
1558 * Checks whether language support is enabled
1560 * @return $languageSupport Whether language support is enabled or disabled
1562 public final function isLanguageSupportEnabled () {
1563 return $this->languageSupport;
1567 * Removes all commentd, tabs and new-line characters to compact the content
1569 * @param $uncompactedContent The uncompacted content
1570 * @return $compactedContent The compacted content
1572 public function compactContent (string $uncompactedContent) {
1573 // First, remove all tab/new-line/revert characters
1574 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1576 // Then regex all comments like <!-- //--> away
1577 preg_match_all($this->regExpComments, $compactedContent, $matches);
1579 // Do we have entries?
1580 if (isset($matches[0][0])) {
1582 foreach ($matches[0] as $match) {
1584 $compactedContent = str_replace($match, '', $compactedContent);
1588 // Set the content again
1589 $this->setRawTemplateData($compactedContent);
1591 // Return compacted content
1592 return $compactedContent;