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 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $pointerInstance An instance of a FrameworkFileInputOutputPointer class
39 * @return $iteratorInstance An instance of a Iterator class
41 public final static function createFileIoIterator (FrameworkFileInputOutputPointer $pointerInstance) {
43 $iteratorInstance = new FileIoIterator();
45 // Set the instance here
46 $iteratorInstance->setPointerInstance($pointerInstance);
48 // Return the prepared instance
49 return $iteratorInstance;
53 * Gets currently read data
55 * @return $current Currently read data
57 public function current () {
61 $this->partialStub('Please implement this method.');
68 * Gets current seek position ("key").
70 * @return $key Current key in iteration
72 public function key () {
76 $this->partialStub('Please implement this method.');
83 * Advances to next "block" of bytes
87 public function next () {
88 $this->partialStub('Please implement this method.');
92 * Rewinds to the beginning of the file
96 public function rewind () {
97 $this->partialStub('Please implement this method.');
101 * Seeks to given position
103 * @param $seekPosition Seek position in file
106 public function seek ($seedPosition) {
107 $this->partialStub('Please implement this method. seekPosition=' . $seekPosition);
111 * Checks wether the current entry is valid (not at the end of the file).
112 * This method will return TRUE if an emptied (nulled) entry has been found.
116 public function valid () {
117 $this->partialStub('Please implement this method.');