Fake template engine added, variables can now be compiled for config entries:
[core.git] / inc / classes / main / template / class_BaseTemplateEngine.php
index 5a45bd71bca5f9c5401b7ccc86e58f25ca4284d4..2256fab0f24879fe8c00921f4b722f8b4c349cb5 100644 (file)
@@ -131,6 +131,11 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         */
        private $codeEnd = '?>';
 
+       /**
+        * Language support is enabled by default
+        */
+       private $languageSupport = true;
+
        // Exception codes for the template engine
        const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED   = 0x110;
        const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
@@ -145,10 +150,6 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);
-
-               // Clean up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
@@ -196,13 +197,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                // Is the variable found?
                if ($found !== false) {
                        // Read it
-                       $found = $this->varStack[$this->currGroup][$found]['value'];
+                       $content = $this->varStack[$this->currGroup][$found]['value'];
                } // END - if
 
-               //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", found=".$found."<br />\n";
-
                // Return the current position
-               return $found;
+               //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.",var=".$var.", content[".gettype($content)."]=".$content."<br />\n";
+               return $content;
        }
 
        /**
@@ -474,7 +474,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                if ($idx !== false) {
                        // Remove this variable
                        $this->varStack->offsetUnset($idx);
-               }
+               } // END - if
        }
 
        /**
@@ -527,7 +527,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * @param       $template       The template we shall load
         * @param       $extOther       An other extension to use
         * @return      void
-        * @throws      FileNotFoundException   If the template was not found
+        * @throws      FileIoException If the template was not found
         */
        protected function loadTemplate ($template, $extOther = '') {
                // Get extension for the template if empty
@@ -539,22 +539,35 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        $ext = (string) $extOther;
                }
 
-               // Construct the FQFN for the template by honoring the current language
-               $fqfn = sprintf("%s%s%s%s/%s/%s%s",
-                       $this->getConfigInstance()->getConfigEntry('base_path'),
-                       $this->getTemplateBasePath(),
-                       $this->getGenericBasePath(),
-                       $this->getLanguageInstance()->getLanguageCode(),
-                       $this->getTemplateType(),
-                       (string) $template,
-                       $ext
-               );
+               // Is language support enabled?
+               if ($this->isLanguageSupportEnabled()) {
+                       // Construct the FQFN for the template by honoring the current language
+                       $fqfn = sprintf("%s%s%s%s/%s/%s%s",
+                               $this->getConfigInstance()->getConfigEntry('base_path'),
+                               $this->getTemplateBasePath(),
+                               $this->getGenericBasePath(),
+                               $this->getLanguageInstance()->getLanguageCode(),
+                               $this->getTemplateType(),
+                               (string) $template,
+                               $ext
+                       );
+               } else {
+                       // Construct the FQFN for the template without language
+                       $fqfn = sprintf("%s%s%s%s/%s%s",
+                               $this->getConfigInstance()->getConfigEntry('base_path'),
+                               $this->getTemplateBasePath(),
+                               $this->getGenericBasePath(),
+                               $this->getTemplateType(),
+                               (string) $template,
+                               $ext
+                       );
+               }
 
                // First try this
                try {
                        // Load the raw template data
                        $this->loadRawTemplateData($fqfn);
-               } catch (FileNotFoundException $e) {
+               } catch (FileIoException $e) {
                        // If we shall load a code-template we need to switch the file extension
                        if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
                                // Switch over to the code-template extension and try it again
@@ -564,7 +577,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                $this->loadTemplate($template, $ext);
                        } else {
                                // Throw it again
-                               throw new FileNotFoundException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
+                               throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
                        }
                }
 
@@ -693,10 +706,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                                // Remember this template for recursion detection
                                                // RECURSIVE PROTECTION!
                                                $this->loadedTemplates[] = $template;
-                                       } catch (FileNotFoundException $e) {
-                                               // Even this is not done... :/
-                                               $this->rawTemplates[] = $template;
-                                       } catch (FilePointerNotOpenedException $e) {
+                                       } catch (FileIoException $e) {
                                                // Even this is not done... :/
                                                $this->rawTemplates[] = $template;
                                        }
@@ -795,10 +805,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                        // Remember this template for recursion detection
                                        // RECURSIVE PROTECTION!
                                        $this->loadedTemplates[] = $template;
-                               } catch (FileNotFoundException $e) {
-                                       // This template was never found. We silently ignore it
-                                       unset($this->rawTemplates[$key]);
-                               } catch (FilePointerNotOpenedException $e) {
+                               } catch (FileIoException $e) {
                                        // This template was never found. We silently ignore it
                                        unset($this->rawTemplates[$key]);
                                }
@@ -954,6 +961,8 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * @param       $template       The email template we shall load which is located in
         *                                              'emails' by default
         * @return      void
