RowSelection
Read onlyYes
FinalYes
File-absolute rows: the selectors cover every row of the file, in order, adjacent selectors merged.
Methods
- __construct() : mixed
- all() : self
- contains() : bool
- Whether every row the other selection selects is selected here.
- difference() : self
- head() : self
- intersection() : self
- masked() : self
- The selected rows whose entry is true, one entry per selected row in order.
- none() : self
- rowCount() : int
- Rows selected.
- selectors() : array<int, RowSelector>
- selectsAny() : bool
- slice() : self
- $rows rows from row $offset on, row 0 being row $offset.
- split() : array<int, self>
- One selection per consecutive part of the given row counts, row 0 of each being the part's first row.
- totalRows() : int
- Rows covered, selected or skipped.
- union() : self
- window() : self
- The rows from $offset on, $limit of them at most.
Methods
__construct()
public
__construct(RowSelector ...$selectors) : mixed
Parameters
- $selectors : RowSelector
all()
public
static all(int $rows) : self
Parameters
- $rows : int
Return values
selfcontains()
Whether every row the other selection selects is selected here.
public
contains(self $other) : bool
Parameters
- $other : self
Return values
booldifference()
public
difference(self $other) : self
Parameters
- $other : self
Return values
selfhead()
public
head(int $rows) : self
Parameters
- $rows : int
Return values
selfintersection()
public
intersection(self $other) : self
Parameters
- $other : self
Return values
selfmasked()
The selected rows whose entry is true, one entry per selected row in order.
public
masked(array<int, bool> $mask) : self
Parameters
- $mask : array<int, bool>
Return values
selfnone()
public
static none(int $rows) : self
Parameters
- $rows : int
Return values
selfrowCount()
Rows selected.
public
rowCount() : int
Return values
intselectors()
public
selectors() : array<int, RowSelector>
Return values
array<int, RowSelector>selectsAny()
public
selectsAny() : bool
Return values
boolslice()
$rows rows from row $offset on, row 0 being row $offset.
public
slice(int $offset, int $rows) : self
Parameters
- $offset : int
- $rows : int
Return values
selfsplit()
One selection per consecutive part of the given row counts, row 0 of each being the part's first row.
public
split(array<int, int> $rowCounts) : array<int, self>
Parameters
- $rowCounts : array<int, int>
Return values
array<int, self>totalRows()
Rows covered, selected or skipped.
public
totalRows() : int
Return values
intunion()
public
union(self $other) : self
Parameters
- $other : self
Return values
selfwindow()
The rows from $offset on, $limit of them at most.
public
static window(int $rows[, int $offset = 0 ][, int|null $limit = null ]) : self
Parameters
- $rows : int
- $offset : int = 0
- $limit : int|null = null