VoidProcessor implements Processor
Read onlyYes
FinalYes
Discards all rows and yields an empty batch.
Interfaces
- Processor
- Unlike a Transformer, receives the whole upstream generator, not one batch.
Methods
- __construct() : mixed
- bind() : BoundStep<string|int, Processor>
- breaks() : bool
- True when process() needs every input row before it emits one: the processor ends its pipeline.
- describe() : null|Description
- fromDescription() : static
- process() : Generator<string|int, Rows>
- Process a stream of Rows and return a new stream.
Methods
__construct()
public
__construct([Schema|null $declared = null ]) : mixed
Parameters
- $declared : Schema|null = null
bind()
public
bind(Schema $input) : BoundStep<string|int, Processor>
Parameters
- $input : Schema
Return values
BoundStep<string|int, Processor>breaks()
True when process() needs every input row before it emits one: the processor ends its pipeline.
public
breaks() : bool
Return values
booldescribe()
public
describe() : null|Description
Return values
null|Description —null when this instance cannot cross a process boundary (a live client, a custom collaborator)
fromDescription()
public
static fromDescription(array<string|int, mixed> $data, Rebuild $rebuild) : static
Parameters
- $data : array<string|int, mixed>
- $rebuild : Rebuild
Return values
staticprocess()
Process a stream of Rows and return a new stream.
public
process(Generator $rows, Backend $backend) : Generator<string|int, Rows>
Parameters
- $rows : Generator
- $backend : Backend