PeerFrame implements WindowFrame
Read onlyYes
FinalYes
Interfaces
Methods
- __construct() : mixed
- bounds() : array{0: int, 1: int}
- Inclusive indexes into the sorted partition.
- describe() : null|Description
- ends() : array<int, int>
- fromDescription() : static
Methods
__construct()
public
__construct(array<int, SortColumn> $orderBy) : mixed
Parameters
- $orderBy : array<int, SortColumn>
bounds()
Inclusive indexes into the sorted partition.
public
bounds(int $index, Rows $partition) : array{0: int, 1: int}
An empty frame is expressed as [1, 0] (start > end).
Parameters
- $index : int
- $partition : Rows
Return values
array{0: int, 1: int}describe()
public
describe() : null|Description
Return values
null|Description —null when this instance cannot cross a process boundary (a live client, a custom collaborator)
ends()
public
ends(Rows $partition) : array<int, int>
Parameters
- $partition : Rows
Return values
array<int, int> —for every row the index of the last row of its peer group
fromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild