3 * The own template engine for loading caching and sending out images
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
10 * @todo This template engine does not make use of setTemplateType()
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 MailTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
27 * Main nodes in the XML tree
29 private $mainNodes = array(
34 * Sub nodes in the XML tree
36 private $subNodes = array(
46 private $mailerInstance = NULL;
51 private $currMainNode = '';
54 * Protected constructor
58 protected function __construct () {
59 // Call parent constructor
60 parent::__construct(__CLASS__);
64 * Creates an instance of the class TemplateEngine and prepares it for usage
66 * @return $templateInstance An instance of TemplateEngine
67 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
68 * @throws InvalidBasePathStringException If $templateBasePath is no string
69 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
70 * directory or not found
71 * @throws BasePathReadProtectedException If $templateBasePath is
74 public static final function createMailTemplateEngine () {
76 $templateInstance = new MailTemplateEngine();
78 // Get the application instance from registry
79 $applicationInstance = Registry::getRegistry()->getInstance('app');
81 // Determine base path
82 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
84 // Is the base path valid?
85 if (empty($templateBasePath)) {
87 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
88 } elseif (!is_string($templateBasePath)) {
90 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
91 } elseif (!is_dir($templateBasePath)) {
93 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
94 } elseif (!is_readable($templateBasePath)) {
96 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
100 $templateInstance->setTemplateBasePath($templateBasePath);
102 // Set template extensions
103 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
104 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
106 // Absolute output path for compiled templates
107 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
109 // Return the prepared instance
110 return $templateInstance;
114 * Getter for current main node
116 * @return $currMainNode Current main node
118 public final function getCurrMainNode () {
119 return $this->currMainNode;
123 * Getter for main node array
125 * @return $mainNodes Array with valid main node names
127 public final function getMainNodes () {
128 return $this->mainNodes;
132 * Getter for sub node array
134 * @return $subNodes Array with valid sub node names
136 public final function getSubNodes () {
137 return $this->subNodes;
141 * Handles the start element of an XML resource
143 * @param $resource XML parser resource (currently ignored)
144 * @param $element The element we shall handle
145 * @param $attributes All attributes
147 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
149 protected function startElement ($resource, $element, array $attributes) {
150 // Initial method name which will never be called...
151 $methodName = 'initEmail';
153 // Make the element name lower-case
154 $element = strtolower($element);
156 // Is the element a main node?
157 //* DEBUG: */ echo "START: >".$element."<<br />\n";
158 if (in_array($element, $this->getMainNodes())) {
159 // Okay, main node found!
160 $methodName = 'setEmail' . $this->convertToClassName($element);
161 } elseif (in_array($element, $this->getSubNodes())) {
163 $methodName = 'setEmailProperty' . $this->convertToClassName($element);
164 } elseif ($element != 'text-mail') {
165 // Invalid node name found
166 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
170 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
171 call_user_func_array(array($this, $methodName), $attributes);
175 * Ends the main or sub node by sending out the gathered data
177 * @param $resource An XML resource pointer (currently ignored)
178 * @param $nodeName Name of the node we want to finish
180 * @throws XmlNodeMismatchException If current main node mismatches the closing one
182 protected function finishElement ($resource, $nodeName) {
183 // Make all lower-case
184 $nodeName = strtolower($nodeName);
186 // Does this match with current main node?
187 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
188 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
190 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
191 } elseif (in_array($nodeName, $this->getSubNodes())) {
192 // Silently ignore sub nodes
196 // Construct method name
197 $methodName = 'finish' . $this->convertToClassName($nodeName);
199 // Call the corresponding method
200 call_user_func_array(array($this, $methodName), array());
204 * Adds the message text to the template engine
206 * @param $resource XML parser resource (currently ignored)
207 * @param $characters Characters to handle
210 protected function characterHandler ($resource, $characters) {
211 // Trim all spaces away
212 $characters = trim($characters);
214 // Is this string empty?
215 if (empty($characters)) {
216 // Then skip it silently
220 // Add the message now
221 $this->assignVariable('message', $characters);
225 * Intializes the mail
228 * @todo Add cache creation here
230 private function initEmail () {
235 * Setter for mail data node
238 * @todo Should we call back the mailer class here?
240 private function setEmailMailData () {
241 // Set current main node
242 $this->currMainNode = 'mail-data';
246 * Setter for sender address property
248 * @param $senderAddress Sender address to set in email
251 private function setEmailPropertySenderAddress ($senderAddress) {
252 // Set the template variable
253 $this->assignVariable('sender', $senderAddress);
257 * Setter for recipient address property
259 * @param $recipientAddress Recipient address to set in email
262 private function setEmailPropertyRecipientAddress ($recipientAddress) {
263 // Set the template variable
264 $this->assignVariable('recipient', $recipientAddress);
268 * Setter for subject line property
270 * @param $subjectLine Subject line to set in email
273 private function setEmailPropertySubjectLine ($subjectLine) {
274 // Set the template variable
275 $this->assignVariable('subject', $subjectLine);
279 * Method stub to avoid output
283 private function setEmailPropertyMessage () {
288 * Gets the template variable "message", stores it back as raw template data
289 * and compiles all variables so the mail message got prepared for output
293 private function finishMailData () {
294 // Get the message and set it as new raw template data back
295 $message = $this->readVariable('message');
296 $this->setRawTemplateData($message);
298 // Get some variables to compile
299 //$sender = $this->compileRawCode($this->readVariable('sender'));
300 //$this->assignVariable('sender', $sender);
302 // Then compile all variables
303 $this->compileVariables();
307 * Invokes the final mail process
311 private function finishTextMail () {
312 $this->getMailerInstance()->invokeMailDelivery();
316 * Getter for image cache file (FQFN)
318 * @return $fqfn Full-qualified file name of the image cache
321 public function getMailCacheFqfn () {
324 $this->debugBackTrace('Unfinished area!');
331 * Setter for mailer instance
333 * @param $mailerInstance A mailer instance
336 public final function setMailerInstance (DeliverableMail $mailerInstance) {
337 $this->mailerInstance = $mailerInstance;
341 * Getter for mailer instance
343 * @return $mailerInstance A mailer instance
345 protected final function getMailerInstance () {
346 return $this->mailerInstance;
350 * Outputs the mail to the world. This should only the mailer debug class do!
352 * @param $responseInstance An instance of a Responseable class
355 public function transferToResponse (Responseable $responseInstance) {
356 $responseInstance->writeToBody($this->getCompiledData());