3 * The own template engine for loading caching and sending out the web pages
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class TemplateEngine extends BaseFrameworkSystem implements CompileableTemplate {
27 * The local path name where all templates and sub folders for special
28 * templates are stored. We will internally determine the language plus
29 * "html" for web templates or "emails" for email templates
31 private $basePath = "";
34 * The extension for web and email templates (not compiled templates)
36 private $templateExtension = ".tpl";
39 * The extension for code templates (not compiled templates)
41 private $codeExtension = ".ctp";
44 * Path relative to $basePath and language code for compiled code-templates
46 private $compileOutputPath = "templates/_compiled";
49 * The raw (maybe uncompiled) template
51 private $rawTemplateData = "";
54 * Template data with compiled-in variables
56 private $compiledData = "";
59 * The last loaded template's FQFN for debugging the engine
61 private $lastTemplate = "";
64 * The variable stack for the templates. This must be initialized and
65 * shall become an instance of FrameworkArrayObject.
67 private $varStack = null;
70 * Configuration variables in a simple array
72 private $configVariables = array();
75 * Loaded templates for recursive protection and detection
77 private $loadedTemplates = array();
80 * Compiled templates for recursive protection and detection
82 private $compiledTemplates = array();
85 * Loaded raw template data
87 private $loadedRawData = null;
90 * Raw templates which are linked in code templates
92 private $rawTemplates = null;
95 * A regular expression for variable=value pairs
97 private $regExpVarValue = '/([\w_]+)(="([^"]*)"|=([\w_]+))?/';
100 * A regular expression for filtering out code tags
102 * E.g.: {?template:variable=value;var2=value2;[...]?}
104 private $regExpCodeTags = '/\{\?([a-z_]+)(:("[^"]+"|[^?}]+)+)?\?\}/';
109 private $helpers = array();
111 // Exception codes for the template engine
112 const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x020;
113 const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x021;
114 const EXCEPTION_INVALID_VIEW_HELPER = 0x022;
117 * Protected constructor
121 protected function __construct () {
122 // Call parent constructor
123 parent::__construct(__CLASS__);
125 // Set part description
126 $this->setObjectDescription("Web template engine");
128 // Create unique ID number
129 $this->generateUniqueId();
132 $this->removeNumberFormaters();
133 $this->removeSystemArray();
137 * Creates an instance of the class TemplateEngine and prepares it for usage
139 * @param $basePath The local base path for all templates
140 * @param $langInstance An instance of LanguageSystem (default)
141 * @param $ioInstance An instance of FileIoHandler (default, middleware!)
142 * @return $tplInstance An instance of TemplateEngine
143 * @throws BasePathIsEmptyException If the provided $basePath is empty
144 * @throws InvalidBasePathStringException If $basePath is no string
145 * @throws BasePathIsNoDirectoryException If $basePath is no
146 * directory or not found
147 * @throws BasePathReadProtectedException If $basePath is
150 public final static function createTemplateEngine ($basePath, ManageableLanguage $langInstance, FileIoHandler $ioInstance) {
151 // Get a new instance
152 $tplInstance = new TemplateEngine();
154 // Is the base path valid?
155 if (empty($basePath)) {
156 // Base path is empty
157 throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
158 } elseif (!is_string($basePath)) {
160 throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
161 } elseif (!is_dir($basePath)) {
163 throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
164 } elseif (!is_readable($basePath)) {
166 throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
169 // Get configuration instance
170 $cfgInstance = FrameworkConfiguration::getInstance();
173 $tplInstance->setBasePath($basePath);
175 // Initialize the variable stack
176 $tplInstance->initVariableStack();
178 // Set the language and IO instances
179 $tplInstance->setLanguageInstance($langInstance);
180 $tplInstance->setFileIoInstance($ioInstance);
182 // Set template extensions
183 $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
184 $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
186 // Absolute output path for compiled templates
187 $tplInstance->setCompileOutputPath(PATH . $cfgInstance->readConfig('compile_output_path'));
189 // Return the prepared instance
194 * Search for a variable in the stack
196 * @param $var The variable we are looking for
197 * @return $idx FALSE means not found, >=0 means found on a specific index
199 private function isVariableAlreadySet ($var) {
200 // First everything is not found
204 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
206 $currEntry = $idx->current();
208 // Is the entry found?
209 if ($currEntry['name'] == $var) {
211 $found = $idx->key();
216 // Return the current position
221 * Return a content of a variable or null if not found
223 * @param $var The variable we are looking for
224 * @return $content Content of the variable or null if not found
226 private function readVariable ($var) {
227 // First everything is not found
231 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
233 $currEntry = $idx->current();
235 // Is the entry found?
236 if ($currEntry['name'] == $var) {
238 $content = $currEntry['value'];
243 // Return the current position
248 * Add a variable to the stack
250 * @param $var The variable we are looking for
251 * @param $value The value we want to store in the variable
254 private function addVariable ($var, $value) {
255 // Add it to the stack
256 $this->varStack->append(array(
257 'name' => trim($var),
258 'value' => trim($value)
263 * Modify an entry on the stack
265 * @param $var The variable we are looking for
266 * @param $value The value we want to store in the variable
269 private function modifyVariable ($var, $value) {
270 // It should be there so let's look again...
271 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
273 $currEntry = $idx->current();
275 // Is this the requested variable?
276 if ($currEntry['name'] == $var) {
277 // Change it to the other value
278 $this->varStack->offsetSet($idx->key(), array(
287 * Setter for template type. Only "html", "emails" and "compiled" should
290 * @param $templateType The current template's type
293 private final function setTemplateType ($templateType) {
295 $templateType = (string) $templateType;
297 // And set it (only 2 letters)
298 $this->templateType = $templateType;
302 * Setter for the last loaded template's FQFN
304 * @param $template The last loaded template
307 private final function setLastTemplate ($template) {
309 $template = (string) $template;
310 $this->lastTemplate = $template;
314 * Getter for the last loaded template's FQFN
316 * @return $template The last loaded template
318 private final function getLastTemplate () {
319 return $this->lastTemplate;
323 * Initialize the variable stack. This holds all variables for later
328 public final function initVariableStack () {
329 $this->varStack = new FrameworkArrayObject("FakedVariableStack");
333 * Setter for base path
335 * @param $basePath The local base path for all templates
338 public final function setBasePath ($basePath) {
340 $basePath = (string) $basePath;
343 $this->basePath = $basePath;
347 * Getter for base path
349 * @return $basePath The local base path for all templates
351 public final function getBasePath () {
353 return $this->basePath;
357 * Setter for template extension
359 * @param $templateExtension The file extension for all uncompiled
363 public final function setRawTemplateExtension ($templateExtension) {
365 $templateExtension = (string) $templateExtension;
368 $this->templateExtension = $templateExtension;
372 * Setter for code template extension
374 * @param $codeExtension The file extension for all uncompiled
378 public final function setCodeTemplateExtension ($codeExtension) {
380 $codeExtension = (string) $codeExtension;
383 $this->codeExtension = $codeExtension;
387 * Getter for template extension
389 * @return $templateExtension The file extension for all uncompiled
392 public final function getRawTemplateExtension () {
394 return $this->templateExtension;
398 * Getter for code-template extension
400 * @return $codeExtension The file extension for all code-
403 public final function getCodeTemplateExtension () {
405 return $this->codeExtension;
409 * Setter for path of compiled templates
411 * @param $compileOutputPath The local base path for all compiled
415 public final function setCompileOutputPath ($compileOutputPath) {
417 $compileOutputPath = (string) $compileOutputPath;
420 $this->compileOutputPath = $compileOutputPath;
424 * Getter for template type
426 * @return $templateType The current template's type
428 public final function getTemplateType () {
429 return $this->templateType;
433 * Assign (add) a given variable with a value
435 * @param $var The variable we are looking for
436 * @param $value The value we want to store in the variable
439 public final function assignVariable ($var, $value) {
440 // First search for the variable if it was already added
441 $idx = $this->isVariableAlreadySet($var);
444 if ($idx === false) {
445 // Add it to the stack
446 $this->addVariable($var, $value);
447 } elseif (!empty($value)) {
448 // Modify the stack entry
449 $this->modifyVariable($var, $value);
454 * Removes a given variable
456 * @param $var The variable we are looking for
459 public final function removeVariable ($var) {
460 // First search for the variable if it was already added
461 $idx = $this->isVariableAlreadySet($var);
464 if ($idx !== false) {
465 // Remove this variable
466 $this->varStack->offsetUnset($idx);
471 * Private setter for raw template data
473 * @param $rawTemplateData The raw data from the template
476 private final function setRawTemplateData ($rawTemplateData) {
478 $rawTemplateData = (string) $rawTemplateData;
480 // And store it in this class
481 $this->rawTemplateData = $rawTemplateData;
485 * Private setter for compiled templates
489 private final function setCompiledData ($compiledData) {
491 $compiledData = (string) $compiledData;
493 // And store it in this class
494 $this->compiledData = $compiledData;
498 * Private loader for all template types
500 * @param $template The template we shall load
503 private function loadTemplate ($template) {
505 $template = (string) $template;
507 // Get extension for the template
508 $ext = $this->getRawTemplateExtension();
510 // If we shall load a code-template we need to switch the file extension
511 if ($this->getTemplateType() == $this->getConfigInstance()->readConfig('code_template_type')) {
512 // Switch over to the code-template extension
513 $ext = $this->getCodeTemplateExtension();
516 // Construct the FQFN for the template by honoring the current language
517 $fqfn = sprintf("%s%s/%s/%s%s",
518 $this->getBasePath(),
519 $this->getLanguageInstance()->getLanguageCode(),
520 $this->getTemplateType(),
525 // Load the raw template data
526 $this->loadRawTemplateData($fqfn);
530 * A private loader for raw template names
532 * @param $fqfn The full-qualified file name for a template
534 * @throws NullPointerException If $inputInstance is null
535 * @throws NoObjectException If $inputInstance is not an object
536 * @throws MissingMethodException If $inputInstance is missing a
539 private function loadRawTemplateData ($fqfn) {
540 // Get a input/output instance from the middleware
541 $ioInstance = $this->getFileIoInstance();
543 // Validate the instance
544 if (is_null($ioInstance)) {
546 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
547 } elseif (!is_object($ioInstance)) {
548 // Throw another exception
549 throw new NoObjectException($ioInstance, self::EXCEPTION_IS_NO_OBJECT);
550 } elseif (!method_exists($ioInstance, 'loadFileContents')) {
551 // Throw yet another exception
552 throw new MissingMethodException(array($ioInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
555 // Load the raw template
556 $rawTemplateData = $ioInstance->loadFileContents($fqfn);
558 // Store the template's contents into this class
559 $this->setRawTemplateData($rawTemplateData);
561 // Remember the template's FQFN
562 $this->setLastTemplate($fqfn);
566 * Try to assign an extracted template variable as a "content" or "config"
569 * @param $varName The variable's name (shall be content orconfig) by
571 * @param $var The variable we want to assign
573 private function assignTemplateVariable ($varName, $var) {
574 // Is it not a config variable?
575 if ($varName != "config") {
576 // Regular template variables
577 $this->assignVariable($var, "");
579 // Configuration variables
580 $this->assignConfigVariable($var);
585 * Extract variables from a given raw data stream
587 * @param $rawData The raw template data we shall analyze
590 private function extractVariablesFromRawData ($rawData) {
592 $rawData = (string) $rawData;
594 // Search for variables
595 @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
597 // Did we find some variables?
598 if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
599 // Initialize all missing variables
600 foreach ($variableMatches[3] as $key=>$var) {
601 // Try to assign it, empty strings are being ignored
602 $this->assignTemplateVariable($variableMatches[1][$key], $var);
608 * Main analysis of the loaded template
610 * @param $templateMatches Found template place-holders, see below
613 *---------------------------------
614 * Structure of $templateMatches:
615 *---------------------------------
616 * [0] => Array - An array with all full matches
617 * [1] => Array - An array with left part (before the ":") of a match
618 * [2] => Array - An array with right part of a match including ":"
619 * [3] => Array - An array with right part of a match excluding ":"
621 private function analyzeTemplate (array $templateMatches) {
622 // Backup raw template data
623 $backup = $this->getRawTemplateData();
625 // Initialize some arrays
626 if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
628 // Load all requested templates
629 foreach ($templateMatches[1] as $template) {
631 // Load and compile only templates which we have not yet loaded
632 // RECURSIVE PROTECTION! BE CAREFUL HERE!
633 if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
635 // Template not found, but maybe variable assigned?
636 if ($this->isVariableAlreadySet($template) !== false) {
637 // Use that content here
638 $this->loadedRawData[$template] = $this->readVariable($template);
640 // Recursive protection:
641 $this->loadedTemplates[] = $template;
643 // Then try to search for code-templates
645 // Load the code template and remember it's contents
646 $this->loadCodeTemplate($template);
647 $this->loadedRawData[$template] = $this->getRawTemplateData();
649 // Remember this template for recursion detection
650 // RECURSIVE PROTECTION!
651 $this->loadedTemplates[] = $template;
652 } catch (FilePointerNotOpenedException $e) {
653 // Even this is not done... :/
654 $this->rawTemplates[] = $template;
658 } // if ((!isset( ...
660 } // for ($templateMatches ...
662 // Restore the raw template data
663 $this->setRawTemplateData($backup);
667 * Compile a given raw template code and remember it for later usage
669 * @param $code The raw template code
670 * @param $template The template's name
673 private function compileCode ($code, $template) {
674 // Is this template already compiled?
675 if (in_array($template, $this->compiledTemplates)) {
680 // Remember this template being compiled
681 $this->compiledTemplates[] = $template;
683 // Compile the loaded code in five steps:
685 // 1. Backup current template data
686 $backup = $this->getRawTemplateData();
688 // 2. Set the current template's raw data as the new content
689 $this->setRawTemplateData($code);
691 // 3. Compile the template data
692 $this->compileTemplate();
694 // 4. Remember it's contents
695 $this->loadedRawData[$template] = $this->getRawTemplateData();
697 // 5. Restore the previous raw content from backup variable
698 $this->setRawTemplateData($backup);
702 * Insert all given and loaded templates by running through all loaded
703 * codes and searching for their place-holder in the main template
705 * @param $templateMatches See method analyzeTemplate()
708 private function insertAllTemplates (array $templateMatches) {
709 // Run through all loaded codes
710 foreach ($this->loadedRawData as $template=>$code) {
712 // Search for the template
713 $foundIndex = array_search($template, $templateMatches[1]);
715 // Lookup the matching template replacement
716 if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
718 // Get the current raw template
719 $rawData = $this->getRawTemplateData();
721 // Replace the space holder with the template code
722 $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData);
724 // Set the new raw data
725 $this->setRawTemplateData($rawData);
733 * Load all extra raw templates
737 private function loadExtraRawTemplates () {
738 // Are there some raw templates we need to load?
739 if (count($this->rawTemplates) > 0) {
740 // Try to load all raw templates
741 foreach ($this->rawTemplates as $key => $template) {
744 $this->loadWebTemplate($template);
746 // Remember it's contents
747 $this->rawTemplates[$template] = $this->getRawTemplateData();
749 // Remove it from the loader list
750 unset($this->rawTemplates[$key]);
752 // Remember this template for recursion detection
753 // RECURSIVE PROTECTION!
754 $this->loadedTemplates[] = $template;
755 } catch (FilePointerNotOpenedException $e) {
756 // This template was never found. We silently ignore it
757 unset($this->rawTemplates[$key]);
764 * Assign all found template variables
766 * @param $varMatches An array full of variable/value pairs.
769 private function assignAllVariables (array $varMatches) {
770 // Search for all variables
771 foreach ($varMatches[1] as $key=>$var) {
773 // Detect leading equals
774 if (substr($varMatches[2][$key], 0, 1) == "=") {
775 // Remove and cast it
776 $varMatches[2][$key] = (string) substr($varMatches[2][$key], 1);
779 // Do we have some quotes left and right side? Then it is free text
780 if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
781 // Free string detected! Which we can assign directly
782 $this->assignVariable($var, $varMatches[3][$key]);
783 } elseif (!empty($varMatches[2][$key])) {
784 // Non-string found so we need some deeper analysis...
785 /* @TODO Unfinished work or don't die here. */
786 die("Deeper analysis not yet implemented!");
789 } // for ($varMatches ...
792 * Compiles all loaded raw templates
794 * @param $templateMatches See method analyzeTemplate() for details
797 private function compileRawTemplateData (array $templateMatches) {
798 // Are some code-templates found which we need to compile?
799 if (count($this->loadedRawData) > 0) {
802 foreach ($this->loadedRawData as $template=>$code) {
804 // Is this template already compiled?
805 if (in_array($template, $this->compiledTemplates)) {
810 // Search for the template
811 $foundIndex = array_search($template, $templateMatches[1]);
813 // Lookup the matching variable data
814 if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
816 // Split it up with another reg. exp. into variable=value pairs
817 preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
819 // Assign all variables
820 $this->assignAllVariables($varMatches);
822 } // END - if (isset($templateMatches ...
824 // Compile the loaded template
825 $this->compileCode($code, $template);
827 } // END - foreach ($this->loadedRawData ...
829 // Insert all templates
830 $this->insertAllTemplates($templateMatches);
832 } // END - if (count($this->loadedRawData) ...
836 * Inserts all raw templates into their respective variables
840 private function insertRawTemplates () {
841 // Load all templates
842 foreach ($this->rawTemplates as $template=>$content) {
843 // Set the template as a variable with the content
844 $this->assignVariable($template, $content);
849 * Finalizes the compilation of all template variables
853 private function finalizeVariableCompilation () {
855 $content = $this->getRawTemplateData();
857 // Walk through all variables
858 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
860 $currEntry = $idx->current();
862 // Replace all [$var] or {?$var?} with the content
863 //* DEBUG: */ echo "name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
864 $content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content);
865 $content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content);
866 $content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content);
869 // Set the content back
870 $this->setRawTemplateData($content);
874 * Getter for raw template data
876 * @return $rawTemplateData The raw data from the template
878 public final function getRawTemplateData () {
879 return $this->rawTemplateData;
883 * Getter for compiled templates
885 public final function getCompiledData () {
886 return $this->compiledData;
890 * Load a specified web template into the engine
892 * @param $template The web template we shall load which is
893 * located in "html" by default
896 public function loadWebTemplate ($template) {
898 $this->setTemplateType($this->getConfigInstance()->readConfig('web_template_type'));
900 // Load the special template
901 $this->loadTemplate($template);
905 * Assign a given congfiguration variable with a value
907 * @param $var The configuration variable we want to assign
910 public function assignConfigVariable ($var) {
911 // Sweet and simple...
912 $this->configVariables[$var] = $this->getConfigInstance()->readConfig($var);
916 * Load a specified email template into the engine
918 * @param $template The email template we shall load which is
919 * located in "emails" by default
922 public function loadEmailTemplate ($template) {
924 $this->setTemplateType($this->getConfigInstance()->readConfig('email_template_type'));
926 // Load the special template
927 $this->loadTemplate($template);
931 * Load a specified code template into the engine
933 * @param $template The code template we shall load which is
934 * located in "code" by default
937 public function loadCodeTemplate ($template) {
939 $this->setTemplateType($this->getConfigInstance()->readConfig('code_template_type'));
941 // Load the special template
942 $this->loadTemplate($template);
946 * Compile all variables by inserting their respective values
950 public final function compileVariables () {
951 // Initialize the $content array
952 $validVar = $this->getConfigInstance()->readConfig('tpl_valid_var');
955 // Iterate through all variables
956 for ($idx = $this->varStack->getIterator(); $idx->valid(); $idx->next()) {
958 // Get current variable from the stack
959 $currVariable = $idx->current();
961 // Transfer it's name/value combination to the $content array
962 //* DEBUG: */ echo $currVariable['name']."=<pre>".htmlentities($currVariable['value'])."</pre>\n";
963 $dummy[$currVariable['name']] = $currVariable['value'];
967 // Set the new variable (don't remove the second dollar !)
970 // Prepare all configuration variables
971 $config = $this->configVariables;
973 // Remove some variables
975 unset($currVariable);
977 // Run the compilation twice to get content from helper classes in
980 // Finalize the compilation of template variables
981 $this->finalizeVariableCompilation();
983 // Prepare the eval() command for comiling the template
984 $eval = sprintf("\$result = \"%s\";",
985 addslashes($this->getRawTemplateData())
988 // This loop does remove the backslashes (\) in PHP parameters
989 /* @TODO Make this some nicer... */
990 while (strpos($eval, "<?") !== false) {
991 // Get left part before "<?"
992 $evalLeft = substr($eval, 0, strpos($eval, "<?"));
994 // Get all from right of "<?"
995 $evalRight = substr($eval, (strpos($eval, "<?") + 2));
997 // Is this a full PHP tag?
998 if (substr(strtolower($evalRight), 0, 3) == "php") {
999 // Remove "php" string from full PHP tag
1000 $evalRight = substr($evalRight, 3);
1003 // Cut middle part out and remove escapes
1004 $evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>")));
1005 $evalMiddle = stripslashes($evalMiddle);
1007 // Remove the middle part from right one
1008 $evalRight = substr($evalRight, (strpos($evalRight, "?>") + 2));
1010 // And put all together
1011 $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
1014 // Prepare PHP code for eval() command
1015 $eval = str_replace(
1018 "%>", "\$result .= \"", $eval
1023 if ((defined('DEBUG_EVAL')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
1024 $this->__toString(),
1028 // Run the constructed command. This will "compile" all variables in
1031 // Set raw template data
1032 $this->setRawTemplateData($result);
1036 // Set the new content
1037 $this->setCompiledData($result);
1041 * Compile all required templates into the current loaded one
1044 * @throws UnexpectedTemplateTypeException If the template type is
1046 * @throws InvalidArrayCountException If an unexpected array
1047 * count has been found
1049 public final function compileTemplate () {
1050 // We will only work with template type "code" from configuration
1051 if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
1053 throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->readConfig('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
1056 // Get the raw data.
1057 $rawData = $this->getRawTemplateData();
1059 // Remove double spaces and trim leading/trailing spaces
1060 $rawData = trim(str_replace(" ", " ", $rawData));
1062 // Search for raw variables
1063 $this->extractVariablesFromRawData($rawData);
1065 // Search for code-tags which are {? ?}
1066 preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
1068 // Analyze the matches array
1069 if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
1070 // Entries are found:
1072 // The main analysis
1073 $this->analyzeTemplate($templateMatches);
1075 // Compile raw template data
1076 $this->compileRawTemplateData($templateMatches);
1078 // Are there some raw templates left for loading?
1079 $this->loadExtraRawTemplates();
1081 // Are some raw templates found and loaded?
1082 if (count($this->rawTemplates) > 0) {
1084 // Insert all raw templates
1085 $this->insertRawTemplates();
1087 // Remove the raw template content as well
1088 $this->setRawTemplateData("");
1092 } // END - if($templateMatches ...
1096 * Output the compiled page to the outside world. In case of web templates
1097 * this would be vaild (X)HTML code. And in case of email templates this
1098 * would store a prepared email body inside the template engine.
1102 public final function output () {
1103 // Check which type of template we have
1104 switch ($this->getTemplateType()) {
1105 case "html": // Raw HTML templates can be send to the output buffer
1107 $this->getWebOutputInstance()->output($this->getCompiledData());
1110 default: // Unknown type found
1111 // Construct message
1112 $msg = sprintf("[%s:] Unknown/unsupported template type <strong>%s</strong> detected.",
1113 $this->__toString(),
1114 $this->getTemplateType()
1117 if ((is_object($this->getDebugInstance())) && (method_exists($this->getDebugInstance(), 'output'))) {
1118 // Use debug output handler
1119 $this->getDebugInstance()->output($msg);
1123 // DO NOT REWRITE THIS TO app_die() !!!
1131 * Loads a given view helper (by name)
1133 * @param $helperName The helper's name
1135 * @throws ViewHelperNotFoundException If the given view helper was not found
1137 protected function loadViewHelper ($helperName) {
1138 // Make first character upper case, rest low
1139 $helperName = ucfirst($helperName);
1141 // Is this view helper loaded?
1142 if (!isset($this->helpers[$helperName])) {
1143 // Create a class name
1144 $className = "{$helperName}ViewHelper";
1146 // Does this class exists?
1147 if (!class_exists($className)) {
1149 throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER);
1152 // Generate new instance
1153 $eval = sprintf("\$this->helpers[%s] = %s::create%s();",
1163 // Return the requested instance
1164 return $this->helpers[$helperName];
1168 * Assigns the last loaded raw template content with a given variable
1170 * @param $templateName Name of the template we want to assign
1171 * @param $variableName Name of the variable we want to assign
1174 public function assignTemplateWithVariable ($templateName, $variableName) {
1175 // Get the content from last loaded raw template
1176 $content = $this->getRawTemplateData();
1178 // Assign the variable
1179 $this->assignVariable($variableName, $content);
1181 // Purge raw content
1182 $this->setRawTemplateData("");
1186 * Transfers the content of this template engine to a given response instance
1188 * @param $responseInstance An instance of a response class
1191 public function transferToResponse (Responseable $responseInstance) {
1192 // Get the content and set it in the response class
1193 $responseInstance->writeToBody($this->getCompiledData());
1197 * Assigns all the application data with template variables
1199 * @param $appInstance A manageable application instance
1202 public function assignApplicationData (ManageableApplication $appInstance) {
1203 // Get long name and assign it
1204 $this->assignVariable("app_full_name" , $appInstance->getAppName());
1206 // Get short name and assign it
1207 $this->assignVariable("app_short_name", $appInstance->getAppShortName());
1209 // Get version number and assign it
1210 $this->assignVariable("app_version" , $appInstance->getAppVersion());