Documentation

ResultSet
in package

Application

implements TabularDataReader, JsonSerializable

Represents the result set of a {@link Reader} processed by a {@link Statement}.

Interfaces

TabularDataReader: Represents a Tabular data.
JsonSerializable

Properties

$header : array<string|int, string>
$records : Iterator

Methods

__construct() : mixed
__destruct() : mixed
chunkBy() : iterable<string|int, TabularDataReader>
count() : int: Returns the number of records contained in the tabular data structure excluding the header record.
createFromRecords() : self: Returns a new instance from a collection without header.
createFromTabularDataReader() : self: Returns a new instance from an object implementing the TabularDataReader interface.
each() : bool
exists() : bool
fetchColumn() : Iterator<int, mixed>: Returns a single column from the next record of the tabular data.
fetchColumnByName() : Iterator: DEPRECATION WARNING! This method will be removed in the next major point release.
fetchColumnByOffset() : Iterator: DEPRECATION WARNING! This method will be removed in the next major point release.
fetchOne() : array<string|int, mixed>: DEPRECATION WARNING! This method will be removed in the next major point release.
fetchPairs() : Iterator: Returns the next key-value pairs from the tabular data (first column is the key, second column is the value).
filter() : TabularDataReader
first() : array<string|int, mixed>
firstAsObject() : object|null
from() : self: Returns a new instance from a tabular data implementing object.
getHeader() : array<string|int, string>: Returns the header associated with the result set.
getIterator() : Iterator<string|int, TValue>: Returns the tabular data rows as an iterator object containing flat array.
getObjects() : Iterator: DEPRECATION WARNING! This method will be removed in the next major point release.
getRecords() : Iterator<string|int, TValue>: Returns the tabular data records as an iterator object.
getRecordsAsObject() : iterator<string|int, T>
jsonSerialize() : array<string|int, mixed>
last() : array<string|int, mixed>
lastAsObject() : object|null
map() : Iterator<string|int, TMap>: Run a map over each container members.
mapHeader() : TabularDataReader
matching() : iterable<int, TabularDataReader>: EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
matchingFirst() : TabularDataReader|null: EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
matchingFirstOrFail() : TabularDataReader: EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
nth() : array<string|int, mixed>
nthAsObject() : object|null
reduce() : TInitial|null
select() : TabularDataReader
selectAllExcept() : TabularDataReader
slice() : TabularDataReader
sorted() : TabularDataReader
tryFrom() : self|null: Returns a new instance from a tabular data implementing object.
value() : mixed
combineHeader() : Iterator<string|int, TValue>: Combines the header to each record if present.
getColumnIndex() : string|int: Filters a column name against the header if any.
getColumnIndexByKey() : int|string: Returns the selected column name according to its offset.
getColumnIndexByValue() : string: Returns the selected column name.
prepareHeader() : array<string|int, string>
validateHeader() : array<string|int, mixed>
yieldColumn() : Generator

$header


        protected
            array<string|int, string>
    $header

$records


        protected
            Iterator
    $records

__construct()


    public
                    __construct([Iterator|array<string|int, array<string|int, mixed>> $records = [] ][, array<string|int, string> $header = [] ]) : mixed

Parameters

$records : Iterator|array<string|int, array<string|int, mixed>> = []
$header : array<string|int, string> = []

__destruct()


    public
                    __destruct() : mixed

chunkBy()


    public
                    chunkBy(positive-int $recordsCount) : iterable<string|int, TabularDataReader>

Parameters

$recordsCount : positive-int

Return values

iterable<string|int, TabularDataReader>

count()

Returns the number of records contained in the tabular data structure excluding the header record.


    public
                    count() : int

Return values

int

createFromRecords()

Returns a new instance from a collection without header.


    public
            static        createFromRecords([iterable<string|int, mixed> $records = [] ]) : self

use League\Csv\ResultSet::from() instead

Parameters

$records : iterable<string|int, mixed> = []

Return values

self

createFromTabularDataReader()

Returns a new instance from an object implementing the TabularDataReader interface.


    public
            static        createFromTabularDataReader(TabularDataReader $reader) : self

use League\Csv\ResultSet::from() instead

Parameters

$reader : TabularDataReader

Return values

self

each()


    public
                    each(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64
callable(array<string|int, mixed>, Array=): mixed $callback) : bool

Parameters

$callback : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 callable(array<string|int, mixed>, Array=): mixed

Return values

bool

exists()


    public
                    exists(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64
callable(array<string|int, mixed>, Array=): bool $callback) : bool

Parameters

$callback : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 callable(array<string|int, mixed>, Array=): bool

Return values

bool

fetchColumn()

Returns a single column from the next record of the tabular data.


    public
                    fetchColumn([string|int $index = 0 ]) : Iterator<int, mixed>

By default, if no value is supplied the first column is fetched

Parameters

$index : string|int = 0: CSV column index

Return values

Iterator<int, mixed>

fetchColumnByName()

DEPRECATION WARNING! This method will be removed in the next major point release.


    public
                    fetchColumnByName(string $name) : Iterator

since version 9.23.0

use League\Csv\Resultset::fetchColumn() instead

Parameters

$name : string

Return values

Iterator

fetchColumnByOffset()

DEPRECATION WARNING! This method will be removed in the next major point release.


    public
                    fetchColumnByOffset(int $offset) : Iterator

since version 9.23.0

use League\Csv\Resultset::fetchColumn() instead

Parameters

$offset : int

Return values

Iterator

fetchOne()

DEPRECATION WARNING! This method will be removed in the next major point release.


    public
                    fetchOne([int $nth_record = 0 ]) : array<string|int, mixed>

since version 9.9.0

use League\Csv\Resultset::nth() instead

Parameters

$nth_record : int = 0: the tabular data record offset

Return values

array<string|int, mixed>

fetchPairs()

Returns the next key-value pairs from the tabular data (first column is the key, second column is the value).


    public
                    fetchPairs([string|int $offset_index = 0 ][, string|int $value_index = 1 ]) : Iterator

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

$offset_index : string|int = 0: The column index to serve as offset
$value_index : string|int = 1: The column index to serve as value

Return values

Iterator

filter()


    public
                    filter(Predicate|Closure $predicate) : TabularDataReader

Parameters

$predicate : Predicate|Closure

Return values

TabularDataReader

first()


    public
                    first() : array<string|int, mixed>

Return values

array<string|int, mixed>

firstAsObject()


    public
                    firstAsObject(class-string $className[, array<string|int, mixed> $header = [] ]) : object|null

Parameters

$className : class-string
$header : array<string|int, mixed> = []

Return values

object|null

from()

Returns a new instance from a tabular data implementing object.


    public
            static        from(PDOStatement|Result|mysqli_result|SQLite3Result|TabularData|TabularDataProvider $tabularData) : self

Parameters

$tabularData : PDOStatement|Result|mysqli_result|SQLite3Result|TabularData|TabularDataProvider

Return values

self

getHeader()

Returns the header associated with the result set.


    public
                    getHeader() : array<string|int, string>

Return values

array<string|int, string>

getIterator()

Returns the tabular data rows as an iterator object containing flat array.


    public
                    getIterator() : Iterator<string|int, TValue>

Return values

Iterator<string|int, TValue>

getObjects()

DEPRECATION WARNING! This method will be removed in the next major point release.


    public
                    getObjects(class-string $className[, array<string|int, string> $header = [] ]) : Iterator

Since version 9.15.0

use League\Csv\ResultSet::getRecordsAsObject() instead

Parameters

$className : class-string
$header : array<string|int, string> = []

Return values

Iterator

getRecords()

Returns the tabular data records as an iterator object.


    public
                    getRecords([array<string|int, string> $header = [] ]) : Iterator<string|int, TValue>

Parameters

$header : array<string|int, string> = []

Return values

Iterator<string|int, TValue>

getRecordsAsObject()


    public
                    getRecordsAsObject(T> $className[, array<string|int, string> $header = [] ]) : iterator<string|int, T>

Parameters

$className : T>
$header : array<string|int, string> = []

Return values

iterator<string|int, T>

jsonSerialize()


    public
                    jsonSerialize() : array<string|int, mixed>

Return values

array<string|int, mixed>

last()


    public
                    last() : array<string|int, mixed>

Return values

array<string|int, mixed>

lastAsObject()


    public
                    lastAsObject(class-string $className[, array<string|int, mixed> $header = [] ]) : object|null

Parameters

$className : class-string
$header : array<string|int, mixed> = []

Return values

object|null

map()

Run a map over each container members.


    public
                    map(callable(array<string|int, mixed>, int): TMap $callback) : Iterator<string|int, TMap>

Parameters

$callback : callable(array<string|int, mixed>, int): TMap

Return values

Iterator<string|int, TMap>

mapHeader()


    public
                    mapHeader(array<string|int, string> $headers) : TabularDataReader

Parameters

$headers : array<string|int, string>

Return values

TabularDataReader

matching()

EXPERIMENTAL WARNING! This method implementation will change in the next major point release.


    public
                    matching(string $expression) : iterable<int, TabularDataReader>

Extract all found fragment identifiers for the specifield tabular data

Parameters

$expression : string

Return values

iterable<int, TabularDataReader>

matchingFirst()

EXPERIMENTAL WARNING! This method implementation will change in the next major point release.


    public
                    matchingFirst(string $expression) : TabularDataReader|null

Extract the first found fragment identifier of the tabular data or returns null

Parameters

$expression : string

Return values

TabularDataReader|null

