*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
/**
* Main nodes in the XML tree ('image' is ignored)
*/
- private $mainNodes = array("base", "type", "resolution", "background-color", "foreground-color", "image-string");
+ private $mainNodes = array(
+ 'base',
+ 'type',
+ 'resolution',
+ 'background-color',
+ 'foreground-color',
+ 'image-string'
+ );
/**
* Sub nodes in the XML tree
*/
- private $subNodes = array("name", "string-name", "x", "y", "font-size", "width", "height", "red", "green", "blue", "text");
+ private $subNodes = array(
+ 'name',
+ 'string-name',
+ 'x',
+ 'y',
+ 'font-size',
+ 'width',
+ 'height',
+ 'red',
+ 'green',
+ 'blue',
+ 'text'
+ );
/**
* Image instance
/**
* 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!)
+ * @param $appInstance A manageable application
* @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
+ * @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 createImageTemplateEngine ($basePath, ManageableLanguage $langInstance, FileIoHandler $ioInstance) {
+ public final static function createImageTemplateEngine (ManageableApplication $appInstance) {
// Get a new instance
- $tplInstance = new ImageTemplateEngine();
+ $templateInstance = new ImageTemplateEngine();
+
+ // Get language and file I/O instances from application
+ $langInstance = $appInstance->getLanguageInstance();
+ $ioInstance = $appInstance->getFileIoInstance();
+
+ // Determine base path
+ $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->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();
+ $configInstance = FrameworkConfiguration::getInstance();
// Set the base path
- $tplInstance->setBasePath($basePath);
+ $templateInstance->setTemplateBasePath($templateBasePath);
// Set the language and IO instances
- $tplInstance->setLanguageInstance($langInstance);
- $tplInstance->setFileIoInstance($ioInstance);
+ $templateInstance->setLanguageInstance($langInstance);
+ $templateInstance->setFileIoInstance($ioInstance);
// Set template extensions
- $tplInstance->setRawTemplateExtension($cfgInstance->readConfig('raw_template_extension'));
- $tplInstance->setCodeTemplateExtension($cfgInstance->readConfig('code_template_extension'));
+ $templateInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
+ $templateInstance->setCodeTemplateExtension($configInstance->getConfigEntry('code_template_extension'));
// Absolute output path for compiled templates
- $tplInstance->setCompileOutputPath($cfgInstance->readConfig('base_path') . $cfgInstance->readConfig('compile_output_path'));
+ $templateInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
// Return the prepared instance
- return $tplInstance;
+ return $templateInstance;
}
/**
$methodName = 'setImageProperty' . $this->convertToClassName($element);
} elseif ($element != 'image') {
// 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
//* 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;
*/
public function getImageCacheFqfn () {
// Get the FQFN ready
- $fqfn = $this->getBasePath().'_cache/' . md5($this->imageInstance->getImageName().":".$this->__toString().":".$this->imageInstance->__toString()) . "." . $this->imageInstance->getImageType();
+ $fqfn = sprintf("%s%s%s/%s.%s",
+ $this->getConfigInstance()->getConfigEntry('base_path'),
+ $this->getGenericBasePath(),
+ 'images/_cache',
+ md5(
+ $this->imageInstance->getImageName().':'.$this->__toString().':'.$this->imageInstance->__toString()
+ ),
+ $this->imageInstance->getImageType()
+ );
// Return it
return $fqfn;
// Set the image instance
$responseInstance->setImageInstance($this->imageInstance);
}
+
+ /**
+ * Load a specified image template into the engine
+ *
+ * @param $template The image template we shall load which is
+ * located in 'image' by default
+ * @return void
+ */
+ public function loadImageTemplate ($template) {
+ // Set template type
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('image_template_type'));
+
+ // Load the special template
+ $this->loadTemplate($template);
+ }
}
// [EOF]
projects / core.git / blobdiff