*
* @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.shipsimu.org
*
/**
* Rewinds to the beginning of the file
*
- * @return void
+ * @return $status Status of this operation
*/
function rewind ();
/**
- * Seeks to given position
+ * Advances to next "block" of bytes
*
- * @param $seekPosition Seek position in file
- * @param $whence "Seek mode" (see http://de.php.net/fseek)
* @return void
*/
- function seek ($seekPosition, $whence = SEEK_SET);
+ function next ();
+
+ /**
+ * Checks wether the current entry is valid (not at the end of the file).
+ * This method will return TRUE if an emptied (nulled) entry has been found.
+ *
+ * @return $isValid Whether the next entry is valid
+ */
+ function valid ();
/**
- * "Getter" for seek position
+ * Gets current seek position ("key").
*
- * @return $seekPosition Seek position
+ * @return $key Current key in iteration
*/
- function getSeekPosition ();
+ function key ();
}
// [EOF]