X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Ffile_directories%2Finput%2Ftext%2Fclass_FrameworkTextFileInputPointer.php;h=27565cef23d3f1194b2f26ffb9cfb123d798b254;hp=5347f34d223da5a0028bcea0b3c7669aa0761d58;hb=08a0c865dd2c8ee0b6dbf96f4f07e9ee0ce0f02b;hpb=515b61f538c641f6e16d908767bcfdb18f889318 diff --git a/framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php b/framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php index 5347f34d..27565cef 100644 --- a/framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php +++ b/framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php @@ -1,19 +1,26 @@ * @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 * @@ -36,7 +43,7 @@ class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer { * * @return void */ - protected function __construct () { + private function __construct () { // Call parent constructor parent::__construct(__CLASS__); } @@ -46,40 +53,40 @@ class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer { * 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 (!BaseFrameworkSystem::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 ((!BaseFrameworkSystem::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 ((!BaseFrameworkSystem::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); - } // END - if + throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID); + } // 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; @@ -110,27 +117,30 @@ class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer { * * @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 @@ -145,7 +155,7 @@ class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer { * @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); } @@ -161,7 +171,7 @@ class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer { /** * Checks wether the current entry is valid (not at the end of the file). - * This method will return TRUE if an emptied (nulled) entry has been found. + * This method will return true if an emptied (nulled) entry has been found. * * @return $isValid Whether the next entry is valid * @throws UnsupportedOperationException If this method is called