class_BaseMailer.php

Go to the documentation of this file.

<?php
class BaseMailer extends BaseFrameworkSystem {
        private $recipientList = array();

        private $templateName = "";

        protected function __construct ($className) {
                // Call parent constructor
                parent::__construct($className);

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        protected final function loadTemplate ($templateName) {
                // Set template name
                $this->setTemplateName($templateName);

                // Get configuration entry
                $templatePrefix = $this->getConfigInstance()->readConfig('email_tpl_' . $templateName);

                // Load this email template
                $this->getTemplateInstance()->loadEmailTemplate($templatePrefix . '_' . $templateName);
        }

        public function addRecipientByUserInstance (ManageableMember $userInstance) {
                // Get template name
                $templateName = $this->getTemplateName();

                // Is the list initialized?
                if (!isset($this->recipientList[$templateName]['recipients'])) {
                        // Then initialize it here
                        $this->recipientList[$templateName]['recipients'] = array();
                } // END - if

                // Add it as a recipient
                $this->recipientList[$templateName]['recipients'][] = $userInstance;
        }

        private final function addTemplateVariable ($section, $variableName) {
                // Get template name
                $templateName = $this->getTemplateName();

                // Generate full section name
                $sectionName = $section . '_vars';

                // Is the list initialized?
                if (!isset($this->recipientList[$templateName][$sectionName])) {
                        // Then initialize it here
                        $this->recipientList[$templateName][$sectionName] = array();
                } // END - if

                // Add the variable to the list
                $this->recipientList[$templateName][$sectionName][$variableName] = 'OK';
        }

        public final function addConfigTemplateVariable ($variableName) {
                $this->addTemplateVariable("config", $variableName);
        }

        public final function addValueTemplateVariable ($variableName) {
                $this->addTemplateVariable("value", $variableName);
        }

        public final function addValueInstance ($variableName, FrameworkInterface $valueInstance) {
                $this->recipientList[$this->getTemplateName()]['values'][$variableName] = $valueInstance;
        }

        public final function setTemplateName ($templateName) {
                $this->templateName = (string) $templateName;
        }

        protected final function getTemplateName () {
                return $this->templateName;
        }

        public final function setSubjectLine ($subjectLine) {
                $this->recipientList[$this->getTemplateName()]['subject'] = (string) $subjectLine;
        }

        public final function getSubjectLine () {
                // Default subject is null
                $subjectLine = null;

                // Get template name
                $templateName = $this->getTemplateName();

                // Does the subject line exist?
                if ((!empty($templateName)) && (isset($this->recipientList[$templateName]['subject']))) {
                        // Then use it
                        $subjectLine = $this->recipientList[$templateName]['subject'];
                } // END - if

                // Return it
                return $subjectLine;
        }

        public function useSubjectFromTemplate () {
                // Set the subject line
                $this->setSubjectLine("{?subject?}");
        }

        public final function getRecipientList () {
                return $this->recipientList;
        }
}

// [EOF]
?>