3 * A general FileIo class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
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 BaseFileIo extends BaseFrameworkSystem {
26 * The current file we are working in
28 private $fileName = '';
33 private $filePointer = NULL;
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
47 * Destructor for cleaning purposes, etc
51 public final function __destruct() {
52 // Is there a resource pointer? Then we have to close the file here!
53 if (is_resource($this->getPointer())) {
54 // Try to close a file
58 // Call the parent destructor
63 * Close a file source and set it's instance to null and the file name
67 * @throws NullPointerException If the file pointer instance is not set by setPointer()
68 * @throws InvalidResourceException If there is being set
70 public function closeFile () {
72 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
74 if (is_null($this->getPointer())) {
75 // Pointer not initialized
76 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
77 } elseif (!is_resource($this->getPointer())) {
78 // Pointer is not a valid resource!
79 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
82 // Close the file pointer and reset the instance variable
83 @fclose($this->getPointer());
84 $this->setPointer(NULL);
85 $this->setFileName('');
88 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
92 * Setter for the file pointer
94 * @param $filePointer File resource
97 protected final function setPointer ($filePointer) {
98 $this->filePointer = $filePointer;
102 * Getter for the file pointer
104 * @return $filePointer The file pointer which shall be a valid file resource
106 public final function getPointer () {
107 return $this->filePointer;
111 * Setter for file name
113 * @param $fileName The new file name
116 protected final function setFileName ($fileName) {
117 $fileName = (string) $fileName;
118 $this->fileName = $fileName;
122 * Getter for file name
124 * @return $fileName The current file name
126 public final function getFileName () {
127 return $this->fileName;
131 * Determines seek position
133 * @return $seekPosition Current seek position
135 public final function determineSeekPosition () {
136 return ftell($this->getPointer());
140 * Determines whether the EOF has been reached
142 * @return $isEndOfFileReached Whether the EOF has been reached
144 public final function isEndOfFileReached () {
145 return feof($this->getPointer());
149 * Seek to given offset (default) or other possibilities as fseek() gives.
151 * @param $offset Offset to seek to (or used as "base" for other seeks)
152 * @param $whence Added to offset (default: only use offset to seek to)
153 * @return $status Status of file seek: 0 = success, -1 = failed
155 public function seek ($offset, $whence = SEEK_SET) {
157 $status = fseek($this->getPointer(), $offset, $whence);
160 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] status=%d', __METHOD__, __LINE__, $status));
167 * @return $size Size (in bytes) of file
168 * @todo Handle seekStatus
170 public function size () {
171 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
173 // Get current seek position
174 $seekPosition = $this->determineSeekPosition();
177 $seekStatus = $this->seek(0, SEEK_END);
178 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
180 // Get position again (which is the end of the file)
181 $size = $this->determineSeekPosition();
183 // Reset seek position to old
184 $this->seek($seekPosition);
187 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] size=%s - EXIT!', __METHOD__, __LINE__, $size));