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 FileIterator 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 Block class
39 * @return $iteratorInstance An instance of a Iterator class
41 public final static function createFileIterator (Block $blockInstance) {
43 $iteratorInstance = new FileIterator();
45 // Set the instance here
46 $iteratorInstance->setBlockInstance($blockInstance);
48 // Return the prepared instance
49 return $iteratorInstance;
53 * Gets currently read data
55 * @return $current Currently read data
57 public function current () {
58 // Call block instance
59 return $this->getBlockInstance()->current();
63 * Gets current seek position ("key").
65 * @return $key Current key in iteration
67 public function key () {
69 return $this->getBlockInstance()->determineSeekPosition();
73 * Advances to next "block" of bytes
77 public function next () {
78 // Call block instance
79 $this->getBlockInstance()->next();
83 * Rewinds to the beginning of the file
85 * @return $status Status of this operation
87 public function rewind () {
88 // Call block instance
89 return $this->getBlockInstance()->rewind();
93 * Checks wether the current entry is valid (not at the end of the file).
94 * This method will return TRUE if an emptied (nulled) entry has been found.
96 * @return $isValid Whether the next entry is valid
98 public function valid () {
99 // Call block instance
100 return $this->getBlockInstance()->valid();
104 * Seeks to given position
106 * @param $seekPosition Seek position in file
107 * @return $status Status of this operation
109 public function seek ($seekPosition) {
110 // Call block instance
111 return $this->getBlockInstance()->seek($seekPosition);
115 * Writes at given position by seeking to it.
117 * @param $seekPosition Seek position in file
118 * @param $data Data to be written
121 public function writeAtPosition ($seekPosition, $data) {
123 $this->seek($seekPosition);
125 // Then write the data at that position
126 $this->getBlockInstance()->writeToFile($data);
132 * @return $size Size (in bytes) of file
134 public function size () {
135 // Call the block object
136 $size = $this->getBlockInstance()->size();
143 * Reads given amount of bytes from file.
145 * @param $bytes Amount of bytes to read
146 * @return $data Data read from file
148 public function read ($bytes) {
149 // Call block instance
150 return $this->getBlockInstance()->read($bytes);
154 * Analyzes entries in index file. This will count all found (and valid)
155 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
156 * only gaps are found, the file is considered as "virgin" (no entries).
160 public function analyzeFile () {
161 // Just call the block instance
162 $this->getBlockInstance()->analyzeFile();
166 * Checks whether the file header is initialized
168 * @return $isInitialized Whether the file header is initialized
170 public function isFileHeaderInitialized () {
171 // Just call the block instance
172 return $this->getBlockInstance()->isFileHeaderInitialized();
176 * Creates the assigned file
180 public function createFileHeader () {
181 // Just call the block instance
182 $this->getBlockInstance()->createFileHeader();
186 * Pre-allocates file (if enabled) with some space for later faster write access.
188 * @param $type Type of the file
191 public function preAllocateFile ($type) {
192 // Just call the block instance
193 $this->getBlockInstance()->preAllocateFile($type);