5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 FileIoIterator extends BaseIterator implements SeekableWritableFileIterator {
26 * Current absolute seek position (returned by key())
28 private $seekPosition = FALSE;
31 * Total entries (read from file)
33 private $totalEntriesFile = FALSE;
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this class
48 * @param $pointerInstance An instance of a InputOutputPointer class
49 * @return $iteratorInstance An instance of a Iterator class
51 public final static function createFileIoIterator (InputOutputPointer $pointerInstance) {
53 $iteratorInstance = new FileIoIterator();
55 // Set the instance here
56 $iteratorInstance->setPointerInstance($pointerInstance);
58 // Return the prepared instance
59 return $iteratorInstance;
63 * Gets currently read data
65 * @return $current Currently read data
67 public function current () {
71 $this->partialStub('Please implement this method.');
78 * Gets current seek position ("key").
80 * @return $key Current key in iteration
82 public function key () {
86 $this->partialStub('Please implement this method.');
93 * Advances to next "block" of bytes
97 public function next () {
98 $this->partialStub('Please implement this method.');
102 * Rewinds to the beginning of the file
106 public function rewind () {
107 $this->partialStub('Please implement this method.');
111 * Seeks to given position
113 * @param $seekPosition Seek position in file
116 public function seek ($seedPosition) {
117 $this->partialStub('Please implement this method. seekPosition=' . $seekPosition);
123 * @return $size Size (in bytes) of file
125 public function size () {
126 // Call the pointer object
127 $size = $this->getPointerInstance()->size();
134 * Checks wether the current entry is valid (not at the end of the file).
135 * This method will return TRUE if an emptied (nulled) entry has been found.
139 public function valid () {
140 $this->partialStub('Please implement this method.');