3 namespace CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\FileSystem\BaseFileIo;
8 use CoreFramework\FileSystem\FileReadProtectedException;
9 use CoreFramework\Filesystem\Pointer\InputPointer;
10 use CoreFramework\Generic\NullPointerException;
11 use CoreFramework\Generic\UnsupportedOperationException;
12 use CoreFramework\Object\BaseFrameworkSystem;
15 * A class for reading text files
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Create a file pointer based on the given file. The file will also
51 * @param $fileName The file name we shall pass to fopen()
52 * @throws FileIsEmptyException If the provided file name is empty.
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 ($fileName) {
58 // Some pre-sanity checks...
59 if ((is_null($fileName)) || (empty($fileName))) {
61 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
62 } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
63 // File cannot be reached
64 throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
65 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
66 // File does not exist!
67 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
68 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
69 // File cannot be read from (but exists)
70 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
73 // Try to open a handler
74 $filePointer = fopen($fileName, 'r');
75 if ((is_null($filePointer)) || ($filePointer === false)) {
76 // Something bad happend
77 throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
80 // Create new instance
81 $pointerInstance = new FrameworkTextFileInputPointer();
83 // Set file pointer and file name
84 $pointerInstance->setPointer($filePointer);
85 $pointerInstance->setFileName($fileName);
87 // Return the instance
88 return $pointerInstance;
92 * Read data a file pointer
94 * @return $data Read data from file
96 public function readFromFile () {
97 // Read 1024 Byte data from the file pointer and return it
98 return $this->read(1024);
102 * Reads a line, maximum 4096 Bytes from current file pointer
104 * @return $data Read data from file
106 public function readLine () {
107 // Read whole line from the file pointer and return it
108 return $this->read();
112 * Reads given amount of bytes from file.
114 * @param $bytes Amount of bytes to read or whole line (only text files)
115 * @return $data Data read from file
116 * @throws NullPointerException If the file pointer instance
117 * is not set by setPointer()
118 * @throws InvalidResourceException If there is being set
120 public function read ($bytes = NULL) {
121 // Some sanity checks
122 if (is_null($this->getPointer())) {
123 // Pointer not initialized
124 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
125 } elseif (!is_resource($this->getPointer())) {
126 // Pointer is not a valid resource!
127 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
131 if (is_int($bytes)) {
132 // Try to read given characters
133 $data = fgets($this->getPointer(), $bytes);
135 // Try to read whole line
136 $data = fgets($this->getPointer());
144 * Analyzes entries in index file. This will count all found (and valid)
145 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
146 * only gaps are found, the file is considered as "virgin" (no entries).
149 * @throws UnsupportedOperationException If this method is called
151 public function analyzeFile () {
152 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
156 * Advances to next "block" of bytes
159 * @throws UnsupportedOperationException If this method is called
161 public function next () {
162 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
166 * Checks wether the current entry is valid (not at the end of the file).
167 * This method will return true if an emptied (nulled) entry has been found.
169 * @return $isValid Whether the next entry is valid
170 * @throws UnsupportedOperationException If this method is called
172 public function valid () {
173 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
177 * Gets current seek position ("key").
179 * @return $key Current key in iteration
180 * @throws UnsupportedOperationException If this method is called
182 public function key () {
183 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);