inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php

   1 <?php
   2 /**
   3  * An interface for seekable iterators which also allow to write to the file
   4  * in different ways.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 interface SeekableWritableFileIterator extends SeekableIterator {
  26         /**
  27          * Seeks to given position
  28          *
  29          * @param       $seekPosition   Seek position in file
  30          * @return      void
  31          */
  32         function seek ($seekPosition);
  33
  34         /**
  35          * Size of file stack
  36          *
  37          * @return      $size   Size (in bytes) of file
  38          */
  39         function size ();
  40
  41         /**
  42          * Writes at given position by seeking to it.
  43          *
  44          * @param       $seekPosition   Seek position in file
  45          * @param       $data                   Data to be written
  46          * @return      void
  47          */
  48         function writeAtPosition ($seedPosition, $data);
  49 }
  50
  51 // [EOF]
  52 ?>