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 * Close a file source and set it's instance to null and the file name
61 public function closeFile () {
62 $this->partialStub('Unfinished method.');
65 $this->setFileName('');
69 * Setter for file name
71 * @param $fileName The new file name
74 protected final function setFileName ($fileName) {
75 $fileName = (string) $fileName;
76 $this->fileName = $fileName;
80 * Getter for file name
82 * @return $fileName The current file name
84 public final function getFileName () {
85 return $this->fileName;
89 * Determines seek position
91 * @return $seekPosition Current seek position
94 public final function determineSeekPosition () {
95 $this->partialStub('Unfinished method.');
99 * Seek to given offset (default) or other possibilities as fseek() gives.
101 * @param $offset Offset to seek to (or used as "base" for other seeks)
102 * @param $whence Added to offset (default: only use offset to seek to)
103 * @return $status Status of file seek: 0 = success, -1 = failed
106 public function seek ($offset, $whence = SEEK_SET) {
107 $this->partialStub('Unfinished method.');
113 * @return $size Size (in bytes) of file
114 * @todo Handle seekStatus
117 public function size () {
118 $this->partialStub('Unfinished method.');