X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Ftemplate%2Fclass_BaseTemplateEngine.php;h=dccbddc41df98b31ab945f89005e05fad5c9bb28;hp=1908e3bc9b87eef6372134402779611f29e4177a;hb=refs%2Fheads%2Fmaster;hpb=2b4f4b88ec5f9d385110e800494c680e164b5a36 diff --git a/framework/main/classes/template/class_BaseTemplateEngine.php b/framework/main/classes/template/class_BaseTemplateEngine.php index 1908e3bc..dccbddc4 100644 --- a/framework/main/classes/template/class_BaseTemplateEngine.php +++ b/framework/main/classes/template/class_BaseTemplateEngine.php @@ -5,14 +5,19 @@ namespace Org\Mxchange\CoreFramework\Template\Engine; // Import framework stuff use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap; use Org\Mxchange\CoreFramework\EntryPoint\ApplicationEntryPoint; -use Org\Mxchange\CoreFramework\Factory\ObjectFactory; +use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory; use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException; +use Org\Mxchange\CoreFramework\Generic\FrameworkInterface; +use Org\Mxchange\CoreFramework\Generic\NullPointerException; +use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper; use Org\Mxchange\CoreFramework\Manager\ManageableApplication; use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem; -use Org\Mxchange\CoreFramework\Registry\GenericRegistry; use Org\Mxchange\CoreFramework\Response\Responseable; +use Org\Mxchange\CoreFramework\Traits\Handler\Io\IoHandlerTrait; +use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils; // Import SPL stuff +use \BadMethodCallException; use \InvalidArgumentException; use \SplFileInfo; @@ -21,7 +26,7 @@ use \SplFileInfo; * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.shipsimu.org * @@ -39,6 +44,20 @@ use \SplFileInfo; * along with this program. If not, see . */ abstract class BaseTemplateEngine extends BaseFrameworkSystem { + // Load traits + use IoHandlerTrait; + + // 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; + + /** + * HTML template type + */ + private static $htmlTemplateType = 'invalid'; + /** * The local path name where all templates and sub folders for special * templates are stored. We will internally determine the language plus @@ -89,17 +108,17 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { /** * The variable stack for the templates */ - private $varStack = array(); + private $varStack = []; /** * Loaded templates for recursive protection and detection */ - private $loadedTemplates = array(); + private $loadedTemplates = []; /** * Compiled templates for recursive protection and detection */ - private $compiledTemplates = array(); + private $compiledTemplates = []; /** * Loaded raw template data @@ -131,7 +150,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { /** * Loaded helpers */ - private $helpers = array(); + private $helpers = []; /** * Current variable group @@ -141,7 +160,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { /** * All template groups except "general" */ - private $variableGroups = array(); + private $variableGroups = []; /** * Code begin @@ -158,32 +177,29 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ private $languageSupport = true; - /** - * XML compacting is disabled by default - */ - 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 * * @param $className Name of the class * @return void */ - protected function __construct ($className) { + protected function __construct (string $className) { // Call parent constructor + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: className=%s - CONSTRUCTED!', $className)); parent::__construct($className); // Init file I/O instance $ioInstance = ObjectFactory::createObjectByConfiguredName('file_io_class'); // Set it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: ioInstance=%s', $ioInstance->__toString())); $this->setFileIoInstance($ioInstance); + + // "Cache" config entry + self::$htmlTemplateType = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('html_template_type'); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: self::htmlTemplateType=%s - EXIT!', self::$htmlTemplateType)); } /** @@ -193,36 +209,40 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $variableGroup Optional variable group to look in * @return $index false means not found, >=0 means found on a specific index */ - private function getVariableIndex ($variableName, $variableGroup = NULL) { + private function getVariableIndex (string $variableName, string $variableGroup = NULL) { // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,variableGroup[%s]=%s - CALLED!', $variableName, gettype($variableGroup), $variableGroup)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // First everything is not found + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableName=%s', $variableName)); $found = false; // If the stack is NULL, use the current group if (is_null($variableGroup)) { // Use current group - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->currGroup=%s set as stack!', $this->currGroup)); $variableGroup = $this->currGroup; - } // END - if + } // Is the group there? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableGroup=%s', $variableGroup)); if ($this->isVarStackSet($variableGroup)) { // Now search for it foreach ($this->getVarStack($variableGroup) as $index => $currEntry) { - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':currGroup=' . $variableGroup . ',idx=' . $index . ',currEntry=' . $currEntry['name'] . ',variableName=' . $variableName); // Is the entry found? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: index=%d,currGroup=%s,currEntry[name]=%s,variableName=%s', $index, $variableGroup, $currEntry['name'], $variableName)); if ($currEntry['name'] == $variableName) { // Found! - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.':FOUND!'); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: index=%d - BREAK!', $index)); $found = $index; break; - } // END - if - } // END - foreach - } // END - if + } + } + } // Return the current position + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: found=%d - EXIT!', $found)); return $found; } @@ -231,13 +251,22 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $variableGroup Variable group to check * @return $isSet Whether the given variable group is set + * @throws InvalidArgumentException If the variable name is left empty */ - protected final function isVarStackSet ($variableGroup) { + protected final function isVarStackSet (string $variableGroup) { + // Validate parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s - CALLED!', $variableGroup)); + if (empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Check it - $isSet = isset($this->varStack[$variableGroup]); + $isset = isset($this->varStack[$variableGroup]); // Return result - return $isSet; + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: isset=%d - EXIT!', intval($isset))); + return $isset; } /** @@ -245,8 +274,18 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $variableGroup Variable group to check * @return $varStack Found variable group + * @throws InvalidArgumentException If the variable name is left empty */ - public final function getVarStack ($variableGroup) { + public final function getVarStack (string $variableGroup) { + // Validate parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s - CALLED!', $variableGroup)); + if (empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + + // Return value + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: this->varStack[%s]()=%d - EXIT!', $variableGroup, count($this->varStack[$variableGroup]))); return $this->varStack[$variableGroup]; } @@ -256,9 +295,21 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $variableGroup Variable group to check * @param $varStack Variable stack to check * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - protected final function setVarStack ($variableGroup, array $varStack) { + protected final function setVarStack (string $variableGroup, array $varStack) { + // Validate parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s,varStack()=%d - CALLED!', $variableGroup, count($varStack))); + if (empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + + // Set var stack $this->varStack[$variableGroup] = $varStack; + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -267,32 +318,46 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @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 + * @throws InvalidArgumentException If the variable name is left empty */ - protected function readVariable ($variableName, $variableGroup = NULL) { + protected function readVariable (string $variableName, string $variableGroup = NULL) { + // Check parameters + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,variableGroup[%s]=%s - CALLED!', $variableName, gettype($variableGroup), $variableGroup)); + if (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (!is_null($variableGroup) && empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // First everything is not found + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableName=%s', $variableName)); $content = NULL; // If the stack is NULL, use the current group if (is_null($variableGroup)) { // Use current group - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.' currGroup=' . $this->currGroup . ' set as stack!'); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->currGroup=%s set as stack!', $this->currGroup)); $variableGroup = $this->currGroup; - } // END - if + } // Get variable index $found = $this->getVariableIndex($variableName, $variableGroup); // Is the variable found? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: found[]=%s', gettype($found))); if ($found !== false) { // Read it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->getVariableValue(%s,%s) ...', $variableGroup, $found)); $content = $this->getVariableValue($variableGroup, $found); - } // END - if + } // Return the current position - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': variableGroup=' . $variableGroup . ',variableName=' . $variableName . ', content[' . gettype($content) . ']=' . $content); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: content()=%d - EXIT!', strlen($content))); return $content; } @@ -303,12 +368,17 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $value Value we want to store in the variable * @return void */ - private function addVariable ($variableName, $value) { + private function addVariable (string $variableName, $value) { // Set general variable group + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,value[]=%s - CALLED!', $variableName, gettype($value))); $this->setVariableGroup('general'); // Add it to the stack + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->addVariableGroup(%s,value[]=%s) ...', $variableName, gettype($value))); $this->addGroupVariable($variableName, $value); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -318,15 +388,19 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ private function readCurrentGroup () { // Default is not found - $result = array(); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: CALLED!'); + $result = []; // Is the group there? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->currGroup=%s', $this->currGroup)); if ($this->isVarStackSet($this->currGroup)) { // Then use it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->getVarStack(%s) ...', $this->currGroup)); $result = $this->getVarStack($this->currGroup); - } // END - if + } // Return result + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: result()=%d - EXIT!', count($result))); return $result; } @@ -336,18 +410,29 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $groupName Name of variable group * @param $add Whether add this group * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function setVariableGroup ($groupName, $add = true) { + public function setVariableGroup (string $groupName, bool $add = true) { + // Check parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: groupName=%s,add=%d - CALLED!', $groupName, intval($add))); + if (empty($groupName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "groupName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Set group name - //* DEBIG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': currGroup=' . $groupName); $this->currGroup = $groupName; // Skip group 'general' if (($groupName != 'general') && ($add === true)) { + // Mark as 'OK' + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Marking groupName=%s as OK ...', $groupdName)); $this->variableGroups[$groupName] = 'OK'; - } // END - if - } + } + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); + } /** * Adds a variable to current group @@ -355,34 +440,54 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $variableName Variable to set * @param $value Value to store in variable * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function addGroupVariable ($variableName, $value) { - // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + public function addGroupVariable (string $variableName, $value) { + // Check parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,value[]=%s - CALLED!', $variableName, gettype($value))); + if (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (is_object($value) || is_resource($value)) { + // Throw an exception + throw new InvalidArgumentException(sprintf('value[]=%s is not supported', gettype($value)), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } - // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': group=' . $this->currGroup . ', variableName=' . $variableName . ', value=' . $value); + // Replace all dashes to underscores to match variables with configuration entries + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking StringUtils::convertDashesToUnderscores(%s) ...', $variableName)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Get current variables in group + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->currGroup=%s,variableName=%s,value[]=%s', $this->currGroup, $variableName, gettype($value))); $currVars = $this->readCurrentGroup(); // Append our variable + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: currVars()=%d - BEFORE!', count($currVars))); array_push($currVars, $this->generateVariableArray($variableName, $value)); // Add it to the stack + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setVarStack(%s,currVars()=%d) - AFTER!', $this->currGroup, count($currVars))); $this->setVarStack($this->currGroup, $currVars); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** * Getter for variable value, throws a NoVariableException if the variable is not found * * @param $variableGroup Variable group to use - * @param $index Index in variable array - * @return $value Value to set + * @param $index Index in variable array + * @return $value Value to set */ - private function getVariableValue ($variableGroup, $index) { + private function getVariableValue (string $variableGroup, int $index) { // Return it - return $this->varStack[$variableGroup][$index]['value']; + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s,index[]=%d - CALLED!', $variableGroup, $index)); + $value = $this->varStack[$variableGroup][$index]['value']; + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: value[]=%s - EXIT!', gettype($value))); + return $value; } /** @@ -391,23 +496,22 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @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 ($variableName, $value) { + private function modifyVariable (string $variableName, $value) { // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,value[]=%s - CALLED!', $variableName, gettype($value))); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Get index for variable + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: this->getVariableIndex(%s) ...', $variableName)); $index = $this->getVariableIndex($variableName); - // Is the variable set? - 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 + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: this->setVariableValue(%s,%d,value[]=%s) ...', $this->currGroup, $index, gettype($value))); $this->setVariableValue($this->currGroup, $index, $value); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -418,8 +522,13 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $value Value to set * @return void */ - private function setVariableValue ($variableGroup, $index, $value) { + private function setVariableValue (string $variableGroup, int $index, $value) { + // Set variable + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s,index[]=%d,value[]=%s - CALLED!', $variableGroup, $index, gettype($value))); $this->varStack[$variableGroup][$index]['value'] = $value; + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -431,28 +540,47 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $variableName Variable to set * @param $value Value to set * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - protected function setVariable ($variableGroup, $variableName, $value) { + protected function setVariable (string $variableGroup, string $variableName, $value) { + // Check parameters + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableGroup=%s,variableName=%s,value[]=%s - CALLED!', $variableGroup, $variableName, gettype($value))); + if (empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Get index for variable + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: this->getVariableIndex(%s) ...', $variableName)); $index = $this->getVariableIndex($variableName); // Is the variable set? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: index[]=%s', gettype($index))); if ($index === false) { // Is the stack there? if (!isset($this->varStack[$variableGroup])) { // Then initialize it here - $this->varStack[$variableGroup] = array(); - } // END - if + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Initializing this->varStack[%s] ...', $variableGroup)); + $this->varStack[$variableGroup] = []; + } // Not found, add it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Pushing variableGroup=%s,variableName=%s,value[]=%s ...', $variableGroup, $variableName, gettype($value))); array_push($this->varStack[$variableGroup], $this->generateVariableArray($variableName, $value)); } else { // Then modify it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setVariableValue(%s,%d,value[]=%s) ...', $this->currGroup, $index, gettype($value))); $this->setVariableValue($this->currGroup, $index, $value); } + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -463,17 +591,19 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $value Value to set * @return $varData Variable data array */ - private function generateVariableArray ($variableName, $value) { + private function generateVariableArray (string $variableName, $value) { // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,value[]=%s - CALLED!', $variableName, gettype($value))); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Generate the temporary array - $varData = array( + $varData = [ 'name' => $variableName, 'value' => $value - ); + ]; // And return it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: varData()=%d - EXIT!', count($varData))); return $varData; } @@ -484,8 +614,8 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $templateType The current template's type * @return void */ - protected final function setTemplateType ($templateType) { - $this->templateType = (string) $templateType; + protected final function setTemplateType (string $templateType) { + $this->templateType = $templateType; } /** @@ -522,9 +652,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $templateBasePath The relative base path for all templates * @return void */ - protected final function setTemplateBasePath ($templateBasePath) { + protected final function setTemplateBasePath (string $templateBasePath) { // And set it - $this->templateBasePath = (string) $templateBasePath; + $this->templateBasePath = $templateBasePath; } /** @@ -554,9 +684,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * templates * @return void */ - protected final function setRawTemplateExtension ($templateExtension) { + protected final function setRawTemplateExtension (string $templateExtension) { // And set it - $this->templateExtension = (string) $templateExtension; + $this->templateExtension = $templateExtension; } /** @@ -566,9 +696,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * templates * @return void */ - protected final function setCodeTemplateExtension ($codeExtension) { + protected final function setCodeTemplateExtension (string $codeExtension) { // And set it - $this->codeExtension = (string) $codeExtension; + $this->codeExtension = $codeExtension; } /** @@ -600,9 +730,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * templates * @return void */ - protected final function setCompileOutputPath ($compileOutputPath) { + protected final function setCompileOutputPath (string $compileOutputPath) { // And set it - $this->compileOutputPath = (string) $compileOutputPath; + $this->compileOutputPath = $compileOutputPath; } /** @@ -611,22 +741,40 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $index Index to unset * @param $variableGroup Variable group (default: currGroup) * @return void - */ - protected final function unsetVariableStackOffset ($index, $variableGroup = NULL) { + * @throws InvalidArgumentException If the variable name is left empty + * @throws BadMethodCallException If this method was called but combination of variableGroup/index isn't found + */ + protected final function unsetVariableStackOffset (int $index, string $variableGroup = NULL) { + // Check variables + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: index=%d,variableGroup[%s]=%s - CALLED!', $index, gettype($variableGroup), $variableGroup)); + if ($index < 0) { + // Invalid index + throw new InvalidArgumentException(sprintf('index=%d is below zero', $index), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (!is_null($variableGroup) && empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Is the variable group not set? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableGroup[]=%s', gettype($variableGroup))); if (is_null($variableGroup)) { // Then set it to current $variableGroup = $this->currGroup; - } // END - if + } // Is the entry there? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Checking variableGroup=%s,index=%d ...', $variableGroup, $index)); if (!isset($this->varStack[$variableGroup][$index])) { // Abort here, we need fixing! - $this->debugInstance(); - } // END - if + throw new BadMethodCallException(sprintf('variableGroup=%s,index=%d does not exist, but method was invoked', $variableGroup, $index), FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } // Remove it + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Unsetting variableGroup=%s,index=%d ...', $variableGroup, $index)); unset($this->varStack[$variableGroup][$index]); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -635,11 +783,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $rawTemplateData The raw data from the template * @return void */ - protected final function setRawTemplateData ($rawTemplateData) { + protected final function setRawTemplateData (string $rawTemplateData) { // And store it in this class - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . strlen($rawTemplateData) . ' Bytes set.'); - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(__METHOD__.': ' . $this->currGroup . ' variables: ' . count($this->getVarStack($this->currGroup)) . ', groups=' . count($this->varStack)); - $this->rawTemplateData = (string) $rawTemplateData; + $this->rawTemplateData = $rawTemplateData; } /** @@ -648,19 +794,18 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @return $rawTemplateData The raw data from the template */ public final function getRawTemplateData () { - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->rawTemplateData) . ' Bytes read.'); return $this->rawTemplateData; } /** * Private setter for compiled templates * + * @param $compiledData Compiled template data * @return void */ - private final function setCompiledData ($compiledData) { + private final function setCompiledData (string $compiledData) { // And store it in this class - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($compiledData) . ' Bytes set.'); - $this->compiledData = (string) $compiledData; + $this->compiledData = $compiledData; } /** @@ -669,7 +814,6 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @return $compiledData Compiled template data */ public final function getCompiledData () { - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: ' . strlen($this->compiledData) . ' Bytes read.'); return $this->compiledData; } @@ -679,16 +823,24 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $templateName The template we shall load * @param $extOther An other extension to use * @return void + * @throws InvalidArgumentException If the variable name is left empty * @throws FileNotFoundException If the template was not found */ - protected function loadTemplate ($templateName, $extOther = '') { + protected function loadTemplate (string $templateName, string $extOther = '') { + // Check parameter + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: templateName=%s,extOther=%s - CALLED!', $templateName, $extOther)); + if (empty($templateName)) { + // Throw IAE + throw new InvalidArgumentException('Parameter "templateName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Get extension for the template if empty if (empty($extOther)) { // None provided, so get the raw one $ext = $this->getRawTemplateExtension(); } else { // Then use it! - $ext = (string) $extOther; + $ext = $extOther; } /* @@ -696,6 +848,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * now entirely done by php_intl. These old thing with language-based * template paths comes from an older time. */ + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: ext=%s', $ext)); $fileInstance = new SplFileInfo(sprintf('%s%s%s%s%s%s', $this->getTemplateBasePath(), $this->getGenericBasePath(), @@ -706,16 +859,20 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { )); // First try this + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: fileInstance=%s', $fileInstance->__toString())); try { // Load the raw template data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->loadRawTemplateData(%s) ...', $fileInstance->__toString())); $this->loadRawTemplateData($fileInstance); } catch (FileNotFoundException $e) { // If we shall load a code-template we need to switch the file extension - if (($this->getTemplateType() != $this->getConfigInstance()->getConfigEntry('html_template_type')) && (empty($extOther))) { + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->templateType=%s,self::htmlTemplateType=%s,extOther=%s', $this->getTemplateType(), self::$htmlTemplateType, $extOther)); + if (($this->getTemplateType() != self::$htmlTemplateType) && (empty($extOther))) { // Switch over to the code-template extension and try it again $ext = $this->getCodeTemplateExtension(); // Try it again... + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->loadTemplate(%s,%s) ...', $templateName, $ex)); $this->loadTemplate($templateName, $ext); } else { // Throw it again @@ -723,6 +880,8 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { } } + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -732,43 +891,50 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ private function loadRawTemplateData (SplFileInfo $fileInstance) { - // Some debug code to look on the file which is being loaded - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: fileInstance=' . $fileInstance); - // Load the raw template + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: fileInstance=%s - CALLED!', $fileInstance->__toString())); $rawTemplateData = $this->getFileIoInstance()->loadFileContents($fileInstance); // Store the template's contents into this class + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setRawTemplateData(%d) ...', strlen($rawTemplateData))); $this->setRawTemplateData($rawTemplateData); // Remember the template's file instance + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setLastTemplate(%s) ...', $fileInstance->__toString())); $this->setLastTemplate($fileInstance); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** * Try to assign an extracted template variable as a "content" or 'config' * variable. * - * @param $variableName The variable's name (shall be content or config) + * @param $variableName The variable's name (shall be content or config) * by default - * @param $variableName The variable we want to assign + * @param $configKey Possible configuration key * @return void */ - private function assignTemplateVariable ($variableName, $var) { + private function assignTemplateVariable (string $variableName, string $configKey = '') { // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); - - // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',variableName=' . $variableName); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: variableName=%s,configKey=%s - CALLED!', $variableName, $configKey)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Is it not a config variable? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableName=%s', $variableName)); if ($variableName != 'config') { // Regular template variables + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->assignVariable(%s,"") ...', $variableName)); $this->assignVariable($variableName, ''); } else { // Configuration variables - $this->assignConfigVariable($var); + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->assignConfigVariable(%s,"") ...', $configKey)); + $this->assignConfigVariable($configKey); } + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -777,30 +943,33 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $rawData The raw template data we shall analyze * @return void */ - private function extractVariablesFromRawData ($rawData) { - // Cast to string - $rawData = (string) $rawData; - + private function extractVariablesFromRawData (string $rawData) { // Search for variables + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: rawData(%d)=%s - CALLED!', strlen($rawData), $rawData)); preg_match_all('/\$(\w+)(\[(\w+)\])?/', $rawData, $variableMatches); - // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawData(' . strlen($rawData) . ')=' . $rawData . ',variableMatches=' . print_r($variableMatches, true)); - // Did we find some variables? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableMatches[]=%s', gettype($variableMatches))); if ((is_array($variableMatches)) && (count($variableMatches) == 4) && (count($variableMatches[0]) > 0)) { // Initialize all missing variables + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableMatches()=%d', count($variableMatches))); foreach ($variableMatches[3] as $key => $var) { // Variable name + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: key=%s,var=%s', $key, $var)); $variableName = $variableMatches[1][$key]; // Workarround: Do not assign empty variables + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: variableName=%s', $variableName)); if (!empty($var)) { // Try to assign it, empty strings are being ignored + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->assignTemplateVariable(%s,%s) ...', $variableName, $var)); $this->assignTemplateVariable($variableName, $var); - } // END - if - } // END - foreach - } // END - if + } + } + } + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -819,50 +988,65 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ private function analyzeTemplate (array $templateMatches) { // Backup raw template data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: templateMatches()=%d', count($templateMatches))); $backup = $this->getRawTemplateData(); // Initialize some arrays + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: backup[%s]()=%d,this->loadedRawData[]=%s', gettype($backup), strlen($backup), gettype($this->loadedRawData))); if (is_null($this->loadedRawData)) { // Initialize both - $this->loadedRawData = array(); - $this->rawTemplates = array(); - } // END - if + $this->loadedRawData = []; + $this->rawTemplates = []; + } // Load all requested templates + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: templateMatches[1]()=%d', count($templateMatches[1]))); foreach ($templateMatches[1] as $template) { // Load and compile only templates which we have not yet loaded + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: template=%s', $template)); // RECURSIVE PROTECTION! BE CAREFUL HERE! if ((!isset($this->loadedRawData[$template])) && (!in_array($template, $this->loadedTemplates))) { - // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template); - // Template not found, but maybe variable assigned? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: template=%s not loaded yet', $template)); if ($this->getVariableIndex($template) !== false) { // Use that content here + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Assigning this->loadedTemplateData[%s] from variable template=%s ...', $template, $template)); $this->loadedRawData[$template] = $this->readVariable($template); // Recursive protection: + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Marking template=%s as loaded ...', $template)); array_push($this->loadedTemplates, $template); } else { // Then try to search for code-templates + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: template=%s is maybe name of code template?', $template)); try { - // Load the code template and remember it's contents + // Load the code template ... + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->loadCodeTemplate(%s) ...', $template)); $this->loadCodeTemplate($template); + + // ... and remember it's contents + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Setting this->loadedRawData[%s] from this->rawTemplateData ...', $template)); $this->loadedRawData[$template] = $this->getRawTemplateData(); // Remember this template for recursion detection // RECURSIVE PROTECTION! + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Marking template=%s as loaded ...', $template)); array_push($this->loadedTemplates, $template); } catch (FileNotFoundException $e) { // Even this is not done... :/ + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Marking template=%s as loaded ...', $template)); array_push($this->rawTemplates, $template); } } - } // END - if - } // END - foreach + } + } // Restore the raw template data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setRawTemplateData(backup()=%d) ...', strlen($backup))); $this->setRawTemplateData($backup); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -872,32 +1056,43 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $template The template's name * @return void */ - private function compileCode ($code, $template) { + private function compileCode (string $code, string $template) { // Is this template already compiled? + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: code=%s,template=%s - CALLED!', $code, $template)); if (in_array($template, $this->compiledTemplates)) { // Abort here... + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Found template=%s in this->compiledTemplates - EXIT!', $template)); return; - } // END - if + } // Remember this template being compiled + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: Adding template=%s to this->compiledTemplates ...', $template)); array_push($this->compiledTemplates, $template); // Compile the loaded code in five steps: // // 1. Backup current template data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: this->compiledTemplates()=%d', count($this->compiledTemplates))); $backup = $this->getRawTemplateData(); // 2. Set the current template's raw data as the new content + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setRawTemplateData(code()=%d) ... - backup[%s]()=%d', strlen($code), gettype($backup), strlen($backup))); $this->setRawTemplateData($code); // 3. Compile the template data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: Invoking this->compileTemplate() ...'); $this->compileTemplate(); // 4. Remember it's contents + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-TEMPLATE: Setting this->loadedRawData[%s] from this->rawTemplateData ...', $template)); $this->loadedRawData[$template] = $this->getRawTemplateData(); // 5. Restore the previous raw content from backup variable + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: Invoking this->setRawTemplateData(backup()=%d) ...', strlen($backup))); $this->setRawTemplateData($backup); + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -909,24 +1104,30 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ private function insertAllTemplates (array $templateMatches) { // Run through all loaded codes + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-TEMPLATE: templateMatches()=%d', count($templateMatches))); foreach ($this->loadedRawData as $template => $code) { - // Search for the template + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: template=%s,code()=%d', $template, strlen($code))); $foundIndex = array_search($template, $templateMatches[1]); // Lookup the matching template replacement + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: foundIndex[%s]=d', gettype($foundIndex), $foundIndex)); if (($foundIndex !== false) && (isset($templateMatches[0][$foundIndex]))) { - // Get the current raw template $rawData = $this->getRawTemplateData(); // Replace the space holder with the template code + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: rawData()=%s - BEFORE!', strlen($rawData))); $rawData = str_replace($templateMatches[0][$foundIndex], $code, $rawData); // Set the new raw data + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-TEMPLATE: rawData()=%s - AFTER!', strlen($rawData))); $this->setRawTemplateData($rawData); - } // END - if - } // END - foreach + } + } + + // Trace message + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-TEMPLATE: EXIT!'); } /** @@ -956,8 +1157,8 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // This template was never found. We silently ignore it unset($this->rawTemplates[$key]); } - } // END - foreach - } // END - if + } + } } /** @@ -968,22 +1169,20 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @todo Unfinished work or don't die here. */ private function assignAllVariables (array $varMatches) { - // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches()=' . count($varMatches)); - // Search for all variables + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varMatches()=' . count($varMatches)); foreach ($varMatches[1] as $key => $var) { // Replace all dashes to underscores to match variables with configuration entries - $var = trim(self::convertDashesToUnderscores($var)); + $var = trim(StringUtils::convertDashesToUnderscores($var)); // Debug message - self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:key=' . $key . ',var=' . $var); + self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:key=' . $key . ',var=' . $var); // Detect leading equals if (substr($varMatches[2][$key], 0, 1) == '=') { // Remove and cast it $varMatches[2][$key] = (string) substr($varMatches[2][$key], 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) == '"')) { @@ -993,7 +1192,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // @TODO Non-string found so we need some deeper analysis... ApplicationEntryPoint::exitApplication('Deeper analysis not yet implemented!'); } - } // END - foreach + } } /** @@ -1003,22 +1202,20 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @return void */ private function compileRawTemplateData (array $templateMatches) { - // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:loadedRawData()= ' .count($this->loadedRawData)); - // Are some code-templates found which we need to compile? + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:loadedRawData()= ' .count($this->loadedRawData)); if (count($this->loadedRawData) > 0) { // Then compile all! foreach ($this->loadedRawData as $template => $code) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:template=' . $template . ',code(' . strlen($code) . ')=' . $code); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:template=' . $template . ',code(' . strlen($code) . ')=' . $code); // Is this template already compiled? if (in_array($template, $this->compiledTemplates)) { // Then skip it - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Template ' . $template . ' already compiled. SKIPPED!'); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Template ' . $template . ' already compiled. SKIPPED!'); continue; - } // END - if + } // Search for the template $foundIndex = array_search($template, $templateMatches[1]); @@ -1027,19 +1224,19 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { 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__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varMatches=' . print_r($varMatches, true)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: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) ... + } } /** @@ -1063,18 +1260,11 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { private function finalizeVariableCompilation () { // Get the content $content = $this->getRawTemplateData(); - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content before=' . strlen($content) . ' (' . md5($content) . ')'); - - // Do we have the stack? - if (!$this->isVarStackSet('general')) { - // Abort here silently - // @TODO This silent abort should be logged, maybe. - return; - } // END - if + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content before=' . strlen($content) . ' (' . md5($content) . ')'); // Walk through all variables foreach ($this->getVarStack('general') as $currEntry) { - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currEntry['name'] . ', value=
' . htmlentities($currEntry['value']) . '
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currEntry['name'] . ', value=
' . htmlentities($currEntry['value']) . '
'); // Replace all [$var] or {?$var?} with the content // @TODO Old behaviour, will become obsolete! $content = str_replace('$content[' . $currEntry['name'] . ']', $currEntry['value'], $content); @@ -1084,11 +1274,10 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // The new behaviour $content = str_replace('{?' . $currEntry['name'] . '?}', $currEntry['value'], $content); - } // END - for - - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: content after=' . strlen($content) . ' (' . md5($content) . ')'); + } // Set the content back + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: content after=' . strlen($content) . ' (' . md5($content) . ')'); $this->setRawTemplateData($content); } @@ -1098,10 +1287,17 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $template The web template we shall load which is located in * 'html' by default * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function loadHtmlTemplate ($template) { + public function loadHtmlTemplate (string $template) { + // Validate parameter + if (empty($template)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "template" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Set template type - $this->setTemplateType($this->getConfigInstance()->getConfigEntry('html_template_type')); + $this->setTemplateType(self::$htmlTemplateType); // Load the special template $this->loadTemplate($template); @@ -1115,15 +1311,15 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @return void * @throws InvalidArgumentException If the variable name is left empty */ - public final function assignVariable ($variableName, $value) { - // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); - - // Empty variable found? + public final function assignVariable (string $variableName, $value) { + // Validate parameter if (empty($variableName)) { // Throw an exception - throw new InvalidArgumentException('Parameter "variableName" is empty'); - } // END - if + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + + // Replace all dashes to underscores to match variables with configuration entries + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // First search for the variable if it was already added $index = $this->getVariableIndex($variableName); @@ -1131,11 +1327,11 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // Was it found? if ($index === false) { // Add it to the stack - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:ADD: ' . $variableName . '[' . gettype($value) . ']=' . $value); $this->addVariable($variableName, $value); } elseif (!empty($value)) { // Modify the stack entry - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:MOD: ' . $variableName . '[' . gettype($value) . ']=' . $value); $this->modifyVariable($variableName, $value); } } @@ -1146,17 +1342,27 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $variableName The variable we are looking for * @param $variableGroup Name of variable group (default: 'general') * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public final function removeVariable ($variableName, $variableGroup = 'general') { + public final function removeVariable (string $variableName, string $variableGroup = 'general') { + // Validate parameter + if (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (empty($variableGroup)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableGroup" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // First search for the variable if it was already added $index = $this->getVariableIndex($variableName, $variableGroup); // Was it found? if ($index !== false) { // Remove this variable - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:UNSET: variableGroup=' . $variableGroup . ',variableName=' . $variableName . ',index=' . $index); $this->unsetVariableStackOffset($index, $variableGroup); - } // END - if + } } /** @@ -1165,8 +1371,18 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $templateName Name of the template we want to assign * @param $variableName Name of the variable we want to assign * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function assignTemplateWithVariable ($templateName, $variableName) { + public function assignTemplateWithVariable (string $templateName, string $variableName) { + // Validate parameter + if (empty($templateName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "templateName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Get the content from last loaded raw template $content = $this->getRawTemplateData(); @@ -1182,14 +1398,21 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $variableName The configuration variable we want to assign * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function assignConfigVariable ($variableName) { + public function assignConfigVariable (string $variableName) { + // Validate parameter + if (empty($variableName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "variableName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Replace all dashes to underscores to match variables with configuration entries - $variableName = trim(self::convertDashesToUnderscores($variableName)); + $variableName = trim(StringUtils::convertDashesToUnderscores($variableName)); // Sweet and simple... - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: variableName=' . $variableName . ',getConfigEntry()=' . $this->getConfigInstance()->getConfigEntry($variableName)); - $this->assignVariable($variableName, $this->getConfigInstance()->getConfigEntry($variableName)); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: variableName=' . $variableName . ',getConfigEntry()=' . FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName)); + $this->assignVariable($variableName, FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($variableName)); } /** @@ -1207,7 +1430,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { foreach ($variables as $name => $value) { // Set variable with name for 'config' group $this->assignVariable($name, $value); - } // END - foreach + } } /** @@ -1217,7 +1440,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ public function assignApplicationData () { // Get application instance - $applicationInstance = GenericRegistry::getRegistry()->getInstance('application'); + $applicationInstance = ApplicationHelper::getSelfInstance(); // Get long name and assign it $this->assignVariable('app_full_name' , $applicationInstance->getAppName()); @@ -1238,10 +1461,17 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $template The code template we shall load which is * located in 'code' by default * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function loadCodeTemplate ($template) { + public function loadCodeTemplate (string $template) { + // Validate parameter + if (empty($template)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "template" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Set template type - $this->setTemplateType($this->getConfigInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')); + $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')); // Load the special template $this->loadTemplate($template); @@ -1253,10 +1483,17 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $template The email template we shall load which is * located in 'emails' by default * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function loadEmailTemplate ($template) { + public function loadEmailTemplate (string $template) { + // Validate parameter + if (empty($template)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "template" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Set template type - $this->setTemplateType($this->getConfigInstance()->getConfigEntry('email_template_type')); + $this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('email_template_type')); // Load the special template $this->loadTemplate($template); @@ -1273,9 +1510,9 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // Do we have the stack? if (!$this->isVarStackSet('general')) { // Abort here silently - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: Aborted, variable stack general not found!'); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: Aborted, variable stack general not found!'); return; - } // END - if + } // Iterate through all general variables foreach ($this->getVarStack('general') as $index => $currVariable) { @@ -1283,21 +1520,21 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { $value = $this->compileRawCode($this->readVariable($currVariable['name']), true); // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: name=' . $currVariable['name'] . ',value=' . $value); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: name=' . $currVariable['name'] . ',value=' . $value); // Remove it from stack $this->removeVariable($currVariable['name'], 'general'); - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: value='. $value . ',name=' . $currVariable['name'] . ',index=' . $index); // Is it a configuration key? - if ($this->getConfigInstance()->isConfigurationEntrySet($value)) { + if (FrameworkBootstrap::getConfigurationInstance()->isConfigurationEntrySet($value)) { // The value itself is a configuration entry $this->assignConfigVariable($value); } else { // Re-assign the value directly $this->assignVariable($currVariable['name'], $value); } - } // END - foreach + } } /** @@ -1308,15 +1545,15 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ public final function compileVariables () { // Initialize the $content array - $validVar = $this->getConfigInstance()->getConfigEntry('tpl_valid_var'); - $dummy = array(); + $validVar = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('tpl_valid_var'); + $dummy = []; // Iterate through all general variables foreach ($this->getVarStack('general') as $currVariable) { // Transfer it's name/value combination to the $content array - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:' . $currVariable['name'] . '=
' . htmlentities($currVariable['value']).'
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:' . $currVariable['name'] . '=
' . htmlentities($currVariable['value']).'
'); $dummy[$currVariable['name']] = $currVariable['value']; - }// END - if + } // Set the new variable (don't remove the second dollar!) $$validVar = $dummy; @@ -1353,7 +1590,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // And put all together $eval = sprintf('%s<%%php %s %%>%s', $evalLeft, $evalMiddle, $evalRight); - } // END - while + } // Prepare PHP code for eval() command $eval = str_replace( @@ -1375,12 +1612,12 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // Output backtrace here $this->debugBackTrace(); - } // END - if + } // Set raw template data $this->setRawTemplateData($result); $cnt++; - } // END - while + } // Final variable assignment $this->finalizeVariableCompilation(); @@ -1400,13 +1637,13 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { */ public function compileTemplate () { // Get code type to make things shorter - $codeType = $this->getConfigInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type'); + $codeType = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type'); // We will only work with template type "code" from configuration if (substr($this->getTemplateType(), 0, strlen($codeType)) != $codeType) { // Abort here - throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), $this->getConfigInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED); - } // END - if + throw new UnexpectedTemplateTypeException(array($this, $this->getTemplateType(), FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('code_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_template_type')), self::EXCEPTION_TEMPLATE_TYPE_IS_UNEXPECTED); + } // Get the raw data. $rawData = $this->getRawTemplateData(); @@ -1421,7 +1658,7 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { preg_match_all($this->regExpCodeTags, $rawData, $templateMatches); // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:templateMatches=' . print_r($templateMatches , true)); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:templateMatches=' . print_r($templateMatches , true)); // Analyze the matches array if ((is_array($templateMatches)) && (count($templateMatches) == 4) && (count($templateMatches[0]) > 0)) { @@ -1443,8 +1680,8 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // Remove the raw template content as well $this->setRawTemplateData(''); - } // END - if - } // END - if($templateMatches ... + } + } } /** @@ -1452,16 +1689,23 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * * @param $helperName The helper's name * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - protected function loadViewHelper ($helperName) { + protected function loadViewHelper (string $helperName) { + // Validate parameter + if (empty($helperName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "helperName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Is this view helper loaded? if (!isset($this->helpers[$helperName])) { // Create a class name - $className = self::convertToClassName($helperName) . 'ViewHelper'; + $className = StringUtils::convertToClassName($helperName) . 'ViewHelper'; // Generate new instance $this->helpers[$helperName] = ObjectFactory::createObjectByName($className); - } // END - if + } // Return the requested instance return $this->helpers[$helperName]; @@ -1484,25 +1728,32 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $rawCode Raw code to compile * @param $setMatchAsCode Sets $match if readVariable() returns empty result * @return $rawCode Compile code with inserted variable value + * @throws InvalidArgumentException If the variable name is left empty */ - public function compileRawCode ($rawCode, $setMatchAsCode=false) { + public function compileRawCode (string $rawCode, bool $setMatchAsCode = false) { + // Validate parameter + if (empty($rawCode)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "rawCode" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Find the variables - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=
' . htmlentities($rawCode) . '
'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=
' . htmlentities($rawCode) . '
'); preg_match_all($this->regExpVarValue, $rawCode, $varMatches); // Compile all variables - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:
' . print_r($varMatches, true) . '
'); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:
' . print_r($varMatches, true) . '
'); foreach ($varMatches[0] as $match) { // Add variable tags around it $varCode = '{?' . $match . '?}'; // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:varCode=' . $varCode); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:varCode=' . $varCode); // Is the variable found in code? (safes some calls) if (strpos($rawCode, $varCode) !== false) { // Debug message - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: match=' . $match . ',rawCode[' . gettype($rawCode) . ']=' . $rawCode); // Use $match as new value or $value from read variable? if ($setMatchAsCode === true) { @@ -1515,11 +1766,11 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { // Insert value $rawCode = str_replace($varCode, $value, $rawCode); } - } // END - if - } // END - foreach + } + } // Return the compiled data - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']:rawCode=
' . htmlentities($rawCode) . '
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE:rawCode=
' . htmlentities($rawCode) . '
'); return $rawCode; } @@ -1538,9 +1789,19 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { * @param $oldName Old name of variable * @param $newName New name of variable * @return void + * @throws InvalidArgumentException If the variable name is left empty */ - public function renameVariable ($oldName, $newName) { - //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE[' . __METHOD__ . ':' . __LINE__ . ']: oldName=' . $oldName . ', newName=' . $newName); + public function renameVariable (string $oldName, string $newName) { + // Validate parameter + //* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-TEMPLATE: oldName=' . $oldName . ', newName=' . $newName); + if (empty($oldName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "oldName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } elseif (empty($newName)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "newName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // Get raw template code $rawData = $this->getRawTemplateData(); @@ -1551,41 +1812,14 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { $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 function renderXmlContent ($content = NULL) { - // Is the content set? - if (is_null($content)) { - // Get current content - $content = $this->getRawTemplateData(); - } // END - if - - // Get a XmlParser instance - $parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', array($this)); - - // 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)); - } // END - if - - // Parse the XML document - $parserInstance->parseXmlContent($content); - } - /** * Enables or disables language support * * @param $languageSupport New language support setting * @return void */ - public final function enableLanguageSupport ($languageSupport = true) { - $this->languageSupport = (bool) $languageSupport; + public final function enableLanguageSupport (bool $languageSupport = true) { + $this->languageSupport = $languageSupport; } /** @@ -1597,32 +1831,19 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { return $this->languageSupport; } - /** - * Enables or disables XML compacting - * - * @param $xmlCompacting New XML compacting setting - * @return void - */ - public final function enableXmlCompacting ($xmlCompacting = true) { - $this->xmlCompacting = (bool) $xmlCompacting; - } - - /** - * Checks whether XML compacting is enabled - * - * @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) { + public function compactContent (string $uncompactedContent) { + // Validate parameter + if (empty($uncompactedContent)) { + // Throw an exception + throw new InvalidArgumentException('Parameter "uncompactedContent" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT); + } + // First, remove all tab/new-line/revert characters $compactedContent = str_replace(chr(9), '', str_replace(chr(10), '', str_replace(chr(13), '', $uncompactedContent))); @@ -1635,8 +1856,8 @@ abstract class BaseTemplateEngine extends BaseFrameworkSystem { foreach ($matches[0] as $match) { // Remove the match $compactedContent = str_replace($match, '', $compactedContent); - } // END - foreach - } // END - if + } + } // Set the content again $this->setRawTemplateData($compactedContent);