matchingFirstOrFail()

EXPERIMENTAL WARNING! This method implementation will change in the next major point release.


    public
                    matchingFirstOrFail(string $expression) : TabularDataReader

Extract the first found fragment identifier of the tabular data or fail

Parameters

$expression : string

Return values

TabularDataReader

nth()


    public
                    nth(int $nth) : array<string|int, mixed>

Parameters

$nth : int

Return values

array<string|int, mixed>

nthAsObject()


    public
                    nthAsObject(int $nth, class-string $className[, array<string|int, mixed> $header = [] ]) : object|null

Parameters

$nth : int
$className : class-string
$header : array<string|int, mixed> = []

Return values

object|null

reduce()


    public
                    reduce(
Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64

Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64
callable(Array, array<string|int, mixed>, Array=): TInitial $callback[, TInitial|null $initial = null ]) : TInitial|null

Parameters

$callback : Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 Warning: Array to string conversion in C:\xampp\htdocs\vendor\phpdocumentor\phpdocumentor\src\phpDocumentor\Transformer\Writer\Twig\LinkRenderer\CallableAdapter.php on line 64 callable(Array, array<string|int, mixed>, Array=): TInitial
$initial : TInitial|null = null

Return values

TInitial|null

select()


    public
                    select(string|int ...$columns) : TabularDataReader

Parameters

$columns : string|int

Return values

TabularDataReader

selectAllExcept()


    public
                    selectAllExcept(string|int ...$columns) : TabularDataReader

Parameters

$columns : string|int

Return values

TabularDataReader

slice()


    public
                    slice(int $offset[, int|null $length = null ]) : TabularDataReader

Parameters

$offset : int
$length : int|null = null

Return values

TabularDataReader

sorted()


    public
                    sorted(Sort|Closure $orderBy) : TabularDataReader

Parameters

$orderBy : Sort|Closure

Return values

TabularDataReader

tryFrom()

Returns a new instance from a tabular data implementing object.


    public
            static        tryFrom(PDOStatement|Result|mysqli_result|SQLite3Result|TabularData|TabularDataProvider $tabularData) : self|null

Parameters

$tabularData : PDOStatement|Result|mysqli_result|SQLite3Result|TabularData|TabularDataProvider

Return values

self|null

value()


    public
                    value([int|string $column = 0 ]) : mixed

Parameters

$column : int|string = 0

combineHeader()

Combines the header to each record if present.


    protected
                    combineHeader(array<string|int, string|int> $header) : Iterator<string|int, TValue>

Parameters

$header : array<string|int, string|int>

Return values

Iterator<string|int, TValue>

getColumnIndex()

Filters a column name against the header if any.


    protected
                    getColumnIndex(string|int $field, string $type, string $method) : string|int

Parameters

$field : string|int
$type : string
$method : string

Return values

string|int

getColumnIndexByKey()

Returns the selected column name according to its offset.


    protected
                    getColumnIndexByKey(int $index, string $type, string $method) : int|string

Parameters

$index : int
$type : string
$method : string

Return values

int|string

getColumnIndexByValue()

Returns the selected column name.


    protected
                    getColumnIndexByValue(string $value, string $type, string $method) : string

Parameters

$value : string
$type : string
$method : string

Return values

string

prepareHeader()


    protected
                    prepareHeader(array<string|int, string> $header) : array<string|int, string>

Parameters

$header : array<string|int, string>

Return values

array<string|int, string>

validateHeader()


    protected
                    validateHeader(array<string|int, mixed> $header) : array<string|int, mixed>

Parameters

$header : array<string|int, mixed>

Return values

array<string|int, mixed>

yieldColumn()


    protected
                    yieldColumn(string|int $offset) : Generator

Parameters

$offset : string|int

Return values

Generator

ResultSet in package Application implements TabularDataReader, JsonSerializable

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$header

$records

Methods

__construct()

Parameters

Tags

__destruct()

chunkBy()

Parameters

Tags

Return values

count()

Return values

createFromRecords()

Parameters

Return values

createFromTabularDataReader()

Parameters

Tags

Return values

each()

Parameters

Return values

exists()

Parameters

Return values

fetchColumn()

Parameters

Return values

fetchColumnByName()

Parameters

Tags

Return values

fetchColumnByOffset()

Parameters

Tags

Return values

fetchOne()

Parameters

Tags

Return values

fetchPairs()

Parameters

Return values

filter()

Parameters

Return values

first()

Return values

firstAsObject()

Parameters

Tags

Return values

from()

Parameters

Tags

Return values

getHeader()

Return values

getIterator()

Tags

Return values

getObjects()

Parameters

Tags

Return values

getRecords()

Parameters

Tags

Return values

getRecordsAsObject()

Parameters

Tags

ResultSet
in package

Application

implements TabularDataReader, JsonSerializable