Added more methods (required).
[core.git] / inc / classes / interfaces / io / pointer / io / class_InputOutputPointer.php
index 529dbe6f1ad36a22677511d7fbbdc2b7ba6fecc1..0cb98dd847801d3cb036a5701bb0d4192b2fe342 100644 (file)
@@ -25,18 +25,32 @@ interface InputOutputPointer extends InputPointer, OutputPointer {
        /**
         * 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
+        * @todo        This method will load large but empty files in a whole
+        */
+       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 ();
+
+       /**
+        * Gets current seek position ("key").
+        *
+        * @return      $key    Current key in iteration
         */
-       function seek ($seekPosition, $whence = SEEK_SET);
+       function key ();
 }
 
 // [EOF]