X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Ffile_directories%2Fclass_BaseFileIo.php;h=d093dda0f2913b8fee0f0534136f10b0a0bacf50;hb=refs%2Fheads%2Fmaster;hp=ce65bd898a9b8f087af82ffdd4ad13f3fa580295;hpb=b002c5909aa0f781505dde5414964b0f014cde01;p=core.git

diff --git a/framework/main/classes/file_directories/class_BaseFileIo.php b/framework/main/classes/file_directories/class_BaseFileIo.php
index ce65bd89..d093dda0 100644
--- a/framework/main/classes/file_directories/class_BaseFileIo.php
+++ b/framework/main/classes/file_directories/class_BaseFileIo.php
@@ -1,14 +1,16 @@
 <?php
 // Own namespace
-namespace Org\Mxchange\CoreFramework\FileSystem;
+namespace Org\Mxchange\CoreFramework\Filesystem;
 
 // Import framework stuff
 use Org\Mxchange\CoreFramework\Filesystem\CloseableFile;
 use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
 
 // Import SPL stuff
+use \OutOfBoundsException;
 use \SplFileObject;
 
 /**
@@ -16,7 +18,7 @@ use \SplFileObject;
  *
  * @author		Roland Haeder <webmaster@ship-simu.org>
  * @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.ship-simu.org
  *
@@ -45,9 +47,13 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 * @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-FILE-IO: className=%s - CONSTRUCTED!', $className));
 		parent::__construct($className);
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: EXIT!');
 	}
 
 	/**
@@ -57,13 +63,18 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 */
 	public final function __destruct() {
 		// Is there a resource pointer? Then we have to close the file here!
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-FILE-IO: this->fileObject[]=%s - DESTRUCTOR!', gettype($this->getFileObject())));
 		if (is_object($this->getFileObject())) {
 			// Try to close a file
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: Invoking this->closeFile() ...');
 			$this->closeFile();
-		} // END - if
+		}
 
 		// Call the parent destructor
 		parent::__destruct();
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: EXIT!');
 	}
 
 	/**
@@ -71,29 +82,26 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 * to empty.
 	 *
 	 * @return	void
-	 * @throws	NullPointerException	If the file pointer instance is not set by setPointer()
+	 * @throws	NullPointerException	If the file pointer instance is not set by setFileObject()
 	 * @throws	LogicException	If there is no object being set
 	 */
 	public function closeFile () {
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileObject()->getPathname()));
-
+		// Validate parameter
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-FILE-IO: fileName=%s - CALLED!', $this->getFileObject()->getPathname()));
 		if (is_null($this->getFileObject())) {
 			// Pointer not initialized
-			throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+			throw new NullPointerException($this, FrameworkInterface::EXCEPTION_IS_NULL_POINTER);
 		} elseif (!is_object($this->getFileObject())) {
 			// Pointer is not a valid resource!
-			throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
+			throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())), FrameworkInterface::EXCEPTION_LOGIC_EXCEPTION);
 		}
 
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: Closing file %s ...', __METHOD__, __LINE__, $this->getFileObject()->getPathname()));
-
 		// Close the file pointer by NULL-ing it
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-FILE-IO: Closing file %s ...', $this->getFileObject()->getPathname()));
 		$this->resetFileObject();
 
-		// Debug message
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: EXIT!');
 	}
 
 	/**
@@ -103,7 +111,11 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 */
 	protected final function resetFileObject () {
 		// Set it to NULL
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: Setting this->fileObject=NULL - CALLED!');
 		$this->fileObject = NULL;
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: EXIT!');
 	}
 
 	/**
@@ -150,12 +162,19 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 * @param	$whence		Added to offset (default: only use offset to seek to)
 	 * @return	$status		Status of file seek: 0 = success, -1 = failed
 	 */
-	public function seek ($offset, $whence = SEEK_SET) {
+	public function seek (int $offset, int $whence = SEEK_SET) {
+		// Validate parameter
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-FILE-IO: offset=%d,whence=%d - CALLED!', $offset, $whence));
+		if ($offset < 0) {
+			// Throw exception
+			throw new OutOfBoundsException(sprintf('offset=%d is not valid', $offset));
+		}
+
 		// Seek to position
 		$status = $this->getFileObject()->fseek($offset, $whence);
 
 		// Return status
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] status=%d', __METHOD__, __LINE__, $status));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-FILE-IO: status=%d - EXIT!', $status));
 		return $status;
 	}
 
@@ -166,23 +185,23 @@ abstract class BaseFileIo extends BaseFrameworkSystem implements FilePointer, Cl
 	 * @todo	Handle seekStatus
 	 */
 	public function size () {
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
 		// Get current seek position
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('BASE-FILE-IO: CALLED!');
 		$seekPosition = $this->determineSeekPosition();
 
 		// Seek to end
 		$seekStatus = $this->seek(0, SEEK_END);
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
 
-		// Get position again  (which is the end of the file)
+		// Get position again (which is the end of the file)
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-FILE-IO: seekStatus[%s]=%d', gettype($seekStatus), $seekStatus));
 		$size = $this->determineSeekPosition();
 
 		// Reset seek position to old
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('BASE-FILE-IO: size[%s]=%d', gettype($size), $size));
 		$this->seek($seekPosition);
 
 		// Return size
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d:] size=%s - EXIT!', __METHOD__, __LINE__, $size));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('BASE-FILE-IO: size=%d - EXIT!', $size));
 		return $size;
 	}