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;
16 * A class for reading text files
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Create a file pointer based on the given file. The file will also
52 * @param $fileName The file name we shall pass to fopen()
53 * @throws FileIoException If the file is not reachable
54 * @throws FileReadProtectedException If the file cannot be read from
57 public static final function createFrameworkTextFileInputPointer ($infoInstance) {
58 if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
59 // File cannot be reached
60 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
61 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
62 // File does not exist!
63 throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
64 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
65 // File cannot be read from (but exists)
66 throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
69 // Try to open a handler
70 $fileObject = $infoInstance->openFile('r');
71 if ((is_null($fileObject)) || ($fileObject === false)) {
72 // Something bad happend
73 throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
76 // Create new instance
77 $pointerInstance = new FrameworkTextFileInputPointer();
79 // Set file pointer and file name
80 $pointerInstance->setPointer($fileObject);
82 // Return the instance
83 return $pointerInstance;
87 * Read data a file pointer
89 * @return $data Read data from file
91 public function readFromFile () {
92 // Read 1024 Byte data from the file pointer and return it
93 return $this->read(1024);
97 * Reads a line, maximum 4096 Bytes from current file pointer
99 * @return $data Read data from file
101 public function readLine () {
102 // Read whole line from the file pointer and return it
103 return $this->read();
107 * Reads given amount of bytes from file.
109 * @param $bytes Amount of bytes to read or whole line (only text files)
110 * @return $data Data read from file
111 * @throws NullPointerException If the file pointer instance is not set by setPointer()
112 * @throws InvalidResourceException If there is no object being set
114 public function read ($bytes = NULL) {
115 // Some sanity checks
116 if (is_null($this->getFileObject())) {
117 // Pointer not initialized
118 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
119 } elseif (!is_object($this->getFileObject())) {
120 // Pointer is not a valid resource!
121 throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
125 if (is_int($bytes)) {
126 // Try to read given characters
127 $data = $this->getFileObject()->fread($bytes);
129 // Try to read whole line
130 $data = $this->getFileObject()->fgets();
138 * Analyzes entries in index file. This will count all found (and valid)
139 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
140 * only gaps are found, the file is considered as "virgin" (no entries).
143 * @throws UnsupportedOperationException If this method is called
145 public function analyzeFile () {
146 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
150 * Advances to next "block" of bytes
153 * @throws UnsupportedOperationException If this method is called
155 public function next () {
156 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
160 * Checks wether the current entry is valid (not at the end of the file).
161 * This method will return true if an emptied (nulled) entry has been found.
163 * @return $isValid Whether the next entry is valid
164 * @throws UnsupportedOperationException If this method is called
166 public function valid () {
167 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
171 * Gets current seek position ("key").
173 * @return $key Current key in iteration
174 * @throws UnsupportedOperationException If this method is called
176 public function key () {
177 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);