3 * A general mailer class for all other mailers
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class BaseMailer extends BaseFrameworkSystem {
26 * Iterateable list of recipients
28 private $recipientList = array();
33 private $templateName = "";
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
46 $this->removeNumberFormaters();
47 $this->removeSystemArray();
51 * Loads a text or HTML template depending on configuration into the template engine
53 * @param $templateName Name of the template we shall load
56 protected final function loadTemplate ($templateName) {
58 $this->setTemplateName($templateName);
60 // Get configuration entry
61 $templatePrefix = $this->getConfigInstance()->readConfig('email_tpl_' . $templateName);
63 // Load this email template
64 $this->getTemplateInstance()->loadEmailTemplate($templatePrefix . '_' . $templateName);
68 * Adds a user class to the recipient list for current template
70 * @param $userInstance An instance of a user class
73 public function addRecipientByUserInstance (ManageableMember $userInstance) {
75 $templateName = $this->getTemplateName();
77 // Is the list initialized?
78 if (!isset($this->recipientList[$templateName]['recipients'])) {
79 // Then initialize it here
80 $this->recipientList[$templateName]['recipients'] = array();
83 // Add it as a recipient
84 $this->recipientList[$templateName]['recipients'][] = $userInstance;
88 * Adds a template variable (just the name) to the recipient list in given section of current template
90 * @param $section Section can be "config" or "value" currently
91 * @param $variableName Template variable name to add
94 private final function addTemplateVariable ($section, $variableName) {
96 $templateName = $this->getTemplateName();
98 // Generate full section name
99 $sectionName = $section . '_vars';
101 // Is the list initialized?
102 if (!isset($this->recipientList[$templateName][$sectionName])) {
103 // Then initialize it here
104 $this->recipientList[$templateName][$sectionName] = array();
107 // Add the variable to the list
108 $this->recipientList[$templateName][$sectionName][$variableName] = 'OK';
112 * Adds a config template variable to the recipient list of current template
114 * @param $variableName Template variable name to add
117 public final function addConfigTemplateVariable ($variableName) {
118 $this->addTemplateVariable("config", $variableName);
122 * Adds a "value" template variable to the recipient list of current template
124 * @param $variableName Template variable name to add
127 public final function addValueTemplateVariable ($variableName) {
128 $this->addTemplateVariable("value", $variableName);
132 * Adds a value instance for a given variable name. It should be set!
134 * @param $variableName Template variable we want to assign a value instance
135 * @param $valueInstance An object instance which can provide "field values"
138 public final function addValueInstance ($variableName, FrameworkInterface $valueInstance) {
139 $this->recipientList[$this->getTemplateName()]['values'][$variableName] = $valueInstance;
143 * Protected setter for template name
145 * @param $templateName Name of email template
148 public final function setTemplateName ($templateName) {
149 $this->templateName = (string) $templateName;
153 * Protected getter for template name
155 * @return $templateName Name of email template
157 protected final function getTemplateName () {
158 return $this->templateName;
162 * Setter for subject line
164 * @param $subjectLine Subject line to set
167 public final function setSubjectLine ($subjectLine) {
168 $this->recipientList[$this->getTemplateName()]['subject'] = (string) $subjectLine;
172 * Getter for subject line or null if not found
174 * @return $subjectLine Subject line to set
176 public final function getSubjectLine () {
177 // Default subject is null
181 $templateName = $this->getTemplateName();
183 // Does the subject line exist?
184 if ((!empty($templateName)) && (isset($this->recipientList[$templateName]['subject']))) {
186 $subjectLine = $this->recipientList[$templateName]['subject'];
194 * Use subject line provided by the (XML) template otherwise a subject line must be set
198 public function useSubjectFromTemplate () {
199 // Set the subject line
200 $this->setSubjectLine("{?subject?}");
204 * Getter for recipient list array
206 * @return $recipientList Array with reciepients
208 public final function getRecipientList () {
209 return $this->recipientList;