3 * A mailer class for debugging purposes only. This class will print the
4 * prepared mail out and will not send it to the recipient.
6 * @author Roland Haeder <webmaster@shipsimu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.shipsimu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class DebugMailer extends BaseMailer implements DeliverableMail {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
37 * Creates an instance of this mailer class
39 * @param $templateInstance A template instance
40 * @param $applicationInstance An application helper class
41 * @param $templateName Name of email template to set
42 * @return $mailerInstance An instance of this mailer class
44 public static final function createDebugMailer (CompileableTemplate $templateInstance, ManageableApplication $applicationInstance, $templateName) {
46 $mailerInstance = new DebugMailer();
48 // Set template instance
49 $mailerInstance->setTemplateInstance($templateInstance);
51 // Set application instance
52 $mailerInstance->setApplicationInstance($applicationInstance);
55 $mailerInstance->setTemplateName('resend_link');
57 // Return the instance
58 return $mailerInstance;
62 * Deliver email to the recipient(s)
65 * @throws InvalidInterfaceException If the recipient instance does not implement ManageableMember
67 public function deliverEmail () {
68 // Get template instance
69 $templateInstance = $this->getTemplateInstance();
71 // "Deliver" all emails
72 foreach ($this->getRecipientList() as $templateName => $recipientList) {
73 // Walk through all recipients and "sent", or better print, it out
74 foreach ($recipientList['recipients'] as $recipientInstance) {
75 // The recipient should be a user instance, right?
76 if (!$recipientInstance instanceof ManageableMember) {
77 // Invalid entry found!
78 throw new InvalidInterfaceException(array($this, 'ManageableMember'), self::EXCEPTION_REQUIRED_INTERFACE_MISSING);
81 // User class found, so entry is valid, first load the template
82 $this->loadTemplate($templateName);
85 $templateInstance->assignVariable('subject', $this->getSubjectLine());
87 // Walk through all variables, first config to assign them
88 foreach ($recipientList['config_vars'] as $variable => $dummy) {
89 // Load the config value and set it
90 $templateInstance->assignConfigVariable($variable);
93 // Now do the same with the values but ask the "value instance" instead!
94 foreach ($recipientList['value_vars'] as $variable => $dummy) {
95 // Is the value instance there?
96 if (!isset($recipientList['values'][$variable])) {
98 throw new NullPointerException ($this, self::EXCEPTION_IS_NULL_POINTER);
101 // Get the field from the value instance
102 $fieldValue = $recipientList['values'][$variable]->getField($variable);
104 // Set it in template engine
105 $templateInstance->assignVariable($variable, $fieldValue);
108 // Render the content
109 $templateInstance->renderXmlContent();
111 // Get responce instance
112 $responseInstance = $this->getApplicationInstance()->getResponseInstance();
114 // Transfer the data to the response
115 $this->getTemplateInstance()->transferToResponse($responseInstance);
121 * Send notification to the admin
126 public function sendAdminNotification () {
131 * Invokes the mail delivery process which will prepare the output of the message in a code template
135 public function invokeMailDelivery () {
136 // Get template instance
137 $templateInstance = $this->getTemplateInstance();
139 // Get the compiled message and set it as new template variable
140 $message = $templateInstance->getCompiledData();
141 $templateInstance->assignVariable('message', $message);
143 // Load the code template
144 $templateInstance->loadCodeTemplate('mail_debug');
146 // Compile the template
147 $templateInstance->compileTemplate();
149 // Assign this template with variable
150 $templateInstance->assignTemplateWithVariable('mail_debug', 'content');
152 // Load header template
153 $templateInstance->loadCodeTemplate('header');
155 // Compile and assign it with a variable
156 $templateInstance->compileTemplate();
157 $templateInstance->assignTemplateWithVariable('header', 'header');
159 // Load footer template
160 $templateInstance->loadCodeTemplate('footer');
162 // Compile and assign it with a variable
163 $templateInstance->compileTemplate();
164 $templateInstance->assignTemplateWithVariable('footer', 'footer');
166 // Load the master template
167 $templateInstance->loadCodeTemplate($this->getApplicationInstance()->buildMasterTemplateName());
169 // Then compile it again
170 $templateInstance->compileVariables();