X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Ffile_directories%2Fbinary%2Fstack%2Fclass_StackFile.php;h=4f3c5b5ebd2cc85f097dcf7f059a15c09310518b;hp=f93dd76953b3f43f7984fcba3d10b3b8fad9568b;hb=HEAD;hpb=287198e6942b1a08c760c92d83b52105d10a11cb

diff --git a/framework/main/classes/file_directories/binary/stack/class_StackFile.php b/framework/main/classes/file_directories/binary/stack/class_StackFile.php
index f93dd769..4f3c5b5e 100644
--- a/framework/main/classes/file_directories/binary/stack/class_StackFile.php
+++ b/framework/main/classes/file_directories/binary/stack/class_StackFile.php
@@ -22,7 +22,7 @@ use \SplFileInfo;
  *
  * @author		Roland Haeder <webmaster@ship-simu.org>
  * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 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.ship-simu.org
  *
@@ -59,7 +59,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	public final static function createStackFile (SplFileInfo $infoInstance, StackableFile $stackInstance) {
 		// Get a new instance
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: infoInstance[%s]=%s,stackInstance=%s - CALLED!', get_class($infoInstance), $infoInstance, $stackInstance->__toString()));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: infoInstance[%s]=%s,stackInstance=%s - CALLED!', get_class($infoInstance), $infoInstance, $stackInstance->__toString()));
 		$stackFileInstance = new StackFile();
 
 		// Set stack instance here for callbacks
@@ -72,7 +72,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 		$stackFileInstance->initCountersGapsArray();
 
 		// Return the prepared instance
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: stackFileInstance=%s - EXIT!', $stackFileInstance->__toString()));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: stackFileInstance=%s - EXIT!', $stackFileInstance->__toString()));
 		return $stackFileInstance;
 	}
 
@@ -84,18 +84,18 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	public function flushFileHeader () {
 		// Validate call
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: CALLED!');
 		if (!($this->getStackInstance() instanceof StackableFIle)) {
 			// Index instance not set
 			throw new BadMethodCallException('this->stackInstance[] is not properly set.');
 		}
 
 		// Call block instance
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: Calling this->indexInstance->flushFileHeader() ...');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: Invoking this->indexInstance->flushFileHeader() ...');
 		$this->getStackInstance()->flushFileHeader();
 
 		// Trace message
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: EXIT!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: EXIT!');
 	}
 
 	/**
@@ -108,7 +108,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	public function preAllocateFile (string $type) {
 		// Is it enabled?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: type=%s - CALLED!', $type));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: type=%s - CALLED!', $type));
 		if (empty($type)) {
 			// Empty type
 			throw new InvalidArgumentException('Parameter "type" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -118,7 +118,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 		}
 
 		// Message to user
-		self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: Pre-allocating file ...');
+		self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('STACK-FILE: Pre-allocating file ...');
 
 		// Calculate minimum block length and get file size
 		$minimumBlockLength = $this->getStackInstance()->calculateMinimumBlockLength();
@@ -127,7 +127,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 		$this->preAllocateFileByTypeLength($type, $minimumBlockLength);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: EXIT!');
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: EXIT!');
 	}
 
 	/**
@@ -135,27 +135,26 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 * This method will return true if an emptied (nulled) entry has been found.
 	 *
 	 * @return	$isValid	Whether the next entry is valid
-	 * @throws	UnexpectedValueException	If some value is not expected
 	 * @throws	BadMethodCallException	If this->stackInstance is not properly set
 	 */
 	public function isValid () {
 		// Validate call
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: CALLED!');
 		if (!($this->getStackInstance() instanceof StackableFile)) {
 			// Index instance not set
 			throw new BadMethodCallException('this->stackInstance[] is not properly set.');
 		}
 
 		// Get length from index
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: Calling this->stackInstance->calculateMinimumBlockLength() ...');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: Invoking this->stackInstance->calculateMinimumBlockLength() ...');
 		$length = $this->getStackInstance()->calculateMinimumBlockLength();
 
 		// Call protected method
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: Calling this->isValidByLength(%d) ...', $length));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('STACK-FILE: Invoking this->isValidByLength(%d) ...', $length));
 		$isValid = $this->isValidByLength($length);
 
 		// Return result
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: isValid=%d - EXIT!', intval($isValid)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: isValid=%d - EXIT!', intval($isValid)));
 		return $isValid;
 	}
 
