Introduced FileNotFoundException
[core.git] / inc / classes / main / template / class_BaseTemplateEngine.php
index 306867ff7b12ec71077acd39767934e6578a853c..68511ad143380df67820e706012fa5178d4a1edf 100644 (file)
@@ -124,7 +124,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * All template groups except "general"
         */
-       private $varGroups = array();
+       private $variableGroups = array();
 
        /**
         * Code begin
@@ -327,7 +327,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
 
                // Skip group 'general'
                if (($groupName != 'general') && ($add === TRUE)) {
-                       $this->varGroups[$groupName] = 'OK';
+                       $this->variableGroups[$groupName] = 'OK';
                } // END - if
        }
 
@@ -359,13 +359,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * Getter for variable value, throws a NoVariableException if the variable is not found
         *
-        * @param       $varGroup       Variable group to use
+        * @param       $variableGroup  Variable group to use
         * @param       $index          Index in variable array
         * @return      $value          Value to set
         */
-       private function getVariableValue ($varGroup, $index) {
+       private function getVariableValue ($variableGroup, $index) {
                // Return it
-               return $this->varStack[$varGroup][$index]['value'];
+               return $this->varStack[$variableGroup][$index]['value'];
        }
 
        /**
@@ -396,13 +396,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * Sets a variable value for given variable group and index
         *
-        * @param       $varGroup       Variable group to use
+        * @param       $variableGroup  Variable group to use
         * @param       $index          Index in variable array
         * @param       $value          Value to set
         * @return      void
         */
-       private function setVariableValue ($varGroup, $index, $value) {
-               $this->varStack[$varGroup][$index]['value'] = $value;
+       private function setVariableValue ($variableGroup, $index, $value) {
+               $this->varStack[$variableGroup][$index]['value'] = $value;
        }
 
        /**
@@ -410,12 +410,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * variable is already set. If so, the variable got modified, otherwise
         * added.
         *
-        * @param       $varGroup               Variable group to use
+        * @param       $variableGroup          Variable group to use
         * @param       $variableName   Variable to set
         * @param       $value                  Value to set
         * @return      void
         */
-       protected function setVariable ($varGroup, $variableName, $value) {
+       protected function setVariable ($variableGroup, $variableName, $value) {
                // Replace all dashes to underscores to match variables with configuration entries
                $variableName = trim($this->convertDashesToUnderscores($variableName));
 
@@ -425,13 +425,13 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                // Is the variable set?
                if ($index === FALSE) {
                        // Is the stack there?
-                       if (!isset($this->varStack[$varGroup])) {
+                       if (!isset($this->varStack[$variableGroup])) {
                                // Then initialize it here
-                               $this->varStack[$varGroup] = array();
+                               $this->varStack[$variableGroup] = array();
                        } // END - if
 
                        // Not found, add it
-                       array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value));
+                       array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value));
                } else {
                        // Then modify it
                        $this->setVariableValue($this->currGroup, $index, $value);
@@ -505,7 +505,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * @param               $templateBasePath               The relative base path for all templates
         * @return      void
         */
-       public final function setTemplateBasePath ($templateBasePath) {
+       protected final function setTemplateBasePath ($templateBasePath) {
                // And set it
                $this->templateBasePath = (string) $templateBasePath;
        }
@@ -537,7 +537,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         *                                                      templates
         * @return      void
         */
-       public final function setRawTemplateExtension ($templateExtension) {
+       protected final function setRawTemplateExtension ($templateExtension) {
                // And set it
                $this->templateExtension = (string) $templateExtension;
        }
@@ -549,7 +549,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         *                                                      templates
         * @return      void
         */
-       public final function setCodeTemplateExtension ($codeExtension) {
+       protected final function setCodeTemplateExtension ($codeExtension) {
                // And set it
                $this->codeExtension = (string) $codeExtension;
        }
@@ -583,7 +583,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         *                                                              templates
         * @return      void
         */
-       public final function setCompileOutputPath ($compileOutputPath) {
+       protected final function setCompileOutputPath ($compileOutputPath) {
                // And set it
                $this->compileOutputPath = (string) $compileOutputPath;
        }
@@ -647,7 +647,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
-        * Getter for compiled templates
+        * Getter for compiled templates, must be public for e.g. Mailer classes.
         *
         * @return      $compiledData   Compiled template data
         */
@@ -702,9 +702,9 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                try {
                        // Load the raw template data
                        $this->loadRawTemplateData($fqfn);
-               } catch (FileIoException $e) {
+               } catch (FileNotFoundException $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))) {
+                       if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('html_template_type')) && (empty($extOther))) {
                                // Switch over to the code-template extension and try it again
                                $ext = $this->getCodeTemplateExtension();
 
@@ -712,7 +712,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                $this->loadTemplate($template, $ext);
                        } else {
                                // Throw it again
-                               throw new FileIoException($fqfn, FrameworkFileInputPointer::EXCEPTION_FILE_NOT_FOUND);
+                               throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_FOUND);
                        }
                }
 
@@ -742,25 +742,25 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
         * Try to assign an extracted template variable as a "content" or 'config'
         * variable.
         *
-        * @param       $varName                The variable's name (shall be content or config)
+        * @param       $variableName           The variable's name (shall be content or config)
         *                                                      by default
         * @param       $variableName   The variable we want to assign
         * @return      void
         */
-       private function assignTemplateVariable ($varName, $var) {
+       private function assignTemplateVariable ($variableName, $var) {
                // Replace all dashes to underscores to match variables with configuration entries
                $variableName = trim($this->convertDashesToUnderscores($variableName));
 
                // Debug message
-               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: varName=' . $varName . ',variableName=' . $variableName);
+               //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',variableName=' . $variableName);
 
                // Is it not a config variable?
-               if ($varName != 'config') {
+               if ($variableName != 'config') {
                        // Regular template variables
                        $this->assignVariable($variableName, '');
                } else {
                        // Configuration variables
-                       $this->assignConfigVariable($variableName);
+                       $this->assignConfigVariable($var);
                }
        }
 
@@ -785,12 +785,12 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        // Initialize all missing variables
                        foreach ($variableMatches[3] as $key => $var) {
                                // Variable name
-                               $varName = $variableMatches[1][$key];
+                               $variableName = $variableMatches[1][$key];
 
                                // Workarround: Do not assign empty variables
                                if (!empty($var)) {
                                        // Try to assign it, empty strings are being ignored
-                                       $this->assignTemplateVariable($varName, $var);
+                                       $this->assignTemplateVariable($variableName, $var);
                                } // END - if
                        } // END - foreach
                } // END - if
@@ -830,13 +830,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template);
 
                                // Template not found, but maybe variable assigned?
-                               if ($this->getVariableIndex($template, 'config') !== FALSE) {
-                                       // Use that content here
-                                       $this->loadedRawData[$template] = $this->readVariable($template, 'config');
-
-                                       // Recursive protection:
-                                       array_push($this->loadedTemplates, $template);
-                               } elseif ($this->getVariableIndex($template) !== FALSE) {
+                               if ($this->getVariableIndex($template) !== FALSE) {
                                        // Use that content here
                                        $this->loadedRawData[$template] = $this->readVariable($template);
 
@@ -852,7 +846,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                                // Remember this template for recursion detection
                                                // RECURSIVE PROTECTION!
                                                array_push($this->loadedTemplates, $template);
-                                       } catch (FileIoException $e) {
+                                       } catch (FileNotFoundException $e) {
                                                // Even this is not done... :/
                                                array_push($this->rawTemplates, $template);
                                        }
@@ -940,7 +934,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                        foreach ($this->rawTemplates as $key => $template) {
                                try {
                                        // Load the template
-                                       $this->loadWebTemplate($template);
+                                       $this->loadHtmlTemplate($template);
 
                                        // Remember it's contents
                                        $this->rawTemplates[$template] = $this->getRawTemplateData();
@@ -951,7 +945,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                        // Remember this template for recursion detection
                                        // RECURSIVE PROTECTION!
                                        array_push($this->loadedTemplates, $template);
-                               } catch (FileIoException $e) {
+                               } catch (FileNotFoundException $e) {
                                        // This template was never found. We silently ignore it
                                        unset($this->rawTemplates[$key]);
                                }
@@ -1092,15 +1086,15 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        }
 
        /**
-        * Load a specified web template into the engine
+        * Load a specified HTML template into the engine
         *
         * @param       $template       The web template we shall load which is located in
         *                                              'html' by default
         * @return      void
         */
-       public function loadWebTemplate ($template) {
+       public function loadHtmlTemplate ($template) {
                // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
+               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('html_template_type'));
 
                // Load the special template
                $this->loadTemplate($template);
@@ -1188,24 +1182,24 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
 
                // Sweet and simple...
                //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
-               $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
+               $this->assignVariable($variableName, $this->getConfigInstance()->getConfigEntry($variableName));
        }
 
        /**
-        * Injects an array of config variables into the stack of currently loaded
-        * template. This method should only be used in very rare circumstances,
-        * e.g. when you have to copy a whole set of variables into the template
-        * engine. Before you use this method, please make sure you have considered
-        * all other possiblities.
+        * Assigns a lot variables into the stack of currently loaded template.
+        * This method should only be used in very rare circumstances, e.g. when
+        * you have to copy a whole set of variables into the template engine.
+        * Before you use this method, please make sure you have considered all
+        * other possiblities.
         *
-        * @param       $variables      An array with variables to be injected
+        * @param       $variables      An array with variables to be assigned
         * @return      void
         */
-       public function injectConfigVariables (array $variables) {
+       public function assignMultipleVariables (array $variables) {
                // "Inject" all
                foreach ($variables as $name => $value) {
                        // Set variable with name for 'config' group
-                       $this->setVariable('config', $name, $value);
+                       $this->assignVariable($name, $value);
                } // END - foreach
        }
 
@@ -1244,6 +1238,21 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                $this->loadTemplate($template);
        }
 
+       /**
+        * Load a specified email template into the engine
+        *
+        * @param       $template       The email template we shall load which is
+        *                                              located in 'emails' by default
+        * @return      void
+        */
+       public function loadEmailTemplate ($template) {
+               // Set template type
+               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('email_template_type'));
+
+               // Load the special template
+               $this->loadTemplate($template);
+       }
+
        /**
         * Compiles configuration place-holders in all variables. This 'walks'
         * through the variable group 'general'. It interprets all values from that
@@ -1277,7 +1286,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                                $this->assignConfigVariable($value);
                        } else {
                                // Re-assign the value directly
-                               $this->setVariable('config', $currVariable['name'], $value);
+                               $this->assignVariable($currVariable['name'], $value);
                        }
                } // END - foreach
        }
@@ -1508,10 +1517,10 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
        /**
         * Getter for variable group array
         *
-        * @return      $vargroups      All variable groups
+        * @return      $variableGroups All variable groups
         */
        public final function getVariableGroups () {
-               return $this->varGroups;
+               return $this->variableGroups;
        }
 
        /**
@@ -1550,7 +1559,7 @@ class BaseTemplateEngine extends BaseFrameworkSystem {
                // Get a XmlParser instance
                $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
 
-               // Check if we have XML compacting enabled
+               // Check if XML compacting is enabled
                if ($this->isXmlCompactingEnabled()) {
                        // Yes, so get a decorator class for transparent compacting
                        $parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));