<?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\FileReadProtectedException;
-use CoreFramework\Filesystem\Pointer\InputPointer;
-use CoreFramework\Generic\NullPointerException;
-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 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__);
}
* Create a file pointer based on the given file. The file will also
* be verified here.
*
- * @param $fileName The file name we shall pass to fopen()
- * @throws FileIsEmptyException If the provided file name is empty.
+ * @param $infoInstance An instance of a SplFileInfo class
* @throws FileIoException If the file is not reachable
* @throws FileReadProtectedException If the file is not found or cannot be read
* @throws FileNotFoundException If the file does not exist
* @return void
*/
- public static final function createFrameworkRawFileInputPointer ($fileName) {
+ public static final function createFrameworkRawFileInputPointer (SplFileInfo $infoInstance) {
// 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)) {
+ if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
// File cannot be accessed (due to open_basedir restriction)
- throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
- } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
- // File exists but cannot be read from
- throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
- } 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_NOT_FOUND);
+ throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_NOT_FOUND);
+ } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
+ // File exists but cannot be read from
+ throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
}
// Try to open a handler
- $filePointer = fopen($fileName, 'rb');
- if ((is_null($filePointer)) || ($filePointer === false)) {
+ $fileObject = $infoInstance->openFile('rb');
+ 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 FrameworkRawFileInputPointer();
// Set file pointer and file name
- $pointerInstance->setPointer($filePointer);
- $pointerInstance->setFileName($fileName);
+ $pointerInstance->setFileObject($fileObject);
// Return the instance
return $pointerInstance;
* Read data a file pointer
*
* @return mixed The result of fread()
- * @throws NullPointerException If the file pointer instance
- * is not set by setPointer()
- * @throws InvalidResourceException If there is being set
+ * @throws NullPointerException If the file pointer instance is not set by setFileObject()
+ * @throws LogicException If there is no object being set
*/
public function readFromFile () {
- if (is_null($this->getPointer())) {
+ if (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())));
}
// Read data from the file pointer and return it
* @param $bytes Amount of bytes to read
* @return $data Data read from file
*/
- public function read ($bytes = NULL) {
- // $bytes shall be integer
- assert(is_int($bytes));
-
+ public function read (int $bytes = 0) {
// Try to read given characters
- $data = fread($this->getPointer(), $bytes);
+ $data = $this->getFileObject()->fread($bytes);
// Then return it
return $data;
* @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);
}
projects / core.git / blobdiff