framework/main/interfaces/io/file/class_FileInputStreamer.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Stream\Filesystem;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Stream\Input\StreamableInput;
   7
   8 // Import SPL stuff
   9 use \SplFileInfo;
  10
  11 /**
  12  * An interface for file input operations.
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16 <<<<<<< HEAD:framework/main/interfaces/io/file/class_FileInputStreamer.php
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18 =======
  19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  20 >>>>>>> Some updates::inc/main/interfaces/io/file/class_FileInputStreamer.php
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  24  * This program is free software: you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation, either version 3 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License
  35  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  36  */
  37 interface FileInputStreamer extends StreamableInput {
  38
  39         /**
  40          * Reads from a local or remote file
  41          *
  42          * @param       $infoInstance   An instance of a SplFileInfo class
  43          * @return      $array  An array containing all read lines
  44          * @throws      InvalidArrayCountException      If an array has not the expected size
  45          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  46          */
  47         function loadFileContents (SplFileInfo $infoInstance);
  48
  49 }