\League\CsvResultSet

__construct()

__construct(\Iterator  $records, array  $header) 

New instance.

Parameters

__destruct()

__destruct() 

{@inheritdoc}

getHeader()

getHeader() : array<mixed,string>

Returns the header associated with the result set.

Returns

getRecords()

getRecords() 

{@inheritdoc}

getIterator()

getIterator() 

{@inheritdoc}

count()

count() 

{@inheritdoc}

jsonSerialize()

jsonSerialize() 

{@inheritdoc}

fetchOne()

fetchOne(integer  $nth_record) 

Returns the nth record from the result set.

By default if no index is provided the first record of the resultet is returned

Parameters

Throws

\League\Csv\Exception

if argument is lesser than 0

fetchColumn()

fetchColumn(string|integer  $index) 

Returns a single column from the next record of the result set.

By default if no value is supplied the first column is fetch

Parameters

fetchPairs()

fetchPairs(string|integer  $offset_index, string|integer  $value_index = 1) 

Returns the next key-value pairs from a result set (first column is the key, second column is the value).

By default if no column index is provided:

• the first column is used to provide the keys
• the second column is used to provide the value

Parameters

getColumnIndex()

getColumnIndex(string|integer  $field, string  $error_message) : string|integer

Filter a column name against the header if any.

Parameters

Returns

getColumnIndexByValue()

getColumnIndexByValue(\League\Csv\string  $value, \League\Csv\string  $error_message) 

Returns the selected column name.

Parameters

Throws

\League\Csv\Exception

if the column is not found

getColumnIndexByKey()

getColumnIndexByKey(\League\Csv\int  $index, \League\Csv\string  $error_message) : integer|string

Returns the selected column name according to its offset.

Parameters

Throws

\League\Csv\Exception

if the field is invalid or not found

Returns