3 * A class for reading files
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class FrameworkFileInputPointer extends BaseFrameworkSystem {
26 * The current file we are working in
28 private $fileName = "";
33 private $filePointer = null;
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
45 $this->removeNumberFormaters();
46 $this->removeSystemArray();
50 * Destructor for cleaning purposes, etc
54 public final function __destruct() {
55 // Is there a resource pointer? Then we have to close the file here!
56 if (is_resource($this->getPointer())) {
57 // Try to close a file
61 // Call the parent destructor
66 * Create a file pointer based on the given file. The file will also
69 * @param $fileName The file name we shall pass to fopen()
70 * @throws FileIsEmptyException If the provided file name is empty.
71 * @throws FilePointerNotOpenedException If fopen() returns not a
75 public final static function createFrameworkFileInputPointer ($fileName) {
76 // Some pre-sanity checks...
77 if ((is_null($fileName)) || (empty($fileName))) {
79 throw new FileIsEmptyException(null, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
80 } elseif (!file_exists($fileName)) {
81 // File does not exist!
82 throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
83 } elseif (!is_readable($fileName)) {
84 // File does not exist!
85 throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
88 // Try to open a handler
89 $filePointer = @fopen($fileName, 'rb');
90 if ((is_null($filePointer)) || ($filePointer === false)) {
91 // Something bad happend
92 throw new FilePointerNotOpenedException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
95 // Create new instance
96 $pointerInstance = new FrameworkFileInputPointer();
98 // Set file pointer and file name
99 $pointerInstance->setPointer($filePointer);
100 $pointerInstance->setFileName($fileName);
102 // Return the instance
103 return $pointerInstance;
107 * Read data a file pointer
109 * @return mixed The result of fread()
110 * @throws NullPointerException If the file pointer instance
111 * is not set by setPointer()
112 * @throws InvalidFileResourceException If there is being set
113 * an invalid file resource
115 public function readFromFile () {
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 InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
124 // Read data from the file pointer and return it
125 return fread($this->getPointer(), 1024);
129 * Read lines from a file pointer
131 * @return mixed The result of fread()
132 * @throws NullPointerException If the file pointer instance
133 * is not set by setPointer()
134 * @throws InvalidFileResourceException If there is being set
135 * an invalid file resource
137 public function readLinesFromFile () {
138 if (is_null($this->getPointer())) {
139 // Pointer not initialized
140 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
141 } elseif (!is_resource($this->getPointer())) {
142 // Pointer is not a valid resource!
143 throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
146 // Read data from the file pointer and return it
147 return fgets($this->getPointer(), 1024);
151 * Close a file source and set it's instance to null and the file name
155 * @throws NullPointerException If the file pointer instance
156 * is not set by setPointer()
157 * @throws InvalidFileResourceException If there is being set
159 public function closeFile () {
160 if (is_null($this->getPointer())) {
161 // Pointer not initialized
162 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
163 } elseif (!is_resource($this->getPointer())) {
164 // Pointer is not a valid resource!
165 throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
168 // Close the file pointer and reset the instance variable
169 @fclose($this->getPointer());
170 $this->setPointer(null);
171 $this->setFileName("");
175 * Setter for the file pointer
177 * @param $filePointer File resource
180 public final function setPointer ($filePointer) {
181 // Sanity-check if pointer is a valid file resource
182 if (is_resource($filePointer) || is_null($filePointer)) {
183 // Is a valid resource
184 $this->filePointer = $filePointer;
187 throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
192 * Getter for the file pointer
194 * @return $filePointer The file pointer which shall be a valid
197 public final function getPointer () {
198 return $this->filePointer;
202 * Setter for file name
204 * @param $fileName The new file name
207 public final function setFileName ($fileName) {
208 $fileName = (string) $fileName;
209 $this->fileName = $fileName;
213 * Getter for file name
215 * @return $fileName The current file name
217 public final function getFileName () {
218 return $this->fileName;