From: Roland Häder <roland@mxchange.org>
Date: Sun, 26 Feb 2023 12:44:47 +0000 (+0100)
Subject: Continued:
X-Git-Url: https://git.mxchange.org/?p=core.git;a=commitdiff_plain;h=02f84ee056b0183431ca8c922010da971d50422e

Continued:
- added a lot more debug lines
- added more checks on parameter
---

diff --git a/framework/main/classes/database/result/class_CachedDatabaseResult.php b/framework/main/classes/database/result/class_CachedDatabaseResult.php
index f08b0e8a..3989cb70 100644
--- a/framework/main/classes/database/result/class_CachedDatabaseResult.php
+++ b/framework/main/classes/database/result/class_CachedDatabaseResult.php
@@ -133,16 +133,21 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	private function updateCurrentEntryByCriteria (LocalUpdateCriteria $updateInstance) {
 		// Get the current entry key
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: updateInstance=%s - CALLED!', $updateInstance->__toString()));
 		$entryKey = $this->key();
 
 		// Now get the update criteria array and update all entries
 		foreach ($updateInstance->getUpdateCriteria() as $criteriaKey => $criteriaValue) {
 			// Update data
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: criteriaKey=%s,criteriaValue[%s]=%s', $criteriaKey, gettype($criteriaValue), $criteriaValue));
 			$this->resultArray[BaseDatabaseResult::RESULT_NAME_ROWS][$entryKey][$criteriaKey] = $criteriaValue;
 
 			// Mark it as out-dated
 			$this->outDated[$criteriaKey] = 1;
 		}
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -153,6 +158,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function next () {
 		// Default is not valid
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: CALLED!');
 		$nextValid = false;
 
 		// Increase position
@@ -166,6 +172,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 		}
 
 		// Return the result
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: nextValid=%d - EXIT!', intval($nextValid)));
 		return $nextValid;
 	}
 
@@ -178,6 +185,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function seek (int $seekPosition) {
 		// Validate parameter
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: seekPosition=%d - CALLED!', $seekPosition));
 		if ($seekPosition < 0) {
 			// Throw exception
 			throw new OutOfBoundsException(sprintf('seekPositon=%d is not seekable', $seekPosition));
@@ -187,10 +195,14 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 		$this->rewind();
 
 		// Search for the entry
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d,seekPosition=%d', $this->currentPos, $seekPosition));
 		while (($this->currentPos < $seekPosition) && ($this->valid())) {
 			// Continue on
 			$this->next();
 		}
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -200,6 +212,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function current () {
 		// Default is not found
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: CALLED!');
 		$current = NULL;
 
 		// Does the current enty exist?
@@ -209,6 +222,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 		}
 
 		// Return the result
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: current[]=%s - EXIT!', gettype($current)));
 		return $current;
 	}
 
@@ -219,11 +233,11 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function valid () {
 		// Check if all is fine ...
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
 		$isValid = ($this->ifStatusIsOkay() && isset($this->resultArray[BaseDatabaseResult::RESULT_NAME_ROWS][$this->currentPos]) && isset($this->resultArray[BaseDatabaseResult::RESULT_NAME_ROWS][0]));
 
 		// Return the result
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: isValid=%d - EXIT!', intval($isValid)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: isValid=%d - EXIT!', intval($isValid)));
 		return $isValid;
 	}
 
@@ -234,11 +248,11 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function count () {
 		// Count rows
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-DATABASE-RESULT: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: CALLED!');
 		$count = count($this->resultArray[BaseDatabaseResult::RESULT_NAME_ROWS]);
 
 		// Return it
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: count=%d - EXIT!', $count));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: count=%d - EXIT!', $count));
 		return $count;
 	}
 
@@ -249,11 +263,11 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function ifStatusIsOkay () {
 		// Check all conditions
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
 		$ifStatusOkay = (isset($this->resultArray[BaseDatabaseResult::RESULT_NAME_STATUS]) && $this->resultArray[BaseDatabaseResult::RESULT_NAME_STATUS] === BaseDatabaseBackend::RESULT_OKAY);
 
 		// Return status
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: ifStatusOkay=%s - EXIT!', intval($ifStatusOkay)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: ifStatusOkay=%s - EXIT!', intval($ifStatusOkay)));
 		return $ifStatusOkay;
 	}
 
