WorkbookSheet
FinalYes
Methods
- __construct() : mixed
- close() : void
- columns() : array<int, string>
- decode() : null|array<string, mixed>|string
- rows() : Generator<int, array<string|int, mixed>>
- sample() : Generator<int, array<string|int, mixed>>
- rows() for a bounded schema sample: every row it hands out stays buffered and the sheet stays open, so the rows() that follows replays the sample and parses on from where the sample stopped, instead of parsing the sample a second time. Closing the sheet stays with its owner.
Methods
__construct()
public
__construct(Path $path, WorkbookReader $reader) : mixed
Parameters
- $path : Path
- $reader : WorkbookReader
close()
public
close() : void
columns()
public
columns() : array<int, string>
Return values
array<int, string>decode()
public
decode(array<string|int, mixed> $cells) : null|array<string, mixed>|string
Parameters
- $cells : array<string|int, mixed>
-
a row rows() or sample() yielded
Return values
null|array<string, mixed>|string —see RecordDecoder::decode()
rows()
public
rows() : Generator<int, array<string|int, mixed>>
Return values
Generator<int, array<string|int, mixed>> —raw cells by their row number, the header row excluded
sample()
rows() for a bounded schema sample: every row it hands out stays buffered and the sheet stays open, so the rows() that follows replays the sample and parses on from where the sample stopped, instead of parsing the sample a second time. Closing the sheet stays with its owner.
public
sample() : Generator<int, array<string|int, mixed>>
Return values
Generator<int, array<string|int, mixed>> —raw cells by their row number