3 namespace CoreFramework\Filesystem\Pointer\Input;
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\FileSystem\BaseFileIo;
8 use CoreFramework\Filesystem\Pointer\InputPointer;
9 use CoreFramework\Generic\NullPointerException;
10 use CoreFramework\Object\BaseFrameworkSystem;
13 * A class for reading text files
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Create a file pointer based on the given file. The file will also
49 * @param $fileName The file name we shall pass to fopen()
50 * @throws FileIsEmptyException If the provided file name is empty.
51 * @throws FileIoException If the file is not reachable
52 * @throws FileReadProtectedException If the file cannot be read from
55 public static final function createFrameworkTextFileInputPointer ($fileName) {
56 // Some pre-sanity checks...
57 if ((is_null($fileName)) || (empty($fileName))) {
59 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
60 } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
61 // File cannot be reached
62 throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
63 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
64 // File does not exist!
65 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
66 } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
67 // File cannot be read from (but exists)
68 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
71 // Try to open a handler
72 $filePointer = fopen($fileName, 'r');
73 if ((is_null($filePointer)) || ($filePointer === false)) {
74 // Something bad happend
75 throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
78 // Create new instance
79 $pointerInstance = new FrameworkTextFileInputPointer();
81 // Set file pointer and file name
82 $pointerInstance->setPointer($filePointer);
83 $pointerInstance->setFileName($fileName);
85 // Return the instance
86 return $pointerInstance;
90 * Read data a file pointer
92 * @return $data Read data from file
94 public function readFromFile () {
95 // Read 1024 Byte data from the file pointer and return it
96 return $this->read(1024);
100 * Reads a line, maximum 4096 Bytes from current file pointer
102 * @return $data Read data from file
104 public function readLine () {
105 // Read whole line from the file pointer and return it
106 return $this->read();
110 * Reads given amount of bytes from file.
112 * @param $bytes Amount of bytes to read or whole line (only text files)
113 * @return $data Data read from file
114 * @throws NullPointerException If the file pointer instance
115 * is not set by setPointer()
116 * @throws InvalidResourceException If there is being set
118 public function read ($bytes = NULL) {
119 // Some sanity checks
120 if (is_null($this->getPointer())) {
121 // Pointer not initialized
122 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
123 } elseif (!is_resource($this->getPointer())) {
124 // Pointer is not a valid resource!
125 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
129 if (is_int($bytes)) {
130 // Try to read given characters
131 $data = fgets($this->getPointer(), $bytes);
133 // Try to read whole line
134 $data = fgets($this->getPointer());
142 * Analyzes entries in index file. This will count all found (and valid)
143 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
144 * only gaps are found, the file is considered as "virgin" (no entries).
147 * @throws UnsupportedOperationException If this method is called
149 public function analyzeFile () {
150 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
154 * Advances to next "block" of bytes
157 * @throws UnsupportedOperationException If this method is called
159 public function next () {
160 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
164 * Checks wether the current entry is valid (not at the end of the file).
165 * This method will return true if an emptied (nulled) entry has been found.
167 * @return $isValid Whether the next entry is valid
168 * @throws UnsupportedOperationException If this method is called
170 public function valid () {
171 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
175 * Gets current seek position ("key").
177 * @return $key Current key in iteration
178 * @throws UnsupportedOperationException If this method is called
180 public function key () {
181 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);