@@ -264,7 +278,7 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function key () {
 		// Return current array position
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
 		return $this->currentPos;
 	}
 
@@ -275,12 +289,12 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function rewind () {
 		// Reset both current array position and current row
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: this->currentPos=%d - CALLED!', $this->currentPos));
 		$this->resetCurrentPosition();
 		$this->currentRow = [];
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-DATABASE-RESULT: EXIT!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -291,11 +305,11 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	private function resetCurrentPosition () {
 		// Reset position
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-DATABASE-RESULT: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: CALLED!');
 		$this->currentPos = ($this->count() > 0 ? 0 : -1);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CACHED-DATABASE-RESULT: EXIT!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -320,39 +334,57 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function add2UpdateQueue (LocalUpdateCriteria $updateInstance) {
 		// Rewind the pointer
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: updateInstance=%s - CALLED!', $updateInstance->__toString()));
 		$this->rewind();
 
 		// Get search criteria
 		$searchInstance = $updateInstance->getSearchInstance();
 
-		// And start looking for the result
+		// Get affected rows
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: searchInstance=%s', $searchInstance->__toString()));
 		$foundEntries = $this->getAffectedRows();
+
+		// And start looking for the result
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: foundEntries=%d,searchInstance->limit=%d', $foundEntries, $searchInstance->getLimit()));
 		while (($this->valid()) && ($foundEntries < $searchInstance->getLimit())) {
 			// Get next entry
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: Invoking this->next() ...');
 			$this->next();
+
+			// Get current entry
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: Invoking this->current() ...');
 			$currentEntry = $this->current();
 
 			// Is this entry found?
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: currentEntry[]=%s - EXIT!', gettype($currentEntry)));
 			if ($searchInstance->ifEntryMatches($currentEntry)) {
 				// Update this entry
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking this->updateCurrentEntryByCriteria(%s) ...', $updateInstance->__toString()));
 				$this->updateCurrentEntryByCriteria($updateInstance);
 
 				// Count one up
 				$foundEntries++;
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: foundEntries=%d', $foundEntries));
 			}
 		}
 
 		// If no entry is found/updated throw an exception
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: foundEntries=%d', $foundEntries));
 		if ($foundEntries == 0) {
 			// Throw an exception here
 			throw new ResultUpdateException($this, self::EXCEPTION_RESULT_UPDATE_FAILED);
 		}
 
 		// Set affected rows
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking this->setAffectedRows(%d) ...', $foundEntries));
 		$this->setAffectedRows($foundEntries);
 
 		// Set update instance
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking this->setUpdateInstance(%s) ...', $updateInstance->__toString()));
 		$this->setUpdateInstance($updateInstance);
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -389,7 +421,12 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 * @return	$needsUpdate	Whether we have out-dated entries
 	 */
 	public function ifDataNeedsFlush () {
+		// Check if records are out-dated
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: CALLED!');
 		$needsUpdate = (count($this->outDated) > 0);
+
+		// Return it
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: needsUpdate=%d - EXIT!', intval($needsUpdate)));
 		return $needsUpdate;
 	}
 
@@ -401,13 +438,19 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 */
 	public function addElementsToDataSet (StoreableCriteria $criteriaInstance) {
 		// Walk only through out-dated columns
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: criteriaInstance=%s - CALLED!', $criteriaInstance->__toString()));
 		foreach ($this->outDated as $key => $dummy) {
 			// Does this key exist?
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: key=%s,dummy[]=%s', $key, gettype($dummy)));
 			if ($this->find($key)) {
 				// Then update it
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking criteriaInstance->addCriteria(%s,foundValue[]=%s) ...', $key, gettype($this->getFoundValue())));
 				$criteriaInstance->addCriteria($key, $this->getFoundValue());
 			}
 		}
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 	/**
@@ -415,36 +458,51 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 *
 	 * @param	$key	The key we shall find
 	 * @return	$found	Whether the key was found or not
+	 * @throws	InvalidArgumentException	If a parameter is invalid
 	 */
 	public function find (string $key) {
+		// Check parameter
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: key=%s - CALLED!', $key));
+		if (empty($key)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "key" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		}
+
 		// By default nothing is found
 		$found = false;
 
 		// Rewind the pointer
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: Invoking this->rewind() ...');
 		$this->rewind();
 
 		// Walk through all entries
 		while ($this->valid()) {
 			// Advance to next entry
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: Invoking this->next() ...');
 			$this->next();
 
 			// Get the whole array
 			$currentEntry = $this->current();
 
 			// Is the element there?
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: currentEntry[]=%s - EXIT!', gettype($currentEntry)));
 			if (isset($currentEntry[$key])) {
 				// Okay, found!
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: key=%s is found in currentEntry', $key));
 				$found = true;
 
 				// So "cache" it
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: Setting this->foundValue to currentEntry[%s][]=%s is found in currentEntry', $key, gettype($currentEntry[$key])));
 				$this->foundValue = $currentEntry[$key];
 
 				// And stop searching
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('CACHED-DATABASE-RESULT: BREAK!');
 				break;
 			}
 		}
 
 		// Return the result
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: found=%d - EXIT!', intval($found)));
 		return $found;
 	}
 
@@ -453,26 +511,47 @@ class CachedDatabaseResult extends BaseDatabaseResult implements SearchableResul
 	 *
 	 * @param	$databaseColumn		Database column where the index might be found
 	 * @param	$frontendInstance	The frontend instance to ask for array element
-	 * @para	$callBack			Call-back object for setting the index;
+	 * @para	$callback			Call-back object for setting the index;
 	 * 								0=object instance,1=method name
 	 * @return	void
+	 * @throws	InvalidArgumentException	If a parameter is invalid
 	 * @todo	Find a caching way without modifying the result array
 	 */
-	public function solveResultIndex (string $databaseColumn, DatabaseFrontend $frontendInstance, array $callBack) {
+	public function solveResultIndex (string $databaseColumn, DatabaseFrontend $frontendInstance, array $callback) {
+		// Check parameter
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: databaseColumn=%s,frontendInstance=%s,callback()=%d - CALLED!', $databaseColumn, $frontendInstance->__toString(), count($callback)));
+		if (empty($key)) {
+			// Throw IAE
+			throw new InvalidArgumentException('Parameter "key" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		} elseif (count($callback) != 2) {
+			// Throw it again
+			throw new InvalidArgumentException(sprintf('callback()=%d must be exactly 2', count($callback)), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		} elseif (!is_callable($callback)) {
+			// Throw it again
+			throw new InvalidArgumentException(sprintf('%s:%s() is not callable', $callback[0], $callback[1]), FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
+		}
+
 		// By default nothing is found
 		$indexValue = 0;
 
 		// Is the element in result itself found?
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking this->find(%s),frontendInstance->indexKey=%s ...', $databaseColumn, $frontendInstance->getIndexKey()));
 		if ($this->find($databaseColumn)) {
 			// Use this value
 			$indexValue = $this->getFoundValue();
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: indexValue[]=%s from this->find(%s) - databaseColumn', gettype($indexValue), $databaseColumn));
 		} elseif ($this->find($frontendInstance->getIndexKey())) {
 			// Use this value
 			$indexValue = $this->getFoundValue();
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('CACHED-DATABASE-RESULT: indexValue[]=%s from this->find(%s) - frontendInstance->indexKey', gettype($indexValue), $frontendInstance->getIndexKey()));
 		}
 
 		// Set the index
-		call_user_func_array($callBack, array($indexValue));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('CACHED-DATABASE-RESULT: Invoking %s:%s(indexValue[]=%s) ...', $callback[0], $callback[1], gettype($indexValue)));
+		call_user_func_array($callback, [$indexValue]);
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('CACHED-DATABASE-RESULT: EXIT!');
 	}
 
 }