3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\FileSystem\BaseFileIo;
8 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
9 use Org\Mxchange\CoreFramework\FileSystem\FileReadProtectedException;
10 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
11 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
12 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
13 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
19 * A class for reading text files
21 * @author Roland Haeder <webmaster@shipsimu.org>
23 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
24 * @license GNU GPL 3.0 or any newer version
25 * @link http://www.shipsimu.org
27 * This program is free software: you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation, either version 3 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Create a file pointer based on the given file. The file will also
55 * @param $fileName The file name we shall pass to fopen()
56 * @throws FileIoException If the file is not reachable
57 * @throws FileReadProtectedException If the file cannot be read from
60 public static final function createFrameworkTextFileInputPointer (SplFileInfo $infoInstance) {
62 if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
63 // File cannot be reached
64 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
65 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
66 // File does not exist!
67 throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
68 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
69 // File cannot be read from (but exists)
70 throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
73 // Try to open a handler
74 $fileObject = $infoInstance->openFile('r');
77 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEXT-FILE-INPUT: fileObject[]=' . gettype($fileObject));
80 if ((is_null($fileObject)) || ($fileObject === false)) {
81 // Something bad happend
82 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
85 // Create new instance
86 $pointerInstance = new FrameworkTextFileInputPointer();
88 // Set file pointer and file name
89 $pointerInstance->setFileObject($fileObject);
91 // Return the instance
92 return $pointerInstance;
96 * Read data a file pointer
98 * @return $data Read data from file
100 public function readFromFile () {
101 // Read 1024 Byte data from the file pointer and return it
102 return $this->read(1024);
106 * Reads a line, maximum 4096 Bytes from current file pointer
108 * @return $data Read data from file
110 public function readLine () {
111 // Read whole line from the file pointer and return it
112 return $this->read();
116 * Reads given amount of bytes from file.
118 * @param $bytes Amount of bytes to read or whole line (only text files)
119 * @return $data Data read from file
120 * @throws NullPointerException If the file pointer instance is not set by setFileObject()
121 * @throws InvalidResourceException If there is no object being set
123 public function read ($bytes = NULL) {
124 // Some sanity checks
125 if (is_null($this->getFileObject())) {
126 // Pointer not initialized
127 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
128 } elseif (!is_object($this->getFileObject())) {
129 // Pointer is not a valid resource!
130 throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
134 if (is_int($bytes)) {
135 // Try to read given characters
136 $data = $this->getFileObject()->fread($bytes);
138 // Try to read whole line
139 $data = $this->getFileObject()->fgets();
147 * Analyzes entries in index file. This will count all found (and valid)
148 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
149 * only gaps are found, the file is considered as "virgin" (no entries).
152 * @throws UnsupportedOperationException If this method is called
154 public function analyzeFile () {
155 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
159 * Advances to next "block" of bytes
162 * @throws UnsupportedOperationException If this method is called
164 public function next () {
165 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
169 * Checks wether the current entry is valid (not at the end of the file).
170 * This method will return true if an emptied (nulled) entry has been found.
172 * @return $isValid Whether the next entry is valid
173 * @throws UnsupportedOperationException If this method is called
175 public function valid () {
176 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
180 * Gets current seek position ("key").
182 * @return $key Current key in iteration
183 * @throws UnsupportedOperationException If this method is called
185 public function key () {
186 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);