inc/classes/interfaces/io/file/class_FileInputStreamer.php

   1 <?php
   2 /**
   3  * An interface for file input operations.
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 FileInputStreamer extends Streamable {
  25         /**
  26          * Reads from a local or remote file
  27          *
  28          * @param       $fqfn   The file's FQFN we shall load
  29          * @return      $array  An array containing all read lines
  30          * @throws      InvalidArrayCountException      If an array has not the
  31          *                                                                      expected size
  32          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  33          */
  34         function loadFileContents ($fqfn);
  35 }
  36
  37 //
  38 ?>