0.3.0 inital import

[mailer.git] / inc / classes / interfaces / io / file / class_FileInputStreamer.php

diff --git a/inc/classes/interfaces/io/file/class_FileInputStreamer.php b/inc/classes/interfaces/io/file/class_FileInputStreamer.php
new file mode 100644 (file)
index 0000000..891c658
--- /dev/null
+++ b/inc/classes/interfaces/io/file/class_FileInputStreamer.php
@@ -0,0 +1,27 @@
+<?php
+/**
+ * An interface for file input operations.
+ * 
+ *
+ * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
+ * @version    0.1
+ */
+interface FileInputStreamer extends Streamable {
+       /**
+        * Reads from a local or remote file
+        *
+        * @param               $fqfn   The file's FQFN we shall load
+        * @return      $array  An array containing all read lines
+        * @throws      NullPointerException    If an instance is null
+        * @throws      NoObjectException               If the instance is not an object
+        *                                                              instance
+        * @throws      MissingMethodException  If a required method is missing.
+        * @throws      InvalidArrayCountException      If an array has not the
+        *                                                                      expected size
+        * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
+        */
+       function loadFileContents ($fqfn);
+}
+
+//
+?>