inc/classes/interfaces/io/pointer/class_InputPointer.php

   1 <?php
   2 /**
   3  * An interface for (mostly) file input pointers.
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface InputPointer extends StreamableInput, FilePointer {
  25         /**
  26          * Read data a file pointer
  27          *
  28          * @return      $data   Read data from file
  29          */
  30         function readFromFile ();
  31
  32         /**
  33          * Reads a line, maximum 4096 Bytes from current file pointer
  34          *
  35          * @return      $data   Read data from file
  36          */
  37         function readLine ();
  38
  39         /**
  40          * Reads given amount of bytes from file.
  41          *
  42          * @param       $bytes  Amount of bytes to read or whole line (only text files)
  43          * @return      $data   Data read from file
  44          * @throws      NullPointerException    If the file pointer instance
  45          *                                                                      is not set by setPointer()
  46          * @throws      InvalidResourceException        If there is being set
  47          */
  48         function read ($bytes = NULL);
  49 }
  50
  51 // [EOF]
  52 ?>