ExcelFileBatches implements FileBatches
Read onlyYes
FinalYes
Interfaces
- FileBatches
Methods
- __construct() : mixed
- batches() : Generator<mixed, void>
- The columns of every sheet must be the ones the inferred schema was derived from - checked before the sheet's first batch is built.
- close() : void
- Closes the sample sheets this read did not take.
- describe() : Description|null
- fromDescription() : static
Methods
__construct()
public
__construct(WorkbookReader $workbook, null|ExcelSniffer $sample, null|InferredColumns $inferred[, null|SchemaInference $inference = null ]) : mixed
Parameters
- $workbook : WorkbookReader
- $sample : null|ExcelSniffer
-
the open sheets of the inference this read follows, read on from where the sample stopped; null to parse every sheet afresh; never described
- $inferred : null|InferredColumns
-
the columns every sheet must carry; null when declared or union by name
- $inference : null|SchemaInference = null
-
the inference that made the schema; null when it was declared
batches()
The columns of every sheet must be the ones the inferred schema was derived from - checked before the sheet's first batch is built.
public
batches(FileRead $read, Criteria $criteria, SourceFile $source, Schema $body, Backend $backend, ReadWindow $window) : Generator<mixed, void>
Parameters
- $read : FileRead
- $criteria : Criteria
- $source : SourceFile
- $body : Schema
- $backend : Backend
- $window : ReadWindow
Tags
Return values
Generator<mixed, void>close()
Closes the sample sheets this read did not take.
public
close() : void
describe()
public
describe() : Description|null
Return values
Description|nullfromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild