From: Roland Häder <roland@mxchange.org>
Date: Thu, 2 Mar 2023 21:37:27 +0000 (+0100)
Subject: Continued:
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=04b5844e6550c7ac66712f2af912bf55503dff58;p=core.git

Continued:
- re-enabled debug lines
- added some checks
- added some debug lines
---

diff --git a/framework/main/classes/template/xml/class_BaseXmlTemplateEngine.php b/framework/main/classes/template/xml/class_BaseXmlTemplateEngine.php
index 2ce4f693..0b7cb379 100644
--- a/framework/main/classes/template/xml/class_BaseXmlTemplateEngine.php
+++ b/framework/main/classes/template/xml/class_BaseXmlTemplateEngine.php
@@ -99,7 +99,11 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	protected function __construct (string $className) {
 		// Call parent constructor
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: className=%s - CONSTRUCTED!', $className));
 		parent::__construct($className);
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -118,7 +122,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	protected function initXmlTemplateEngine (string $typePrefix, string $xmlTemplateType) {
 		// Check on parameter
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: typePrefix=%s,xmlTemplateType=%s - CALLED!', $typePrefix, $xmlTemplateType));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: typePrefix=%s,xmlTemplateType=%s - CALLED!', $typePrefix, $xmlTemplateType));
 		if (empty($typePrefix)) {
 			// Throw IAE
 			throw new InvalidArgumentException('Parameter "typePrefix" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -136,9 +140,15 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$applicationInstance = ApplicationHelper::getSelfInstance();
 
 		// Determine base path
-		$templateBasePath = FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('application_base_path') . FrameworkBootstrap::getRequestInstance()->getRequestElement('app') . '/';
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: applicationInstance=%s', $applicationInstance->__toString()));
+		$templateBasePath = sprintf('%s%s%s',
+			FrameworkBootstrap::getConfigurationInstance()->getConfigEntry('application_base_path'),
+			FrameworkBootstrap::getRequestInstance()->getRequestElement('app'),
+			DIRECTORY_SEPARATOR
+		);
 
 		// Is the base path valid?
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: templateBasePath=%s', $templateBasePath));
 		if (empty($templateBasePath)) {
 			// Base path is empty
 			throw new BasePathIsEmptyException($this, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
@@ -151,7 +161,6 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		}
 
 		// Set the base path
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: templateBasePath=%s', $templateBasePath));
 		$this->setTemplateBasePath($templateBasePath);
 
 		// Set template extensions
@@ -171,18 +180,18 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$this->stackerName = $typePrefix . '_' . $xmlTemplateType;
 
 		// Init stacker
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: this->stackerName=%s', $this->stackerName));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: this->stackerName=%s', $this->stackerName));
 		$stackInstance->initStack($this->stackerName);
 
 		// Set it
 		$this->setStackInstance($stackInstance);
 
 		// Set it in main nodes
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: Adding xmlTemplateType=%s to this->mainNodes ...', $xmlTemplateType));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Adding xmlTemplateType=%s to this->mainNodes ...', $xmlTemplateType));
 		array_push($this->mainNodes, str_replace('_', '-', $xmlTemplateType));
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -193,21 +202,22 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	public function loadXmlTemplate (string $templateName = '') {
 		// Is the template name empty?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: templateName=%s - CALLED!', $templateName));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: templateName=%s - CALLED!', $templateName));
 		if (empty($templateName)) {
 			// Set generic template name
 			$templateName = $this->typePrefix . '_' . $this->xmlTemplateType . '_template_type';
 		}
 
 		// Set template type
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: templateName=%s', $templateName));
 		$this->setTemplateType(FrameworkBootstrap::getConfigurationInstance()->getConfigEntry($templateName));
 
 		// Load the special template
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->loadTemplate(%s) ...', $this->xmlTemplateType));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->loadTemplate(%s) ...', $this->xmlTemplateType));
 		$this->loadTemplate($this->xmlTemplateType);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -275,7 +285,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	public function readXmlData (string $key) {
 		// Is key parameter valid?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: key=%s - CALLED!', $key));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: key=%s - CALLED!', $key));
 		if (empty($key)) {
 			// Throw exception
 			throw new InvalidArgumentException('Parameter key is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -285,14 +295,14 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$value = parent::readVariable($key, 'general');
 
 		// Is this null?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: value[]=%s', gettype($value)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: value[]=%s', gettype($value)));
 		if (is_null($value)) {
 			// Bah, needs fixing.
 			$this->debugInstance(sprintf('[%s:%d]: key=%s returns NULL', __METHOD__, __LINE__, $key));
 		}
 
 		// Return value
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: value=%s - EXIT!', $value));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: value[%s]=%s - EXIT!', gettype($value), $value));
 		return $value;
 	}
 
@@ -306,7 +316,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	protected function handleTemplateDependency (string $node, string $templateDependency) {
 		// Check parameter
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: node=%s,templateDependency=%s - CALLED!', $node, $templateDependency));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: node=%s,templateDependency=%s - CALLED!', $node, $templateDependency));
 		if (empty($node)) {
 			// Throw IAE
 			throw new InvalidArgumentException('Parameter "node" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -316,22 +326,29 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		}
 
 		// Is the template dependency set?
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: node=%s,templateDependency=%s', $node, $templateDependency));
 		if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
+			// Create class name
+			$configKey = sprintf('%s_%s_%s_template_class', $this->typePrefix, self::convertDashesToUnderscores($node), $this->xmlTemplateType);
+
 			// Get a temporay template instance
-			$templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance($this->typePrefix . '_' . self::convertDashesToUnderscores($node) . '_' . $this->xmlTemplateType . '_template_class');
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: configKey=%s', $configKey));
+			$templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance();
 
 			// Then load it
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: templateInstance=%s', $templateInstance->__toString()));
 			$templateInstance->loadXmlTemplate($templateDependency);
 
 			// Parse the XML content
 			$templateInstance->renderXmlContent();
 
 			// Save the parsed raw content in our dependency array
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking templateInstance->getRawTemplateData() for this->dependencyContent[%s] ...', $node));
 			$this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
 		}
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -346,7 +363,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	public final function startElement ($resource, string $element, array $attributes) {
 		// Check parameters
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: resource[%s]=%s,element=%s,attributes()=%d - CALLED!', gettype($resource), $resource, $element, count($attributes)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: resource[%s]=%s,element=%s,attributes()=%d - CALLED!', gettype($resource), $resource, $element, count($attributes)));
 		if (!is_resource($resource)) {
 			// Throw IAE
 			throw new InvalidArgumentException(sprintf('Parameter resource has unexpected type %s', gettype($resource)), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -359,9 +376,11 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$methodName = $this->initMethodName;
 
 		// Make the element name lower-case
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: methodName=%s', $methodName));
 		$element = strtolower($element);
 
 		// Is the element a main node?
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: element=%s', $element));
 		if (in_array($element, $this->getMainNodes())) {
 			// Okay, main node found!
 			$methodName = 'start' . StringUtils::convertToClassName($element);
@@ -377,11 +396,11 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		}
 
 		// Call method
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->%s(attributes()=%d) ...', $methodName, count($attributes)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->%s(attributes()=%d) ...', $methodName, count($attributes)));
 		call_user_func_array([$this, $methodName], $attributes);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -394,7 +413,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 */
 	public final function finishElement ($resource, string $nodeName) {
 		// Check parameters
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: resource[%s]=%s,nodeName=%s - CALLED!', gettype($resource), $resource, $nodeName));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: resource[%s]=%s,nodeName=%s - CALLED!', gettype($resource), $resource, $nodeName));
 		if (!is_resource($resource)) {
 			// Throw IAE
 			throw new InvalidArgumentException(sprintf('Parameter resource has unexpected type %s', gettype($resource)), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -407,6 +426,7 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$nodeName = strtolower($nodeName);
 
 		// Does this match with current main node?
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: nodeName=%s', $nodeName));
 		if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
 			// Did not match!
 			throw new XmlNodeMismatchException ([$this, $nodeName, $this->getCurrMainNode()], XmlParser::EXCEPTION_XML_NODE_MISMATCH);
@@ -416,11 +436,11 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 		$methodName = 'finish' . StringUtils::convertToClassName($nodeName);
 
 		// Call the corresponding method
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->%s() ...', $methodName));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking this->%s() ...', $methodName));
 		call_user_func_array([$this, $methodName], []);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**
@@ -428,31 +448,35 @@ abstract class BaseXmlTemplateEngine extends BaseTemplateEngine implements Compi
 	 *
 	 * @param	$content	Valid XML content or if not set the current loaded raw content
 	 * @return	void
-	 * @throws	XmlParserException	If an XML error was found
+	 * @throws	InvalidArgumentException	If a parameter has an invalid value
 	 */
 	public function renderXmlContent (string $content = NULL) {
 		// Is the content set?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: content[%s]()=%d - CALLED!', gettype($content), strlen($content)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: content[%s]()=%d - CALLED!', gettype($content), strlen($content)));
 		if (is_null($content)) {
 			// Get current content
 			$content = $this->getRawTemplateData();
+		} elseif (empty($content)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "content" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		}
 
 		// Get a XmlParser instance
 		$parserInstance = ObjectFactory::createObjectByConfiguredName('xml_parser_class', [$this]);
 
 		// Check if XML compacting is enabled
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: parserInstance=%s', $parserInstance->__toString()));
 		if ($this->isXmlCompactingEnabled()) {
 			// Yes, so get a decorator class for transparent compacting
 			$parserInstance = ObjectFactory::createObjectByConfiguredName('deco_compacting_xml_parser_class', [$parserInstance]);
 		}
 
 		// Parse the XML document
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking parserInstance->parseXmlContent(content()=%d) ...', strlen($content)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-XML-TEMPLATE-ENGINE: Invoking parserInstance->parseXmlContent(content()=%d) ...', strlen($content)));
 		$parserInstance->parseXmlContent($content);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('BASE-XML-TEMPLATE-ENGINE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-XML-TEMPLATE-ENGINE: EXIT!');
 	}
 
 	/**