ExcelExtractor implements BatchableExtractor, Extractor, FileExtractor, InfersSchema, LimitPushDown, MetadataColumnsExtractor, RewindableExtractor uses Batches, PushesLimit, FileReading
FinalYes
Interfaces
- BatchableExtractor
- Extractor
- FileExtractor
- InfersSchema
- LimitPushDown
- MetadataColumnsExtractor
- RewindableExtractor
Methods
- __construct() : mixed
- __destruct() : mixed
- An inference no extract() followed still holds its sample's open readers, and OpenSpout's file-based shared-strings cache leaves its temp folder behind until a reader closes.
- extract() : Generator<Signal|null, void>
- inferSchema() : static
- isRepeatable() : bool
- schema() : Schema
- source() : Path
- withConvertEmptyToNull() : self
- withHeader() : self
- withOffset() : self
- withReader() : self
- withSchema() : static
- withSheetName() : self
Methods
__construct()
public
__construct(Path $path[, Filesystem $filesystem = new NativeLocalFilesystem() ]) : mixed
Parameters
- $path : Path
- $filesystem : Filesystem = new NativeLocalFilesystem()
__destruct()
An inference no extract() followed still holds its sample's open readers, and OpenSpout's file-based shared-strings cache leaves its temp folder behind until a reader closes.
public
__destruct() : mixed
extract()
public
extract(FlowContext $context) : Generator<Signal|null, void>
Parameters
- $context : FlowContext
Return values
Generator<Signal|null, void>inferSchema()
public
inferSchema(SchemaInferenceBuilder $builder) : static
Parameters
- $builder : SchemaInferenceBuilder
Return values
staticisRepeatable()
public
isRepeatable() : bool
Return values
boolschema()
public
schema() : Schema
Return values
Schemasource()
public
source() : Path
Return values
PathwithConvertEmptyToNull()
public
withConvertEmptyToNull(bool $convertEmptyToNull) : self
Parameters
- $convertEmptyToNull : bool
Return values
selfwithHeader()
public
withHeader(bool $withHeader) : self
Parameters
- $withHeader : bool
Return values
selfwithOffset()
public
withOffset(int $offset) : self
Parameters
- $offset : int
Return values
selfwithReader()
public
withReader(ExcelReader $reader) : self
Parameters
- $reader : ExcelReader
Return values
selfwithSchema()
public
withSchema(Schema $schema) : static
Parameters
- $schema : Schema
Return values
staticwithSheetName()
public
withSheetName(string $sheetName) : self
Parameters
- $sheetName : string