3 namespace CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\FileSystem\BaseFileIo;
8 use CoreFramework\Filesystem\FileNotFoundException;
9 use CoreFramework\FileSystem\FileReadProtectedException;
10 use CoreFramework\Filesystem\Pointer\InputPointer;
11 use CoreFramework\Generic\NullPointerException;
12 use CoreFramework\Generic\UnsupportedOperationException;
13 use 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 FileIsEmptyException If the provided file name is empty.
54 * @throws FileIoException If the file is not reachable
55 * @throws FileReadProtectedException If the file cannot be read from
58 public static final function createFrameworkTextFileInputPointer ($fileName) {
59 // Some pre-sanity checks...
60 if ((is_null($fileName)) || (empty($fileName))) {
62 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
63 } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
64 // File cannot be reached
65 throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
66 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
67 // File does not exist!
68 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
69 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
70 // File cannot be read from (but exists)
71 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
74 // Try to open a handler
75 $filePointer = fopen($fileName, 'r');
76 if ((is_null($filePointer)) || ($filePointer === false)) {
77 // Something bad happend
78 throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
81 // Create new instance
82 $pointerInstance = new FrameworkTextFileInputPointer();
84 // Set file pointer and file name
85 $pointerInstance->setPointer($filePointer);
86 $pointerInstance->setFileName($fileName);
88 // Return the instance
89 return $pointerInstance;
93 * Read data a file pointer
95 * @return $data Read data from file
97 public function readFromFile () {
98 // Read 1024 Byte data from the file pointer and return it
99 return $this->read(1024);
103 * Reads a line, maximum 4096 Bytes from current file pointer
105 * @return $data Read data from file
107 public function readLine () {
108 // Read whole line from the file pointer and return it
109 return $this->read();
113 * Reads given amount of bytes from file.
115 * @param $bytes Amount of bytes to read or whole line (only text files)
116 * @return $data Data read from file
117 * @throws NullPointerException If the file pointer instance
118 * is not set by setPointer()
119 * @throws InvalidResourceException If there is being set
121 public function read ($bytes = NULL) {
122 // Some sanity checks
123 if (is_null($this->getPointer())) {
124 // Pointer not initialized
125 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
126 } elseif (!is_resource($this->getPointer())) {
127 // Pointer is not a valid resource!
128 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
132 if (is_int($bytes)) {
133 // Try to read given characters
134 $data = fgets($this->getPointer(), $bytes);
136 // Try to read whole line
137 $data = fgets($this->getPointer());
145 * Analyzes entries in index file. This will count all found (and valid)
146 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
147 * only gaps are found, the file is considered as "virgin" (no entries).
150 * @throws UnsupportedOperationException If this method is called
152 public function analyzeFile () {
153 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
157 * Advances to next "block" of bytes
160 * @throws UnsupportedOperationException If this method is called
162 public function next () {
163 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
167 * Checks wether the current entry is valid (not at the end of the file).
168 * This method will return true if an emptied (nulled) entry has been found.
170 * @return $isValid Whether the next entry is valid
171 * @throws UnsupportedOperationException If this method is called
173 public function valid () {
174 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
178 * Gets current seek position ("key").
180 * @return $key Current key in iteration
181 * @throws UnsupportedOperationException If this method is called
183 public function key () {
184 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);