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

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