5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 BaseFile extends BaseFrameworkSystem {
26 * The current file we are working in
28 private $fileName = '';
31 * Protected constructor
33 * @param $className Name of the class
36 protected function __construct ($className) {
37 // Call parent constructor
38 parent::__construct($className);
42 * Destructor for cleaning purposes, etc
46 public final function __destruct() {
47 // Try to close a file
50 // Call the parent destructor
55 * Getter for the file pointer
57 * @return $filePointer The file pointer which shall be a valid file resource
58 * @throws UnsupportedOperationException If this method is called
60 public final function getPointer () {
61 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
62 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
66 * Setter for file name
68 * @param $fileName The new file name
71 protected final function setFileName ($fileName) {
72 $fileName = (string) $fileName;
73 $this->fileName = $fileName;
77 * Getter for file name
79 * @return $fileName The current file name
81 public final function getFileName () {
82 return $this->fileName;
86 * Initializes this file class
88 * @param $fileName Name of this abstract file
91 protected function initFile ($fileName) {
92 // Get a file i/o pointer instance
93 $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName));
95 // ... and set it here
96 $this->setPointerInstance($pointerInstance);
100 * Close a file source and set it's instance to null and the file name
106 public function closeFile () {
107 $this->partialStub('Unfinished method.');
110 $this->setFileName('');
114 * Determines seek position
116 * @return $seekPosition Current seek position
118 public function determineSeekPosition () {
119 return $this->getPointerInstance()->determineSeekPosition();
123 * Seek to given offset (default) or other possibilities as fseek() gives.
125 * @param $offset Offset to seek to (or used as "base" for other seeks)
126 * @param $whence Added to offset (default: only use offset to seek to)
127 * @return $status Status of file seek: 0 = success, -1 = failed
129 public function seek ($offset, $whence = SEEK_SET) {
130 return $this->getPointerInstance()->seek($offset, $whence);
136 * @return $size Size (in bytes) of file
137 * @todo Handle seekStatus
139 public function size () {
140 return $this->getPointerInstance()->size();
144 * Read data a file pointer
146 * @return mixed The result of fread()
147 * @throws NullPointerException If the file pointer instance
148 * is not set by setPointer()
149 * @throws InvalidResourceException If there is being set
151 public function readFromFile () {
152 return $this->getPointerInstance()->readFromFile();
156 * Reads given amount of bytes from file.
158 * @param $bytes Amount of bytes to read
159 * @return $data Data read from file
161 public function read ($bytes) {
162 return $this->getPointerInstance()->read($bytes);
166 * Write data to a file pointer
168 * @param $dataStream The data stream we shall write to the file
169 * @return mixed Number of writes bytes or FALSE on error
170 * @throws NullPointerException If the file pointer instance
171 * is not set by setPointer()
172 * @throws InvalidResourceException If there is being set
173 * an invalid file resource
175 public function writeToFile ($dataStream) {
176 return $this->getPointerInstance()->writeToFile($dataStream);
180 * Rewinds to the beginning of the file
182 * @return $status Status of this operation
184 public function rewind () {
185 return $this->getPointerInstance()->rewind();