]> git.mxchange.org Git - core.git/blobdiff - inc/classes/interfaces/io/pointer/io/class_InputOutputPointer.php
Continued CSV parsing:
[core.git] / inc / classes / interfaces / io / pointer / io / class_InputOutputPointer.php
index 6dc483a3df9daece2f98bfb3d425cddf4b8f2755..4a1fc52451ec54da49f47874e17146dbee199382 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @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 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -25,18 +25,31 @@ interface InputOutputPointer extends InputPointer, OutputPointer {
        /**
         * Rewinds to the beginning of the file
         *
-        * @return      $status         Status of this operation
+        * @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      $tatus                  Status of this operation
+        * @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 ();
+
+       /**
+        * Gets current seek position ("key").
+        *
+        * @return      $key    Current key in iteration
+        */
+       function key ();
 }
 
 // [EOF]