Flow PHP

FilteredBatches

Read onlyYes
FinalYes

The matching rows of a read's batches (every row without an evaluator), offset and limit counted over them, rechunked to the batch size; it stops pulling batches at the limit.

Methods

__construct()  : mixed
columns()  : array<int, string>
The columns each batch must hold: the returned ones and the filter's root columns.
filter()  : Generator<int, array<string, array<int, mixed>>>

Methods

__construct()

public __construct(FilterEvaluator|null $evaluator, array<int, string> $columns[, int $offset = 0 ][, int|null $limit = null ][, int<1, max> $batchSize = 1024 ]) : mixed
Parameters
$evaluator : FilterEvaluator|null
$columns : array<int, string>

the columns returned

$offset : int = 0
$limit : int|null = null
$batchSize : int<1, max> = 1024

columns()

The columns each batch must hold: the returned ones and the filter's root columns.

public columns() : array<int, string>
Return values
array<int, string>

filter()

public filter(iterable<string|int, array<string, array<int, mixed>>> $batches) : Generator<int, array<string, array<int, mixed>>>
Parameters
$batches : iterable<string|int, array<string, array<int, mixed>>>
Return values
Generator<int, array<string, array<int, mixed>>>
On this page

Search results