3 * A generic template engine
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseTemplateEngine extends BaseFrameworkSystem {
26 * The local path name where all templates and sub folders for special
27 * templates are stored. We will internally determine the language plus
28 * "html" for web templates or "emails" for email templates
30 private $templateBasePath = '';
35 private $templateType = 'html';
38 * The extension for web and email templates (not compiled templates)
40 private $templateExtension = '.tpl';
43 * The extension for code templates (not compiled templates)
45 private $codeExtension = '.ctp';
48 * Path relative to $templateBasePath and language code for compiled code-templates
50 private $compileOutputPath = 'templates/_compiled/';
53 * The path name for all templates
55 private $genericBasePath = 'templates/';
58 * The raw (maybe uncompiled) template
60 private $rawTemplateData = '';
63 * Template data with compiled-in variables
65 private $compiledData = '';
68 * The last loaded template's FQFN for debugging the engine
70 private $lastTemplate = '';
73 * The variable stack for the templates
75 private $varStack = array();
78 * Loaded templates for recursive protection and detection
80 private $loadedTemplates = array();
83 * Compiled templates for recursive protection and detection
85 private $compiledTemplates = array();
88 * Loaded raw template data
90 private $loadedRawData = NULL;
93 * Raw templates which are linked in code templates
95 private $rawTemplates = NULL;
98 * A regular expression for variable=value pairs
100 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
103 * A regular expression for filtering out code tags
105 * E.g.: {?template:variable=value;var2=value2;[...]?}
107 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
112 private $helpers = array();
115 * Current variable group
117 private $currGroup = 'general';
120 * All template groups except "general"
122 private $varGroups = array();
127 private $codeBegin = '<?php';
132 private $codeEnd = '?>';
135 * Language support is enabled by default
137 private $languageSupport = true;
140 * XML compacting is disabled by default
142 private $xmlCompacting = false;
144 // Exception codes for the template engine
145 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
146 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
147 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
148 const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
151 * Protected constructor
153 * @param $className Name of the class
156 protected function __construct ($className) {
157 // Call parent constructor
158 parent::__construct($className);
160 // Init file I/O instance
161 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
164 $this->setFileIoInstance($ioInstance);
168 * Search for a variable in the stack
170 * @param $var The variable we are looking for
171 * @param $stack Optional variable stack to look in
172 * @return $index FALSE means not found, >=0 means found on a specific index
174 private function getVariableIndex ($var, $stack = NULL) {
175 // Replace all dashes to underscores to match variables with configuration entries
176 $var = trim($this->convertDashesToUnderscores($var));
178 // First everything is not found
181 // If the stack is null, use the current group
182 if (is_null($stack)) {
184 //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
185 $stack = $this->currGroup;
188 // Is the group there?
189 if ($this->isVarStackSet($stack)) {
191 foreach ($this->getVarStack($stack) as $index => $currEntry) {
192 //* DEBUG: */ $this->debugOutput(__METHOD__.':currGroup=' . $stack . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',var=' . $var);
193 // Is the entry found?
194 if ($currEntry['name'] == $var) {
196 //* DEBUG: */ $this->debugOutput(__METHOD__.':FOUND!');
203 // Return the current position
208 * Checks whether the given variable stack is set
210 * @param $stack Variable stack to check
211 * @return $isSet Whether the given variable stack is set
213 protected final function isVarStackSet ($stack) {
215 $isSet = isset($this->varStack[$stack]);
222 * Getter for given variable stack
224 * @param $stack Variable stack to check
225 * @return $varStack Found variable stack
227 public final function getVarStack ($stack) {
228 return $this->varStack[$stack];
232 * Setter for given variable stack
234 * @param $stack Variable stack to check
235 * @param $varStack Variable stack to check
238 protected final function setVarStack ($stack, array $varStack) {
239 $this->varStack[$stack] = $varStack;
243 * Return a content of a variable or null if not found
245 * @param $var The variable we are looking for
246 * @param $stack Optional variable stack to look in
247 * @return $content Content of the variable or null if not found
249 protected function readVariable ($var, $stack = NULL) {
250 // Replace all dashes to underscores to match variables with configuration entries
251 $var = trim($this->convertDashesToUnderscores($var));
253 // First everything is not found
256 // If the stack is null, use the current group
257 if (is_null($stack)) {
259 //* DEBUG: */ $this->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
260 $stack = $this->currGroup;
263 // Get variable index
264 $found = $this->getVariableIndex($var, $stack);
266 // Is the variable found?
267 if ($found !== false) {
269 $content = $this->getVariableValue($stack, $found);
272 // Return the current position
273 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $stack . ',var=' . $var . ', content[' . gettype($content) . ']=' . $content);
278 * Add a variable to the stack
280 * @param $var The variable we are looking for
281 * @param $value The value we want to store in the variable
284 private function addVariable ($var, $value) {
285 // Set general variable group
286 $this->setVariableGroup('general');
288 // Add it to the stack
289 $this->addGroupVariable($var, $value);
293 * Returns all variables of current group or empty array
295 * @return $result Whether array of found variables or empty array
297 private function readCurrentGroup () {
298 // Default is not found
301 // Is the group there?
302 if ($this->isVarStackSet($this->currGroup)) {
304 $result = $this->getVarStack($this->currGroup);
312 * Settter for variable group
314 * @param $groupName Name of variable group
315 * @param $add Whether add this group
318 public function setVariableGroup ($groupName, $add = true) {
320 //* DEBIG: */ $this->debugOutput(__METHOD__.': currGroup=' . $groupName);
321 $this->currGroup = $groupName;
323 // Skip group 'general'
324 if (($groupName != 'general') && ($add === true)) {
325 $this->varGroups[$groupName] = 'OK';
331 * Adds a variable to current group
333 * @param $var Variable to set
334 * @param $value Value to store in variable
337 public function addGroupVariable ($var, $value) {
338 // Replace all dashes to underscores to match variables with configuration entries
339 $var = trim($this->convertDashesToUnderscores($var));
342 //* DEBUG: */ $this->debugOutput(__METHOD__.': group=' . $this->currGroup . ', var=' . $var . ', value=' . $value);
344 // Get current variables in group
345 $currVars = $this->readCurrentGroup();
347 // Append our variable
348 $currVars[] = $this->generateVariableArray($var, $value);
350 // Add it to the stack
351 $this->setVarStack($this->currGroup, $currVars);
355 * Getter for variable value, throws a NoVariableException if the variable is not found
357 * @param $varGroup Variable group to use
358 * @param $index Index in variable array
359 * @return $value Value to set
361 private function getVariableValue ($varGroup, $index) {
363 return $this->varStack[$varGroup][$index]['value'];
367 * Modify an entry on the stack
369 * @param $var The variable we are looking for
370 * @param $value The value we want to store in the variable
372 * @throws NoVariableException If the given variable is not found
374 private function modifyVariable ($var, $value) {
375 // Replace all dashes to underscores to match variables with configuration entries
376 $var = trim($this->convertDashesToUnderscores($var));
378 // Get index for variable
379 $index = $this->getVariableIndex($var);
381 // Is the variable set?
382 if ($index === false) {
383 // Unset variables cannot be modified
384 throw new NoVariableException(array($this, $var, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
388 $this->setVariableValue($this->currGroup, $index, $value);
392 * Sets a variable value for given variable group and index
394 * @param $varGroup Variable group to use
395 * @param $index Index in variable array
396 * @param $value Value to set
399 private function setVariableValue ($varGroup, $index, $value) {
400 $this->varStack[$varGroup][$index]['value'] = $value;
404 * Sets a variable within given group. This method does detect if the
405 * variable is already set. If so, the variable got modified, otherwise
408 * @param $varGroup Variable group to use
409 * @param $var Variable to set
410 * @param $value Value to set
413 protected function setVariable ($varGroup, $var, $value) {
414 // Replace all dashes to underscores to match variables with configuration entries
415 $var = trim($this->convertDashesToUnderscores($var));
417 // Get index for variable
418 $index = $this->getVariableIndex($var);
420 // Is the variable set?
421 if ($index === false) {
423 $this->varStack[$varGroup][] = $this->generateVariableArray($var, $value);
426 $this->setVariableValue($this->currGroup, $index, $value);
431 * "Generates" (better returns) an array for all variables for given
432 * variable/value pay.
434 * @param $var Variable to set
435 * @param $value Value to set
436 * @return $varData Variable data array
438 private function generateVariableArray ($var, $value) {
439 // Replace all dashes to underscores to match variables with configuration entries
440 $var = trim($this->convertDashesToUnderscores($var));
442 // Generate the temporary array
453 * Setter for template type. Only 'html', 'emails' and 'compiled' should
456 * @param $templateType The current template's type
459 protected final function setTemplateType ($templateType) {
460 $this->templateType = (string) $templateType;
464 * Setter for the last loaded template's FQFN
466 * @param $template The last loaded template
469 private final function setLastTemplate ($template) {
470 $this->lastTemplate = (string) $template;
474 * Getter for the last loaded template's FQFN
476 * @return $template The last loaded template
478 private final function getLastTemplate () {
479 return $this->lastTemplate;
483 * Setter for base path
485 * @param $templateBasePath The relative base path for all templates
488 public final function setTemplateBasePath ($templateBasePath) {
490 $this->templateBasePath = (string) $templateBasePath;
494 * Getter for base path
496 * @return $templateBasePath The relative base path for all templates
498 public final function getTemplateBasePath () {
500 return $this->templateBasePath;
504 * Getter for generic base path
506 * @return $templateBasePath The relative base path for all templates
508 public final function getGenericBasePath () {
510 return $this->genericBasePath;
514 * Setter for template extension
516 * @param $templateExtension The file extension for all uncompiled
520 public final function setRawTemplateExtension ($templateExtension) {
522 $this->templateExtension = (string) $templateExtension;
526 * Setter for code template extension
528 * @param $codeExtension The file extension for all uncompiled
532 public final function setCodeTemplateExtension ($codeExtension) {
534 $this->codeExtension = (string) $codeExtension;
538 * Getter for template extension
540 * @return $templateExtension The file extension for all uncompiled
543 public final function getRawTemplateExtension () {
545 return $this->templateExtension;
549 * Getter for code-template extension
551 * @return $codeExtension The file extension for all code-
554 public final function getCodeTemplateExtension () {
556 return $this->codeExtension;
560 * Setter for path of compiled templates
562 * @param $compileOutputPath The local base path for all compiled
566 public final function setCompileOutputPath ($compileOutputPath) {
568 $this->compileOutputPath = (string) $compileOutputPath;
572 * Getter for template type
574 * @return $templateType The current template's type
576 public final function getTemplateType () {
577 return $this->templateType;
581 * Assign (add) a given variable with a value
583 * @param $var The variable we are looking for
584 * @param $value The value we want to store in the variable
586 * @throws EmptyVariableException If the variable name is left empty
588 public final function assignVariable ($var, $value) {
589 // Replace all dashes to underscores to match variables with configuration entries
590 $var = trim($this->convertDashesToUnderscores($var));
592 // Empty variable found?
594 // Throw an exception
595 throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
598 // First search for the variable if it was already added
599 $index = $this->getVariableIndex($var);
602 if ($index === false) {
603 // Add it to the stack
604 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':ADD: ' . $var . '[' . gettype($value) . ']=' . $value);
605 $this->addVariable($var, $value);
606 } elseif (!empty($value)) {
607 // Modify the stack entry
608 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':MOD: ' . $var . '[' . gettype($value) . ']=' . $value);
609 $this->modifyVariable($var, $value);
614 * Removes a given variable
616 * @param $var The variable we are looking for
619 public final function removeVariable ($var) {
620 // First search for the variable if it was already added
621 $index = $this->getVariableIndex($var);
624 if ($index !== false) {
625 // Remove this variable
626 $this->unsetVariableStackOffset($index);
631 * Unsets the given offset in the variable stack
633 * @param $index Index to unset
636 protected final function unsetVariableStackOffset ($index) {
637 // Is the entry there?
638 if (!isset($this->varStack[$this->currGroup][$index])) {
639 // Abort here, we need fixing!
640 $this->debugInstance();
644 unset($this->varStack[$this->currGroup][$index]);
648 * Private setter for raw template data
650 * @param $rawTemplateData The raw data from the template
653 protected final function setRawTemplateData ($rawTemplateData) {
654 // And store it in this class
655 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
656 //* DEBUG: */ $this->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
657 $this->rawTemplateData = (string) $rawTemplateData;
661 * Getter for raw template data
663 * @return $rawTemplateData The raw data from the template
665 public final function getRawTemplateData () {
666 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
667 return $this->rawTemplateData;
671 * Private setter for compiled templates
675 private final function setCompiledData ($compiledData) {
676 // And store it in this class
677 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
678 $this->compiledData = (string) $compiledData;
682 * Getter for compiled templates
684 * @return $compiledData Compiled template data
686 public final function getCompiledData () {
687 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
688 return $this->compiledData;
692 * Private loader for all template types
694 * @param $template The template we shall load
695 * @param $extOther An other extension to use
697 * @throws FileIoException If the template was not found
699 protected function loadTemplate ($template, $extOther = '') {
700 // Get extension for the template if empty
701 if (empty($extOther)) {
702 // None provided, so get the raw one
703 $ext = $this->getRawTemplateExtension();
706 $ext = (string) $extOther;
709 // Is language support enabled?
710 if ($this->isLanguageSupportEnabled()) {
711 // Construct the FQFN for the template by honoring the current language
712 $fqfn = sprintf("%s%s%s%s/%s/%s%s",
713 $this->getConfigInstance()->getConfigEntry('base_path'),
714 $this->getTemplateBasePath(),
715 $this->getGenericBasePath(),
716 $this->getLanguageInstance()->getLanguageCode(),
717 $this->getTemplateType(),
722 // Construct the FQFN for the template without language
723 $fqfn = sprintf("%s%s%s%s/%s%s",
724 $this->getConfigInstance()->getConfigEntry('base_path'),
725 $this->getTemplateBasePath(),
726 $this->getGenericBasePath(),
727 $this->getTemplateType(),
735 // Load the raw template data
736 $this->loadRawTemplateData($fqfn);
737 } catch (FileIoException $e) {
738 // If we shall load a code-template we need to switch the file extension
739 if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
740 // Switch over to the code-template extension and try it again
741 $ext = $this->getCodeTemplateExtension();
744 $this->loadTemplate($template, $ext);
747 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
754 * A private loader for raw template names
756 * @param $fqfn The full-qualified file name for a template
759 private function loadRawTemplateData ($fqfn) {
760 // Get a input/output instance from the middleware
761 $ioInstance = $this->getFileIoInstance();
763 // Some debug code to look on the file which is being loaded
764 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
766 // Load the raw template
767 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
769 // Store the template's contents into this class
770 $this->setRawTemplateData($rawTemplateData);
772 // Remember the template's FQFN
773 $this->setLastTemplate($fqfn);
777 * Try to assign an extracted template variable as a "content" or 'config'
780 * @param $varName The variable's name (shall be content orconfig) by
782 * @param $var The variable we want to assign
784 private function assignTemplateVariable ($varName, $var) {
785 // Replace all dashes to underscores to match variables with configuration entries
786 $var = trim($this->convertDashesToUnderscores($var));
789 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': varName=' . $varName . ',var=' . $var);
791 // Is it not a config variable?
792 if ($varName != 'config') {
793 // Regular template variables
794 $this->assignVariable($var, '');
796 // Configuration variables
797 $this->assignConfigVariable($var);
802 * Extract variables from a given raw data stream
804 * @param $rawData The raw template data we shall analyze
807 private function extractVariablesFromRawData ($rawData) {
809 $rawData = (string) $rawData;
811 // Search for variables
812 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
815 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true));
817 // Did we find some variables?
818 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
819 // Initialize all missing variables
820 foreach ($variableMatches[3] as $key => $var) {
822 $varName = $variableMatches[1][$key];
824 // Workarround: Do not assign empty variables
826 // Try to assign it, empty strings are being ignored
827 $this->assignTemplateVariable($varName, $var);
834 * Main analysis of the loaded template
836 * @param $templateMatches Found template place-holders, see below
839 *---------------------------------
840 * Structure of $templateMatches:
841 *---------------------------------
842 * [0] => Array - An array with all full matches
843 * [1] => Array - An array with left part (before the ':') of a match
844 * [2] => Array - An array with right part of a match including ':'
845 * [3] => Array - An array with right part of a match excluding ':'
847 private function analyzeTemplate (array $templateMatches) {
848 // Backup raw template data
849 $backup = $this->getRawTemplateData();
851 // Initialize some arrays
852 if (is_null($this->loadedRawData)) {
854 $this->loadedRawData = array();
855 $this->rawTemplates = array();
858 // Load all requested templates
859 foreach ($templateMatches[1] as $template) {
860 // Load and compile only templates which we have not yet loaded
861 // RECURSIVE PROTECTION! BE CAREFUL HERE!
862 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
864 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template);
866 // Template not found, but maybe variable assigned?
867 if ($this->getVariableIndex($template, 'config') !== false) {
868 // Use that content here
869 $this->loadedRawData[$template] = $this->readVariable($template, 'config');
871 // Recursive protection:
872 $this->loadedTemplates[] = $template;
873 } elseif ($this->getVariableIndex($template) !== false) {
874 // Use that content here
875 $this->loadedRawData[$template] = $this->readVariable($template);
877 // Recursive protection:
878 $this->loadedTemplates[] = $template;
880 // Then try to search for code-templates
882 // Load the code template and remember it's contents
883 $this->loadCodeTemplate($template);
884 $this->loadedRawData[$template] = $this->getRawTemplateData();
886 // Remember this template for recursion detection
887 // RECURSIVE PROTECTION!
888 $this->loadedTemplates[] = $template;
889 } catch (FileIoException $e) {
890 // Even this is not done... :/
891 $this->rawTemplates[] = $template;
897 // Restore the raw template data
898 $this->setRawTemplateData($backup);
902 * Compile a given raw template code and remember it for later usage
904 * @param $code The raw template code
905 * @param $template The template's name
908 private function compileCode ($code, $template) {
909 // Is this template already compiled?
910 if (in_array($template, $this->compiledTemplates)) {
915 // Remember this template being compiled
916 $this->compiledTemplates[] = $template;
918 // Compile the loaded code in five steps:
920 // 1. Backup current template data
921 $backup = $this->getRawTemplateData();
923 // 2. Set the current template's raw data as the new content
924 $this->setRawTemplateData($code);
926 // 3. Compile the template data
927 $this->compileTemplate();
929 // 4. Remember it's contents
930 $this->loadedRawData[$template] = $this->getRawTemplateData();
932 // 5. Restore the previous raw content from backup variable
933 $this->setRawTemplateData($backup);
937 * Insert all given and loaded templates by running through all loaded
938 * codes and searching for their place-holder in the main template
940 * @param $templateMatches See method analyzeTemplate()
943 private function insertAllTemplates (array $templateMatches) {
944 // Run through all loaded codes
945 foreach ($this->loadedRawData as $template => $code) {
947 // Search for the template
948 $foundIndex = array_search($template, $templateMatches[1]);
950 // Lookup the matching template replacement
951 if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
953 // Get the current raw template
954 $rawData = $this->getRawTemplateData();
956 // Replace the space holder with the template code
957 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
959 // Set the new raw data
960 $this->setRawTemplateData($rawData);
966 * Load all extra raw templates
970 private function loadExtraRawTemplates () {
971 // Are there some raw templates we need to load?
972 if (count($this->rawTemplates) > 0) {
973 // Try to load all raw templates
974 foreach ($this->rawTemplates as $key => $template) {
977 $this->loadWebTemplate($template);
979 // Remember it's contents
980 $this->rawTemplates[$template] = $this->getRawTemplateData();
982 // Remove it from the loader list
983 unset($this->rawTemplates[$key]);
985 // Remember this template for recursion detection
986 // RECURSIVE PROTECTION!
987 $this->loadedTemplates[] = $template;
988 } catch (FileIoException $e) {
989 // This template was never found. We silently ignore it
990 unset($this->rawTemplates[$key]);
997 * Assign all found template variables
999 * @param $varMatches An array full of variable/value pairs.
1001 * @todo Unfinished work or don't die here.
1003 private function assignAllVariables (array $varMatches) {
1005 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1007 // Search for all variables
1008 foreach ($varMatches[1] as $key => $var) {
1009 // Replace all dashes to underscores to match variables with configuration entries
1010 $var = trim($this->convertDashesToUnderscores($var));
1013 $this->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1015 // Detect leading equals
1016 if (substr($varMatches[2][$key], 0, 1) == '=') {
1017 // Remove and cast it
1018 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1021 // Do we have some quotes left and right side? Then it is free text
1022 if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
1023 // Free string detected! Which we can assign directly
1024 $this->assignVariable($var, $varMatches[3][$key]);
1025 } elseif (!empty($varMatches[2][$key])) {
1026 // @TODO Non-string found so we need some deeper analysis...
1027 ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
1033 * Compiles all loaded raw templates
1035 * @param $templateMatches See method analyzeTemplate() for details
1038 private function compileRawTemplateData (array $templateMatches) {
1040 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1042 // Are some code-templates found which we need to compile?
1043 if (count($this->loadedRawData) > 0) {
1044 // Then compile all!
1045 foreach ($this->loadedRawData as $template => $code) {
1047 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1049 // Is this template already compiled?
1050 if (in_array($template, $this->compiledTemplates)) {
1052 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1056 // Search for the template
1057 $foundIndex = array_search($template, $templateMatches[1]);
1059 // Lookup the matching variable data
1060 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
1061 // Split it up with another reg. exp. into variable=value pairs
1062 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1063 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, true));
1065 // Assign all variables
1066 $this->assignAllVariables($varMatches);
1067 } // END - if (isset($templateMatches ...
1069 // Compile the loaded template
1070 $this->compileCode($code, $template);
1071 } // END - foreach ($this->loadedRawData ...
1073 // Insert all templates
1074 $this->insertAllTemplates($templateMatches);
1075 } // END - if (count($this->loadedRawData) ...
1079 * Inserts all raw templates into their respective variables
1083 private function insertRawTemplates () {
1084 // Load all templates
1085 foreach ($this->rawTemplates as $template => $content) {
1086 // Set the template as a variable with the content
1087 $this->assignVariable($template, $content);
1092 * Finalizes the compilation of all template variables
1096 private function finalizeVariableCompilation () {
1098 $content = $this->getRawTemplateData();
1099 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1101 // Do we have the stack?
1102 if (!$this->isVarStackSet('general')) {
1103 // Abort here silently
1104 // @TODO This silent abort should be logged, maybe.
1108 // Walk through all variables
1109 foreach ($this->getVarStack('general') as $currEntry) {
1110 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1111 // Replace all [$var] or {?$var?} with the content
1112 // @TODO Old behaviour, will become obsolete!
1113 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1115 // @TODO Yet another old way
1116 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1118 // The new behaviour
1119 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1122 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1124 // Set the content back
1125 $this->setRawTemplateData($content);
1129 * Load a specified web template into the engine
1131 * @param $template The web template we shall load which is located in
1135 public function loadWebTemplate ($template) {
1136 // Set template type
1137 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1139 // Load the special template
1140 $this->loadTemplate($template);
1144 * Assign a given congfiguration variable with a value
1146 * @param $var The configuration variable we want to assign
1149 public function assignConfigVariable ($var) {
1150 // Replace all dashes to underscores to match variables with configuration entries
1151 $var = trim($this->convertDashesToUnderscores($var));
1153 // Sweet and simple...
1154 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': var=' . $var . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($var));
1155 $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
1159 * Load a specified code template into the engine
1161 * @param $template The code template we shall load which is
1162 * located in 'code' by default
1165 public function loadCodeTemplate ($template) {
1166 // Set template type
1167 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1169 // Load the special template
1170 $this->loadTemplate($template);
1174 * Compiles configuration place-holders in all variables. This 'walks'
1175 * through the variable stack 'general'. It interprets all values from that
1176 * variables as configuration entries after compiling them.
1180 public final function compileConfigInVariables () {
1181 // Do we have the stack?
1182 if (!$this->isVarStackSet('general')) {
1183 // Abort here silently
1184 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1188 // Iterate through all general variables
1189 foreach ($this->getVarStack('general') as $index => $currVariable) {
1190 // Compile the value
1191 $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
1194 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1196 // Remove it from stack
1197 $this->removeVariable($index, 'general');
1199 // Re-assign the variable
1200 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1201 $this->assignConfigVariable($value);
1206 * Compile all variables by inserting their respective values
1209 * @todo Make this code some nicer...
1211 public final function compileVariables () {
1212 // Initialize the $content array
1213 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1216 // Iterate through all general variables
1217 foreach ($this->getVarStack('general') as $currVariable) {
1218 // Transfer it's name/value combination to the $content array
1219 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1220 $dummy[$currVariable['name']] = $currVariable['value'];
1223 // Set the new variable (don't remove the second dollar!)
1224 $$validVar = $dummy;
1226 // Remove some variables
1228 unset($currVariable);
1230 // Run the compilation three times to get content from helper classes in
1233 // Finalize the compilation of template variables
1234 $this->finalizeVariableCompilation();
1236 // Prepare the eval() command for comiling the template
1237 $eval = sprintf("\$result = \"%s\";",
1238 addslashes($this->getRawTemplateData())
1241 // This loop does remove the backslashes (\) in PHP parameters
1242 while (strpos($eval, $this->codeBegin) !== false) {
1243 // Get left part before "<?"
1244 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1246 // Get all from right of "<?"
1247 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1249 // Cut middle part out and remove escapes
1250 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1251 $evalMiddle = stripslashes($evalMiddle);
1253 // Remove the middle part from right one
1254 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1256 // And put all together
1257 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1260 // Prepare PHP code for eval() command
1261 $eval = str_replace(
1270 // Run the constructed command. This will "compile" all variables in
1273 // Goes something wrong?
1274 if ((!isset($result)) || (empty($result))) {
1275 // Output eval command
1276 $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
1278 // Output backtrace here
1279 $this->debugBackTrace();
1282 // Set raw template data
1283 $this->setRawTemplateData($result);
1287 // Final variable assignment
1288 $this->finalizeVariableCompilation();
1290 // Set the new content
1291 $this->setCompiledData($this->getRawTemplateData());
1295 * Compile all required templates into the current loaded one
1298 * @throws UnexpectedTemplateTypeException If the template type is
1300 * @throws InvalidArrayCountException If an unexpected array
1301 * count has been found
1303 public function compileTemplate () {
1304 // Get code type to make things shorter
1305 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1307 // We will only work with template type "code" from configuration
1308 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1310 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1313 // Get the raw data.
1314 $rawData = $this->getRawTemplateData();
1316 // Remove double spaces and trim leading/trailing spaces
1317 $rawData = trim(str_replace(' ', ' ', $rawData));
1319 // Search for raw variables
1320 $this->extractVariablesFromRawData($rawData);
1322 // Search for code-tags which are {? ?}
1323 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1326 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , true));
1328 // Analyze the matches array
1329 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1330 // Entries are found:
1332 // The main analysis
1333 $this->analyzeTemplate($templateMatches);
1335 // Compile raw template data
1336 $this->compileRawTemplateData($templateMatches);
1338 // Are there some raw templates left for loading?
1339 $this->loadExtraRawTemplates();
1341 // Are some raw templates found and loaded?
1342 if (count($this->rawTemplates) > 0) {
1343 // Insert all raw templates
1344 $this->insertRawTemplates();
1346 // Remove the raw template content as well
1347 $this->setRawTemplateData('');
1349 } // END - if($templateMatches ...
1353 * Loads a given view helper (by name)
1355 * @param $helperName The helper's name
1358 protected function loadViewHelper ($helperName) {
1359 // Make first character upper case, rest low
1360 $helperName = $this->convertToClassName($helperName);
1362 // Is this view helper loaded?
1363 if (!isset($this->helpers[$helperName])) {
1364 // Create a class name
1365 $className = $helperName . 'ViewHelper';
1367 // Generate new instance
1368 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1371 // Return the requested instance
1372 return $this->helpers[$helperName];
1376 * Assigns the last loaded raw template content with a given variable
1378 * @param $templateName Name of the template we want to assign
1379 * @param $variableName Name of the variable we want to assign
1382 public function assignTemplateWithVariable ($templateName, $variableName) {
1383 // Get the content from last loaded raw template
1384 $content = $this->getRawTemplateData();
1386 // Assign the variable
1387 $this->assignVariable($variableName, $content);
1389 // Purge raw content
1390 $this->setRawTemplateData('');
1394 * Transfers the content of this template engine to a given response instance
1396 * @param $responseInstance An instance of a response class
1399 public function transferToResponse (Responseable $responseInstance) {
1400 // Get the content and set it in response class
1401 $responseInstance->writeToBody($this->getCompiledData());
1405 * Assigns all the application data with template variables
1407 * @param $applicationInstance A manageable application instance
1410 public function assignApplicationData (ManageableApplication $applicationInstance) {
1411 // Get long name and assign it
1412 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1414 // Get short name and assign it
1415 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1417 // Get version number and assign it
1418 $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
1420 // Assign extra application-depending data
1421 $applicationInstance->assignExtraTemplateData($this);
1425 * "Compiles" a variable by replacing {?var?} with it's content
1427 * @param $rawCode Raw code to compile
1428 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1429 * @return $rawCode Compile code with inserted variable value
1431 public function compileRawCode ($rawCode, $setMatchAsCode=false) {
1432 // Find the variables
1433 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1434 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1436 // Compile all variables
1437 //* NOISY-DEBUG: */ $this->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, true) . '</pre>');
1438 foreach ($varMatches[0] as $match) {
1439 // Add variable tags around it
1440 $varCode = '{?' . $match . '?}';
1443 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1445 // Is the variable found in code? (safes some calls)
1446 if (strpos($rawCode, $varCode) !== false) {
1448 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1450 // Use $match as new value or $value from read variable?
1451 if ($setMatchAsCode === true) {
1453 $rawCode = str_replace($varCode, $match, $rawCode);
1455 // Read the variable
1456 $value = $this->readVariable($match);
1459 $rawCode = str_replace($varCode, $value, $rawCode);
1464 // Return the compiled data
1465 //* DEBUG: */ $this->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1470 * Getter for variable group array
1472 * @return $vargroups All variable groups
1474 public final function getVariableGroups () {
1475 return $this->varGroups;
1479 * Renames a variable in code and in stack
1481 * @param $oldName Old name of variable
1482 * @param $newName New name of variable
1485 public function renameVariable ($oldName, $newName) {
1486 //* DEBUG: */ $this->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1487 // Get raw template code
1488 $rawData = $this->getRawTemplateData();
1491 $rawData = str_replace($oldName, $newName, $rawData);
1493 // Set the code back
1494 $this->setRawTemplateData($rawData);
1498 * Renders the given XML content
1500 * @param $content Valid XML content or if not set the current loaded raw content
1502 * @throws XmlParserException If an XML error was found
1504 public function renderXmlContent ($content = NULL) {
1505 // Is the content set?
1506 if (is_null($content)) {
1507 // Get current content
1508 $content = $this->getRawTemplateData();
1511 // Get a XmlParser instance
1512 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1514 // Check if we have XML compacting enabled
1515 if ($this->isXmlCompactingEnabled()) {
1516 // Yes, so get a decorator class for transparent compacting
1517 $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1520 // Parse the XML document
1521 $parserInstance->parseXmlContent($content);
1525 * Enables or disables language support
1527 * @param $languageSupport New language support setting
1530 public final function enableLanguageSupport ($languageSupport = true) {
1531 $this->languageSupport = (bool) $languageSupport;
1535 * Checks whether language support is enabled
1537 * @return $languageSupport Whether language support is enabled or disabled
1539 public final function isLanguageSupportEnabled () {
1540 return $this->languageSupport;
1544 * Enables or disables XML compacting
1546 * @param $xmlCompacting New XML compacting setting
1549 public final function enableXmlCompacting ($xmlCompacting = true) {
1550 $this->xmlCompacting = (bool) $xmlCompacting;
1554 * Checks whether XML compacting is enabled
1556 * @return $xmlCompacting Whether XML compacting is enabled or disabled
1558 public final function isXmlCompactingEnabled () {
1559 return $this->xmlCompacting;
1563 * Removes all commentd, tabs and new-line characters to compact the content
1565 * @param $uncompactedContent The uncompacted content
1566 * @return $compactedContent The compacted content
1568 public function compactContent ($uncompactedContent) {
1569 // First, remove all tab/new-line/revert characters
1570 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1572 // Then regex all comments like <!-- //--> away
1573 preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
1575 // Do we have entries?
1576 if (isset($matches[0][0])) {
1578 foreach ($matches[0] as $match) {
1580 $compactedContent = str_replace($match, '', $compactedContent);
1584 // Set the content again
1585 $this->setRawTemplateData($compactedContent);
1587 // Return compacted content
1588 return $compactedContent;