Continued with renaming-season:

[core.git] / framework / main / interfaces / io / file / csv / class_CsvInputStreamer.php

diff --git a/framework/main/interfaces/io/file/csv/class_CsvInputStreamer.php b/framework/main/interfaces/io/file/csv/class_CsvInputStreamer.php
new file mode 100644 (file)
index 0000000..5cd509e
--- /dev/null
+++ b/framework/main/interfaces/io/file/csv/class_CsvInputStreamer.php
@@ -0,0 +1,39 @@
+<?php
+// Own namespace
+namespace CoreFramework\Stream\Filesystem;
+
+// Import framework stuff
+use CoreFramework\Stream\Filesystem\FileInputStreamer;
+
+/**
+ * An interface for CSV file input operations.
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+interface CsvInputStreamer extends FileInputStreamer {
+       /**
+        * Reads a line from CSV file and returns it as an indexed array
+        *
+        * @param       $columnSeparator        Character to use separting columns
+        * @return      $lineArray                      An index array with the read line
+        */
+       function readCsvFileLine ($columnSeparator);
+
+}