@@ -167,11 +166,11 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	public function readFileHeader () {
 		// Call stacke instance
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: Calling this->stackInstance->readStackHeader() - CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: Invoking this->stackInstance->readStackHeader() - CALLED!');
 		$this->getStackInstance()->readStackHeader();
 
 		// Trace message
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: EXIT!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: EXIT!');
 	}
 
 	/**
@@ -183,15 +182,15 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	protected function readNextBlock () {
 		// First calculate minimum block length
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: this->seekPosition=%d - CALLED!', $this->getSeekPosition()));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: this->seekPosition=%d - CALLED!', $this->getSeekPosition()));
 		$length = $this->getStackInstance()->calculateMinimumBlockLength();
 
 		// Call protected method
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: Calling parent::readNextBlockByLength(%d) ...', $length));
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: Invoking parent::readNextBlockByLength(%d) ...', $length));
 		parent::readNextBlockByLength($length);
 
 		// Trace message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: EXIT!');
+		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: EXIT!');
 	}
 
 	/**
@@ -204,7 +203,7 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 */
 	public function writeValueToFile (string $stackName, $value) {
 		// Validate parameter
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: stackName=%s,value[]=%s - CALLED!', $stackName, gettype($value)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: stackName=%s,value[]=%s - CALLED!', $stackName, gettype($value)));
 		if (empty($stackName)) {
 			// Throw IAE
 			throw new InvalidArgumentException('Parameter "stackName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
@@ -214,19 +213,19 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 		}
 
 		// Encode/convert the value into a "binary format"
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: Calling StringUtils::encodeData(value[]=%s) ...', gettype($value)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: Invoking StringUtils::encodeData(value[]=%s) ...', gettype($value)));
 		$encoded = StringUtils::encodeData($value);
 
 		// Get a strong hash for the "encoded" data
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: Calling CryptoUtils::hash(%s) ...', $encoded));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: Invoking CryptoUtils::hash(%s) ...', $encoded));
 		$hash = CryptoUtils::hash($encoded);
 
 		// Then write it to the next free gap
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: Calling this->stackInstance->writeDataToFreeGap(%s,%s,%s) ...', $stackName, $hash, $encoded));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: Invoking this->stackInstance->writeDataToFreeGap(%s,%s,%s) ...', $stackName, $hash, $encoded));
 		$data = $this->getStackInstance()->writeDataToFreeGap($stackName, $hash, $encoded);
 
 		// Return info
-		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('STACK-FILE: data[]=%s - EXIT!', gettype($data)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('STACK-FILE: data[]=%s - EXIT!', gettype($data)));
 		return $data;
 	}
 
@@ -240,8 +239,8 @@ class StackFile extends BaseBinaryFile implements FileStacker {
 	 * @throws	UnsupportedOperationException	If this method is called
 	 */
 	public function writeDataToFreeGap (string $stackName, string $hash, string $encoded) {
-		self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('STACK-FILE: stackName=' . $stackName . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
-		throw new UnsupportedOperationException([$this, __FUNCTION__], self::EXCEPTION_UNSPPORTED_OPERATION);
+		self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('STACK-FILE: stackName=' . $stackName . ',hash=' . $hash . ',encoded()=' . strlen($encoded));
+		throw new UnsupportedOperationException([$this, __FUNCTION__], FrameworkInterface::EXCEPTION_UNSPPORTED_OPERATION);
 	}
 
 }