AbstractCsv.php
2 weeks ago
ByteSequence.php
2 weeks ago
CannotInsertRecord.php
2 weeks ago
CharsetConverter.php
2 weeks ago
ColumnConsistency.php
2 weeks ago
EncloseField.php
2 weeks ago
EscapeFormula.php
2 weeks ago
Exception.php
9 months ago
HTMLConverter.php
2 weeks ago
Info.php
2 weeks ago
InvalidArgument.php
9 months ago
MapIterator.php
2 weeks ago
RFC4180Field.php
2 weeks ago
Reader.php
2 weeks ago
ResultSet.php
2 weeks ago
Statement.php
2 weeks ago
Stream.php
2 weeks ago
SyntaxError.php
2 weeks ago
TabularDataReader.php
2 weeks ago
UnableToProcessCsv.php
9 months ago
UnavailableFeature.php
9 months ago
UnavailableStream.php
9 months ago
Writer.php
2 weeks ago
XMLConverter.php
2 weeks ago
functions.php
9 months ago
functions_include.php
9 months ago
TabularDataReader.php
110 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * League.Csv (https://csv.thephpleague.com) |
| 5 | * |
| 6 | * (c) Ignace Nyamagana Butera <nyamsprod@gmail.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | declare (strict_types=1); |
| 12 | namespace IAWPSCOPED\League\Csv; |
| 13 | |
| 14 | use Countable; |
| 15 | use Iterator; |
| 16 | use IteratorAggregate; |
| 17 | /** |
| 18 | * Represents a Tabular data. |
| 19 | * |
| 20 | * @method Iterator fetchColumnByName(string $name) returns a column from its name |
| 21 | * @method Iterator fetchColumnByOffset(int $offset) returns a column from its offset |
| 22 | * @internal |
| 23 | */ |
| 24 | interface TabularDataReader extends Countable, IteratorAggregate |
| 25 | { |
| 26 | /** |
| 27 | * Returns the number of records contained in the tabular data structure |
| 28 | * excluding the header record. |
| 29 | */ |
| 30 | public function count() : int; |
| 31 | /** |
| 32 | * Returns the tabular data records as an iterator object. |
| 33 | * |
| 34 | * Each record is represented as a simple array containing strings or null values. |
| 35 | * |
| 36 | * If the CSV document has a header record then each record is combined |
| 37 | * to the header record and the header record is removed from the iterator. |
| 38 | * |
| 39 | * If the CSV document is inconsistent. Missing record fields are |
| 40 | * filled with null values while extra record fields are strip from |
| 41 | * the returned object. |
| 42 | */ |
| 43 | public function getIterator() : Iterator; |
| 44 | /** |
| 45 | * Returns the header associated with the tabular data. |
| 46 | * |
| 47 | * The header must contains unique string or is an empty array |
| 48 | * if no header was specified. |
| 49 | * |
| 50 | * @return array<string> |
| 51 | */ |
| 52 | public function getHeader() : array; |
| 53 | /** |
| 54 | * Returns the tabular data records as an iterator object. |
| 55 | * |
| 56 | * Each record is represented as a simple array containing strings or null values. |
| 57 | * |
| 58 | * If the tabular data has a header record then each record is combined |
| 59 | * to the header record and the header record is removed from the iterator. |
| 60 | * |
| 61 | * If the tabular data is inconsistent. Missing record fields are |
| 62 | * filled with null values while extra record fields are strip from |
| 63 | * the returned object. |
| 64 | * |
| 65 | * @param array<string> $header an optional header to use instead of the CSV document header |
| 66 | */ |
| 67 | public function getRecords(array $header = []) : Iterator; |
| 68 | /** |
| 69 | * Returns the nth record from the tabular data. |
| 70 | * |
| 71 | * By default if no index is provided the first record of the tabular data is returned |
| 72 | * |
| 73 | * @param int $nth_record the tabular data record offset |
| 74 | * |
| 75 | * @throws UnableToProcessCsv if argument is lesser than 0 |
| 76 | */ |
| 77 | public function fetchOne(int $nth_record = 0) : array; |
| 78 | /** |
| 79 | * DEPRECATION WARNING! This class will be removed in the next major point release. |
| 80 | * |
| 81 | * @deprecated since version 9.8.0 |
| 82 | * |
| 83 | * @see ::fetchColumnByName |
| 84 | * @see ::fetchColumnByOffset |
| 85 | * |
| 86 | * Returns a single column from the next record of the tabular data. |
| 87 | * |
| 88 | * By default if no value is supplied the first column is fetch |
| 89 | * |
| 90 | * @param string|int $index CSV column index |
| 91 | * |
| 92 | * @throws UnableToProcessCsv if the column index is invalid or not found |
| 93 | */ |
| 94 | public function fetchColumn($index = 0) : Iterator; |
| 95 | /** |
| 96 | * Returns the next key-value pairs from the tabular data (first |
| 97 | * column is the key, second column is the value). |
| 98 | * |
| 99 | * By default if no column index is provided: |
| 100 | * - the first column is used to provide the keys |
| 101 | * - the second column is used to provide the value |
| 102 | * |
| 103 | * @param string|int $offset_index The column index to serve as offset |
| 104 | * @param string|int $value_index The column index to serve as value |
| 105 | * |
| 106 | * @throws UnableToProcessCsv if the column index is invalid or not found |
| 107 | */ |
| 108 | public function fetchPairs($offset_index = 0, $value_index = 1) : Iterator; |
| 109 | } |
| 110 |