3 namespace Org\Mxchange\CoreFramework\Stream\Filesystem;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Stream\Input\StreamableInput;
12 * An interface for file input operations.
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
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.
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.
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/>.
33 interface FileInputStreamer extends StreamableInput {
35 * Reads from a local or remote file
37 * @param $infoInstance An instance of a SplFileInfo class
38 * @return $array An array containing all read lines
39 * @throws InvalidArrayCountException If an array has not the expected size
40 * @throws InvalidMD5ChecksumException If two MD5 hashes did not match
42 function loadFileContents (SplFileInfo $infoInstance);