All XML-parsing-related stuff refactured to new XmlParser class

[core.git] / inc / classes / main / template / mail / class_MailTemplateEngine.php

diff --git a/inc/classes/main/template/mail/class_MailTemplateEngine.php b/inc/classes/main/template/mail/class_MailTemplateEngine.php
index 241e24fe44fa492a9b7f04a2a9c664a96faaf521..1d39894b2b8b97ef3442ad097019ad9008a45a4a 100644 (file)
--- a/inc/classes/main/template/mail/class_MailTemplateEngine.php
+++ b/inc/classes/main/template/mail/class_MailTemplateEngine.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -30,7 +30,12 @@ class MailTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Sub nodes in the XML tree
         */
-       private $subNodes = array("subject-line", "sender-address", "recipient-address", "message");
+       private $subNodes = array(
+               'subject-line',
+               'sender-address',
+               'recipient-address',
+               'message'
+       );
 
        /**
         * Mailer instance
@@ -55,52 +60,57 @@ class MailTemplateEngine extends BaseTemplateEngine implements CompileableTempla
        /**
         * Creates an instance of the class TemplateEngine and prepares it for usage
         *
-        * @param       $basePath               The local base path for all templates
-        * @param       $langInstance   An instance of LanguageSystem (default)
-        * @param       $ioInstance             An instance of FileIoHandler (default, middleware!)
+        * @param       $appInstance    A manageable application
         * @return      $tplInstance    An instance of TemplateEngine
-        * @throws      BasePathIsEmptyException                If the provided $basePath is empty
-        * @throws      InvalidBasePathStringException  If $basePath is no string
-        * @throws      BasePathIsNoDirectoryException  If $basePath is no
+        * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
+        * @throws      InvalidBasePathStringException  If $templateBasePath is no string
+        * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
         *                                                                                      directory or not found
-        * @throws      BasePathReadProtectedException  If $basePath is
+        * @throws      BasePathReadProtectedException  If $templateBasePath is
         *                                                                                      read-protected
         */
-       public final static function createMailTemplateEngine ($basePath, ManageableLanguage  $langInstance, FileIoHandler $ioInstance) {
+       public final static function createMailTemplateEngine (ManageableApplication $appInstance) {
                // Get a new instance
                $tplInstance = new MailTemplateEngine();
 
+               // Get language and file I/O instances from application
+               $langInstance = $appInstance->getLanguageInstance();
+               $ioInstance = $appInstance->getFileIoInstance();
+
+               // Determine base path
+               $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
+
                // Is the base path valid?
-               if (empty($basePath)) {
+               if (empty($templateBasePath)) {
                        // Base path is empty
                        throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif (!is_string($basePath)) {
+               } elseif (!is_string($templateBasePath)) {
                        // Is not a string
-                       throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
-               } elseif (!is_dir($basePath)) {
+                       throw new InvalidBasePathStringException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
+               } elseif (!is_dir($templateBasePath)) {
                        // Is not a path
-                       throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
-               } elseif (!is_readable($basePath)) {
+                       throw new BasePathIsNoDirectoryException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
+               } elseif (!is_readable($templateBasePath)) {
                        // Is not readable
-                       throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
+                       throw new BasePathReadProtectedException(array($tplInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
                }
 
                // Get configuration instance
                $configInstance = FrameworkConfiguration::getInstance();
 
                // Set the base path
-               $tplInstance->setBasePath($basePath);
+               $tplInstance->setTemplateBasePath($templateBasePath);
 
                // Set the language and IO instances
                $tplInstance->setLanguageInstance($langInstance);
                $tplInstance->setFileIoInstance($ioInstance);
 
                // Set template extensions
-               $tplInstance->setRawTemplateExtension($configInstance->readConfig('raw_template_extension'));
-               $tplInstance->setCodeTemplateExtension($configInstance->readConfig('code_template_extension'));
+               $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
+               $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('code_template_extension'));
 
                // Absolute output path for compiled templates
-               $tplInstance->setCompileOutputPath($configInstance->readConfig('base_path') . $configInstance->readConfig('compile_output_path'));
+               $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
 
                // Return the prepared instance
                return $tplInstance;
@@ -159,7 +169,7 @@ class MailTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                        $methodName = 'setEmailProperty' . $this->convertToClassName($element);
                } elseif ($element != 'text-mail') {
                        // Invalid node name found
-                       throw new InvalidXmlNodeException(array($this, $element, $attributes), BaseHelper::EXCEPTION_XML_NODE_UNKNOWN);
+                       throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
                }
 
                // Call method
@@ -183,7 +193,7 @@ class MailTemplateEngine extends BaseTemplateEngine implements CompileableTempla
                //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
                if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
                        // Did not match!
-                       throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), BaseHelper::EXCEPTION_XML_NODE_MISMATCH);
+                       throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
                } elseif (in_array($nodeName, $this->getSubNodes())) {
                        // Silently ignore sub nodes
                        return;