Flow PHP

Rows implements ArrayAccess, Countable, IteratorAggregate

FinalYes
Tags
implements

Interfaces

ArrayAccess
Countable
IteratorAggregate

Methods

__construct()  : mixed
__serialize()  : Schema, rows: list>}
__unserialize()  : void
add()  : self
all()  : array<string|int, Row>
chunks()  : Generator<string|int, Rows>
count()  : int
diffLeft()  : self
diffRight()  : self
drop()  : self
dropRight()  : self
empty()  : bool
first()  : Row
getIterator()  : Iterator<int, Row>
hash()  : string
head()  : self
joinCross()  : self
joinInner()  : self
joinLeft()  : self
joinLeftAnti()  : self
joinRight()  : self
last()  : Row|null
matchTo()  : self
Re-checks the batch against a different Schema and adopts it - the door the constructor opens, for rows already gathered into a batch.
merge()  : self
offsetExists()  : bool
offsetGet()  : Row
offsetSet()  : void
offsetUnset()  : void
project()  : self
Drops the columns $schema does not declare and adopts it. Widening or retyping the batch is not a projection - that goes through matchTo().
reduceToArray()  : array<string|int, mixed>
remove()  : self
reverse()  : self
schema()  : Schema
sortAscending()  : self
sortBy()  : self
sortDescending()  : self
tail()  : self
take()  : self
takeRight()  : self
toArray()  : array<int, array<string|int, mixed>>
unique()  : self

Methods

__serialize()

public __serialize() : Schema, rows: list>}
Return values
Schema, rows: list>}

__unserialize()

public __unserialize(Schema, rows: list>} $data) : void
Parameters
$data : Schema, rows: list>}

all()

public all() : array<string|int, Row>
Return values
array<string|int, Row>

chunks()

public chunks(int<1, max> $size) : Generator<string|int, Rows>
Parameters
$size : int<1, max>
Return values
Generator<string|int, Rows>

count()

public count() : int
Return values
int

diffLeft()

public diffLeft(self $rows) : self
Parameters
$rows : self
Return values
self

diffRight()

public diffRight(self $rows) : self
Parameters
$rows : self
Return values
self

drop()

public drop(int $size) : self
Parameters
$size : int
Return values
self

dropRight()

public dropRight(int $size) : self
Parameters
$size : int
Return values
self

empty()

public empty() : bool
Return values
bool

getIterator()

public getIterator() : Iterator<int, Row>
Return values
Iterator<int, Row>

head()

public head(int $count) : self
Parameters
$count : int
  • Count of rows to return. Must be >= 0.
Tags
throws
InvalidArgumentException

When count is negative

InvalidTypeException

When count is not an integer

Return values
self

joinCross()

public joinCross(self $right[, string $joinPrefix = 'joined_' ]) : self
Parameters
$right : self
$joinPrefix : string = 'joined_'
Return values
self

last()

public last() : Row|null
Return values
Row|null

matchTo()

Re-checks the batch against a different Schema and adopts it - the door the constructor opens, for rows already gathered into a batch.

public matchTo(Schema $schema) : self
Parameters
$schema : Schema
Tags
throws
SchemaMismatchException
Return values
self

merge()

public merge(self $rows) : self
Parameters
$rows : self
Return values
self

offsetSet()

public offsetSet(mixed $offset, mixed $value) : void
Parameters
$offset : mixed
$value : mixed

offsetUnset()

public offsetUnset(int $offset) : void
Parameters
$offset : int
Tags
throws
RuntimeException

project()

Drops the columns $schema does not declare and adopts it. Widening or retyping the batch is not a projection - that goes through matchTo().

public project(Schema $schema) : self
Parameters
$schema : Schema
Tags
throws
SchemaMismatchException
Return values
self

reduceToArray()

public reduceToArray(string|Reference $reference) : array<string|int, mixed>
Parameters
$reference : string|Reference
Return values
array<string|int, mixed>

remove()

public remove(int $offset) : self
Parameters
$offset : int
Return values
self

reverse()

public reverse() : self
Return values
self

tail()

public tail(int $count) : self
Parameters
$count : int
  • Count of rows to return. Must be >= 0.
Tags
throws
InvalidArgumentException

When count is negative

InvalidTypeException

When count is not an integer

Return values
self

take()

public take(int $size) : self
Parameters
$size : int
Return values
self

takeRight()

public takeRight(int $size) : self
Parameters
$size : int
Return values
self

toArray()

public toArray([bool $withKeys = true ]) : array<int, array<string|int, mixed>>
Parameters
$withKeys : bool = true
Return values
array<int, array<string|int, mixed>>
On this page

Search results