3 * A generic template engine
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseTemplateEngine extends BaseFrameworkSystem {
26 * The local path name where all templates and sub folders for special
27 * templates are stored. We will internally determine the language plus
28 * "html" for web templates or "emails" for email templates
30 private $templateBasePath = '';
35 private $templateType = 'html';
38 * The extension for web and email templates (not compiled templates)
40 private $templateExtension = '.tpl';
43 * The extension for code templates (not compiled templates)
45 private $codeExtension = '.ctp';
48 * Path relative to $templateBasePath and language code for compiled code-templates
50 private $compileOutputPath = 'templates/_compiled/';
53 * The path name for all templates
55 private $genericBasePath = 'templates/';
58 * The raw (maybe uncompiled) template
60 private $rawTemplateData = '';
63 * Template data with compiled-in variables
65 private $compiledData = '';
68 * The last loaded template's FQFN for debugging the engine
70 private $lastTemplate = '';
73 * The variable stack for the templates
75 private $varStack = array();
78 * Loaded templates for recursive protection and detection
80 private $loadedTemplates = array();
83 * Compiled templates for recursive protection and detection
85 private $compiledTemplates = array();
88 * Loaded raw template data
90 private $loadedRawData = NULL;
93 * Raw templates which are linked in code templates
95 private $rawTemplates = NULL;
98 * A regular expression for variable=value pairs
100 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
103 * A regular expression for filtering out code tags
105 * E.g.: {?template:variable=value;var2=value2;[...]?}
107 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
110 * A regular expression to find template comments like <!-- Comment here //-->
112 private $regExpComments = '/<!--[\w\W]*?(\/\/){0,1}-->/';
117 private $helpers = array();
120 * Current variable group
122 private $currGroup = 'general';
125 * All template groups except "general"
127 private $varGroups = array();
132 private $codeBegin = '<?php';
137 private $codeEnd = '?>';
140 * Language support is enabled by default
142 private $languageSupport = TRUE;
145 * XML compacting is disabled by default
147 private $xmlCompacting = FALSE;
149 // Exception codes for the template engine
150 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
151 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
152 const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
153 const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
156 * Protected constructor
158 * @param $className Name of the class
161 protected function __construct ($className) {
162 // Call parent constructor
163 parent::__construct($className);
165 // Init file I/O instance
166 $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
169 $this->setFileIoInstance($ioInstance);
173 * Search for a variable in the stack
175 * @param $variableName The variable we are looking for
176 * @param $variableGroup Optional variable group to look in
177 * @return $index FALSE means not found, >=0 means found on a specific index
179 private function getVariableIndex ($variableName, $variableGroup = NULL) {
180 // Replace all dashes to underscores to match variables with configuration entries
181 $variableName = trim($this->convertDashesToUnderscores($variableName));
183 // First everything is not found
186 // If the stack is NULL, use the current group
187 if (is_null($variableGroup)) {
189 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
190 $variableGroup = $this->currGroup;
193 // Is the group there?
194 if ($this->isVarStackSet($variableGroup)) {
196 foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
197 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
198 // Is the entry found?
199 if ($currEntry['name'] == $variableName) {
201 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
208 // Return the current position
213 * Checks whether the given variable group is set
215 * @param $variableGroup Variable group to check
216 * @return $isSet Whether the given variable group is set
218 protected final function isVarStackSet ($variableGroup) {
220 $isSet = isset($this->varStack[$variableGroup]);
227 * Getter for given variable group
229 * @param $variableGroup Variable group to check
230 * @return $varStack Found variable group
232 public final function getVarStack ($variableGroup) {
233 return $this->varStack[$variableGroup];
237 * Setter for given variable group
239 * @param $variableGroup Variable group to check
240 * @param $varStack Variable stack to check
243 protected final function setVarStack ($variableGroup, array $varStack) {
244 $this->varStack[$variableGroup] = $varStack;
248 * Return a content of a variable or null if not found
250 * @param $variableName The variable we are looking for
251 * @param $variableGroup Optional variable group to look in
252 * @return $content Content of the variable or null if not found
254 protected function readVariable ($variableName, $variableGroup = NULL) {
255 // Replace all dashes to underscores to match variables with configuration entries
256 $variableName = trim($this->convertDashesToUnderscores($variableName));
258 // First everything is not found
261 // If the stack is NULL, use the current group
262 if (is_null($variableGroup)) {
264 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
265 $variableGroup = $this->currGroup;
268 // Get variable index
269 $found = $this->getVariableIndex($variableName, $variableGroup);
271 // Is the variable found?
272 if ($found !== FALSE) {
274 $content = $this->getVariableValue($variableGroup, $found);
277 // Return the current position
278 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
283 * Add a variable to the stack
285 * @param $variableName Name of variable to add
286 * @param $value Value we want to store in the variable
289 private function addVariable ($variableName, $value) {
290 // Set general variable group
291 $this->setVariableGroup('general');
293 // Add it to the stack
294 $this->addGroupVariable($variableName, $value);
298 * Returns all variables of current group or empty array
300 * @return $result Whether array of found variables or empty array
302 private function readCurrentGroup () {
303 // Default is not found
306 // Is the group there?
307 if ($this->isVarStackSet($this->currGroup)) {
309 $result = $this->getVarStack($this->currGroup);
317 * Settter for variable group
319 * @param $groupName Name of variable group
320 * @param $add Whether add this group
323 public function setVariableGroup ($groupName, $add = TRUE) {
325 //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
326 $this->currGroup = $groupName;
328 // Skip group 'general'
329 if (($groupName != 'general') && ($add === TRUE)) {
330 $this->varGroups[$groupName] = 'OK';
336 * Adds a variable to current group
338 * @param $variableName Variable to set
339 * @param $value Value to store in variable
342 public function addGroupVariable ($variableName, $value) {
343 // Replace all dashes to underscores to match variables with configuration entries
344 $variableName = trim($this->convertDashesToUnderscores($variableName));
347 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
349 // Get current variables in group
350 $currVars = $this->readCurrentGroup();
352 // Append our variable
353 array_push($currVars, $this->generateVariableArray($variableName, $value));
355 // Add it to the stack
356 $this->setVarStack($this->currGroup, $currVars);
360 * Getter for variable value, throws a NoVariableException if the variable is not found
362 * @param $varGroup Variable group to use
363 * @param $index Index in variable array
364 * @return $value Value to set
366 private function getVariableValue ($varGroup, $index) {
368 return $this->varStack[$varGroup][$index]['value'];
372 * Modify an entry on the stack
374 * @param $variableName The variable we are looking for
375 * @param $value The value we want to store in the variable
377 * @throws NoVariableException If the given variable is not found
379 private function modifyVariable ($variableName, $value) {
380 // Replace all dashes to underscores to match variables with configuration entries
381 $variableName = trim($this->convertDashesToUnderscores($variableName));
383 // Get index for variable
384 $index = $this->getVariableIndex($variableName);
386 // Is the variable set?
387 if ($index === FALSE) {
388 // Unset variables cannot be modified
389 throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
393 $this->setVariableValue($this->currGroup, $index, $value);
397 * Sets a variable value for given variable group and index
399 * @param $varGroup Variable group to use
400 * @param $index Index in variable array
401 * @param $value Value to set
404 private function setVariableValue ($varGroup, $index, $value) {
405 $this->varStack[$varGroup][$index]['value'] = $value;
409 * Sets a variable within given group. This method does detect if the
410 * variable is already set. If so, the variable got modified, otherwise
413 * @param $varGroup Variable group to use
414 * @param $variableName Variable to set
415 * @param $value Value to set
418 protected function setVariable ($varGroup, $variableName, $value) {
419 // Replace all dashes to underscores to match variables with configuration entries
420 $variableName = trim($this->convertDashesToUnderscores($variableName));
422 // Get index for variable
423 $index = $this->getVariableIndex($variableName);
425 // Is the variable set?
426 if ($index === FALSE) {
427 // Is the stack there?
428 if (!isset($this->varStack[$varGroup])) {
429 // Then initialize it here
430 $this->varStack[$varGroup] = array();
434 array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value));
437 $this->setVariableValue($this->currGroup, $index, $value);
442 * "Generates" (better returns) an array for all variables for given
443 * variable/value pay.
445 * @param $variableName Variable to set
446 * @param $value Value to set
447 * @return $varData Variable data array
449 private function generateVariableArray ($variableName, $value) {
450 // Replace all dashes to underscores to match variables with configuration entries
451 $variableName = trim($this->convertDashesToUnderscores($variableName));
453 // Generate the temporary array
455 'name' => $variableName,
464 * Setter for template type. Only 'html', 'emails' and 'compiled' should
467 * @param $templateType The current template's type
470 protected final function setTemplateType ($templateType) {
471 $this->templateType = (string) $templateType;
475 * Setter for the last loaded template's FQFN
477 * @param $template The last loaded template
480 private final function setLastTemplate ($template) {
481 $this->lastTemplate = (string) $template;
485 * Getter for the last loaded template's FQFN
487 * @return $template The last loaded template
489 private final function getLastTemplate () {
490 return $this->lastTemplate;
494 * Setter for base path
496 * @param $templateBasePath The relative base path for all templates
499 public final function setTemplateBasePath ($templateBasePath) {
501 $this->templateBasePath = (string) $templateBasePath;
505 * Getter for base path
507 * @return $templateBasePath The relative base path for all templates
509 public final function getTemplateBasePath () {
511 return $this->templateBasePath;
515 * Getter for generic base path
517 * @return $templateBasePath The relative base path for all templates
519 public final function getGenericBasePath () {
521 return $this->genericBasePath;
525 * Setter for template extension
527 * @param $templateExtension The file extension for all uncompiled
531 public final function setRawTemplateExtension ($templateExtension) {
533 $this->templateExtension = (string) $templateExtension;
537 * Setter for code template extension
539 * @param $codeExtension The file extension for all uncompiled
543 public final function setCodeTemplateExtension ($codeExtension) {
545 $this->codeExtension = (string) $codeExtension;
549 * Getter for template extension
551 * @return $templateExtension The file extension for all uncompiled
554 public final function getRawTemplateExtension () {
556 return $this->templateExtension;
560 * Getter for code-template extension
562 * @return $codeExtension The file extension for all code-
565 public final function getCodeTemplateExtension () {
567 return $this->codeExtension;
571 * Setter for path of compiled templates
573 * @param $compileOutputPath The local base path for all compiled
577 public final function setCompileOutputPath ($compileOutputPath) {
579 $this->compileOutputPath = (string) $compileOutputPath;
583 * Getter for template type
585 * @return $templateType The current template's type
587 public final function getTemplateType () {
588 return $this->templateType;
592 * Assign (add) a given variable with a value
594 * @param $variableName The variable we are looking for
595 * @param $value The value we want to store in the variable
597 * @throws EmptyVariableException If the variable name is left empty
599 public final function assignVariable ($variableName, $value) {
600 // Replace all dashes to underscores to match variables with configuration entries
601 $variableName = trim($this->convertDashesToUnderscores($variableName));
603 // Empty variable found?
604 if (empty($variableName)) {
605 // Throw an exception
606 throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
609 // First search for the variable if it was already added
610 $index = $this->getVariableIndex($variableName);
613 if ($index === FALSE) {
614 // Add it to the stack
615 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
616 $this->addVariable($variableName, $value);
617 } elseif (!empty($value)) {
618 // Modify the stack entry
619 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
620 $this->modifyVariable($variableName, $value);
625 * Removes a given variable
627 * @param $variableName The variable we are looking for
628 * @param $variableGroup Name of variable group (default: 'general')
631 public final function removeVariable ($variableName, $variableGroup = 'general') {
632 // First search for the variable if it was already added
633 $index = $this->getVariableIndex($variableName, $variableGroup);
636 if ($index !== FALSE) {
637 // Remove this variable
638 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
639 $this->unsetVariableStackOffset($index, $variableGroup);
644 * Unsets the given offset in the variable group
646 * @param $index Index to unset
647 * @param $variableGroup Variable group (default: currGroup)
650 protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
651 // Is the variable group not set?
652 if (is_null($variableGroup)) {
653 // Then set it to current
654 $variableGroup = $this->currGroup;
657 // Is the entry there?
658 if (!isset($this->varStack[$variableGroup][$index])) {
659 // Abort here, we need fixing!
660 $this->debugInstance();
664 unset($this->varStack[$variableGroup][$index]);
668 * Private setter for raw template data
670 * @param $rawTemplateData The raw data from the template
673 protected final function setRawTemplateData ($rawTemplateData) {
674 // And store it in this class
675 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
676 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
677 $this->rawTemplateData = (string) $rawTemplateData;
681 * Getter for raw template data
683 * @return $rawTemplateData The raw data from the template
685 public final function getRawTemplateData () {
686 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
687 return $this->rawTemplateData;
691 * Private setter for compiled templates
695 private final function setCompiledData ($compiledData) {
696 // And store it in this class
697 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
698 $this->compiledData = (string) $compiledData;
702 * Getter for compiled templates
704 * @return $compiledData Compiled template data
706 public final function getCompiledData () {
707 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
708 return $this->compiledData;
712 * Private loader for all template types
714 * @param $template The template we shall load
715 * @param $extOther An other extension to use
717 * @throws FileIoException If the template was not found
719 protected function loadTemplate ($template, $extOther = '') {
720 // Get extension for the template if empty
721 if (empty($extOther)) {
722 // None provided, so get the raw one
723 $ext = $this->getRawTemplateExtension();
726 $ext = (string) $extOther;
729 // Is language support enabled?
730 if ($this->isLanguageSupportEnabled()) {
731 // Construct the FQFN for the template by honoring the current language
732 $fqfn = sprintf('%s%s%s%s/%s/%s%s',
733 $this->getConfigInstance()->getConfigEntry('base_path'),
734 $this->getTemplateBasePath(),
735 $this->getGenericBasePath(),
736 $this->getLanguageInstance()->getLanguageCode(),
737 $this->getTemplateType(),
742 // Construct the FQFN for the template without language
743 $fqfn = sprintf('%s%s%s%s/%s%s',
744 $this->getConfigInstance()->getConfigEntry('base_path'),
745 $this->getTemplateBasePath(),
746 $this->getGenericBasePath(),
747 $this->getTemplateType(),
755 // Load the raw template data
756 $this->loadRawTemplateData($fqfn);
757 } catch (FileIoException $e) {
758 // If we shall load a code-template we need to switch the file extension
759 if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
760 // Switch over to the code-template extension and try it again
761 $ext = $this->getCodeTemplateExtension();
764 $this->loadTemplate($template, $ext);
767 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
774 * A private loader for raw template names
776 * @param $fqfn The full-qualified file name for a template
779 private function loadRawTemplateData ($fqfn) {
780 // Get a input/output instance from the middleware
781 $ioInstance = $this->getFileIoInstance();
783 // Some debug code to look on the file which is being loaded
784 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
786 // Load the raw template
787 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
789 // Store the template's contents into this class
790 $this->setRawTemplateData($rawTemplateData);
792 // Remember the template's FQFN
793 $this->setLastTemplate($fqfn);
797 * Try to assign an extracted template variable as a "content" or 'config'
800 * @param $varName The variable's name (shall be content or config)
802 * @param $variableName The variable we want to assign
805 private function assignTemplateVariable ($varName, $var) {
806 // Replace all dashes to underscores to match variables with configuration entries
807 $variableName = trim($this->convertDashesToUnderscores($variableName));
810 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
812 // Is it not a config variable?
813 if ($varName != 'config') {
814 // Regular template variables
815 $this->assignVariable($variableName, '');
817 // Configuration variables
818 $this->assignConfigVariable($variableName);
823 * Extract variables from a given raw data stream
825 * @param $rawData The raw template data we shall analyze
828 private function extractVariablesFromRawData ($rawData) {
830 $rawData = (string) $rawData;
832 // Search for variables
833 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
836 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE));
838 // Did we find some variables?
839 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
840 // Initialize all missing variables
841 foreach ($variableMatches[3] as $key => $var) {
843 $varName = $variableMatches[1][$key];
845 // Workarround: Do not assign empty variables
847 // Try to assign it, empty strings are being ignored
848 $this->assignTemplateVariable($varName, $var);
855 * Main analysis of the loaded template
857 * @param $templateMatches Found template place-holders, see below
860 *---------------------------------
861 * Structure of $templateMatches:
862 *---------------------------------
863 * [0] => Array - An array with all full matches
864 * [1] => Array - An array with left part (before the ':') of a match
865 * [2] => Array - An array with right part of a match including ':'
866 * [3] => Array - An array with right part of a match excluding ':'
868 private function analyzeTemplate (array $templateMatches) {
869 // Backup raw template data
870 $backup = $this->getRawTemplateData();
872 // Initialize some arrays
873 if (is_null($this->loadedRawData)) {
875 $this->loadedRawData = array();
876 $this->rawTemplates = array();
879 // Load all requested templates
880 foreach ($templateMatches[1] as $template) {
881 // Load and compile only templates which we have not yet loaded
882 // RECURSIVE PROTECTION! BE CAREFUL HERE!
883 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
885 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
887 // Template not found, but maybe variable assigned?
888 if ($this->getVariableIndex($template, 'config') !== FALSE) {
889 // Use that content here
890 $this->loadedRawData[$template] = $this->readVariable($template, 'config');
892 // Recursive protection:
893 array_push($this->loadedTemplates, $template);
894 } elseif ($this->getVariableIndex($template) !== FALSE) {
895 // Use that content here
896 $this->loadedRawData[$template] = $this->readVariable($template);
898 // Recursive protection:
899 array_push($this->loadedTemplates, $template);
901 // Then try to search for code-templates
903 // Load the code template and remember it's contents
904 $this->loadCodeTemplate($template);
905 $this->loadedRawData[$template] = $this->getRawTemplateData();
907 // Remember this template for recursion detection
908 // RECURSIVE PROTECTION!
909 array_push($this->loadedTemplates, $template);
910 } catch (FileIoException $e) {
911 // Even this is not done... :/
912 array_push($this->rawTemplates, $template);
918 // Restore the raw template data
919 $this->setRawTemplateData($backup);
923 * Compile a given raw template code and remember it for later usage
925 * @param $code The raw template code
926 * @param $template The template's name
929 private function compileCode ($code, $template) {
930 // Is this template already compiled?
931 if (in_array($template, $this->compiledTemplates)) {
936 // Remember this template being compiled
937 array_push($this->compiledTemplates, $template);
939 // Compile the loaded code in five steps:
941 // 1. Backup current template data
942 $backup = $this->getRawTemplateData();
944 // 2. Set the current template's raw data as the new content
945 $this->setRawTemplateData($code);
947 // 3. Compile the template data
948 $this->compileTemplate();
950 // 4. Remember it's contents
951 $this->loadedRawData[$template] = $this->getRawTemplateData();
953 // 5. Restore the previous raw content from backup variable
954 $this->setRawTemplateData($backup);
958 * Insert all given and loaded templates by running through all loaded
959 * codes and searching for their place-holder in the main template
961 * @param $templateMatches See method analyzeTemplate()
964 private function insertAllTemplates (array $templateMatches) {
965 // Run through all loaded codes
966 foreach ($this->loadedRawData as $template => $code) {
968 // Search for the template
969 $foundIndex = array_search($template, $templateMatches[1]);
971 // Lookup the matching template replacement
972 if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
974 // Get the current raw template
975 $rawData = $this->getRawTemplateData();
977 // Replace the space holder with the template code
978 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
980 // Set the new raw data
981 $this->setRawTemplateData($rawData);
987 * Load all extra raw templates
991 private function loadExtraRawTemplates () {
992 // Are there some raw templates we need to load?
993 if (count($this->rawTemplates) > 0) {
994 // Try to load all raw templates
995 foreach ($this->rawTemplates as $key => $template) {
998 $this->loadWebTemplate($template);
1000 // Remember it's contents
1001 $this->rawTemplates[$template] = $this->getRawTemplateData();
1003 // Remove it from the loader list
1004 unset($this->rawTemplates[$key]);
1006 // Remember this template for recursion detection
1007 // RECURSIVE PROTECTION!
1008 array_push($this->loadedTemplates, $template);
1009 } catch (FileIoException $e) {
1010 // This template was never found. We silently ignore it
1011 unset($this->rawTemplates[$key]);
1018 * Assign all found template variables
1020 * @param $varMatches An array full of variable/value pairs.
1022 * @todo Unfinished work or don't die here.
1024 private function assignAllVariables (array $varMatches) {
1026 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1028 // Search for all variables
1029 foreach ($varMatches[1] as $key => $var) {
1030 // Replace all dashes to underscores to match variables with configuration entries
1031 $var = trim($this->convertDashesToUnderscores($var));
1034 self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1036 // Detect leading equals
1037 if (substr($varMatches[2][$key], 0, 1) == '=') {
1038 // Remove and cast it
1039 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1042 // Do we have some quotes left and right side? Then it is free text
1043 if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
1044 // Free string detected! Which we can assign directly
1045 $this->assignVariable($var, $varMatches[3][$key]);
1046 } elseif (!empty($varMatches[2][$key])) {
1047 // @TODO Non-string found so we need some deeper analysis...
1048 ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
1054 * Compiles all loaded raw templates
1056 * @param $templateMatches See method analyzeTemplate() for details
1059 private function compileRawTemplateData (array $templateMatches) {
1061 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1063 // Are some code-templates found which we need to compile?
1064 if (count($this->loadedRawData) > 0) {
1065 // Then compile all!
1066 foreach ($this->loadedRawData as $template => $code) {
1068 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1070 // Is this template already compiled?
1071 if (in_array($template, $this->compiledTemplates)) {
1073 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1077 // Search for the template
1078 $foundIndex = array_search($template, $templateMatches[1]);
1080 // Lookup the matching variable data
1081 if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
1082 // Split it up with another reg. exp. into variable=value pairs
1083 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1084 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE));
1086 // Assign all variables
1087 $this->assignAllVariables($varMatches);
1088 } // END - if (isset($templateMatches ...
1090 // Compile the loaded template
1091 $this->compileCode($code, $template);
1092 } // END - foreach ($this->loadedRawData ...
1094 // Insert all templates
1095 $this->insertAllTemplates($templateMatches);
1096 } // END - if (count($this->loadedRawData) ...
1100 * Inserts all raw templates into their respective variables
1104 private function insertRawTemplates () {
1105 // Load all templates
1106 foreach ($this->rawTemplates as $template => $content) {
1107 // Set the template as a variable with the content
1108 $this->assignVariable($template, $content);
1113 * Finalizes the compilation of all template variables
1117 private function finalizeVariableCompilation () {
1119 $content = $this->getRawTemplateData();
1120 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1122 // Do we have the stack?
1123 if (!$this->isVarStackSet('general')) {
1124 // Abort here silently
1125 // @TODO This silent abort should be logged, maybe.
1129 // Walk through all variables
1130 foreach ($this->getVarStack('general') as $currEntry) {
1131 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1132 // Replace all [$var] or {?$var?} with the content
1133 // @TODO Old behaviour, will become obsolete!
1134 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1136 // @TODO Yet another old way
1137 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1139 // The new behaviour
1140 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1143 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1145 // Set the content back
1146 $this->setRawTemplateData($content);
1150 * Load a specified web template into the engine
1152 * @param $template The web template we shall load which is located in
1156 public function loadWebTemplate ($template) {
1157 // Set template type
1158 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1160 // Load the special template
1161 $this->loadTemplate($template);
1165 * Assign a given congfiguration variable with a value
1167 * @param $variableName The configuration variable we want to assign
1170 public function assignConfigVariable ($variableName) {
1171 // Replace all dashes to underscores to match variables with configuration entries
1172 $variableName = trim($this->convertDashesToUnderscores($variableName));
1174 // Sweet and simple...
1175 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1176 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1180 * Load a specified code template into the engine
1182 * @param $template The code template we shall load which is
1183 * located in 'code' by default
1186 public function loadCodeTemplate ($template) {
1187 // Set template type
1188 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1190 // Load the special template
1191 $this->loadTemplate($template);
1195 * Compiles configuration place-holders in all variables. This 'walks'
1196 * through the variable group 'general'. It interprets all values from that
1197 * variables as configuration entries after compiling them.
1201 public final function compileConfigInVariables () {
1202 // Do we have the stack?
1203 if (!$this->isVarStackSet('general')) {
1204 // Abort here silently
1205 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1209 // Iterate through all general variables
1210 foreach ($this->getVarStack('general') as $index => $currVariable) {
1211 // Compile the value
1212 $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
1215 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1217 // Remove it from stack
1218 $this->removeVariable($currVariable['name'], 'general');
1219 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1221 // Is it a configuration key?
1222 if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
1223 // The value itself is a configuration entry
1224 $this->assignConfigVariable($value);
1226 // Re-assign the value directly
1227 $this->setVariable('config', $currVariable['name'], $value);
1233 * Compile all variables by inserting their respective values
1236 * @todo Make this code some nicer...
1238 public final function compileVariables () {
1239 // Initialize the $content array
1240 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1243 // Iterate through all general variables
1244 foreach ($this->getVarStack('general') as $currVariable) {
1245 // Transfer it's name/value combination to the $content array
1246 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1247 $dummy[$currVariable['name']] = $currVariable['value'];
1250 // Set the new variable (don't remove the second dollar!)
1251 $$validVar = $dummy;
1253 // Remove some variables
1255 unset($currVariable);
1257 // Run the compilation three times to get content from helper classes in
1260 // Finalize the compilation of template variables
1261 $this->finalizeVariableCompilation();
1263 // Prepare the eval() command for comiling the template
1264 $eval = sprintf('$result = "%s";',
1265 addslashes($this->getRawTemplateData())
1268 // This loop does remove the backslashes (\) in PHP parameters
1269 while (strpos($eval, $this->codeBegin) !== FALSE) {
1270 // Get left part before "<?"
1271 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1273 // Get all from right of "<?"
1274 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1276 // Cut middle part out and remove escapes
1277 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1278 $evalMiddle = stripslashes($evalMiddle);
1280 // Remove the middle part from right one
1281 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1283 // And put all together
1284 $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
1287 // Prepare PHP code for eval() command
1288 $eval = str_replace(
1297 // Run the constructed command. This will "compile" all variables in
1300 // Goes something wrong?
1301 if ((!isset($result)) || (empty($result))) {
1302 // Output eval command
1303 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, TRUE)), TRUE);
1305 // Output backtrace here
1306 $this->debugBackTrace();
1309 // Set raw template data
1310 $this->setRawTemplateData($result);
1314 // Final variable assignment
1315 $this->finalizeVariableCompilation();
1317 // Set the new content
1318 $this->setCompiledData($this->getRawTemplateData());
1322 * Compile all required templates into the current loaded one
1325 * @throws UnexpectedTemplateTypeException If the template type is
1327 * @throws InvalidArrayCountException If an unexpected array
1328 * count has been found
1330 public function compileTemplate () {
1331 // Get code type to make things shorter
1332 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1334 // We will only work with template type "code" from configuration
1335 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1337 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1340 // Get the raw data.
1341 $rawData = $this->getRawTemplateData();
1343 // Remove double spaces and trim leading/trailing spaces
1344 $rawData = trim(str_replace(' ', ' ', $rawData));
1346 // Search for raw variables
1347 $this->extractVariablesFromRawData($rawData);
1349 // Search for code-tags which are {? ?}
1350 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1353 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , TRUE));
1355 // Analyze the matches array
1356 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1357 // Entries are found:
1359 // The main analysis
1360 $this->analyzeTemplate($templateMatches);
1362 // Compile raw template data
1363 $this->compileRawTemplateData($templateMatches);
1365 // Are there some raw templates left for loading?
1366 $this->loadExtraRawTemplates();
1368 // Are some raw templates found and loaded?
1369 if (count($this->rawTemplates) > 0) {
1370 // Insert all raw templates
1371 $this->insertRawTemplates();
1373 // Remove the raw template content as well
1374 $this->setRawTemplateData('');
1376 } // END - if($templateMatches ...
1380 * Loads a given view helper (by name)
1382 * @param $helperName The helper's name
1385 protected function loadViewHelper ($helperName) {
1386 // Make first character upper case, rest low
1387 $helperName = $this->convertToClassName($helperName);
1389 // Is this view helper loaded?
1390 if (!isset($this->helpers[$helperName])) {
1391 // Create a class name
1392 $className = $helperName . 'ViewHelper';
1394 // Generate new instance
1395 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1398 // Return the requested instance
1399 return $this->helpers[$helperName];
1403 * Assigns the last loaded raw template content with a given variable
1405 * @param $templateName Name of the template we want to assign
1406 * @param $variableName Name of the variable we want to assign
1409 public function assignTemplateWithVariable ($templateName, $variableName) {
1410 // Get the content from last loaded raw template
1411 $content = $this->getRawTemplateData();
1413 // Assign the variable
1414 $this->assignVariable($variableName, $content);
1416 // Purge raw content
1417 $this->setRawTemplateData('');
1421 * Transfers the content of this template engine to a given response instance
1423 * @param $responseInstance An instance of a response class
1426 public function transferToResponse (Responseable $responseInstance) {
1427 // Get the content and set it in response class
1428 $responseInstance->writeToBody($this->getCompiledData());
1432 * Assigns all the application data with template variables
1434 * @param $applicationInstance A manageable application instance
1437 public function assignApplicationData (ManageableApplication $applicationInstance) {
1438 // Get long name and assign it
1439 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1441 // Get short name and assign it
1442 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1444 // Get version number and assign it
1445 $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
1447 // Assign extra application-depending data
1448 $applicationInstance->assignExtraTemplateData($this);
1452 * "Compiles" a variable by replacing {?var?} with it's content
1454 * @param $rawCode Raw code to compile
1455 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1456 * @return $rawCode Compile code with inserted variable value
1458 public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
1459 // Find the variables
1460 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1461 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1463 // Compile all variables
1464 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, TRUE) . '</pre>');
1465 foreach ($varMatches[0] as $match) {
1466 // Add variable tags around it
1467 $varCode = '{?' . $match . '?}';
1470 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1472 // Is the variable found in code? (safes some calls)
1473 if (strpos($rawCode, $varCode) !== FALSE) {
1475 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1477 // Use $match as new value or $value from read variable?
1478 if ($setMatchAsCode === TRUE) {
1480 $rawCode = str_replace($varCode, $match, $rawCode);
1482 // Read the variable
1483 $value = $this->readVariable($match);
1486 $rawCode = str_replace($varCode, $value, $rawCode);
1491 // Return the compiled data
1492 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1497 * Getter for variable group array
1499 * @return $vargroups All variable groups
1501 public final function getVariableGroups () {
1502 return $this->varGroups;
1506 * Renames a variable in code and in stack
1508 * @param $oldName Old name of variable
1509 * @param $newName New name of variable
1512 public function renameVariable ($oldName, $newName) {
1513 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1514 // Get raw template code
1515 $rawData = $this->getRawTemplateData();
1518 $rawData = str_replace($oldName, $newName, $rawData);
1520 // Set the code back
1521 $this->setRawTemplateData($rawData);
1525 * Renders the given XML content
1527 * @param $content Valid XML content or if not set the current loaded raw content
1529 * @throws XmlParserException If an XML error was found
1531 public function renderXmlContent ($content = NULL) {
1532 // Is the content set?
1533 if (is_null($content)) {
1534 // Get current content
1535 $content = $this->getRawTemplateData();
1538 // Get a XmlParser instance
1539 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1541 // Check if we have XML compacting enabled
1542 if ($this->isXmlCompactingEnabled()) {
1543 // Yes, so get a decorator class for transparent compacting
1544 $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1547 // Parse the XML document
1548 $parserInstance->parseXmlContent($content);
1552 * Enables or disables language support
1554 * @param $languageSupport New language support setting
1557 public final function enableLanguageSupport ($languageSupport = TRUE) {
1558 $this->languageSupport = (bool) $languageSupport;
1562 * Checks whether language support is enabled
1564 * @return $languageSupport Whether language support is enabled or disabled
1566 public final function isLanguageSupportEnabled () {
1567 return $this->languageSupport;
1571 * Enables or disables XML compacting
1573 * @param $xmlCompacting New XML compacting setting
1576 public final function enableXmlCompacting ($xmlCompacting = TRUE) {
1577 $this->xmlCompacting = (bool) $xmlCompacting;
1581 * Checks whether XML compacting is enabled
1583 * @return $xmlCompacting Whether XML compacting is enabled or disabled
1585 public final function isXmlCompactingEnabled () {
1586 return $this->xmlCompacting;
1590 * Removes all commentd, tabs and new-line characters to compact the content
1592 * @param $uncompactedContent The uncompacted content
1593 * @return $compactedContent The compacted content
1595 public function compactContent ($uncompactedContent) {
1596 // First, remove all tab/new-line/revert characters
1597 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1599 // Then regex all comments like <!-- //--> away
1600 preg_match_all($this->regExpComments, $compactedContent, $matches);
1602 // Do we have entries?
1603 if (isset($matches[0][0])) {
1605 foreach ($matches[0] as $match) {
1607 $compactedContent = str_replace($match, '', $compactedContent);
1611 // Set the content again
1612 $this->setRawTemplateData($compactedContent);
1614 // Return compacted content
1615 return $compactedContent;