+        * @deprecated
+        * @see         See loadCodeTemplate()
         */
        public function loadEmailTemplate ($template) {
                // Set template type
@@ -978,6 +987,27 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                $this->loadTemplate($template);
        }
 
+       /**
+        * Compiles configuration place-holders in all variables. This 'walks'
+        * through the variable stack 'general'. It interprets all values from that
+        * variables as configuration entries after compiling them.
+        *
+        * @return      void
+        */
+       public final function compileConfigInVariables () {
+               // Iterate through all general variables
+               foreach ($this->varStack['general'] as $idx=>$currVariable) {
+                       // Compile the value
+                       $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
+
+                       // Remove it from stack
+                       unset($this->varStack['general'][$idx]);
+
+                       // Re-assign the variable
+                       $this->assignConfigVariable($value);
+               } // END - foreach
+       }
+
        /**
         * Compile all variables by inserting their respective values
         *
@@ -1050,7 +1080,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        );
 
                        // Run the constructed command. This will "compile" all variables in
-                       @eval($eval);
+                       eval($eval);
 
                        // Goes something wrong?
                        if ((!isset($result)) || (empty($result))) {
@@ -1232,16 +1262,17 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * "Compiles" a variable by replacing {?var?} with it's content
         *
-        * @param       $rawCode        Raw code to compile
+        * @param       $rawCode                        Raw code to compile
+        * @param       $setMatchAsCode         Sets $match if readVariable() returns empty result
         * @return      $rawCode        Compile code with inserted variable value
         */
-       public function compileRawCode ($rawCode) {
+       public function compileRawCode ($rawCode, $setMatchAsCode=false) {
                // Find the variables
-               //* DEBUG: */ echo "rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+               //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
                preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
 
                // Compile all variables
-               //* DEBUG: */ echo "<pre>".print_r($varMatches, true)."</pre>";
+               //* DEBUG: */ echo __METHOD__.":<pre>".print_r($varMatches, true)."</pre>\n";
                foreach ($varMatches[0] as $match) {
                        // Add variable tags around it
                        $varCode = '{?' . $match . '?}';
@@ -1249,12 +1280,20 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        // Is the variable found in code? (safes some calls)
                        if (strpos($rawCode, $varCode) !== false) {
                                // Replace the variable with it's value, if found
-                               //* DEBUG: */ echo __METHOD__.": match=".$match."<br />\n";
-                               $rawCode = str_replace($varCode, $this->readVariable($match), $rawCode);
+                               $value = $this->readVariable($match);
+                               //* DEBUG: */ echo __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."<br />\n";
+                               if (($setMatchAsCode === true) && (is_null($value))) {
+                                       // Insert match
+                                       $rawCode = str_replace($varCode, $match, $rawCode);
+                               } else {
+                                       // Insert value
+                                       $rawCode = str_replace($varCode, $value, $rawCode);
+                               }
                        } // END - if
                } // END - foreach
 
                // Return the compiled data
+               //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
                return $rawCode;
        }
 
@@ -1293,42 +1332,37 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * @return      void
         * @throws      XmlParserException      If an XML error was found
         */
-       public final function renderXmlContent ($content = null) {
+       public function renderXmlContent ($content = null) {
                // Is the content set?
                if (is_null($content)) {
                        // Get current content
                        $content = $this->getRawTemplateData();
                } // END - if
 
-               // Convert all to UTF8
-               if (function_exists('recode')) {
-                       $content = recode("html..utf8", $content);
-               } else {
-                       // @TODO We need to find a fallback solution here
-               } // END - if
-
-               // Get an XML parser
-               $xmlParser = xml_parser_create();
-
-               // Force case-folding to on
-               xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true);
+               // Get a XmlParser instance
+               $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
 
-               // Set object
-               xml_set_object($xmlParser, $this);
-
-               // Set handler call-backs
-               xml_set_element_handler($xmlParser, 'startElement', 'endElement');
-               xml_set_character_data_handler($xmlParser, 'characterHandler');
+               // Parse the XML document
+               $parserInstance->parseXmlContent($content);
+       }
 
-               // Now parse the XML tree
-               if (!xml_parse($xmlParser, $content)) {
-                       // Error found in XML!
-                       //die('<pre>'.htmlentities($content).'</pre>');
-                       throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR);
-               } // END - if
+       /**
+        * Enables or disables language support
+        *
+        * @param       $languageSupport        New language support setting
+        * @return      void
+        */
+       public final function enableLanguageSupport ($languageSupport = true) {
+               $this->languageSupport = (bool) $languageSupport;
+       }
 
-               // Free the parser
-               xml_parser_free($xmlParser);
+       /**
+        * Checks wether language support is enabled
+        *
+        * @return      $languageSupport        Wether language support is enabled or disabled
+        */
+       public final function isLanguageSupportEnabled () {
+               return $this->languageSupport;
        }
 }