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