3 namespace CoreFramework\Template\Engine;
5 // Import framework stuff
6 use CoreFramework\Registry\Registry;
7 use CoreFramework\Response\Responseable;
8 use CoreFramework\Template\CompileableTemplate;
11 * The own template engine for loading caching and sending out images
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
18 * @todo This template engine does not make use of setTemplateType()
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class MailTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
35 * Main nodes in the XML tree
37 private $mainNodes = array(
42 * Sub nodes in the XML tree
44 private $subNodes = array(
54 private $mailerInstance = NULL;
59 private $currMainNode = '';
62 * Protected constructor
66 protected function __construct () {
67 // Call parent constructor
68 parent::__construct(__CLASS__);
72 * Creates an instance of the class TemplateEngine and prepares it for usage
74 * @return $templateInstance An instance of TemplateEngine
75 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
76 * @throws InvalidBasePathStringException If $templateBasePath is no string
77 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
78 * directory or not found
79 * @throws BasePathReadProtectedException If $templateBasePath is
82 public static final function createMailTemplateEngine () {
84 $templateInstance = new MailTemplateEngine();
86 // Get the application instance from registry
87 $applicationInstance = Registry::getRegistry()->getInstance('app');
89 // Determine base path
90 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
92 // Is the base path valid?
93 if (empty($templateBasePath)) {
95 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
96 } elseif (!is_string($templateBasePath)) {
98 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
99 } elseif (!is_dir($templateBasePath)) {
101 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
102 } elseif (!is_readable($templateBasePath)) {
104 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
108 $templateInstance->setTemplateBasePath($templateBasePath);
110 // Set template extensions
111 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
112 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
114 // Absolute output path for compiled templates
115 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
117 // Return the prepared instance
118 return $templateInstance;
122 * Getter for current main node
124 * @return $currMainNode Current main node
126 public final function getCurrMainNode () {
127 return $this->currMainNode;
131 * Getter for main node array
133 * @return $mainNodes Array with valid main node names
135 public final function getMainNodes () {
136 return $this->mainNodes;
140 * Getter for sub node array
142 * @return $subNodes Array with valid sub node names
144 public final function getSubNodes () {
145 return $this->subNodes;
149 * Handles the start element of an XML resource
151 * @param $resource XML parser resource (currently ignored)
152 * @param $element The element we shall handle
153 * @param $attributes All attributes
155 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
157 public function startElement ($resource, $element, array $attributes) {
158 // Initial method name which will never be called...
159 $methodName = 'initEmail';
161 // Make the element name lower-case
162 $element = strtolower($element);
164 // Is the element a main node?
165 //* DEBUG: */ echo "START: >".$element."<<br />\n";
166 if (in_array($element, $this->getMainNodes())) {
167 // Okay, main node found!
168 $methodName = 'setEmail' . self::convertToClassName($element);
169 } elseif (in_array($element, $this->getSubNodes())) {
171 $methodName = 'setEmailProperty' . self::convertToClassName($element);
172 } elseif ($element != 'text-mail') {
173 // Invalid node name found
174 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
178 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
179 call_user_func_array(array($this, $methodName), $attributes);
183 * Ends the main or sub node by sending out the gathered data
185 * @param $resource An XML resource pointer (currently ignored)
186 * @param $nodeName Name of the node we want to finish
188 * @throws XmlNodeMismatchException If current main node mismatches the closing one
190 public function finishElement ($resource, $nodeName) {
191 // Make all lower-case
192 $nodeName = strtolower($nodeName);
194 // Does this match with current main node?
195 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
196 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
198 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
199 } elseif (in_array($nodeName, $this->getSubNodes())) {
200 // Silently ignore sub nodes
204 // Construct method name
205 $methodName = 'finish' . self::convertToClassName($nodeName);
207 // Call the corresponding method
208 call_user_func_array(array($this, $methodName), array());
212 * Adds the message text to the template engine
214 * @param $resource XML parser resource (currently ignored)
215 * @param $characters Characters to handle
218 public function characterHandler ($resource, $characters) {
219 // Trim all spaces away
220 $characters = trim($characters);
222 // Is this string empty?
223 if (empty($characters)) {
224 // Then skip it silently
228 // Add the message now
229 $this->assignVariable('message', $characters);
233 * Intializes the mail
236 * @todo Add cache creation here
238 private function initEmail () {
243 * Setter for mail data node
246 * @todo Should we call back the mailer class here?
248 private function setEmailMailData () {
249 // Set current main node
250 $this->currMainNode = 'mail-data';
254 * Setter for sender address property
256 * @param $senderAddress Sender address to set in email
259 private function setEmailPropertySenderAddress ($senderAddress) {
260 // Set the template variable
261 $this->assignVariable('sender', $senderAddress);
265 * Setter for recipient address property
267 * @param $recipientAddress Recipient address to set in email
270 private function setEmailPropertyRecipientAddress ($recipientAddress) {
271 // Set the template variable
272 $this->assignVariable('recipient', $recipientAddress);
276 * Setter for subject line property
280 private function setEmailPropertySubjectLine () {
285 * Method stub to avoid output
289 private function setEmailPropertyMessage () {
294 * Gets the template variable "message", stores it back as raw template data
295 * and compiles all variables so the mail message got prepared for output
299 private function finishMailData () {
300 // Get the message and set it as new raw template data back
301 $message = $this->readVariable('message');
302 $this->setRawTemplateData($message);
304 // Get some variables to compile
305 //$sender = $this->compileRawCode($this->readVariable('sender'));
306 //$this->assignVariable('sender', $sender);
308 // Then compile all variables
309 $this->compileVariables();
313 * Invokes the final mail process
317 private function finishTextMail () {
318 $this->getMailerInstance()->invokeMailDelivery();
322 * Getter for image cache file (FQFN)
324 * @return $fqfn Full-qualified file name of the image cache
327 public function getMailCacheFqfn () {
330 $this->debugBackTrace('Unfinished area!');
337 * Setter for mailer instance
339 * @param $mailerInstance A mailer instance
342 public final function setMailerInstance (DeliverableMail $mailerInstance) {
343 $this->mailerInstance = $mailerInstance;
347 * Getter for mailer instance
349 * @return $mailerInstance A mailer instance
351 protected final function getMailerInstance () {
352 return $this->mailerInstance;
356 * Outputs the mail to the world. This should only the mailer debug class do!
358 * @param $responseInstance An instance of a Responseable class
361 public function transferToResponse (Responseable $responseInstance) {
362 $responseInstance->writeToBody($this->getCompiledData());