3 * The own template engine for loading caching and sending out images
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 * @param $appInstance A manageable application
67 * @return $templateInstance An instance of TemplateEngine
68 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
69 * @throws InvalidBasePathStringException If $templateBasePath is no string
70 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
71 * directory or not found
72 * @throws BasePathReadProtectedException If $templateBasePath is
75 public static final function createMailTemplateEngine (ManageableApplication $appInstance) {
77 $templateInstance = new MailTemplateEngine();
79 // Determine base path
80 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
82 // Is the base path valid?
83 if (empty($templateBasePath)) {
85 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
86 } elseif (!is_string($templateBasePath)) {
88 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
89 } elseif (!is_dir($templateBasePath)) {
91 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
92 } elseif (!is_readable($templateBasePath)) {
94 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
98 $templateInstance->setTemplateBasePath($templateBasePath);
100 // Set template extensions
101 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
102 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
104 // Absolute output path for compiled templates
105 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
107 // Return the prepared instance
108 return $templateInstance;
112 * Getter for current main node
114 * @return $currMainNode Current main node
116 public final function getCurrMainNode () {
117 return $this->currMainNode;
121 * Getter for main node array
123 * @return $mainNodes Array with valid main node names
125 public final function getMainNodes () {
126 return $this->mainNodes;
130 * Getter for sub node array
132 * @return $subNodes Array with valid sub node names
134 public final function getSubNodes () {
135 return $this->subNodes;
139 * Handles the start element of an XML resource
141 * @param $resource XML parser resource (currently ignored)
142 * @param $element The element we shall handle
143 * @param $attributes All attributes
145 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
147 protected function startElement ($resource, $element, array $attributes) {
148 // Initial method name which will never be called...
149 $methodName = 'initEmail';
151 // Make the element name lower-case
152 $element = strtolower($element);
154 // Is the element a main node?
155 //* DEBUG: */ echo "START: >".$element."<<br />\n";
156 if (in_array($element, $this->getMainNodes())) {
157 // Okay, main node found!
158 $methodName = 'setEmail' . $this->convertToClassName($element);
159 } elseif (in_array($element, $this->getSubNodes())) {
161 $methodName = 'setEmailProperty' . $this->convertToClassName($element);
162 } elseif ($element != 'text-mail') {
163 // Invalid node name found
164 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
168 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
169 call_user_func_array(array($this, $methodName), $attributes);
173 * Ends the main or sub node by sending out the gathered data
175 * @param $resource An XML resource pointer (currently ignored)
176 * @param $nodeName Name of the node we want to finish
178 * @throws XmlNodeMismatchException If current main node mismatches the closing one
180 protected function endElement ($resource, $nodeName) {
181 // Make all lower-case
182 $nodeName = strtolower($nodeName);
184 // Does this match with current main node?
185 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
186 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
188 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
189 } elseif (in_array($nodeName, $this->getSubNodes())) {
190 // Silently ignore sub nodes
194 // Construct method name
195 $methodName = 'finish' . $this->convertToClassName($nodeName);
197 // Call the corresponding method
198 call_user_func_array(array($this, $methodName), array());
202 * Adds the message text to the template engine
204 * @param $resource XML parser resource (currently ignored)
205 * @param $characters Characters to handle
208 protected function characterHandler ($resource, $characters) {
209 // Trim all spaces away
210 $characters = trim($characters);
212 // Is this string empty?
213 if (empty($characters)) {
214 // Then skip it silently
218 // Add the message now
219 $this->assignVariable('message', $characters);
223 * Intializes the mail
226 * @todo Add cache creation here
228 private function initEmail () {
233 * Setter for mail data node
236 * @todo Should we call back the mailer class here?
238 private function setEmailMailData () {
239 // Set current main node
240 $this->currMainNode = 'mail-data';
244 * Setter for sender address property
246 * @param $senderAddress Sender address to set in email
249 private function setEmailPropertySenderAddress ($senderAddress) {
250 // Set the template variable
251 $this->assignVariable('sender', $senderAddress);
255 * Setter for recipient address property
257 * @param $recipientAddress Recipient address to set in email
260 private function setEmailPropertyRecipientAddress ($recipientAddress) {
261 // Set the template variable
262 $this->assignVariable('recipient', $recipientAddress);
266 * Setter for subject line property
268 * @param $subjectLine Subject line to set in email
271 private function setEmailPropertySubjectLine ($subjectLine) {
272 // Set the template variable
273 $this->assignVariable('subject', $subjectLine);
277 * Method stub to avoid output
281 private function setEmailPropertyMessage () {
286 * Gets the template variable "message", stores it back as raw template data
287 * and compiles all variables so the mail message got prepared for output
291 private function finishMailData () {
292 // Get the message and set it as new raw template data back
293 $message = $this->readVariable('message');
294 $this->setRawTemplateData($message);
296 // Get some variables to compile
297 //$sender = $this->compileRawCode($this->readVariable('sender'));
298 //$this->assignVariable('sender', $sender);
300 // Then compile all variables
301 $this->compileVariables();
305 * Invokes the final mail process
309 private function finishTextMail () {
310 $this->getMailerInstance()->invokeMailDelivery();
314 * Getter for image cache file (FQFN)
316 * @return $fqfn Full-qualified file name of the image cache
319 public function getMailCacheFqfn () {
322 $this->debugBackTrace();
329 * Setter for mailer instance
331 * @param $mailerInstance A mailer instance
334 public final function setMailerInstance (DeliverableMail $mailerInstance) {
335 $this->mailerInstance = $mailerInstance;
339 * Getter for mailer instance
341 * @return $mailerInstance A mailer instance
343 protected final function getMailerInstance () {
344 return $this->mailerInstance;
348 * Outputs the mail to the world. This should only the mailer debug class do!
350 * @param $responseInstance An instance of a Responseable class
353 public function transferToResponse (Responseable $responseInstance) {
354 $responseInstance->writeToBody($this->getCompiledData());