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 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 final static function createMailTemplateEngine (ManageableApplication $appInstance) {
77 $templateInstance = new MailTemplateEngine();
79 // Get language and file I/O instances from application
80 $langInstance = $appInstance->getLanguageInstance();
81 $ioInstance = $appInstance->getFileIoInstance();
83 // Determine base path
84 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
86 // Is the base path valid?
87 if (empty($templateBasePath)) {
89 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
90 } elseif (!is_string($templateBasePath)) {
92 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
93 } elseif (!is_dir($templateBasePath)) {
95 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
96 } elseif (!is_readable($templateBasePath)) {
98 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
101 // Get configuration instance
102 $configInstance = FrameworkConfiguration::getInstance();
105 $templateInstance->setTemplateBasePath($templateBasePath);
107 // Set the language and IO instances
108 $templateInstance->setLanguageInstance($langInstance);
109 $templateInstance->setFileIoInstance($ioInstance);
111 // Set template extensions
112 $templateInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
113 $templateInstance->setCodeTemplateExtension($configInstance->getConfigEntry('code_template_extension'));
115 // Absolute output path for compiled templates
116 $templateInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
118 // Return the prepared instance
119 return $templateInstance;
123 * Getter for current main node
125 * @return $currMainNode Current main node
127 public final function getCurrMainNode () {
128 return $this->currMainNode;
132 * Getter for main node array
134 * @return $mainNodes Array with valid main node names
136 public final function getMainNodes () {
137 return $this->mainNodes;
141 * Getter for sub node array
143 * @return $subNodes Array with valid sub node names
145 public final function getSubNodes () {
146 return $this->subNodes;
150 * Handles the start element of an XML resource
152 * @param $resource XML parser resource (currently ignored)
153 * @param $element The element we shall handle
154 * @param $attributes All attributes
156 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
158 protected function startElement ($resource, $element, array $attributes) {
159 // Initial method name which will never be called...
160 $methodName = 'initEmail';
162 // Make the element name lower-case
163 $element = strtolower($element);
165 // Is the element a main node?
166 //* DEBUG: */ echo "START: >".$element."<<br />\n";
167 if (in_array($element, $this->getMainNodes())) {
168 // Okay, main node found!
169 $methodName = 'setEmail' . $this->convertToClassName($element);
170 } elseif (in_array($element, $this->getSubNodes())) {
172 $methodName = 'setEmailProperty' . $this->convertToClassName($element);
173 } elseif ($element != 'text-mail') {
174 // Invalid node name found
175 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
179 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
180 call_user_func_array(array($this, $methodName), $attributes);
184 * Ends the main or sub node by sending out the gathered data
186 * @param $resource An XML resource pointer (currently ignored)
187 * @param $nodeName Name of the node we want to finish
189 * @throws XmlNodeMismatchException If current main node mismatches the closing one
191 protected function endElement ($resource, $nodeName) {
192 // Make all lower-case
193 $nodeName = strtolower($nodeName);
195 // Does this match with current main node?
196 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
197 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
199 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
200 } elseif (in_array($nodeName, $this->getSubNodes())) {
201 // Silently ignore sub nodes
205 // Construct method name
206 $methodName = 'finish' . $this->convertToClassName($nodeName);
208 // Call the corresponding method
209 call_user_func_array(array($this, $methodName), array());
213 * Adds the message text to the template engine
215 * @param $resource XML parser resource (currently ignored)
216 * @param $characters Characters to handle
219 protected function characterHandler ($resource, $characters) {
220 // Trim all spaces away
221 $characters = trim($characters);
223 // Is this string empty?
224 if (empty($characters)) {
225 // Then skip it silently
229 // Add the message now
230 $this->assignVariable('message', $characters);
234 * Intializes the mail
237 * @todo Add cache creation here
239 private function initEmail () {
244 * Setter for mail data node
247 * @todo Should we call back the mailer class here?
249 private function setEmailMailData () {
250 // Set current main node
251 $this->currMainNode = 'mail-data';
255 * Setter for sender address property
257 * @param $senderAddress Sender address to set in email
260 private function setEmailPropertySenderAddress ($senderAddress) {
261 // Set the template variable
262 $this->assignVariable('sender', $senderAddress);
266 * Setter for recipient address property
268 * @param $recipientAddress Recipient address to set in email
271 private function setEmailPropertyRecipientAddress ($recipientAddress) {
272 // Set the template variable
273 $this->assignVariable('recipient', $recipientAddress);
277 * Setter for subject line property
279 * @param $subjectLine Subject line to set in email
282 private function setEmailPropertySubjectLine ($subjectLine) {
283 // Set the template variable
284 $this->assignVariable('subject', $subjectLine);
288 * Method stub to avoid output
292 private function setEmailPropertyMessage () {
297 * Gets the template variable "message", stores it back as raw template data
298 * and compiles all variables so the mail message got prepared for output
302 private function finishMailData () {
303 // Get the message and set it as new raw template data back
304 $message = $this->readVariable('message');
305 $this->setRawTemplateData($message);
307 // Get some variables to compile
308 //$sender = $this->compileRawCode($this->readVariable('sender'));
309 //$this->assignVariable('sender', $sender);
311 // Then compile all variables
312 $this->compileVariables();
316 * Invokes the final mail process
320 private function finishTextMail () {
321 $this->getMailerInstance()->invokeMailDelivery();
325 * Getter for image cache file (FQFN)
327 * @return $fqfn Full-qualified file name of the image cache
330 public function getMailCacheFqfn () {
333 $this->debugBackTrace();
340 * Setter for mailer instance
342 * @param $mailerInstance A mailer instance
345 public final function setMailerInstance (DeliverableMail $mailerInstance) {
346 $this->mailerInstance = $mailerInstance;
350 * Getter for mailer instance
352 * @return $mailerInstance A mailer instance
354 protected final function getMailerInstance () {
355 return $this->mailerInstance;
359 * Outputs the mail to the world. This should only the mailer debug class do!
361 * @param $responseInstance An instance of a Responseable class
364 public function transferToResponse (Responseable $responseInstance) {
365 $responseInstance->writeToBody($this->getCompiledData());