class_MailTemplateEngine.php

Go to the documentation of this file.

<?php
class MailTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
        private $mainNodes = array("mail-data");

        private $subNodes = array("subject-line", "sender-address", "recipient-address", "message");

        private $mailerInstance = null;

        private $currMainNode = "";

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
        }

        public final static function createMailTemplateEngine ($basePath, ManageableLanguage  $langInstance, FileIoHandler $ioInstance) {
                // Get a new instance
                $tplInstance = new MailTemplateEngine();

                // Is the base path valid?
                if (empty($basePath)) {
                        // Base path is empty
                        throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif (!is_string($basePath)) {
                        // Is not a string
                        throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
                } elseif (!is_dir($basePath)) {
                        // Is not a path
                        throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
                } elseif (!is_readable($basePath)) {
                        // Is not readable
                        throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
                }

                // Get configuration instance
                $cfgInstance = FrameworkConfiguration::getInstance();

                // Set the base path
                $tplInstance->setBasePath($basePath);

                // Set the language and IO instances
                $tplInstance->setLanguageInstance($langInstance);
                $tplInstance->setFileIoInstance($ioInstance);

                // Set template extensions
                $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
                $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));

                // Absolute output path for compiled templates
                $tplInstance->setCompileOutputPath($cfgInstance->readConfig('base_path') . $cfgInstance->readConfig('compile_output_path'));

                // Return the prepared instance
                return $tplInstance;
        }

        public final function getCurrMainNode () {
                return $this->currMainNode;
        }

        public final function getMainNodes () {
                return $this->mainNodes;
        }

        public final function getSubNodes () {
                return $this->subNodes;
        }

        protected function startElement ($resource, $element, array $attributes) {
                // Initial method name which will never be called...
                $methodName = 'initEmail';

                // Make the element name lower-case
                $element = strtolower($element);

                // Is the element a main node?
                //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
                if (in_array($element, $this->getMainNodes())) {
                        // Okay, main node found!
                        $methodName = 'setEmail' . $this->convertToClassName($element);
                } elseif (in_array($element, $this->getSubNodes())) {
                        // Sub node found
                        $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);
                }

                // Call method
                //* DEBUG: */ echo "call: ".$methodName."<br />\n";
                call_user_func_array(array($this, $methodName), $attributes);
        }

        protected function endElement ($resource, $nodeName) {
                // Make all lower-case
                $nodeName = strtolower($nodeName);

                // Does this match with current main node?
                //* 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);
                } elseif (in_array($nodeName, $this->getSubNodes())) {
                        // Silently ignore sub nodes
                        return;
                }

                // Construct method name
                $methodName = 'finish' . $this->convertToClassName($nodeName);

                // Call the corresponding method
                call_user_func_array(array($this, $methodName), array());
        }

        protected function characterHandler ($resource, $characters) {
                // Trim all spaces away
                $characters = trim($characters);

                // Is this string empty?
                if (empty($characters)) {
                        // Then skip it silently
                        return false;
                } // END - if

                // Add the message now
                $this->assignVariable('message', $characters);
        }

        private function initEmail () {
                // Unfinished work!
        }

        private function setEmailMailData () {
                // Set current main node
                $this->currMainNode = 'mail-data';
        }

        private function setEmailPropertySenderAddress ($senderAddress) {
                // Set the template variable
                $this->assignVariable('sender', $senderAddress);
        }

        private function setEmailPropertyRecipientAddress ($recipientAddress) {
                // Set the template variable
                $this->assignVariable('recipient', $recipientAddress);
        }

        private function setEmailPropertySubjectLine ($subjectLine) {
                // Set the template variable
                $this->assignVariable('subject', $subjectLine);
        }

        private function setEmailPropertyMessage () {
                // Empty for now
        }

        private function finishMailData () {
                // Get the message and set it as new raw template data back
                $message = $this->readVariable('message');
                $this->setRawTemplateData($message);

                // Get some variables to compile
                //$sender = $this->compileRawCode($this->readVariable('sender'));
                //$this->assignVariable('sender', $sender);

                // Then compile all variables
                $this->compileVariables();
        }

        private function finishTextMail () {
                $this->getMailerInstance()->invokeMailDelivery();
        }

        public function getMailCacheFqfn () {
                // Initialize FQFN
                $fqfn = "";
                $this->debugBackTrace();

                // Return it
                return $fqfn;
        }

        public final function setMailerInstance (DeliverableMail $mailerInstance) {
                $this->mailerInstance = $mailerInstance;
        }

        protected final function getMailerInstance () {
                return $this->mailerInstance;
        }

        public function transferToResponse (Responseable $responseInstance) {
                $responseInstance->writeToBody($this->getCompiledData());
        }
}

// [EOF]
?>