framework/main/interfaces/io/pointer/io/class_InputOutputPointer.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
   7 use Org\Mxchange\CoreFramework\Filesystem\Pointer\OutputPointer;
   8
   9 /**
  10  * An interface for (mostly) file input/output pointers.
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14 <<<<<<< HEAD:framework/main/interfaces/io/pointer/io/class_InputOutputPointer.php
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  16 =======
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  18 >>>>>>> Some updates::inc/main/interfaces/io/pointer/io/class_InputOutputPointer.php
  19  * @license             GNU GPL 3.0 or any newer version
  20  * @link                http://www.shipsimu.org
  21  *
  22  * This program is free software: you can redistribute it and/or modify
  23  * it under the terms of the GNU General Public License as published by
  24  * the Free Software Foundation, either version 3 of the License, or
  25  * (at your option) any later version.
  26  *
  27  * This program is distributed in the hope that it will be useful,
  28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  * GNU General Public License for more details.
  31  *
  32  * You should have received a copy of the GNU General Public License
  33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  34  */
  35 interface InputOutputPointer extends InputPointer, OutputPointer {
  36         /**
  37          * Rewinds to the beginning of the file
  38          *
  39          * @return      $status         Status of this operation
  40          */
  41         function rewind ();
  42
  43         /**
  44          * Advances to next "block" of bytes
  45          *
  46          * @return      void
  47          */
  48         function next ();
  49
  50         /**
  51          * Checks wether the current entry is valid (not at the end of the file).
  52          * This method will return true if an emptied (nulled) entry has been found.
  53          *
  54          * @return      $isValid        Whether the next entry is valid
  55          */
  56         function valid ();
  57
  58         /**
  59          * Gets current seek position ("key").
  60          *
  61          * @return      $key    Current key in iteration
  62          */
  63         function key ();
  64
  65 }