3 namespace CoreFramework\Template\Engine;
5 // Import framework stuff
6 use CoreFramework\Mailer\DeliverableMail;
7 use CoreFramework\Parser\Xml\XmlParser;
8 use CoreFramework\Registry\Registry;
9 use CoreFramework\Response\Responseable;
10 use CoreFramework\Template\CompileableTemplate;
13 use \UnexpectedValueException;
16 * The own template engine for loading caching and sending out images
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
23 * @todo This template engine does not make use of setTemplateType()
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class MailTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
40 * Main nodes in the XML tree
42 private $mainNodes = array(
47 * Sub nodes in the XML tree
49 private $subNodes = array(
59 private $mailerInstance = NULL;
64 private $currMainNode = '';
67 * Protected constructor
71 protected function __construct () {
72 // Call parent constructor
73 parent::__construct(__CLASS__);
77 * Creates an instance of the class TemplateEngine and prepares it for usage
79 * @return $templateInstance An instance of TemplateEngine
80 * @throws UnexpectedValueException If the provided $templateBasePath is empty or no string
81 * @throws InvalidDirectoryException If $templateBasePath is no
82 * directory or not found
83 * @throws BasePathReadProtectedException If $templateBasePath is
86 public static final function createMailTemplateEngine () {
88 $templateInstance = new MailTemplateEngine();
90 // Get the application instance from registry
91 $applicationInstance = Registry::getRegistry()->getInstance('app');
93 // Determine base path
94 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
96 // Is the base path valid?
97 if (empty($templateBasePath)) {
99 throw new UnexpectedValueException(sprintf('[%s:%d] Variable templateBasePath is empty.', $templateInstance->__toString(), __LINE__), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
100 } elseif (!is_string($templateBasePath)) {
102 throw new UnexpectedValueException(sprintf('[%s:%d] %s is not a string with a base path.', $templateInstance->__toString(), __LINE__, $templateBasePath), self::EXCEPTION_INVALID_STRING);
103 } elseif (!is_dir($templateBasePath)) {
105 throw new InvalidDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
106 } elseif (!is_readable($templateBasePath)) {
108 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
112 $templateInstance->setTemplateBasePath($templateBasePath);
114 // Set template extensions
115 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
116 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
118 // Absolute output path for compiled templates
119 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
121 // Return the prepared instance
122 return $templateInstance;
126 * Getter for current main node
128 * @return $currMainNode Current main node
130 public final function getCurrMainNode () {
131 return $this->currMainNode;
135 * Getter for main node array
137 * @return $mainNodes Array with valid main node names
139 public final function getMainNodes () {
140 return $this->mainNodes;
144 * Getter for sub node array
146 * @return $subNodes Array with valid sub node names
148 public final function getSubNodes () {
149 return $this->subNodes;
153 * Handles the start element of an XML resource
155 * @param $resource XML parser resource (currently ignored)
156 * @param $element The element we shall handle
157 * @param $attributes All attributes
159 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
161 public function startElement ($resource, $element, array $attributes) {
162 // Initial method name which will never be called...
163 $methodName = 'initEmail';
165 // Make the element name lower-case
166 $element = strtolower($element);
168 // Is the element a main node?
169 //* DEBUG: */ echo "START: >".$element."<<br />\n";
170 if (in_array($element, $this->getMainNodes())) {
171 // Okay, main node found!
172 $methodName = 'setEmail' . self::convertToClassName($element);
173 } elseif (in_array($element, $this->getSubNodes())) {
175 $methodName = 'setEmailProperty' . self::convertToClassName($element);
176 } elseif ($element != 'text-mail') {
177 // Invalid node name found
178 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
182 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
183 call_user_func_array(array($this, $methodName), $attributes);
187 * Ends the main or sub node by sending out the gathered data
189 * @param $resource An XML resource pointer (currently ignored)
190 * @param $nodeName Name of the node we want to finish
192 * @throws XmlNodeMismatchException If current main node mismatches the closing one
194 public function finishElement ($resource, $nodeName) {
195 // Make all lower-case
196 $nodeName = strtolower($nodeName);
198 // Does this match with current main node?
199 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
200 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
202 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
203 } elseif (in_array($nodeName, $this->getSubNodes())) {
204 // Silently ignore sub nodes
208 // Construct method name
209 $methodName = 'finish' . self::convertToClassName($nodeName);
211 // Call the corresponding method
212 call_user_func_array(array($this, $methodName), array());
216 * Adds the message text to the template engine
218 * @param $resource XML parser resource (currently ignored)
219 * @param $characters Characters to handle
222 public function characterHandler ($resource, $characters) {
223 // Trim all spaces away
224 $characters = trim($characters);
226 // Is this string empty?
227 if (empty($characters)) {
228 // Then skip it silently
232 // Add the message now
233 $this->assignVariable('message', $characters);
237 * Intializes the mail
240 * @todo Add cache creation here
242 private function initEmail () {
247 * Setter for mail data node
250 * @todo Should we call back the mailer class here?
252 private function setEmailMailData () {
253 // Set current main node
254 $this->currMainNode = 'mail-data';
258 * Setter for sender address property
260 * @param $senderAddress Sender address to set in email
263 private function setEmailPropertySenderAddress ($senderAddress) {
264 // Set the template variable
265 $this->assignVariable('sender', $senderAddress);
269 * Setter for recipient address property
271 * @param $recipientAddress Recipient address to set in email
274 private function setEmailPropertyRecipientAddress ($recipientAddress) {
275 // Set the template variable
276 $this->assignVariable('recipient', $recipientAddress);
280 * Setter for subject line property
284 private function setEmailPropertySubjectLine () {
289 * Method stub to avoid output
293 private function setEmailPropertyMessage () {
298 * Gets the template variable "message", stores it back as raw template data
299 * and compiles all variables so the mail message got prepared for output
303 private function finishMailData () {
304 // Get the message and set it as new raw template data back
305 $message = $this->readVariable('message');
306 $this->setRawTemplateData($message);
308 // Get some variables to compile
309 //$sender = $this->compileRawCode($this->readVariable('sender'));
310 //$this->assignVariable('sender', $sender);
312 // Then compile all variables
313 $this->compileVariables();
317 * Invokes the final mail process
321 private function finishTextMail () {
322 $this->getMailerInstance()->invokeMailDelivery();
326 * Getter for image cache file (FQFN)
328 * @return $fqfn Full-qualified file name of the image cache
331 public function getMailCacheFqfn () {
334 $this->debugBackTrace('Unfinished area!');
341 * Setter for mailer instance
343 * @param $mailerInstance A mailer instance
346 public final function setMailerInstance (DeliverableMail $mailerInstance) {
347 $this->mailerInstance = $mailerInstance;
351 * Getter for mailer instance
353 * @return $mailerInstance A mailer instance
355 protected final function getMailerInstance () {
356 return $this->mailerInstance;
360 * Outputs the mail to the world. This should only the mailer debug class do!
362 * @param $responseInstance An instance of a Responseable class
365 public function transferToResponse (Responseable $responseInstance) {
366 $responseInstance->writeToBody($this->getCompiledData());