inc/classes/main/mailer/class_BaseMailer.php

   1 <?php
   2 /**
   3  * A general mailer class for all other mailers
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseMailer extends BaseFrameworkSystem {
  25         /**
  26          * Iterateable list of recipients
  27          */
  28         private $recipientList = array();
  29
  30         /**
  31          * Template name
  32          */
  33         private $templateName = '';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Loads a text or HTML template depending on configuration into the template engine
  48          *
  49          * @param       $templateName   Name of the template we shall load
  50          * @return      void
  51          */
  52         protected final function loadTemplate ($templateName) {
  53                 // Set template name
  54                 $this->setTemplateName($templateName);
  55
  56                 // Get configuration entry
  57                 $templatePrefix = $this->getConfigInstance()->getConfigEntry('email_tpl_' . $templateName);
  58
  59                 // Load this email template
  60                 $this->getTemplateInstance()->loadEmailTemplate($templatePrefix . '_' . $templateName);
  61         }
  62
  63         /**
  64          * Adds a user class to the recipient list for current template
  65          *
  66          * @param       $userInstance   An instance of a user class
  67          * @return      void
  68          */
  69         public function addRecipientByUserInstance (ManageableMember $userInstance) {
  70                 // Get template name
  71                 $templateName = $this->getTemplateName();
  72
  73                 // Is the list initialized?
  74                 if (!isset($this->recipientList[$templateName]['recipients'])) {
  75                         // Then initialize it here
  76                         $this->recipientList[$templateName]['recipients'] = array();
  77                 } // END - if
  78
  79                 // Add it as a recipient
  80                 $this->recipientList[$templateName]['recipients'][] = $userInstance;
  81         }
  82
  83         /**
  84          * Adds a template variable (just the name) to the recipient list in given section of current template
  85          *
  86          * @param       $section                Section can be "config" or "value" currently
  87          * @param       $variableName   Template variable name to add
  88          * @return      void
  89          */
  90         private final function addTemplateVariable ($section, $variableName) {
  91                 // Get template name
  92                 $templateName = $this->getTemplateName();
  93
  94                 // Generate full section name
  95                 $sectionName = $section . '_vars';
  96
  97                 // Is the list initialized?
  98                 if (!isset($this->recipientList[$templateName][$sectionName])) {
  99                         // Then initialize it here
 100                         $this->recipientList[$templateName][$sectionName] = array();
 101                 } // END - if
 102
 103                 // Add the variable to the list
 104                 $this->recipientList[$templateName][$sectionName][$variableName] = 'OK';
 105         }
 106
 107         /**
 108          * Adds a config template variable to the recipient list of current template
 109          *
 110          * @param       $variableName   Template variable name to add
 111          * @return      void
 112          */
 113         public final function addConfigTemplateVariable ($variableName) {
 114                 $this->addTemplateVariable("config", $variableName);
 115         }
 116
 117         /**
 118          * Adds a "value" template variable to the recipient list of current template
 119          *
 120          * @param       $variableName   Template variable name to add
 121          * @return      void
 122          */
 123         public final function addValueTemplateVariable ($variableName) {
 124                 $this->addTemplateVariable("value", $variableName);
 125         }
 126
 127         /**
 128          * Adds a value instance for a given variable name. It should be set!
 129          *
 130          * @param       $variableName   Template variable we want to assign a value instance
 131          * @param       $valueInstance  An object instance which can provide "field values"
 132          * @return      void
 133          */
 134         public final function addValueInstance ($variableName, FrameworkInterface $valueInstance) {
 135                 $this->recipientList[$this->getTemplateName()]['values'][$variableName] = $valueInstance;
 136         }
 137
 138         /**
 139          * Protected setter for template name
 140          *
 141          * @param       $templateName   Name of email template
 142          * @return      void
 143          */
 144         public final function setTemplateName ($templateName) {
 145                 $this->templateName = (string) $templateName;
 146         }
 147
 148         /**
 149          * Protected getter for template name
 150          *
 151          * @return      $templateName   Name of email template
 152          */
 153         protected final function getTemplateName () {
 154                 return $this->templateName;
 155         }
 156
 157         /**
 158          * Setter for subject line
 159          *
 160          * @param       $subjectLine    Subject line to set
 161          * @return      void
 162          */
 163         public final function setSubjectLine ($subjectLine) {
 164                 $this->recipientList[$this->getTemplateName()]['subject'] = (string) $subjectLine;
 165         }
 166
 167         /**
 168          * Getter for subject line or null if not found
 169          *
 170          * @return      $subjectLine    Subject line to set
 171          */
 172         public final function getSubjectLine () {
 173                 // Default subject is null
 174                 $subjectLine = null;
 175
 176                 // Get template name
 177                 $templateName = $this->getTemplateName();
 178
 179                 // Does the subject line exist?
 180                 if ((!empty($templateName)) && (isset($this->recipientList[$templateName]['subject']))) {
 181                         // Then use it
 182                         $subjectLine = $this->recipientList[$templateName]['subject'];
 183                 } // END - if
 184
 185                 // Return it
 186                 return $subjectLine;
 187         }
 188
 189         /**
 190          * Use subject line provided by the (XML) template otherwise a subject line must be set
 191          *
 192          * @return      void
 193          */
 194         public function useSubjectFromTemplate () {
 195                 // Set the subject line
 196                 $this->setSubjectLine("{?subject?}");
 197         }
 198
 199         /**
 200          * Getter for recipient list array
 201          *
 202          * @return      $recipientList  Array with reciepients
 203          */
 204         public final function getRecipientList () {
 205                 return $this->recipientList;
 206         }
 207 }
 208
 209 // [EOF]
 210 ?>