*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
private $varStack = array();
- /**
- * Configuration variables in a simple array
- */
- private $configVariables = array();
-
/**
* Loaded templates for recursive protection and detection
*/
/**
* Current variable group
*/
- private $currGroup = "general";
+ private $currGroup = 'general';
/**
* All template groups except "general"
private $varGroups = array();
// Exception codes for the template engine
- const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x200;
- const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x201;
- const EXCEPTION_INVALID_VIEW_HELPER = 0x202;
+ const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
+ const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
+ const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
/**
* Protected constructor
// Is the group there?
if (isset($this->varStack[$this->currGroup])) {
// Now search for it
- foreach ($this->varStack[$this->currGroup] as $idx=>$currEntry) {
+ foreach ($this->varStack[$this->currGroup] as $idx => $currEntry) {
+ //* DEBUG: */ echo __METHOD__.":currGroup={$this->currGroup},idx={$idx},currEntry={$currEntry['name']},var={$var}<br />\n";
// Is the entry found?
if ($currEntry['name'] == $var) {
// Found!
+ //* DEBUG: */ echo __METHOD__.":FOUND!<br />\n";
$found = $idx;
break;
} // END - if
* @param $var The variable we are looking for
* @return $content Content of the variable or null if not found
*/
- private function readVariable ($var) {
+ protected function readVariable ($var) {
// First everything is not found
$content = null;
*/
private function addVariable ($var, $value) {
// Set general variable group
- $this->setVariableGroup("general");
+ $this->setVariableGroup('general');
// Add it to the stack
$this->addGroupVariable($var, $value);
*
* @param $groupName Name of variable group
* @param $add Wether add this group
- * @return void
+ * @retur4n void
*/
public function setVariableGroup ($groupName, $add = true) {
// Set group name
//* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."<br />\n";
$this->currGroup = $groupName;
- // Skip group "general"
- if (($groupName != "general") && ($add === true)) {
- $this->varGroups[$groupName] = "OK";
+ // Skip group 'general'
+ if (($groupName != 'general') && ($add === true)) {
+ $this->varGroups[$groupName] = 'OK';
} // END - if
}
* @return void
*/
private final function setTemplateType ($templateType) {
- // Cast it
- $templateType = (string) $templateType;
-
- // And set it (only 2 letters)
- $this->templateType = $templateType;
+ $this->templateType = (string) $templateType;
}
/**
* @return void
*/
private final function setLastTemplate ($template) {
- // Cast it to string
- $template = (string) $template;
- $this->lastTemplate = $template;
+ $this->lastTemplate = (string) $template;
}
/**
* @return void
*/
public final function setBasePath ($basePath) {
- // Cast it
- $basePath = (string) $basePath;
-
// And set it
- $this->basePath = $basePath;
+ $this->basePath = (string) $basePath;
}
/**
* @return void
*/
public final function setRawTemplateExtension ($templateExtension) {
- // Cast it
- $templateExtension = (string) $templateExtension;
-
// And set it
- $this->templateExtension = $templateExtension;
+ $this->templateExtension = (string) $templateExtension;
}
/**
* @return void
*/
public final function setCodeTemplateExtension ($codeExtension) {
- // Cast it
- $codeExtension = (string) $codeExtension;
-
// And set it
- $this->codeExtension = $codeExtension;
+ $this->codeExtension = (string) $codeExtension;
}
/**
* @return void
*/
public final function setCompileOutputPath ($compileOutputPath) {
- // Cast it
- $compileOutputPath = (string) $compileOutputPath;
-
// And set it
- $this->compileOutputPath = $compileOutputPath;
+ $this->compileOutputPath = (string) $compileOutputPath;
}
/**
* @param $var The variable we are looking for
* @param $value The value we want to store in the variable
* @return void
+ * @throws EmptyVariableException If the variable name is left empty
*/
public final function assignVariable ($var, $value) {
+ // Trim spaces of variable name
+ $var = trim($var);
+
+ // Empty variable found?
+ if (empty($var)) {
+ // Throw an exception
+ throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+ } // END - if
+
// First search for the variable if it was already added
$idx = $this->isVariableAlreadySet($var);
// Was it found?
if ($idx === false) {
// Add it to the stack
+ //* DEBUG: */ echo "ADD: ".$var."<br />\n";
$this->addVariable($var, $value);
} elseif (!empty($value)) {
// Modify the stack entry
+ //* DEBUG: */ echo "MOD: ".$var."<br />\n";
$this->modifyVariable($var, $value);
}
}
* @param $rawTemplateData The raw data from the template
* @return void
*/
- private final function setRawTemplateData ($rawTemplateData) {
- // Cast it to string
- $rawTemplateData = (string) $rawTemplateData;
-
+ protected final function setRawTemplateData ($rawTemplateData) {
// And store it in this class
- $this->rawTemplateData = $rawTemplateData;
+ //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($rawTemplateData)." Bytes set.<br />\n";
+ //* DEBUG: */ echo $this->currGroup." variables: ".count($this->varStack[$this->currGroup]).", groups=".count($this->varStack)."<br />\n";
+ $this->rawTemplateData = (string) $rawTemplateData;
+ }
+
+ /**
+ * Getter for raw template data
+ *
+ * @return $rawTemplateData The raw data from the template
+ */
+ public final function getRawTemplateData () {
+ //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->rawTemplateData)." Bytes read.<br />\n";
+ return $this->rawTemplateData;
}
/**
* @return void
*/
private final function setCompiledData ($compiledData) {
- // Cast it to string
- $compiledData = (string) $compiledData;
-
// And store it in this class
- $this->compiledData = $compiledData;
+ //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($compiledData)." Bytes set.<br />\n";
+ $this->compiledData = (string) $compiledData;
+ }
+
+ /**
+ * Getter for compiled templates
+ *
+ * @return $compiledData Compiled template data
+ */
+ public final function getCompiledData () {
+ //* DEBUG: */ echo __METHOD__.":".$this->getUniqueId().": ".strlen($this->compiledData)." Bytes read.<br />\n";
+ return $this->compiledData;
}
/**
* @return void
*/
private function loadTemplate ($template) {
- // Cast it to string
- $template = (string) $template;
-
// Get extension for the template
$ext = $this->getRawTemplateExtension();
$this->getBasePath(),
$this->getLanguageInstance()->getLanguageCode(),
$this->getTemplateType(),
- $template,
+ (string) $template,
$ext
);
*
* @param $fqfn The full-qualified file name for a template
* @return void
- * @throws NullPointerException If $inputInstance is null
- * @throws NoObjectException If $inputInstance is not an object
- * @throws MissingMethodException If $inputInstance is missing a
- * required method
*/
private function loadRawTemplateData ($fqfn) {
// Get a input/output instance from the middleware
$ioInstance = $this->getFileIoInstance();
- // Validate the instance
- if (is_null($ioInstance)) {
- // Throw exception
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } elseif (!is_object($ioInstance)) {
- // Throw another exception
- throw new NoObjectException($ioInstance, self::EXCEPTION_IS_NO_OBJECT);
- } elseif (!method_exists($ioInstance, 'loadFileContents')) {
- // Throw yet another exception
- throw new MissingMethodException(array($ioInstance, 'loadFileContents'), self::EXCEPTION_MISSING_METHOD);
- }
-
// Some debug code to look on the file which is being loaded
//* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."<br />\n";
}
/**
- * Try to assign an extracted template variable as a "content" or "config"
+ * Try to assign an extracted template variable as a "content" or 'config'
* variable.
*
* @param $varName The variable's name (shall be content orconfig) by
*/
private function assignTemplateVariable ($varName, $var) {
// Is it not a config variable?
- if ($varName != "config") {
+ if ($varName != 'config') {
// Regular template variables
$this->assignVariable($var, "");
} else {
// Did we find some variables?
if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
// Initialize all missing variables
- foreach ($variableMatches[3] as $key=>$var) {
- // Try to assign it, empty strings are being ignored
- $this->assignTemplateVariable($variableMatches[1][$key], $var);
+ foreach ($variableMatches[3] as $key => $var) {
+ // Variable name
+ $varName = $variableMatches[1][$key];
+
+ // Workarround: Do not assign empty variables
+ if (!empty($var)) {
+ // Try to assign it, empty strings are being ignored
+ $this->assignTemplateVariable($varName, $var);
+ } // END - if
} // END - foreach
} // END - if
}
if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
// Template not found, but maybe variable assigned?
+ //* DEBUG: */ echo __METHOD__.":template={$template}<br />\n";
if ($this->isVariableAlreadySet($template) !== false) {
// Use that content here
$this->loadedRawData[$template] = $this->readVariable($template);
+ // Recursive protection:
+ $this->loadedTemplates[] = $template;
+ } elseif (isset($this->varStack['config'][$template])) {
+ // Use that content here
+ $this->loadedRawData[$template] = $this->varStack['config'][$template];
+
// Recursive protection:
$this->loadedTemplates[] = $template;
} else {
if (in_array($template, $this->compiledTemplates)) {
// Abort here...
return;
- }
+ } // END - if
// Remember this template being compiled
$this->compiledTemplates[] = $template;
*/
private function insertAllTemplates (array $templateMatches) {
// Run through all loaded codes
- foreach ($this->loadedRawData as $template=>$code) {
+ foreach ($this->loadedRawData as $template => $code) {
// Search for the template
$foundIndex = array_search($template, $templateMatches[1]);
// Set the new raw data
$this->setRawTemplateData($rawData);
-
} // END - if
-
} // END - foreach
}
// This template was never found. We silently ignore it
unset($this->rawTemplates[$key]);
}
- }
- }
+ } // END - foreach
+ } // END - if
}
/**
*/
private function assignAllVariables (array $varMatches) {
// Search for all variables
- foreach ($varMatches[1] as $key=>$var) {
+ foreach ($varMatches[1] as $key => $var) {
// Detect leading equals
if (substr($varMatches[2][$key], 0, 1) == "=") {
if (count($this->loadedRawData) > 0) {
// Then compile all!
- foreach ($this->loadedRawData as $template=>$code) {
+ foreach ($this->loadedRawData as $template => $code) {
// Is this template already compiled?
if (in_array($template, $this->compiledTemplates)) {
*/
private function insertRawTemplates () {
// Load all templates
- foreach ($this->rawTemplates as $template=>$content) {
+ foreach ($this->rawTemplates as $template => $content) {
// Set the template as a variable with the content
$this->assignVariable($template, $content);
}
private function finalizeVariableCompilation () {
// Get the content
$content = $this->getRawTemplateData();
+ //* DEBUG: */ echo __METHOD__.": content before=".strlen($content)." (".md5($content).")<br />\n";
// Walk through all variables
foreach ($this->varStack['general'] as $currEntry) {
+ //* DEBUG: */ echo __METHOD__.": name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
// Replace all [$var] or {?$var?} with the content
- //* DEBUG: */ echo "name=".$currEntry['name'].", value=<pre>".htmlentities($currEntry['value'])."</pre>\n";
+ // Old behaviour, will become obsolete!
$content = str_replace("\$content[".$currEntry['name']."]", $currEntry['value'], $content);
+
+ // Yet another old way
$content = str_replace("[".$currEntry['name']."]", $currEntry['value'], $content);
+
+ // The new behaviour
$content = str_replace("{?".$currEntry['name']."?}", $currEntry['value'], $content);
} // END - for
+ //* DEBUG: */ echo __METHOD__.": content after=".strlen($content)." (".md5($content).")<br />\n";
+
// Set the content back
$this->setRawTemplateData($content);
}
- /**
- * Getter for raw template data
- *
- * @return $rawTemplateData The raw data from the template
- */
- public final function getRawTemplateData () {
- return $this->rawTemplateData;
- }
-
- /**
- * Getter for compiled templates
- */
- public final function getCompiledData () {
- return $this->compiledData;
- }
-
/**
* Load a specified web template into the engine
*
- * @param $template The web template we shall load which is
- * located in "html" by default
+ * @param $template The web template we shall load which is located in
+ * "html" by default
* @return void
*/
public function loadWebTemplate ($template) {
*/
public function assignConfigVariable ($var) {
// Sweet and simple...
- $this->configVariables[$var] = $this->getConfigInstance()->readConfig($var);
+ //* DEBUG: */ echo __METHOD__.":var={$var}<br />\n";
+ $this->varStack['config'][$var] = $this->getConfigInstance()->readConfig($var);
}
/**
* Load a specified email template into the engine
*
- * @param $template The email template we shall load which is
- * located in "emails" by default
+ * @param $template The email template we shall load which is located in
+ * "emails" by default
* @return void
*/
public function loadEmailTemplate ($template) {
/**
* Load a specified code template into the engine
*
- * @param $template The code template we shall load which is
+ * @param $template The code template we shall load which is
* located in "code" by default
* @return void
*/
// Transfer it's name/value combination to the $content array
//* DEBUG: */ echo $currVariable['name']."=<pre>".htmlentities($currVariable['value'])."</pre>\n";
$dummy[$currVariable['name']] = $currVariable['value'];
-
}// END - if
- // Set the new variable (don't remove the second dollar !)
+ // Set the new variable (don't remove the second dollar!)
$$validVar = $dummy;
// Prepare all configuration variables
- $config = $this->configVariables;
+ $config = null;
+ if (isset($this->varStack['config'])) {
+ $config = $this->varStack['config'];
+ } // END - if
// Remove some variables
unset($idx);
);
// This loop does remove the backslashes (\) in PHP parameters
- while (strpos($eval, "<?") !== false) {
+ while (strpos($eval, "<?php") !== false) {
// Get left part before "<?"
- $evalLeft = substr($eval, 0, strpos($eval, "<?"));
+ $evalLeft = substr($eval, 0, strpos($eval, "<?php"));
// Get all from right of "<?"
- $evalRight = substr($eval, (strpos($eval, "<?") + 2));
-
- // Is this a full PHP tag?
- if (substr(strtolower($evalRight), 0, 3) == "php") {
- // Remove "php" string from full PHP tag
- $evalRight = substr($evalRight, 3);
- } // END - if
+ $evalRight = substr($eval, (strpos($eval, "<?php") + 5));
// Cut middle part out and remove escapes
$evalMiddle = trim(substr($evalRight, 0, strpos($evalRight, "?>")));
} // END - while
// Prepare PHP code for eval() command
- $evalLength = strlen($eval);
$eval = str_replace(
"<%php", "\";",
str_replace(
)
);
- // Did something change?
- if (strlen($eval) != $eval) {
- // Run the constructed command. This will "compile" all variables in
- @eval($eval);
- } // END - if
+ // Run the constructed command. This will "compile" all variables in
+ @eval($eval);
// Goes something wrong?
if (!isset($result)) {
$this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
// Output backtrace here
- $this->debugBacktrace();
+ $this->debugBackTrace();
} // END - if
// Set raw template data
$this->setRawTemplateData($result);
$cnt++;
- }
+ } // END - while
+
+ // Final variable assignment
+ $this->finalizeVariableCompilation();
// Set the new content
- $this->setCompiledData($result);
+ $this->setCompiledData($this->getRawTemplateData());
}
/**
* @throws InvalidArrayCountException If an unexpected array
* count has been found
*/
- public final function compileTemplate () {
+ public function compileTemplate () {
// We will only work with template type "code" from configuration
if ($this->getTemplateType() != $this->getConfigInstance()->readConfig('code_template_type')) {
// Abort here
}
/**
- * Output the compiled page to the outside world. In case of web templates
- * this would be vaild (X)HTML code. And in case of email templates this
- * would store a prepared email body inside the template engine.
+ * A old deprecated method
*
* @return void
+ * @deprecated
+ * @see BaseTemplateEngine::transferToResponse
*/
public function output () {
// Check which type of template we have
if (!class_exists($className)) {
// Abort here!
throw new ViewHelperNotFoundException(array($this, $helperName), self::EXCEPTION_INVALID_VIEW_HELPER);
- }
+ } // END - if
// Generate new instance
$eval = sprintf("\$this->helpers[%s] = %s::create%s();",
// Run the code
eval($eval);
- }
+ } // END - if
// Return the requested instance
return $this->helpers[$helperName];
*/
public function assignApplicationData (ManageableApplication $appInstance) {
// Get long name and assign it
- $this->assignVariable("app_full_name" , $appInstance->getAppName());
+ $this->assignVariable('app_full_name' , $appInstance->getAppName());
// Get short name and assign it
- $this->assignVariable("app_short_name", $appInstance->getAppShortName());
+ $this->assignVariable('app_short_name', $appInstance->getAppShortName());
// Get version number and assign it
- $this->assignVariable("app_version" , $appInstance->getAppVersion());
+ $this->assignVariable('app_version' , $appInstance->getAppVersion());
+
+ // Assign extra application-depending data
+ $appInstance->assignExtraTemplateData($this);
}
/**
public final function getVariableGroups () {
return $this->varGroups;
}
+
+ /**
+ * Renames a variable in code and in stack
+ *
+ * @param $oldName Old name of variable
+ * @param $newName New name of variable
+ * @return void
+ */
+ public function renameVariable ($oldName, $newName) {
+ //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
+ // Get raw template code
+ $rawData = $this->getRawTemplateData();
+
+ // Replace it
+ $rawData = str_replace($oldName, $newName, $rawData);
+
+ // Set the code back
+ $this->setRawTemplateData($rawData);
+ }
+
+ /**
+ * Renders the given XML content
+ *
+ * @param $content Valid XML content or if not set the current loaded raw content
+ * @return void
+ * @throws XmlParserException If an XML error was found
+ */
+ public final function renderXmlContent ($content = null) {
+ // Is the content set?
+ if (is_null($content)) {
+ // Get current content
+ $content = $this->getRawTemplateData();
+ } // END - if
+
+ // Convert all to UTF8
+ $content = recode("html..utf8", $content);
+
+ // Get an XML parser
+ $xmlParser = xml_parser_create();
+
+ // Force case-folding to on
+ xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, true);
+
+ // Set object
+ xml_set_object($xmlParser, $this);
+
+ // Set handler call-backs
+ xml_set_element_handler($xmlParser, 'startElement', 'endElement');
+ xml_set_character_data_handler($xmlParser, 'characterHandler');
+
+ // Now parse the XML tree
+ if (!xml_parse($xmlParser, $content)) {
+ // Error found in XML!
+ //die("<pre>".htmlentities($content)."</pre>");
+ throw new XmlParserException(array($this, $xmlParser), BaseHelper::EXCEPTION_XML_PARSER_ERROR);
+ } // END - if
+
+ // Free the parser
+ xml_parser_free($xmlParser);
+ }
}
// [EOF]
projects / shipsimu.git / blobdiff