]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/io/file/csv/class_CsvInputStreamer.php
Continued:
[core.git] / framework / main / interfaces / io / file / csv / class_CsvInputStreamer.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Stream\Filesystem;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Stream\Filesystem\FileInputStreamer;
7
8 /**
9  * An interface for CSV file input operations.
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
29  */
30 interface CsvInputStreamer extends FileInputStreamer {
31         /**
32          * Reads a line from CSV file and returns it as an indexed array
33          *
34          * @param       $columnSeparator        Character to use separting columns
35          * @param       $expectedMatches        Expected matches, 0 is default and means flexible
36          * @return      $lineArray                      An index array with the read line
37          * @throws      InvalidArgumentException        If a parameter is invalid
38          */
39         function readCsvFileLine (string $columnSeparator, int $expectedMatches = 0);
40
41 }