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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\FilePointer;
   7 use Org\Mxchange\CoreFramework\Stream\Input\StreamableInput;
   8
   9 /**
  10  * An interface for (mostly) file input pointers.
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14 <<<<<<< HEAD:framework/main/interfaces/io/pointer/class_InputPointer.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/class_InputPointer.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 InputPointer extends StreamableInput, FilePointer {
  36         /**
  37          * Read data a file pointer
  38          *
  39          * @return      $data   Read data from file
  40          */
  41         function readFromFile ();
  42
  43         /**
  44          * Reads a line, maximum 4096 Bytes from current file pointer
  45          *
  46          * @return      $data   Read data from file
  47          */
  48         function readLine ();
  49
  50         /**
  51          * Reads given amount of bytes from file.
  52          *
  53          * @param       $bytes  Amount of bytes to read or whole line (only text files)
  54          * @return      $data   Data read from file
  55          * @throws      NullPointerException    If the file pointer instance
  56          *                                                                      is not set by setPointer()
  57          * @throws      InvalidResourceException        If there is being set
  58          */
  59         function read ($bytes = NULL);
  60
  61 }