3 namespace CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use CoreFramework\Object\BaseFrameworkSystem;
9 * A class for reading text files
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Create a file pointer based on the given file. The file will also
45 * @param $fileName The file name we shall pass to fopen()
46 * @throws FileIsEmptyException If the provided file name is empty.
47 * @throws FileIoException If the file is not reachable
48 * @throws FileReadProtectedException If the file cannot be read from
51 public static final function createFrameworkTextFileInputPointer ($fileName) {
52 // Some pre-sanity checks...
53 if ((is_null($fileName)) || (empty($fileName))) {
55 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
56 } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
57 // File cannot be reached
58 throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
59 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (!file_exists($fileName))) {
60 // File does not exist!
61 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
62 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (file_exists($fileName))) {
63 // File cannot be read from (but exists)
64 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
67 // Try to open a handler
68 $filePointer = fopen($fileName, 'r');
69 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
70 // Something bad happend
71 throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
74 // Create new instance
75 $pointerInstance = new FrameworkTextFileInputPointer();
77 // Set file pointer and file name
78 $pointerInstance->setPointer($filePointer);
79 $pointerInstance->setFileName($fileName);
81 // Return the instance
82 return $pointerInstance;
86 * Read data a file pointer
88 * @return $data Read data from file
90 public function readFromFile () {
91 // Read 1024 Byte data from the file pointer and return it
92 return $this->read(1024);
96 * Reads a line, maximum 4096 Bytes from current file pointer
98 * @return $data Read data from file
100 public function readLine () {
101 // Read whole line from the file pointer and return it
102 return $this->read();
106 * Reads given amount of bytes from file.
108 * @param $bytes Amount of bytes to read or whole line (only text files)
109 * @return $data Data read from file
110 * @throws NullPointerException If the file pointer instance
111 * is not set by setPointer()
112 * @throws InvalidResourceException If there is being set
114 public function read ($bytes = NULL) {
115 // Some sanity checks
116 if (is_null($this->getPointer())) {
117 // Pointer not initialized
118 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
119 } elseif (!is_resource($this->getPointer())) {
120 // Pointer is not a valid resource!
121 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
125 if (is_int($bytes)) {
126 // Try to read given characters
127 $data = fgets($this->getPointer(), $bytes);
129 // Try to read whole line
130 $data = fgets($this->getPointer());
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);