/**
* The own template engine for loading caching and sending out images
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
+ * @todo This template engine does not make use of setTemplateType()
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* Main nodes in the XML tree
*/
- private $mainNodes = array("mail-data");
+ private $mainNodes = array(
+ 'mail-data'
+ );
/**
* Sub nodes in the XML tree
*/
- private $subNodes = array("subject-line", "sender-address", "recipient-address", "message");
+ private $subNodes = array(
+ 'subject-line',
+ 'sender-address',
+ 'recipient-address',
+ 'message'
+ );
/**
* Mailer instance
*/
- private $mailerInstance = null;
+ private $mailerInstance = NULL;
/**
* Current main node
*/
- private $currMainNode = "";
+ private $currMainNode = '';
/**
* Protected constructor
/**
* Creates an instance of the class TemplateEngine and prepares it for usage
*
- * @param $basePath The local base path for all templates
- * @param $langInstance An instance of LanguageSystem (default)
- * @param $ioInstance An instance of FileIoHandler (default, middleware!)
- * @return $tplInstance An instance of TemplateEngine
- * @throws BasePathIsEmptyException If the provided $basePath is empty
- * @throws InvalidBasePathStringException If $basePath is no string
- * @throws BasePathIsNoDirectoryException If $basePath is no
+ * @return $templateInstance An instance of TemplateEngine
+ * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
+ * @throws InvalidBasePathStringException If $templateBasePath is no string
+ * @throws BasePathIsNoDirectoryException If $templateBasePath is no
* directory or not found
- * @throws BasePathReadProtectedException If $basePath is
+ * @throws BasePathReadProtectedException If $templateBasePath is
* read-protected
*/
- public final static function createMailTemplateEngine ($basePath, ManageableLanguage $langInstance, FileIoHandler $ioInstance) {
+ public static final function createMailTemplateEngine () {
// Get a new instance
- $tplInstance = new MailTemplateEngine();
+ $templateInstance = new MailTemplateEngine();
+
+ // Get the application instance from registry
+ $applicationInstance = Registry::getRegistry()->getInstance('app');
+
+ // Determine base path
+ $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
// Is the base path valid?
- if (empty($basePath)) {
+ if (empty($templateBasePath)) {
// Base path is empty
- throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } elseif (!is_string($basePath)) {
+ throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+ } elseif (!is_string($templateBasePath)) {
// Is not a string
- throw new InvalidBasePathStringException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_STRING);
- } elseif (!is_dir($basePath)) {
+ throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
+ } elseif (!is_dir($templateBasePath)) {
// Is not a path
- throw new BasePathIsNoDirectoryException(array($tplInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
- } elseif (!is_readable($basePath)) {
+ throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
+ } elseif (!is_readable($templateBasePath)) {
// Is not readable
- throw new BasePathReadProtectedException(array($tplInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
+ throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
}
- // Get configuration instance
- $cfgInstance = FrameworkConfiguration::getInstance();
-
// Set the base path
- $tplInstance->setBasePath($basePath);
-
- // Set the language and IO instances
- $tplInstance->setLanguageInstance($langInstance);
- $tplInstance->setFileIoInstance($ioInstance);
+ $templateInstance->setTemplateBasePath($templateBasePath);
// Set template extensions
- $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
- $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
+ $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
+ $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('code_template_extension'));
// Absolute output path for compiled templates
- $tplInstance->setCompileOutputPath($cfgInstance->readConfig('base_path') . $cfgInstance->readConfig('compile_output_path'));
+ $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
// Return the prepared instance
- return $tplInstance;
+ return $templateInstance;
}
/**
* @return void
* @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
*/
- protected function startElement ($resource, $element, array $attributes) {
+ public function startElement ($resource, $element, array $attributes) {
// Initial method name which will never be called...
$methodName = 'initEmail';
$methodName = 'setEmailProperty' . $this->convertToClassName($element);
} elseif ($element != 'text-mail') {
// Invalid node name found
- throw new InvalidXmlNodeException(array($this, $element, $attributes), BaseHelper::EXCEPTION_XML_NODE_UNKNOWN);
+ throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
}
// Call method
* @return void
* @throws XmlNodeMismatchException If current main node mismatches the closing one
*/
- protected function endElement ($resource, $nodeName) {
+ public function finishElement ($resource, $nodeName) {
// Make all lower-case
$nodeName = strtolower($nodeName);
//* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
// Did not match!
- throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), BaseHelper::EXCEPTION_XML_NODE_MISMATCH);
+ throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
} elseif (in_array($nodeName, $this->getSubNodes())) {
// Silently ignore sub nodes
return;
* @param $characters Characters to handle
* @return void
*/
- protected function characterHandler ($resource, $characters) {
+ public function characterHandler ($resource, $characters) {
// Trim all spaces away
$characters = trim($characters);
// Is this string empty?
if (empty($characters)) {
// Then skip it silently
- return false;
+ return;
} // END - if
// Add the message now
/**
* Setter for subject line property
*
- * @param $subjectLine Subject line to set in email
* @return void
*/
- private function setEmailPropertySubjectLine ($subjectLine) {
- // Set the template variable
- $this->assignVariable('subject', $subjectLine);
+ private function setEmailPropertySubjectLine () {
+ // Empty for now
}
/**
*/
public function getMailCacheFqfn () {
// Initialize FQFN
- $fqfn = "";
- $this->debugBackTrace();
+ $fqfn = '';
+ $this->debugBackTrace('Unfinished area!');
// Return it
return $fqfn;
projects / core.git / blobdiff