X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=framework%2Fmain%2Fclasses%2Ffile_directories%2Fdirectory%2Fclass_FrameworkDirectoryPointer.php;h=f080e3281e1107430d23f36ea77135f7df59bc9c;hb=HEAD;hp=b4f79334e1dfaf58f33b2f6a5bdb861b8e077a70;hpb=5c7840de0bf7ae2fdfe90f283c91711e38368134;p=core.git

diff --git a/framework/main/classes/file_directories/directory/class_FrameworkDirectoryPointer.php b/framework/main/classes/file_directories/directory/class_FrameworkDirectoryPointer.php
index b4f79334..f080e328 100644
--- a/framework/main/classes/file_directories/directory/class_FrameworkDirectoryPointer.php
+++ b/framework/main/classes/file_directories/directory/class_FrameworkDirectoryPointer.php
@@ -4,6 +4,7 @@ namespace Org\Mxchange\CoreFramework\Filesytem\Pointer;
 
 // Import framework stuff
 use Org\Mxchange\CoreFramework\Filesystem\FrameworkDirectory;
+use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
 
@@ -19,7 +20,7 @@ use \InvalidArgumentException;
  *
  * @author		Roland Haeder <webmaster@shipsimu.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.shipsimu.org
  *
@@ -60,6 +61,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 	 */
 	public function __destruct() {
 		// Is there a resource pointer? Then we have to close the directory here!
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('FRAMEWORK-DIRECTORY-POINTER: DESTRUCTED!');
 		if ($this->getDirectoryIteratorInstance() instanceof DirectoryIterator) {
 			// Try to close a directory
 			$this->closeDirectory();
@@ -67,6 +69,9 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 
 		// Call the parent destructor
 		parent::__destruct();
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('FRAMEWORK-DIRECTORY-POINTER: EXIT!');
 	}
 
 	/**
@@ -82,9 +87,10 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 	 */
 	public static final function createFrameworkDirectoryPointer (string $pathName) {
 		// Some pre-sanity checks...
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('FRAMEWORK-DIRECTORY-POINTER: pathName=%s - CALLED!', $pathName));
 		if (empty($pathName)) {
 			// Throw IAE
-			throw new InvalidArgumentException('Parameter "pathName" is empty');
+			throw new InvalidArgumentException('Parameter "pathName" is empty', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		} elseif (!is_dir($pathName)) {
 			// Not a directory
 			throw new PathIsNoDirectoryException($pathName, self::EXCEPTION_INVALID_PATH_NAME);
@@ -107,7 +113,7 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 		$pointerInstance->setPathName($pathName);
 
 		// Return the instance
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: Opened pathName=' . $pathName . ' - EXIT!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DIRECTORY-POINTER: pointerInstance=%s - EXIT!', $pointerInstance->__toString()));
 		return $pointerInstance;
 	}
 
@@ -118,14 +124,14 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 	 */
 	public function readRawDirectory () {
 		// Can the next entry be read?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('DIRECTORY-POINTER: CALLED!');
 		assert($this->getDirectoryIteratorInstance()->valid());
 
 		// Read data from the directory pointer and return it
 		$currentEntry = $this->getDirectoryIteratorInstance()->current();
 
 		// Return found entry
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: currentEntry[%s]=%s - EXIT!', gettype($currentEntry), $currentEntry));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DIRECTORY-POINTER: currentEntry[%s]=%s - EXIT!', gettype($currentEntry), $currentEntry));
 		return $currentEntry;
 	}
 
@@ -134,17 +140,17 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 	 *
 	 * @param	$except		Some parts of a directory we want to ignore. Valid: directory and file names, other values will be silently ignored
 	 * @return	SplFileInfo		An instance of a SplFileInfo class
+	 * @throws	InvalidArgumentException	If a parameter has an invalid value
 	 */
 	public function readDirectoryExcept (array $except = []) {
 		// No exceptions given?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: except()=%d - CALLED!', count($except)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DIRECTORY-POINTER: except()=%d - CALLED!', count($except)));
 		if (count($except) == 0) {
 			// No exception given, so read all files and directories, but not recursive
-			self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: No exceptions given, please use readRawDirectory() instead!');
-			return $this->readRawDirectory();
+			throw new InvalidArgumentException('Parameter "except" is an empty array', FrameworkInterface::EXCEPTION_INVALID_ARGUMENT);
 		} elseif (!$this->getDirectoryIteratorInstance()->valid()) {
 			// No more left to read
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: EOD reached - EXIT!');
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('DIRECTORY-POINTER: EOD reached - EXIT!');
 			return NULL;
 		}
 
@@ -155,26 +161,26 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 		$currentEntry = $this->readRawDirectory();
 
 		// Shall we exclude directories?
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: currentEntry[]=%s', gettype($currentEntry)));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DIRECTORY-POINTER: currentEntry[]=%s', gettype($currentEntry)));
 		if (is_object($currentEntry)) {
 			// Get file name
 			$fileInfoInstance = $currentEntry;
 
 			// Is it a dot-directory or excluded?
-			//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: fileInfoInstance->filename=%s,isDot=%d', $fileInfoInstance->getFilename(), intval($this->getDirectoryIteratorInstance()->isDot())));
+			/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('DIRECTORY-POINTER: fileInfoInstance->filename=%s,isDot=%d', $fileInfoInstance->getFilename(), intval($this->getDirectoryIteratorInstance()->isDot())));
 			while ($this->getDirectoryIteratorInstance()->valid() && ($this->getDirectoryIteratorInstance()->isDot() || in_array($fileInfoInstance->getFilename(), $except))) {
 				// Update current instance
-				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: fileInfoInstance->filename=%s,isDot=%d', $fileInfoInstance->getFilename(), intval($this->getDirectoryIteratorInstance()->isDot())));
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('DIRECTORY-POINTER: fileInfoInstance->filename=%s,isDot=%d', $fileInfoInstance->getFilename(), intval($this->getDirectoryIteratorInstance()->isDot())));
 				$fileInfoInstance = $this->readRawDirectory();
 
 				// To next entry
-				//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: Invoking directoryIteratorInstance->next() ...');
+				/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('DIRECTORY-POINTER: Invoking directoryIteratorInstance->next() ...');
 				$this->getDirectoryIteratorInstance()->next();
 			}
 		}
 
 		// Return read line
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('DIRECTORY-POINTER: fileInfoInstance[%s]=%s - EXIT!', gettype($fileInfoInstance), $fileInfoInstance));
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('DIRECTORY-POINTER: fileInfoInstance[%s]=%s - EXIT!', gettype($fileInfoInstance), $fileInfoInstance));
 		return $fileInfoInstance;
 	}
 
@@ -186,9 +192,12 @@ class FrameworkDirectoryPointer extends BaseFrameworkSystem implements Framework
 	 */
 	public function closeDirectory () {
 		// Close the directory by unsetting it
-		//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('DIRECTORY-POINTER: CALLED!');
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('DIRECTORY-POINTER: CALLED!');
 		$this->unsetDirectoryIteratorInstance();
 		$this->setPathName('');
+
+		// Trace message
+		/* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('DIRECTORY-POINTER: CALLED!');
 	}
 
 	/**