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

   1 <?php
   2 /**
   3  * An interface for file input operations.
   4  *
   5  *
   6  * @author      Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
   7  * @version     0.1
   8  */
   9 interface FileInputStreamer extends Streamable {
  10         /**
  11          * Reads from a local or remote file
  12          *
  13          * @param               $fqfn   The file's FQFN we shall load
  14          * @return      $array  An array containing all read lines
  15          * @throws      NullPointerException    If an instance is null
  16          * @throws      NoObjectException               If the instance is not an object
  17          *                                                              instance
  18          * @throws      MissingMethodException  If a required method is missing.
  19          * @throws      InvalidArrayCountException      If an array has not the
  20          *                                                                      expected size
  21          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  22          */
  23         function loadFileContents ($fqfn);
  24 }
  25
  26 //
  27 ?>