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_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
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 $variableName The variable we are looking for
171 * @param $variableGroup Optional variable group to look in
172 * @return $index FALSE means not found, >=0 means found on a specific index
174 private function getVariableIndex ($variableName, $variableGroup = NULL) {
175 // Replace all dashes to underscores to match variables with configuration entries
176 $variableName = trim($this->convertDashesToUnderscores($variableName));
178 // First everything is not found
181 // If the stack is NULL, use the current group
182 if (is_null($variableGroup)) {
184 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
185 $variableGroup = $this->currGroup;
188 // Is the group there?
189 if ($this->isVarStackSet($variableGroup)) {
191 foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
192 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
193 // Is the entry found?
194 if ($currEntry['name'] == $variableName) {
196 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
203 // Return the current position
208 * Checks whether the given variable group is set
210 * @param $variableGroup Variable group to check
211 * @return $isSet Whether the given variable group is set
213 protected final function isVarStackSet ($variableGroup) {
215 $isSet = isset($this->varStack[$variableGroup]);
222 * Getter for given variable group
224 * @param $variableGroup Variable group to check
225 * @return $varStack Found variable group
227 public final function getVarStack ($variableGroup) {
228 return $this->varStack[$variableGroup];
232 * Setter for given variable group
234 * @param $variableGroup Variable group to check
235 * @param $varStack Variable stack to check
238 protected final function setVarStack ($variableGroup, array $varStack) {
239 $this->varStack[$variableGroup] = $varStack;
243 * Return a content of a variable or null if not found
245 * @param $variableName The variable we are looking for
246 * @param $variableGroup Optional variable group to look in
247 * @return $content Content of the variable or null if not found
249 protected function readVariable ($variableName, $variableGroup = NULL) {
250 // Replace all dashes to underscores to match variables with configuration entries
251 $variableName = trim($this->convertDashesToUnderscores($variableName));
253 // First everything is not found
256 // If the stack is NULL, use the current group
257 if (is_null($variableGroup)) {
259 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
260 $variableGroup = $this->currGroup;
263 // Get variable index
264 $found = $this->getVariableIndex($variableName, $variableGroup);
266 // Is the variable found?
267 if ($found !== FALSE) {
269 $content = $this->getVariableValue($variableGroup, $found);
272 // Return the current position
273 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
278 * Add a variable to the stack
280 * @param $variableName Name of variable to add
281 * @param $value Value we want to store in the variable
284 private function addVariable ($variableName, $value) {
285 // Set general variable group
286 $this->setVariableGroup('general');
288 // Add it to the stack
289 $this->addGroupVariable($variableName, $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: */ self::createDebugInstance(__CLASS__)->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 $variableName Variable to set
334 * @param $value Value to store in variable
337 public function addGroupVariable ($variableName, $value) {
338 // Replace all dashes to underscores to match variables with configuration entries
339 $variableName = trim($this->convertDashesToUnderscores($variableName));
342 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
344 // Get current variables in group
345 $currVars = $this->readCurrentGroup();
347 // Append our variable
348 array_push($currVars, $this->generateVariableArray($variableName, $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 $variableName 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 ($variableName, $value) {
375 // Replace all dashes to underscores to match variables with configuration entries
376 $variableName = trim($this->convertDashesToUnderscores($variableName));
378 // Get index for variable
379 $index = $this->getVariableIndex($variableName);
381 // Is the variable set?
382 if ($index === FALSE) {
383 // Unset variables cannot be modified
384 throw new NoVariableException(array($this, $variableName, $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 $variableName Variable to set
410 * @param $value Value to set
413 protected function setVariable ($varGroup, $variableName, $value) {
414 // Replace all dashes to underscores to match variables with configuration entries
415 $variableName = trim($this->convertDashesToUnderscores($variableName));
417 // Get index for variable
418 $index = $this->getVariableIndex($variableName);
420 // Is the variable set?
421 if ($index === FALSE) {
422 // Is the stack there?
423 if (!isset($this->varStack[$varGroup])) {
424 // Then initialize it here
425 $this->varStack[$varGroup] = array();
429 array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value));
432 $this->setVariableValue($this->currGroup, $index, $value);
437 * "Generates" (better returns) an array for all variables for given
438 * variable/value pay.
440 * @param $variableName Variable to set
441 * @param $value Value to set
442 * @return $varData Variable data array
444 private function generateVariableArray ($variableName, $value) {
445 // Replace all dashes to underscores to match variables with configuration entries
446 $variableName = trim($this->convertDashesToUnderscores($variableName));
448 // Generate the temporary array
450 'name' => $variableName,
459 * Setter for template type. Only 'html', 'emails' and 'compiled' should
462 * @param $templateType The current template's type
465 protected final function setTemplateType ($templateType) {
466 $this->templateType = (string) $templateType;
470 * Setter for the last loaded template's FQFN
472 * @param $template The last loaded template
475 private final function setLastTemplate ($template) {
476 $this->lastTemplate = (string) $template;
480 * Getter for the last loaded template's FQFN
482 * @return $template The last loaded template
484 private final function getLastTemplate () {
485 return $this->lastTemplate;
489 * Setter for base path
491 * @param $templateBasePath The relative base path for all templates
494 public final function setTemplateBasePath ($templateBasePath) {
496 $this->templateBasePath = (string) $templateBasePath;
500 * Getter for base path
502 * @return $templateBasePath The relative base path for all templates
504 public final function getTemplateBasePath () {
506 return $this->templateBasePath;
510 * Getter for generic base path
512 * @return $templateBasePath The relative base path for all templates
514 public final function getGenericBasePath () {
516 return $this->genericBasePath;
520 * Setter for template extension
522 * @param $templateExtension The file extension for all uncompiled
526 public final function setRawTemplateExtension ($templateExtension) {
528 $this->templateExtension = (string) $templateExtension;
532 * Setter for code template extension
534 * @param $codeExtension The file extension for all uncompiled
538 public final function setCodeTemplateExtension ($codeExtension) {
540 $this->codeExtension = (string) $codeExtension;
544 * Getter for template extension
546 * @return $templateExtension The file extension for all uncompiled
549 public final function getRawTemplateExtension () {
551 return $this->templateExtension;
555 * Getter for code-template extension
557 * @return $codeExtension The file extension for all code-
560 public final function getCodeTemplateExtension () {
562 return $this->codeExtension;
566 * Setter for path of compiled templates
568 * @param $compileOutputPath The local base path for all compiled
572 public final function setCompileOutputPath ($compileOutputPath) {
574 $this->compileOutputPath = (string) $compileOutputPath;
578 * Getter for template type
580 * @return $templateType The current template's type
582 public final function getTemplateType () {
583 return $this->templateType;
587 * Assign (add) a given variable with a value
589 * @param $variableName The variable we are looking for
590 * @param $value The value we want to store in the variable
592 * @throws EmptyVariableException If the variable name is left empty
594 public final function assignVariable ($variableName, $value) {
595 // Replace all dashes to underscores to match variables with configuration entries
596 $variableName = trim($this->convertDashesToUnderscores($variableName));
598 // Empty variable found?
599 if (empty($variableName)) {
600 // Throw an exception
601 throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
604 // First search for the variable if it was already added
605 $index = $this->getVariableIndex($variableName);
608 if ($index === FALSE) {
609 // Add it to the stack
610 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
611 $this->addVariable($variableName, $value);
612 } elseif (!empty($value)) {
613 // Modify the stack entry
614 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
615 $this->modifyVariable($variableName, $value);
620 * Removes a given variable
622 * @param $variableName The variable we are looking for
623 * @param $variableGroup Name of variable group (default: 'general')
626 public final function removeVariable ($variableName, $variableGroup = 'general') {
627 // First search for the variable if it was already added
628 $index = $this->getVariableIndex($variableName, $variableGroup);
631 if ($index !== FALSE) {
632 // Remove this variable
633 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
634 $this->unsetVariableStackOffset($index, $variableGroup);
639 * Unsets the given offset in the variable group
641 * @param $index Index to unset
642 * @param $variableGroup Variable group (default: currGroup)
645 protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
646 // Is the variable group not set?
647 if (is_null($variableGroup)) {
648 // Then set it to current
649 $variableGroup = $this->currGroup;
652 // Is the entry there?
653 if (!isset($this->varStack[$variableGroup][$index])) {
654 // Abort here, we need fixing!
655 $this->debugInstance();
659 unset($this->varStack[$variableGroup][$index]);
663 * Private setter for raw template data
665 * @param $rawTemplateData The raw data from the template
668 protected final function setRawTemplateData ($rawTemplateData) {
669 // And store it in this class
670 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
671 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
672 $this->rawTemplateData = (string) $rawTemplateData;
676 * Getter for raw template data
678 * @return $rawTemplateData The raw data from the template
680 public final function getRawTemplateData () {
681 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
682 return $this->rawTemplateData;
686 * Private setter for compiled templates
690 private final function setCompiledData ($compiledData) {
691 // And store it in this class
692 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
693 $this->compiledData = (string) $compiledData;
697 * Getter for compiled templates
699 * @return $compiledData Compiled template data
701 public final function getCompiledData () {
702 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
703 return $this->compiledData;
707 * Private loader for all template types
709 * @param $template The template we shall load
710 * @param $extOther An other extension to use
712 * @throws FileIoException If the template was not found
714 protected function loadTemplate ($template, $extOther = '') {
715 // Get extension for the template if empty
716 if (empty($extOther)) {
717 // None provided, so get the raw one
718 $ext = $this->getRawTemplateExtension();
721 $ext = (string) $extOther;
724 // Is language support enabled?
725 if ($this->isLanguageSupportEnabled()) {
726 // Construct the FQFN for the template by honoring the current language
727 $fqfn = sprintf("%s%s%s%s/%s/%s%s",
728 $this->getConfigInstance()->getConfigEntry('base_path'),
729 $this->getTemplateBasePath(),
730 $this->getGenericBasePath(),
731 $this->getLanguageInstance()->getLanguageCode(),
732 $this->getTemplateType(),
737 // Construct the FQFN for the template without language
738 $fqfn = sprintf("%s%s%s%s/%s%s",
739 $this->getConfigInstance()->getConfigEntry('base_path'),
740 $this->getTemplateBasePath(),
741 $this->getGenericBasePath(),
742 $this->getTemplateType(),
750 // Load the raw template data
751 $this->loadRawTemplateData($fqfn);
752 } catch (FileIoException $e) {
753 // If we shall load a code-template we need to switch the file extension
754 if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
755 // Switch over to the code-template extension and try it again
756 $ext = $this->getCodeTemplateExtension();
759 $this->loadTemplate($template, $ext);
762 throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
769 * A private loader for raw template names
771 * @param $fqfn The full-qualified file name for a template
774 private function loadRawTemplateData ($fqfn) {
775 // Get a input/output instance from the middleware
776 $ioInstance = $this->getFileIoInstance();
778 // Some debug code to look on the file which is being loaded
779 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
781 // Load the raw template
782 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
784 // Store the template's contents into this class
785 $this->setRawTemplateData($rawTemplateData);
787 // Remember the template's FQFN
788 $this->setLastTemplate($fqfn);
792 * Try to assign an extracted template variable as a "content" or 'config'
795 * @param $varName The variable's name (shall be content or config)
797 * @param $variableName The variable we want to assign
800 private function assignTemplateVariable ($varName, $var) {
801 // Replace all dashes to underscores to match variables with configuration entries
802 $variableName = trim($this->convertDashesToUnderscores($variableName));
805 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
807 // Is it not a config variable?
808 if ($varName != 'config') {
809 // Regular template variables
810 $this->assignVariable($variableName, '');
812 // Configuration variables
813 $this->assignConfigVariable($variableName);
818 * Extract variables from a given raw data stream
820 * @param $rawData The raw template data we shall analyze
823 private function extractVariablesFromRawData ($rawData) {
825 $rawData = (string) $rawData;
827 // Search for variables
828 preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
831 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE));
833 // Did we find some variables?
834 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
835 // Initialize all missing variables
836 foreach ($variableMatches[3] as $key => $var) {
838 $varName = $variableMatches[1][$key];
840 // Workarround: Do not assign empty variables
842 // Try to assign it, empty strings are being ignored
843 $this->assignTemplateVariable($varName, $var);
850 * Main analysis of the loaded template
852 * @param $templateMatches Found template place-holders, see below
855 *---------------------------------
856 * Structure of $templateMatches:
857 *---------------------------------
858 * [0] => Array - An array with all full matches
859 * [1] => Array - An array with left part (before the ':') of a match
860 * [2] => Array - An array with right part of a match including ':'
861 * [3] => Array - An array with right part of a match excluding ':'
863 private function analyzeTemplate (array $templateMatches) {
864 // Backup raw template data
865 $backup = $this->getRawTemplateData();
867 // Initialize some arrays
868 if (is_null($this->loadedRawData)) {
870 $this->loadedRawData = array();
871 $this->rawTemplates = array();
874 // Load all requested templates
875 foreach ($templateMatches[1] as $template) {
876 // Load and compile only templates which we have not yet loaded
877 // RECURSIVE PROTECTION! BE CAREFUL HERE!
878 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
880 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
882 // Template not found, but maybe variable assigned?
883 if ($this->getVariableIndex($template, 'config') !== FALSE) {
884 // Use that content here
885 $this->loadedRawData[$template] = $this->readVariable($template, 'config');
887 // Recursive protection:
888 array_push($this->loadedTemplates, $template);
889 } elseif ($this->getVariableIndex($template) !== FALSE) {
890 // Use that content here
891 $this->loadedRawData[$template] = $this->readVariable($template);
893 // Recursive protection:
894 array_push($this->loadedTemplates, $template);
896 // Then try to search for code-templates
898 // Load the code template and remember it's contents
899 $this->loadCodeTemplate($template);
900 $this->loadedRawData[$template] = $this->getRawTemplateData();
902 // Remember this template for recursion detection
903 // RECURSIVE PROTECTION!
904 array_push($this->loadedTemplates, $template);
905 } catch (FileIoException $e) {
906 // Even this is not done... :/
907 array_push($this->rawTemplates, $template);
913 // Restore the raw template data
914 $this->setRawTemplateData($backup);
918 * Compile a given raw template code and remember it for later usage
920 * @param $code The raw template code
921 * @param $template The template's name
924 private function compileCode ($code, $template) {
925 // Is this template already compiled?
926 if (in_array($template, $this->compiledTemplates)) {
931 // Remember this template being compiled
932 array_push($this->compiledTemplates, $template);
934 // Compile the loaded code in five steps:
936 // 1. Backup current template data
937 $backup = $this->getRawTemplateData();
939 // 2. Set the current template's raw data as the new content
940 $this->setRawTemplateData($code);
942 // 3. Compile the template data
943 $this->compileTemplate();
945 // 4. Remember it's contents
946 $this->loadedRawData[$template] = $this->getRawTemplateData();
948 // 5. Restore the previous raw content from backup variable
949 $this->setRawTemplateData($backup);
953 * Insert all given and loaded templates by running through all loaded
954 * codes and searching for their place-holder in the main template
956 * @param $templateMatches See method analyzeTemplate()
959 private function insertAllTemplates (array $templateMatches) {
960 // Run through all loaded codes
961 foreach ($this->loadedRawData as $template => $code) {
963 // Search for the template
964 $foundIndex = array_search($template, $templateMatches[1]);
966 // Lookup the matching template replacement
967 if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
969 // Get the current raw template
970 $rawData = $this->getRawTemplateData();
972 // Replace the space holder with the template code
973 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
975 // Set the new raw data
976 $this->setRawTemplateData($rawData);
982 * Load all extra raw templates
986 private function loadExtraRawTemplates () {
987 // Are there some raw templates we need to load?
988 if (count($this->rawTemplates) > 0) {
989 // Try to load all raw templates
990 foreach ($this->rawTemplates as $key => $template) {
993 $this->loadWebTemplate($template);
995 // Remember it's contents
996 $this->rawTemplates[$template] = $this->getRawTemplateData();
998 // Remove it from the loader list
999 unset($this->rawTemplates[$key]);
1001 // Remember this template for recursion detection
1002 // RECURSIVE PROTECTION!
1003 array_push($this->loadedTemplates, $template);
1004 } catch (FileIoException $e) {
1005 // This template was never found. We silently ignore it
1006 unset($this->rawTemplates[$key]);
1013 * Assign all found template variables
1015 * @param $varMatches An array full of variable/value pairs.
1017 * @todo Unfinished work or don't die here.
1019 private function assignAllVariables (array $varMatches) {
1021 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
1023 // Search for all variables
1024 foreach ($varMatches[1] as $key => $var) {
1025 // Replace all dashes to underscores to match variables with configuration entries
1026 $var = trim($this->convertDashesToUnderscores($var));
1029 self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
1031 // Detect leading equals
1032 if (substr($varMatches[2][$key], 0, 1) == '=') {
1033 // Remove and cast it
1034 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
1037 // Do we have some quotes left and right side? Then it is free text
1038 if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
1039 // Free string detected! Which we can assign directly
1040 $this->assignVariable($var, $varMatches[3][$key]);
1041 } elseif (!empty($varMatches[2][$key])) {
1042 // @TODO Non-string found so we need some deeper analysis...
1043 ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
1049 * Compiles all loaded raw templates
1051 * @param $templateMatches See method analyzeTemplate() for details
1054 private function compileRawTemplateData (array $templateMatches) {
1056 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
1058 // Are some code-templates found which we need to compile?
1059 if (count($this->loadedRawData) > 0) {
1060 // Then compile all!
1061 foreach ($this->loadedRawData as $template => $code) {
1063 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
1065 // Is this template already compiled?
1066 if (in_array($template, $this->compiledTemplates)) {
1068 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
1072 // Search for the template
1073 $foundIndex = array_search($template, $templateMatches[1]);
1075 // Lookup the matching variable data
1076 if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
1077 // Split it up with another reg. exp. into variable=value pairs
1078 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
1079 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE));
1081 // Assign all variables
1082 $this->assignAllVariables($varMatches);
1083 } // END - if (isset($templateMatches ...
1085 // Compile the loaded template
1086 $this->compileCode($code, $template);
1087 } // END - foreach ($this->loadedRawData ...
1089 // Insert all templates
1090 $this->insertAllTemplates($templateMatches);
1091 } // END - if (count($this->loadedRawData) ...
1095 * Inserts all raw templates into their respective variables
1099 private function insertRawTemplates () {
1100 // Load all templates
1101 foreach ($this->rawTemplates as $template => $content) {
1102 // Set the template as a variable with the content
1103 $this->assignVariable($template, $content);
1108 * Finalizes the compilation of all template variables
1112 private function finalizeVariableCompilation () {
1114 $content = $this->getRawTemplateData();
1115 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
1117 // Do we have the stack?
1118 if (!$this->isVarStackSet('general')) {
1119 // Abort here silently
1120 // @TODO This silent abort should be logged, maybe.
1124 // Walk through all variables
1125 foreach ($this->getVarStack('general') as $currEntry) {
1126 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
1127 // Replace all [$var] or {?$var?} with the content
1128 // @TODO Old behaviour, will become obsolete!
1129 $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1131 // @TODO Yet another old way
1132 $content = str_replace('[' . $currEntry['name'] . ']', $currEntry['value'], $content);
1134 // The new behaviour
1135 $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
1138 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
1140 // Set the content back
1141 $this->setRawTemplateData($content);
1145 * Load a specified web template into the engine
1147 * @param $template The web template we shall load which is located in
1151 public function loadWebTemplate ($template) {
1152 // Set template type
1153 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
1155 // Load the special template
1156 $this->loadTemplate($template);
1160 * Assign a given congfiguration variable with a value
1162 * @param $variableName The configuration variable we want to assign
1165 public function assignConfigVariable ($variableName) {
1166 // Replace all dashes to underscores to match variables with configuration entries
1167 $variableName = trim($this->convertDashesToUnderscores($variableName));
1169 // Sweet and simple...
1170 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
1171 $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
1175 * Load a specified code template into the engine
1177 * @param $template The code template we shall load which is
1178 * located in 'code' by default
1181 public function loadCodeTemplate ($template) {
1182 // Set template type
1183 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_template_type'));
1185 // Load the special template
1186 $this->loadTemplate($template);
1190 * Compiles configuration place-holders in all variables. This 'walks'
1191 * through the variable group 'general'. It interprets all values from that
1192 * variables as configuration entries after compiling them.
1196 public final function compileConfigInVariables () {
1197 // Do we have the stack?
1198 if (!$this->isVarStackSet('general')) {
1199 // Abort here silently
1200 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
1204 // Iterate through all general variables
1205 foreach ($this->getVarStack('general') as $index => $currVariable) {
1206 // Compile the value
1207 $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
1210 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
1212 // Remove it from stack
1213 $this->removeVariable($currVariable['name'], 'general');
1214 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
1216 // Is it a configuration key?
1217 if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
1218 // The value itself is a configuration entry
1219 $this->assignConfigVariable($value);
1221 // Re-assign the value directly
1222 $this->setVariable('config', $currVariable['name'], $value);
1228 * Compile all variables by inserting their respective values
1231 * @todo Make this code some nicer...
1233 public final function compileVariables () {
1234 // Initialize the $content array
1235 $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var');
1238 // Iterate through all general variables
1239 foreach ($this->getVarStack('general') as $currVariable) {
1240 // Transfer it's name/value combination to the $content array
1241 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
1242 $dummy[$currVariable['name']] = $currVariable['value'];
1245 // Set the new variable (don't remove the second dollar!)
1246 $$validVar = $dummy;
1248 // Remove some variables
1250 unset($currVariable);
1252 // Run the compilation three times to get content from helper classes in
1255 // Finalize the compilation of template variables
1256 $this->finalizeVariableCompilation();
1258 // Prepare the eval() command for comiling the template
1259 $eval = sprintf("\$result = \"%s\";",
1260 addslashes($this->getRawTemplateData())
1263 // This loop does remove the backslashes (\) in PHP parameters
1264 while (strpos($eval, $this->codeBegin) !== FALSE) {
1265 // Get left part before "<?"
1266 $evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
1268 // Get all from right of "<?"
1269 $evalRight = substr($eval, (strpos($eval, $this->codeBegin) + 5));
1271 // Cut middle part out and remove escapes
1272 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, $this->codeEnd)));
1273 $evalMiddle = stripslashes($evalMiddle);
1275 // Remove the middle part from right one
1276 $evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
1278 // And put all together
1279 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1282 // Prepare PHP code for eval() command
1283 $eval = str_replace(
1292 // Run the constructed command. This will "compile" all variables in
1295 // Goes something wrong?
1296 if ((!isset($result)) || (empty($result))) {
1297 // Output eval command
1298 self::createDebugInstance(__CLASS__)->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, TRUE)), TRUE);
1300 // Output backtrace here
1301 $this->debugBackTrace();
1304 // Set raw template data
1305 $this->setRawTemplateData($result);
1309 // Final variable assignment
1310 $this->finalizeVariableCompilation();
1312 // Set the new content
1313 $this->setCompiledData($this->getRawTemplateData());
1317 * Compile all required templates into the current loaded one
1320 * @throws UnexpectedTemplateTypeException If the template type is
1322 * @throws InvalidArrayCountException If an unexpected array
1323 * count has been found
1325 public function compileTemplate () {
1326 // Get code type to make things shorter
1327 $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
1329 // We will only work with template type "code" from configuration
1330 if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
1332 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1335 // Get the raw data.
1336 $rawData = $this->getRawTemplateData();
1338 // Remove double spaces and trim leading/trailing spaces
1339 $rawData = trim(str_replace(' ', ' ', $rawData));
1341 // Search for raw variables
1342 $this->extractVariablesFromRawData($rawData);
1344 // Search for code-tags which are {? ?}
1345 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1348 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , TRUE));
1350 // Analyze the matches array
1351 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1352 // Entries are found:
1354 // The main analysis
1355 $this->analyzeTemplate($templateMatches);
1357 // Compile raw template data
1358 $this->compileRawTemplateData($templateMatches);
1360 // Are there some raw templates left for loading?
1361 $this->loadExtraRawTemplates();
1363 // Are some raw templates found and loaded?
1364 if (count($this->rawTemplates) > 0) {
1365 // Insert all raw templates
1366 $this->insertRawTemplates();
1368 // Remove the raw template content as well
1369 $this->setRawTemplateData('');
1371 } // END - if($templateMatches ...
1375 * Loads a given view helper (by name)
1377 * @param $helperName The helper's name
1380 protected function loadViewHelper ($helperName) {
1381 // Make first character upper case, rest low
1382 $helperName = $this->convertToClassName($helperName);
1384 // Is this view helper loaded?
1385 if (!isset($this->helpers[$helperName])) {
1386 // Create a class name
1387 $className = $helperName . 'ViewHelper';
1389 // Generate new instance
1390 $this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
1393 // Return the requested instance
1394 return $this->helpers[$helperName];
1398 * Assigns the last loaded raw template content with a given variable
1400 * @param $templateName Name of the template we want to assign
1401 * @param $variableName Name of the variable we want to assign
1404 public function assignTemplateWithVariable ($templateName, $variableName) {
1405 // Get the content from last loaded raw template
1406 $content = $this->getRawTemplateData();
1408 // Assign the variable
1409 $this->assignVariable($variableName, $content);
1411 // Purge raw content
1412 $this->setRawTemplateData('');
1416 * Transfers the content of this template engine to a given response instance
1418 * @param $responseInstance An instance of a response class
1421 public function transferToResponse (Responseable $responseInstance) {
1422 // Get the content and set it in response class
1423 $responseInstance->writeToBody($this->getCompiledData());
1427 * Assigns all the application data with template variables
1429 * @param $applicationInstance A manageable application instance
1432 public function assignApplicationData (ManageableApplication $applicationInstance) {
1433 // Get long name and assign it
1434 $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
1436 // Get short name and assign it
1437 $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
1439 // Get version number and assign it
1440 $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
1442 // Assign extra application-depending data
1443 $applicationInstance->assignExtraTemplateData($this);
1447 * "Compiles" a variable by replacing {?var?} with it's content
1449 * @param $rawCode Raw code to compile
1450 * @param $setMatchAsCode Sets $match if readVariable() returns empty result
1451 * @return $rawCode Compile code with inserted variable value
1453 public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
1454 // Find the variables
1455 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1456 preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
1458 // Compile all variables
1459 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, TRUE) . '</pre>');
1460 foreach ($varMatches[0] as $match) {
1461 // Add variable tags around it
1462 $varCode = '{?' . $match . '?}';
1465 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
1467 // Is the variable found in code? (safes some calls)
1468 if (strpos($rawCode, $varCode) !== FALSE) {
1470 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
1472 // Use $match as new value or $value from read variable?
1473 if ($setMatchAsCode === TRUE) {
1475 $rawCode = str_replace($varCode, $match, $rawCode);
1477 // Read the variable
1478 $value = $this->readVariable($match);
1481 $rawCode = str_replace($varCode, $value, $rawCode);
1486 // Return the compiled data
1487 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
1492 * Getter for variable group array
1494 * @return $vargroups All variable groups
1496 public final function getVariableGroups () {
1497 return $this->varGroups;
1501 * Renames a variable in code and in stack
1503 * @param $oldName Old name of variable
1504 * @param $newName New name of variable
1507 public function renameVariable ($oldName, $newName) {
1508 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
1509 // Get raw template code
1510 $rawData = $this->getRawTemplateData();
1513 $rawData = str_replace($oldName, $newName, $rawData);
1515 // Set the code back
1516 $this->setRawTemplateData($rawData);
1520 * Renders the given XML content
1522 * @param $content Valid XML content or if not set the current loaded raw content
1524 * @throws XmlParserException If an XML error was found
1526 public function renderXmlContent ($content = NULL) {
1527 // Is the content set?
1528 if (is_null($content)) {
1529 // Get current content
1530 $content = $this->getRawTemplateData();
1533 // Get a XmlParser instance
1534 $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
1536 // Check if we have XML compacting enabled
1537 if ($this->isXmlCompactingEnabled()) {
1538 // Yes, so get a decorator class for transparent compacting
1539 $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
1542 // Parse the XML document
1543 $parserInstance->parseXmlContent($content);
1547 * Enables or disables language support
1549 * @param $languageSupport New language support setting
1552 public final function enableLanguageSupport ($languageSupport = TRUE) {
1553 $this->languageSupport = (bool) $languageSupport;
1557 * Checks whether language support is enabled
1559 * @return $languageSupport Whether language support is enabled or disabled
1561 public final function isLanguageSupportEnabled () {
1562 return $this->languageSupport;
1566 * Enables or disables XML compacting
1568 * @param $xmlCompacting New XML compacting setting
1571 public final function enableXmlCompacting ($xmlCompacting = TRUE) {
1572 $this->xmlCompacting = (bool) $xmlCompacting;
1576 * Checks whether XML compacting is enabled
1578 * @return $xmlCompacting Whether XML compacting is enabled or disabled
1580 public final function isXmlCompactingEnabled () {
1581 return $this->xmlCompacting;
1585 * Removes all commentd, tabs and new-line characters to compact the content
1587 * @param $uncompactedContent The uncompacted content
1588 * @return $compactedContent The compacted content
1590 public function compactContent ($uncompactedContent) {
1591 // First, remove all tab/new-line/revert characters
1592 $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
1594 // Then regex all comments like <!-- //--> away
1595 preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
1597 // Do we have entries?
1598 if (isset($matches[0][0])) {
1600 foreach ($matches[0] as $match) {
1602 $compactedContent = str_replace($match, '', $compactedContent);
1606 // Set the content again
1607 $this->setRawTemplateData($compactedContent);
1609 // Return compacted content
1610 return $compactedContent;