* @param $templateBasePath The relative base path for all templates
* @return void
*/
- public final function setTemplateBasePath ($templateBasePath) {
+ protected final function setTemplateBasePath ($templateBasePath) {
// And set it
$this->templateBasePath = (string) $templateBasePath;
}
* templates
* @return void
*/
- public final function setRawTemplateExtension ($templateExtension) {
+ protected final function setRawTemplateExtension ($templateExtension) {
// And set it
$this->templateExtension = (string) $templateExtension;
}
* templates
* @return void
*/
- public final function setCodeTemplateExtension ($codeExtension) {
+ protected final function setCodeTemplateExtension ($codeExtension) {
// And set it
$this->codeExtension = (string) $codeExtension;
}
* templates
* @return void
*/
- public final function setCompileOutputPath ($compileOutputPath) {
+ protected final function setCompileOutputPath ($compileOutputPath) {
// And set it
$this->compileOutputPath = (string) $compileOutputPath;
}
}
/**
- * Getter for compiled templates
+ * Getter for compiled templates, must be public for e.g. Mailer classes.
*
* @return $compiledData Compiled template data
*/
* @param $template The template we shall load
* @param $extOther An other extension to use
* @return void
- * @throws FileIoException If the template was not found
+ * @throws FileNotFoundException If the template was not found
*/
protected function loadTemplate ($template, $extOther = '') {
// Get extension for the template if empty
try {
// Load the raw template data
$this->loadRawTemplateData($fqfn);
- } catch (FileIoException $e) {
+ } catch (FileNotFoundException $e) {
// If we shall load a code-template we need to switch the file extension
- if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('web_template_type')) && (empty($extOther))) {
+ if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('html_template_type')) && (empty($extOther))) {
// Switch over to the code-template extension and try it again
$ext = $this->getCodeTemplateExtension();
$this->loadTemplate($template, $ext);
} else {
// Throw it again
- throw new FileIoException($fqfn, self::EXCEPTION_FILE_NOT_FOUND);
+ throw new FileNotFoundException($fqfn, self::EXCEPTION_FILE_NOT_FOUND);
}
}
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template);
// Template not found, but maybe variable assigned?
- if ($this->getVariableIndex($template, 'config') !== FALSE) {
- // Use that content here
- $this->loadedRawData[$template] = $this->readVariable($template, 'config');
-
- // Recursive protection:
- array_push($this->loadedTemplates, $template);
- } elseif ($this->getVariableIndex($template) !== FALSE) {
+ if ($this->getVariableIndex($template) !== FALSE) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template);
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
array_push($this->loadedTemplates, $template);
- } catch (FileIoException $e) {
+ } catch (FileNotFoundException $e) {
// Even this is not done... :/
array_push($this->rawTemplates, $template);
}
foreach ($this->rawTemplates as $key => $template) {
try {
// Load the template
- $this->loadWebTemplate($template);
+ $this->loadHtmlTemplate($template);
// Remember it's contents
$this->rawTemplates[$template] = $this->getRawTemplateData();
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
array_push($this->loadedTemplates, $template);
- } catch (FileIoException $e) {
+ } catch (FileNotFoundException $e) {
// This template was never found. We silently ignore it
unset($this->rawTemplates[$key]);
}
}
/**
- * Load a specified web template into the engine
+ * Load a specified HTML template into the engine
*
* @param $template The web template we shall load which is located in
* 'html' by default
* @return void
*/
- public function loadWebTemplate ($template) {
+ public function loadHtmlTemplate ($template) {
// Set template type
- $this->setTemplateType($this->getConfigInstance()->getConfigEntry('web_template_type'));
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('html_template_type'));
// Load the special template
$this->loadTemplate($template);
// Sweet and simple...
//* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
- $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
+ $this->assignVariable($variableName, $this->getConfigInstance()->getConfigEntry($variableName));
}
/**
- * Injects an array of config variables into the stack of currently loaded
- * template. This method should only be used in very rare circumstances,
- * e.g. when you have to copy a whole set of variables into the template
- * engine. Before you use this method, please make sure you have considered
- * all other possiblities.
+ * Assigns a lot variables into the stack of currently loaded template.
+ * This method should only be used in very rare circumstances, e.g. when
+ * you have to copy a whole set of variables into the template engine.
+ * Before you use this method, please make sure you have considered all
+ * other possiblities.
*
- * @param $variables An array with variables to be injected
+ * @param $variables An array with variables to be assigned
* @return void
*/
- public function injectConfigVariables (array $variables) {
+ public function assignMultipleVariables (array $variables) {
// "Inject" all
foreach ($variables as $name => $value) {
// Set variable with name for 'config' group
- $this->setVariable('config', $name, $value);
+ $this->assignVariable($name, $value);
} // END - foreach
}
$this->loadTemplate($template);
}
+ /**
+ * Load a specified email template into the engine
+ *
+ * @param $template The email template we shall load which is
+ * located in 'emails' by default
+ * @return void
+ */
+ public function loadEmailTemplate ($template) {
+ // Set template type
+ $this->setTemplateType($this->getConfigInstance()->getConfigEntry('email_template_type'));
+
+ // Load the special template
+ $this->loadTemplate($template);
+ }
+
/**
* Compiles configuration place-holders in all variables. This 'walks'
* through the variable group 'general'. It interprets all values from that
$this->assignConfigVariable($value);
} else {
// Re-assign the value directly
- $this->setVariable('config', $currVariable['name'], $value);
+ $this->assignVariable($currVariable['name'], $value);
}
} // END - foreach
}
// Get a XmlParser instance
$parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this));
- // Check if we have XML compacting enabled
+ // Check if XML compacting is enabled
if ($this->isXmlCompactingEnabled()) {
// Yes, so get a decorator class for transparent compacting
$parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', array($parserInstance));
projects / core.git / blobdiff