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

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