/**
* A generic template engine
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
*
* 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
/**
* Loaded raw template data
*/
- private $loadedRawData = null;
+ private $loadedRawData = NULL;
/**
* Raw templates which are linked in code templates
*/
- private $rawTemplates = null;
+ private $rawTemplates = NULL;
/**
* A regular expression for variable=value pairs
/**
* Language support is enabled by default
*/
- private $languageSupport = true;
+ private $languageSupport = TRUE;
/**
* XML compacting is disabled by default
*/
- private $xmlCompacting = false;
+ private $xmlCompacting = FALSE;
// Exception codes for the template engine
const EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED = 0x110;
const EXCEPTION_TEMPLATE_CONTAINS_INVALID_VAR = 0x111;
const EXCEPTION_INVALID_VIEW_HELPER = 0x112;
+ const EXCEPTION_VARIABLE_IS_MISSING = 0x113;
/**
* Protected constructor
protected function __construct ($className) {
// Call parent constructor
parent::__construct($className);
+
+ // Init file I/O instance
+ $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class');
+
+ // Set it
+ $this->setFileIoInstance($ioInstance);
}
/**
* Search for a variable in the stack
*
- * @param $var The variable we are looking for
- * @param $stack Optional variable stack to look in
- * @return $idx FALSE means not found, >=0 means found on a specific index
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Optional variable group to look in
+ * @return $index FALSE means not found, >=0 means found on a specific index
*/
- private function isVariableAlreadySet ($var, $stack = null) {
+ private function getVariableIndex ($variableName, $variableGroup = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// First everything is not found
- $found = false;
+ $found = FALSE;
- // If the stack is null, use the current group
- if (is_null($stack)) $stack = $this->currGroup;
+ // If the stack is NULL, use the current group
+ if (is_null($variableGroup)) {
+ // Use current group
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $variableGroup = $this->currGroup;
+ } // END - if
// Is the group there?
- if ($this->isVarStackSet($stack)) {
+ if ($this->isVarStackSet($variableGroup)) {
// Now search for it
- foreach ($this->getVarStack($stack) as $idx => $currEntry) {
- //* DEBUG: */ echo __METHOD__.":currGroup={$stack},idx={$idx},currEntry={$currEntry['name']},var={$var}<br />\n";
+ foreach ($this->getVarStack($variableGroup) as $index => $currEntry) {
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName);
// Is the entry found?
- if ($currEntry['name'] == $var) {
+ if ($currEntry['name'] == $variableName) {
// Found!
- //* DEBUG: */ echo __METHOD__.":FOUND!<br />\n";
- $found = $idx;
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.':FOUND!');
+ $found = $index;
break;
} // END - if
} // END - foreach
}
/**
- * Checks wether the given variable stack is set
+ * Checks whether the given variable group is set
*
- * @param $stack Variable stack to check
- * @return $isSet Wether the given variable stack is set
+ * @param $variableGroup Variable group to check
+ * @return $isSet Whether the given variable group is set
*/
- protected final function isVarStackSet ($stack) {
+ protected final function isVarStackSet ($variableGroup) {
// Check it
- $isSet = isset($this->varStack[$stack]);
+ $isSet = isset($this->varStack[$variableGroup]);
// Return result
return $isSet;
}
/**
- * Getter for given variable stack
+ * Getter for given variable group
+ *
+ * @param $variableGroup Variable group to check
+ * @return $varStack Found variable group
+ */
+ public final function getVarStack ($variableGroup) {
+ return $this->varStack[$variableGroup];
+ }
+
+ /**
+ * Setter for given variable group
*
- * @param $stack Variable stack to check
- * @return $varStack Found variable stack
+ * @param $variableGroup Variable group to check
+ * @param $varStack Variable stack to check
+ * @return void
*/
- public final function getVarStack ($stack) {
- return $this->varStack[$stack];
+ protected final function setVarStack ($variableGroup, array $varStack) {
+ $this->varStack[$variableGroup] = $varStack;
}
/**
* Return a content of a variable or null if not found
*
- * @param $var The variable we are looking for
- * @param $stack Optional variable stack to look in
- * @return $content Content of the variable or null if not found
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Optional variable group to look in
+ * @return $content Content of the variable or null if not found
*/
- protected function readVariable ($var, $stack = null) {
+ protected function readVariable ($variableName, $variableGroup = NULL) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// First everything is not found
- $content = null;
+ $content = NULL;
- // If the stack is null, use the current group
- if (is_null($stack)) $stack = $this->currGroup;
+ // If the stack is NULL, use the current group
+ if (is_null($variableGroup)) {
+ // Use current group
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!');
+ $variableGroup = $this->currGroup;
+ } // END - if
// Get variable index
- $found = $this->isVariableAlreadySet($var, $stack);
+ $found = $this->getVariableIndex($variableName, $variableGroup);
// Is the variable found?
- if ($found !== false) {
+ if ($found !== FALSE) {
// Read it
- $content = $this->getVariableValue($stack, $found);
+ $content = $this->getVariableValue($variableGroup, $found);
} // END - if
// Return the current position
- //* DEBUG: */ echo __METHOD__.": group=".$stack.",var=".$var.", content[".gettype($content)."]=".$content."<br />\n";
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content);
return $content;
}
/**
* Add a variable to the stack
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @param $variableName Name of variable to add
+ * @param $value Value we want to store in the variable
* @return void
*/
- private function addVariable ($var, $value) {
+ private function addVariable ($variableName, $value) {
// Set general variable group
$this->setVariableGroup('general');
// Add it to the stack
- $this->addGroupVariable($var, $value);
+ $this->addGroupVariable($variableName, $value);
}
/**
* Returns all variables of current group or empty array
*
- * @return $result Wether array of found variables or empty array
+ * @return $result Whether array of found variables or empty array
*/
private function readCurrentGroup () {
// Default is not found
* Settter for variable group
*
* @param $groupName Name of variable group
- * @param $add Wether add this group
+ * @param $add Whether add this group
* @return void
*/
- public function setVariableGroup ($groupName, $add = true) {
+ public function setVariableGroup ($groupName, $add = TRUE) {
// Set group name
- //* DEBIG: */ echo __METHOD__.": currGroup=".$groupName."<br />\n";
+ //* DEBIG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': currGroup=' . $groupName);
$this->currGroup = $groupName;
// Skip group 'general'
- if (($groupName != 'general') && ($add === true)) {
+ if (($groupName != 'general') && ($add === TRUE)) {
$this->varGroups[$groupName] = 'OK';
} // END - if
}
/**
* Adds a variable to current group
*
- * @param $var Variable to set
- * @param $value Value to store in variable
+ * @param $variableName Variable to set
+ * @param $value Value to store in variable
* @return void
*/
- public function addGroupVariable ($var, $value) {
- //* DEBUG: */ echo __METHOD__.": group=".$this->currGroup.", var=".$var.", value=".$value."<br />\n";
+ public function addGroupVariable ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value);
// Get current variables in group
$currVars = $this->readCurrentGroup();
// Append our variable
- $currVars[] = array(
- 'name' => $var,
- 'value' => $value
- );
+ array_push($currVars, $this->generateVariableArray($variableName, $value));
// Add it to the stack
$this->setVarStack($this->currGroup, $currVars);
}
+ /**
+ * Getter for variable value, throws a NoVariableException if the variable is not found
+ *
+ * @param $varGroup Variable group to use
+ * @param $index Index in variable array
+ * @return $value Value to set
+ */
+ private function getVariableValue ($varGroup, $index) {
+ // Return it
+ return $this->varStack[$varGroup][$index]['value'];
+ }
+
/**
* Modify an entry on the stack
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @param $variableName The variable we are looking for
+ * @param $value The value we want to store in the variable
* @return void
+ * @throws NoVariableException If the given variable is not found
*/
- private function modifyVariable ($var, $value) {
+ private function modifyVariable ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// Get index for variable
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($variableName);
// Is the variable set?
- if ($idx !== false) {
- // Then modify it
- $this->setVariableValue($this->currGroup, $idx, $value);
+ if ($index === FALSE) {
+ // Unset variables cannot be modified
+ throw new NoVariableException(array($this, $variableName, $value), self::EXCEPTION_VARIABLE_IS_MISSING);
} // END - if
+
+ // Then modify it
+ $this->setVariableValue($this->currGroup, $index, $value);
+ }
+
+ /**
+ * Sets a variable value for given variable group and index
+ *
+ * @param $varGroup Variable group to use
+ * @param $index Index in variable array
+ * @param $value Value to set
+ * @return void
+ */
+ private function setVariableValue ($varGroup, $index, $value) {
+ $this->varStack[$varGroup][$index]['value'] = $value;
+ }
+
+ /**
+ * Sets a variable within given group. This method does detect if the
+ * variable is already set. If so, the variable got modified, otherwise
+ * added.
+ *
+ * @param $varGroup Variable group to use
+ * @param $variableName Variable to set
+ * @param $value Value to set
+ * @return void
+ */
+ protected function setVariable ($varGroup, $variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Get index for variable
+ $index = $this->getVariableIndex($variableName);
+
+ // Is the variable set?
+ if ($index === FALSE) {
+ // Is the stack there?
+ if (!isset($this->varStack[$varGroup])) {
+ // Then initialize it here
+ $this->varStack[$varGroup] = array();
+ } // END - if
+
+ // Not found, add it
+ array_push($this->varStack[$varGroup], $this->generateVariableArray($variableName, $value));
+ } else {
+ // Then modify it
+ $this->setVariableValue($this->currGroup, $index, $value);
+ }
+ }
+
+ /**
+ * "Generates" (better returns) an array for all variables for given
+ * variable/value pay.
+ *
+ * @param $variableName Variable to set
+ * @param $value Value to set
+ * @return $varData Variable data array
+ */
+ private function generateVariableArray ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Generate the temporary array
+ $varData = array(
+ 'name' => $variableName,
+ 'value' => $value
+ );
+
+ // And return it
+ return $varData;
}
/**
/**
* Assign (add) a given variable with a value
*
- * @param $var The variable we are looking for
- * @param $value The value we want to store in the variable
+ * @param $variableName 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);
+ public final function assignVariable ($variableName, $value) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
// Empty variable found?
- if (empty($var)) {
+ if (empty($variableName)) {
// Throw an exception
- throw new EmptyVariableException(array($this, 'var'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+ throw new EmptyVariableException(array($this, 'variableName'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
} // END - if
// First search for the variable if it was already added
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($variableName);
// Was it found?
- if ($idx === false) {
+ if ($index === FALSE) {
// Add it to the stack
- //* DEBUG: */ echo "ADD: ".$var."<br />\n";
- $this->addVariable($var, $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->addVariable($variableName, $value);
} elseif (!empty($value)) {
// Modify the stack entry
- //* DEBUG: */ echo "MOD: ".$var."<br />\n";
- $this->modifyVariable($var, $value);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value);
+ $this->modifyVariable($variableName, $value);
}
}
/**
* Removes a given variable
*
- * @param $var The variable we are looking for
+ * @param $variableName The variable we are looking for
+ * @param $variableGroup Name of variable group (default: 'general')
* @return void
*/
- public final function removeVariable ($var) {
+ public final function removeVariable ($variableName, $variableGroup = 'general') {
// First search for the variable if it was already added
- $idx = $this->isVariableAlreadySet($var);
+ $index = $this->getVariableIndex($variableName, $variableGroup);
// Was it found?
- if ($idx !== false) {
+ if ($index !== FALSE) {
// Remove this variable
- $this->varStack->offsetUnset($idx);
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index);
+ $this->unsetVariableStackOffset($index, $variableGroup);
} // END - if
}
+ /**
+ * Unsets the given offset in the variable group
+ *
+ * @param $index Index to unset
+ * @param $variableGroup Variable group (default: currGroup)
+ * @return void
+ */
+ protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) {
+ // Is the variable group not set?
+ if (is_null($variableGroup)) {
+ // Then set it to current
+ $variableGroup = $this->currGroup;
+ } // END - if
+
+ // Is the entry there?
+ if (!isset($this->varStack[$variableGroup][$index])) {
+ // Abort here, we need fixing!
+ $this->debugInstance();
+ } // END - if
+
+ // Remove it
+ unset($this->varStack[$variableGroup][$index]);
+ }
+
/**
* Private setter for raw template data
*
*/
protected final function setRawTemplateData ($rawTemplateData) {
// And store it in this class
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($rawTemplateData).' Bytes set.<br />\n';
- //* DEBUG: */ echo $this->currGroup.' variables: '.count($this->getVarStack($this->currGroup)).', groups='.count($this->varStack).'<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack));
$this->rawTemplateData = (string) $rawTemplateData;
}
* @return $rawTemplateData The raw data from the template
*/
public final function getRawTemplateData () {
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->rawTemplateData).' Bytes read.<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->rawTemplateData) . ' Bytes read.');
return $this->rawTemplateData;
}
*/
private final function setCompiledData ($compiledData) {
// And store it in this class
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($compiledData).' Bytes set.<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($compiledData) . ' Bytes set.');
$this->compiledData = (string) $compiledData;
}
* @return $compiledData Compiled template data
*/
public final function getCompiledData () {
- //* DEBUG: */ echo __METHOD__.':'.$this->getUniqueId().': '.strlen($this->compiledData).' Bytes read.<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': ' . strlen($this->compiledData) . ' Bytes read.');
return $this->compiledData;
}
// Is language support enabled?
if ($this->isLanguageSupportEnabled()) {
// Construct the FQFN for the template by honoring the current language
- $fqfn = sprintf("%s%s%s%s/%s/%s%s",
+ $fqfn = sprintf('%s%s%s%s/%s/%s%s',
$this->getConfigInstance()->getConfigEntry('base_path'),
$this->getTemplateBasePath(),
$this->getGenericBasePath(),
);
} else {
// Construct the FQFN for the template without language
- $fqfn = sprintf("%s%s%s%s/%s%s",
+ $fqfn = sprintf('%s%s%s%s/%s%s',
$this->getConfigInstance()->getConfigEntry('base_path'),
$this->getTemplateBasePath(),
$this->getGenericBasePath(),
$ioInstance = $this->getFileIoInstance();
// Some debug code to look on the file which is being loaded
- //* DEBUG: */ echo __METHOD__.": FQFN=".$fqfn."<br />\n";
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': FQFN=' . $fqfn);
// Load the raw template
$rawTemplateData = $ioInstance->loadFileContents($fqfn);
* Try to assign an extracted template variable as a "content" or 'config'
* variable.
*
- * @param $varName The variable's name (shall be content orconfig) by
- * default
- * @param $var The variable we want to assign
+ * @param $varName The variable's name (shall be content or config)
+ * by default
+ * @param $variableName The variable we want to assign
+ * @return void
*/
private function assignTemplateVariable ($varName, $var) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': varName=' . $varName . ',variableName=' . $variableName);
+
// Is it not a config variable?
if ($varName != 'config') {
// Regular template variables
- $this->assignVariable($var, '');
+ $this->assignVariable($variableName, '');
} else {
// Configuration variables
- $this->assignConfigVariable($var);
+ $this->assignConfigVariable($variableName);
}
}
$rawData = (string) $rawData;
// Search for variables
- @preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+ preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches);
+
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, TRUE));
// Did we find some variables?
if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) {
$backup = $this->getRawTemplateData();
// Initialize some arrays
- if (is_null($this->loadedRawData)) { $this->loadedRawData = array(); $this->rawTemplates = array(); }
+ if (is_null($this->loadedRawData)) {
+ // Initialize both
+ $this->loadedRawData = array();
+ $this->rawTemplates = array();
+ } // END - if
// Load all requested templates
foreach ($templateMatches[1] as $template) {
-
// Load and compile only templates which we have not yet loaded
// RECURSIVE PROTECTION! BE CAREFUL HERE!
if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template);
// Template not found, but maybe variable assigned?
- //* DEBUG: */ echo __METHOD__.":template={$template}<br />\n";
- if ($this->isVariableAlreadySet($template) !== false) {
+ if ($this->getVariableIndex($template, 'config') !== FALSE) {
// Use that content here
- $this->loadedRawData[$template] = $this->readVariable($template);
+ $this->loadedRawData[$template] = $this->readVariable($template, 'config');
// Recursive protection:
- $this->loadedTemplates[] = $template;
- } elseif ($this->isVariableAlreadySet($template, 'config')) {
+ array_push($this->loadedTemplates, $template);
+ } elseif ($this->getVariableIndex($template) !== FALSE) {
// Use that content here
- $this->loadedRawData[$template] = $this->readVariable($template, 'config');
+ $this->loadedRawData[$template] = $this->readVariable($template);
// Recursive protection:
- $this->loadedTemplates[] = $template;
+ array_push($this->loadedTemplates, $template);
} else {
// Then try to search for code-templates
try {
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
- $this->loadedTemplates[] = $template;
+ array_push($this->loadedTemplates, $template);
} catch (FileIoException $e) {
// Even this is not done... :/
- $this->rawTemplates[] = $template;
+ array_push($this->rawTemplates, $template);
}
}
} // END - if
} // END - if
// Remember this template being compiled
- $this->compiledTemplates[] = $template;
+ array_push($this->compiledTemplates, $template);
// Compile the loaded code in five steps:
//
$foundIndex = array_search($template, $templateMatches[1]);
// Lookup the matching template replacement
- if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) {
+ if (($foundIndex !== FALSE) && (isset($templateMatches[0][$foundIndex]))) {
// Get the current raw template
$rawData = $this->getRawTemplateData();
// Remember this template for recursion detection
// RECURSIVE PROTECTION!
- $this->loadedTemplates[] = $template;
+ array_push($this->loadedTemplates, $template);
} catch (FileIoException $e) {
// This template was never found. We silently ignore it
unset($this->rawTemplates[$key]);
* @todo Unfinished work or don't die here.
*/
private function assignAllVariables (array $varMatches) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches()=' . count($varMatches));
+
// Search for all variables
foreach ($varMatches[1] as $key => $var) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $var = trim($this->convertDashesToUnderscores($var));
+
+ // Debug message
+ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':key=' . $key . ',var=' . $var);
// Detect leading equals
if (substr($varMatches[2][$key], 0, 1) == '=') {
} // END - if
// Do we have some quotes left and right side? Then it is free text
- if ((substr($varMatches[2][$key], 0, 1) == "\"") && (substr($varMatches[2][$key], -1, 1) == "\"")) {
+ if ((substr($varMatches[2][$key], 0, 1) == '"') && (substr($varMatches[2][$key], -1, 1) == '"')) {
// Free string detected! Which we can assign directly
$this->assignVariable($var, $varMatches[3][$key]);
} elseif (!empty($varMatches[2][$key])) {
// @TODO Non-string found so we need some deeper analysis...
- ApplicationEntryPoint::app_die('Deeper analysis not yet implemented!');
+ ApplicationEntryPoint::app_exit('Deeper analysis not yet implemented!');
}
-
- } // for ($varMatches ...
+ } // END - foreach
}
+
/**
* Compiles all loaded raw templates
*
* @return void
*/
private function compileRawTemplateData (array $templateMatches) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':loadedRawData()= ' .count($this->loadedRawData));
+
// Are some code-templates found which we need to compile?
if (count($this->loadedRawData) > 0) {
-
// Then compile all!
foreach ($this->loadedRawData as $template => $code) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':template=' . $template . ',code(' . strlen($code) . ')=' . $code);
// Is this template already compiled?
if (in_array($template, $this->compiledTemplates)) {
// Then skip it
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Template ' . $template . ' already compiled. SKIPPED!');
continue;
- }
+ } // END - if
// Search for the template
$foundIndex = array_search($template, $templateMatches[1]);
// Lookup the matching variable data
- if (($foundIndex !== false) && (isset($templateMatches[3][$foundIndex]))) {
-
+ if (($foundIndex !== FALSE) && (isset($templateMatches[3][$foundIndex]))) {
// Split it up with another reg. exp. into variable=value pairs
preg_match_all($this->regExpVarValue, $templateMatches[3][$foundIndex], $varMatches);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varMatches=' . print_r($varMatches, TRUE));
// Assign all variables
$this->assignAllVariables($varMatches);
-
} // END - if (isset($templateMatches ...
// Compile the loaded template
$this->compileCode($code, $template);
-
} // END - foreach ($this->loadedRawData ...
// Insert all templates
$this->insertAllTemplates($templateMatches);
-
} // END - if (count($this->loadedRawData) ...
}
private function finalizeVariableCompilation () {
// Get the content
$content = $this->getRawTemplateData();
- //* DEBUG: */ echo __METHOD__.': content before='.strlen($content).' ('.md5($content).')<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content before=' . strlen($content) . ' (' . md5($content) . ')');
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
// Walk through all variables
foreach ($this->getVarStack('general') as $currEntry) {
- //* DEBUG: */ echo __METHOD__.': name='.$currEntry['name'].', value=<pre>'.htmlentities($currEntry['value']).'</pre>\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currEntry['name'] . ', value=<pre>' . htmlentities($currEntry['value']) . '</pre>');
// Replace all [$var] or {?$var?} with the content
// @TODO Old behaviour, will become obsolete!
$content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content);
$content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content);
} // END - for
- //* DEBUG: */ echo __METHOD__.': content after='.strlen($content).' ('.md5($content).')<br />\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': content after=' . strlen($content) . ' (' . md5($content) . ')');
// Set the content back
$this->setRawTemplateData($content);
/**
* Assign a given congfiguration variable with a value
*
- * @param $var The configuration variable we want to assign
+ * @param $variableName The configuration variable we want to assign
* @return void
*/
- public function assignConfigVariable ($var) {
+ public function assignConfigVariable ($variableName) {
+ // Replace all dashes to underscores to match variables with configuration entries
+ $variableName = trim($this->convertDashesToUnderscores($variableName));
+
// Sweet and simple...
- //* DEBUG: */ echo __METHOD__.':var={$var}<br />\n';
- $this->setVariable('config', $var, $this->getConfigInstance()->getConfigEntry($var));
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName));
+ $this->setVariable('config', $variableName, $this->getConfigInstance()->getConfigEntry($variableName));
}
/**
/**
* Compiles configuration place-holders in all variables. This 'walks'
- * through the variable stack 'general'. It interprets all values from that
+ * through the variable group 'general'. It interprets all values from that
* variables as configuration entries after compiling them.
*
* @return void
// Do we have the stack?
if (!$this->isVarStackSet('general')) {
// Abort here silently
- // @TODO This silent abort should be logged, maybe.
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': Aborted, variable stack general not found!');
return;
} // END - if
// Iterate through all general variables
- foreach ($this->getVarStack('general') as $idx=>$currVariable) {
+ foreach ($this->getVarStack('general') as $index => $currVariable) {
// Compile the value
- $value = $this->compileRawCode($this->readVariable($currVariable['name']), true);
+ $value = $this->compileRawCode($this->readVariable($currVariable['name']), TRUE);
+
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': name=' . $currVariable['name'] . ',value=' . $value);
// Remove it from stack
- $this->removeVariable($idx, 'general');
+ $this->removeVariable($currVariable['name'], 'general');
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index);
- // Re-assign the variable
- $this->assignConfigVariable($value);
+ // Is it a configuration key?
+ if ($this->getConfigInstance()->isConfigurationEntrySet($value)) {
+ // The value itself is a configuration entry
+ $this->assignConfigVariable($value);
+ } else {
+ // Re-assign the value directly
+ $this->setVariable('config', $currVariable['name'], $value);
+ }
} // END - foreach
}
// Iterate through all general variables
foreach ($this->getVarStack('general') as $currVariable) {
// Transfer it's name/value combination to the $content array
- //* DEBUG: */ echo $currVariable['name'].'=<pre>'.htmlentities($currVariable['value']).'</pre>\n';
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':' . $currVariable['name'] . '=<pre>' . htmlentities($currVariable['value']).'</pre>');
$dummy[$currVariable['name']] = $currVariable['value'];
}// END - if
// Set the new variable (don't remove the second dollar!)
$$validVar = $dummy;
- // Prepare all configuration variables
- $config = null;
- if ($this->isVarStackSet('config')) {
- $config = $this->getVarStack('config');
- } // END - if
-
// Remove some variables
- unset($idx);
+ unset($index);
unset($currVariable);
// Run the compilation three times to get content from helper classes in
$this->finalizeVariableCompilation();
// Prepare the eval() command for comiling the template
- $eval = sprintf("\$result = \"%s\";",
+ $eval = sprintf('$result = "%s";',
addslashes($this->getRawTemplateData())
);
// This loop does remove the backslashes (\) in PHP parameters
- while (strpos($eval, $this->codeBegin) !== false) {
+ while (strpos($eval, $this->codeBegin) !== FALSE) {
// Get left part before "<?"
$evalLeft = substr($eval, 0, strpos($eval, $this->codeBegin));
$evalRight = substr($evalRight, (strpos($evalRight, $this->codeEnd) + 2));
// And put all together
- $eval = sprintf("%s<%%php %s %%>%s", $evalLeft, $evalMiddle, $evalRight);
+ $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight);
} // END - while
// Prepare PHP code for eval() command
$eval = str_replace(
- "<%php", "\";",
+ '<%php', '";',
str_replace(
- "%>",
+ '%>',
"\n\$result .= \"",
$eval
)
// Goes something wrong?
if ((!isset($result)) || (empty($result))) {
// Output eval command
- $this->debugOutput(sprintf("Failed eval() code: <pre>%s</pre>", $this->markupCode($eval, true)), true);
+ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('Failed eval() code: <pre>%s</pre>', $this->markupCode($eval, TRUE)), TRUE);
// Output backtrace here
$this->debugBackTrace();
* count has been found
*/
public function compileTemplate () {
+ // Get code type to make things shorter
+ $codeType = $this->getConfigInstance()->getConfigEntry('code_template_type');
+
// We will only work with template type "code" from configuration
- if ($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('code_template_type')) {
+ if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) {
// Abort here
throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED);
} // END - if
// Search for code-tags which are {? ?}
preg_match_all($this->regExpCodeTags, $rawData, $templateMatches);
+ // Debug message
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':templateMatches=' . print_r($templateMatches , TRUE));
+
// Analyze the matches array
if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) {
// Entries are found:
// Are some raw templates found and loaded?
if (count($this->rawTemplates) > 0) {
-
// Insert all raw templates
$this->insertRawTemplates();
// Remove the raw template content as well
$this->setRawTemplateData('');
-
} // END - if
-
} // END - if($templateMatches ...
}
// Is this view helper loaded?
if (!isset($this->helpers[$helperName])) {
// Create a class name
- $className = "{$helperName}ViewHelper";
+ $className = $helperName . 'ViewHelper';
// Generate new instance
$this->helpers[$helperName] = ObjectFactory::createObjectByName($className);
/**
* Assigns all the application data with template variables
*
- * @param $appInstance A manageable application instance
+ * @param $applicationInstance A manageable application instance
* @return void
*/
- public function assignApplicationData (ManageableApplication $appInstance) {
+ public function assignApplicationData (ManageableApplication $applicationInstance) {
// Get long name and assign it
- $this->assignVariable('app_full_name' , $appInstance->getAppName());
+ $this->assignVariable('app_full_name' , $applicationInstance->getAppName());
// Get short name and assign it
- $this->assignVariable('app_short_name', $appInstance->getAppShortName());
+ $this->assignVariable('app_short_name', $applicationInstance->getAppShortName());
// Get version number and assign it
- $this->assignVariable('app_version' , $appInstance->getAppVersion());
+ $this->assignVariable('app_version' , $applicationInstance->getAppVersion());
// Assign extra application-depending data
- $appInstance->assignExtraTemplateData($this);
+ $applicationInstance->assignExtraTemplateData($this);
}
/**
* @param $setMatchAsCode Sets $match if readVariable() returns empty result
* @return $rawCode Compile code with inserted variable value
*/
- public function compileRawCode ($rawCode, $setMatchAsCode=false) {
+ public function compileRawCode ($rawCode, $setMatchAsCode=FALSE) {
// Find the variables
- //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
preg_match_all($this->regExpVarValue, $rawCode, $varMatches);
// Compile all variables
- //* DEBUG: */ echo __METHOD__.":<pre>".print_r($varMatches, true)."</pre>\n";
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':<pre>' . print_r($varMatches, TRUE) . '</pre>');
foreach ($varMatches[0] as $match) {
// Add variable tags around it
$varCode = '{?' . $match . '?}';
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':varCode=' . $varCode);
+
// Is the variable found in code? (safes some calls)
- if (strpos($rawCode, $varCode) !== false) {
- // Replace the variable with it's value, if found
- $value = $this->readVariable($match);
- //* DEBUG: */ echo __METHOD__.": match=".$match.",value[".gettype($value)."]=".$value."<br />\n";
- if (($setMatchAsCode === true) && (is_null($value))) {
+ if (strpos($rawCode, $varCode) !== FALSE) {
+ // Debug message
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode);
+
+ // Use $match as new value or $value from read variable?
+ if ($setMatchAsCode === TRUE) {
// Insert match
$rawCode = str_replace($varCode, $match, $rawCode);
} else {
+ // Read the variable
+ $value = $this->readVariable($match);
+
// Insert value
$rawCode = str_replace($varCode, $value, $rawCode);
}
} // END - foreach
// Return the compiled data
- //* DEBUG: */ echo __METHOD__.":rawCode=<pre>".htmlentities($rawCode)."</pre>\n";
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ':rawCode=<pre>' . htmlentities($rawCode) . '</pre>');
return $rawCode;
}
* @return void
*/
public function renameVariable ($oldName, $newName) {
- //* DEBUG: */ echo __METHOD__.": oldName={$oldName}, newName={$newName}<br />\n";
+ //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(__METHOD__ . ': oldName=' . $oldName . ', newName=' . $newName);
// Get raw template code
$rawData = $this->getRawTemplateData();
* @return void
* @throws XmlParserException If an XML error was found
*/
- public function renderXmlContent ($content = null) {
+ public function renderXmlContent ($content = NULL) {
// Is the content set?
if (is_null($content)) {
// Get current content
* @param $languageSupport New language support setting
* @return void
*/
- public final function enableLanguageSupport ($languageSupport = true) {
+ public final function enableLanguageSupport ($languageSupport = TRUE) {
$this->languageSupport = (bool) $languageSupport;
}
/**
- * Checks wether language support is enabled
+ * Checks whether language support is enabled
*
- * @return $languageSupport Wether language support is enabled or disabled
+ * @return $languageSupport Whether language support is enabled or disabled
*/
public final function isLanguageSupportEnabled () {
return $this->languageSupport;
* @param $xmlCompacting New XML compacting setting
* @return void
*/
- public final function enableXmlCompacting ($xmlCompacting = true) {
+ public final function enableXmlCompacting ($xmlCompacting = TRUE) {
$this->xmlCompacting = (bool) $xmlCompacting;
}
/**
- * Checks wether XML compacting is enabled
+ * Checks whether XML compacting is enabled
*
- * @return $xmlCompacting Wether XML compacting is enabled or disabled
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
*/
public final function isXmlCompactingEnabled () {
return $this->xmlCompacting;
}
+
+ /**
+ * Removes all commentd, tabs and new-line characters to compact the content
+ *
+ * @param $uncompactedContent The uncompacted content
+ * @return $compactedContent The compacted content
+ */
+ public function compactContent ($uncompactedContent) {
+ // First, remove all tab/new-line/revert characters
+ $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent)));
+
+ // Then regex all comments like <!-- //--> away
+ preg_match_all('/<!--[\w\W]*?(\/\/){0,1}-->/', $compactedContent, $matches);
+
+ // Do we have entries?
+ if (isset($matches[0][0])) {
+ // Remove all
+ foreach ($matches[0] as $match) {
+ // Remove the match
+ $compactedContent = str_replace($match, '', $compactedContent);
+ } // END - foreach
+ } // END - if
+
+ // Set the content again
+ $this->setRawTemplateData($compactedContent);
+
+ // Return compacted content
+ return $compactedContent;
+ }
}
// [EOF]
projects / core.git / blobdiff