<?php
// Own namespace
-namespace CoreFramework\Filesystem\Pointer\Input;
+namespace Org\Mxchange\CoreFramework\Filesystem\Pointer\Input;
// Import framework stuff
-use CoreFramework\Bootstrap\FrameworkBootstrap;
-use CoreFramework\FileSystem\BaseFileIo;
-use CoreFramework\Filesystem\FileNotFoundException;
-use CoreFramework\FileSystem\FileReadProtectedException;
-use CoreFramework\Filesystem\Pointer\InputPointer;
-use CoreFramework\Generic\NullPointerException;
-use CoreFramework\Generic\UnsupportedOperationException;
-use CoreFramework\Object\BaseFrameworkSystem;
+use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
+use Org\Mxchange\CoreFramework\Filesystem\BaseFileIo;
+use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
+use Org\Mxchange\CoreFramework\Filesystem\FileReadProtectedException;
+use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
+use Org\Mxchange\CoreFramework\Generic\NullPointerException;
+use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
+use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
+
+// Import SPL stuff
+use \SplFileInfo;
/**
* A class for reading text files
*
* @author Roland Haeder <webmaster@shipsimu.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 - 2021 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.shipsimu.org
*
*
* @return void
*/
- protected function __construct () {
+ private function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
}
* be verified here.
*
* @param $fileName The file name we shall pass to fopen()
- * @throws FileIsEmptyException If the provided file name is empty.
* @throws FileIoException If the file is not reachable
* @throws FileReadProtectedException If the file cannot be read from
* @return void
*/
- public static final function createFrameworkTextFileInputPointer ($fileName) {
- // Some pre-sanity checks...
- if ((is_null($fileName)) || (empty($fileName))) {
- // No filename given
- throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
- } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
+ public static final function createFrameworkTextFileInputPointer (SplFileInfo $infoInstance) {
+ // Check parameter
+ if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
// File cannot be reached
- throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
- } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
+ throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
+ } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
// File does not exist!
- throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
- } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
+ throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
+ } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
// File cannot be read from (but exists)
- throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
+ throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
}
// Try to open a handler
- $filePointer = fopen($fileName, 'r');
- if ((is_null($filePointer)) || ($filePointer === false)) {
+ $fileObject = $infoInstance->openFile('r');
+
+ // Debug message
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEXT-FILE-INPUT: fileObject[]=' . gettype($fileObject));
+
+ // Is it valid?
+ if ((is_null($fileObject)) || ($fileObject === false)) {
// Something bad happend
- throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
+ throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
} // END - if
// Create new instance
$pointerInstance = new FrameworkTextFileInputPointer();
// Set file pointer and file name
- $pointerInstance->setPointer($filePointer);
- $pointerInstance->setFileName($fileName);
+ $pointerInstance->setFileObject($fileObject);
// Return the instance
return $pointerInstance;
*
* @param $bytes Amount of bytes to read or whole line (only text files)
* @return $data Data read from file
- * @throws NullPointerException If the file pointer instance
- * is not set by setPointer()
- * @throws InvalidResourceException If there is being set
+ * @throws OutOfBoundsException If the position is not seekable
+ * @throws NullPointerException If the file pointer instance is not set by setFileObject()
+ * @throws LogicException If $fileObject is not an object
*/
- public function read ($bytes = NULL) {
+ public function read (int $bytes = 0) {
// Some sanity checks
- if (is_null($this->getPointer())) {
+ if ($bytes < 0) {
+ // Cannot be below zero
+ throw new OutOfBoundsException(sprintf('bytes=%d is not valid', $bytes));
+ } elseif (is_null($this->getFileObject())) {
// Pointer not initialized
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } elseif (!is_resource($this->getPointer())) {
+ } elseif (!is_object($this->getFileObject())) {
// Pointer is not a valid resource!
- throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
+ throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
}
// Is $bytes set?
- if (is_int($bytes)) {
+ if ($bytes > 0) {
// Try to read given characters
- $data = fgets($this->getPointer(), $bytes);
+ $data = $this->getFileObject()->fread($bytes);
} else {
// Try to read whole line
- $data = fgets($this->getPointer());
+ $data = $this->getFileObject()->fgets();
}
// Then return it
* @return void
* @throws UnsupportedOperationException If this method is called
*/
- public function analyzeFile () {
+ public function analyzeFileStructure () {
throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
}