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
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23 interface FileInputStreamer extends Streamable {
  24         /**
  25          * Reads from a local or remote file
  26          *
  27          * @param               $fqfn   The file's FQFN we shall load
  28          * @return      $array  An array containing all read lines
  29          * @throws      NullPointerException    If an instance is null
  30          * @throws      NoObjectException               If the instance is not an object
  31          *                                                              instance
  32          * @throws      MissingMethodException  If a required method is missing.
  33          * @throws      InvalidArrayCountException      If an array has not the
  34          *                                                                      expected size
  35          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  36          */
  37         function loadFileContents ($fqfn);
  38 }
  39
  40 //
  41 ?>