PHP Class Plum\Plum\Workflow

Author: Florian Eckerstorfer ([email protected])

Public Methods

Method	Description
__construct ( array $options = [] )
addConverter ( Plum\Plum\Converter\ConverterInterface \| callable \| array $element ) : Workflow
addFilter ( array \| callable \| Plum\Plum\Filter\FilterInterface $element ) : Workflow
addWriter ( Plum\Plum\Writer\WriterInterface \| array $element ) : Workflow
getConverters ( ) : ConverterPipe[]
getFilters ( ) : FilterPipe[]
getPipeline ( string \| null $type = null ) : AbstractPipe[]
getWriters ( ) : WriterPipe[]
process ( Plum\Plum\Reader\ReaderInterface[] \| Plum\Plum\Reader\ReaderInterface $readers ) : Result

Method	Description
addPipe ( AbstractPipe $pipe ) : Workflow	Inserts an element into the pipeline at the given position.
convertItem ( mixed $item, ConverterPipe $pipe ) : mixed	Applies the given converter to the given item either if no filter is given or if the filter returns true.
convertItemValue ( mixed $item, ConverterPipe $pipe ) : mixed	Applies the given converter to the given field in the given item if no filter is given or if the filters returns true for the field.
finishWriters ( WriterPipe[] $writers )
prepareWriters ( WriterPipe[] $writers )
processItem ( mixed $item, Result $result )
processReader ( Plum\Plum\Reader\ReaderInterface $reader, Result $result )
writeItem ( mixed $item, WriterPipe $pipe ) : boolean	Writes the given item to the given writer if the no filter is given or the filter returns true.

public __construct ( array $options = [] )
$options	array

public addConverter ( Plum\Plum\Converter\ConverterInterface \| callable \| array $element ) : Workflow
$element	Plum\Plum\Converter\ConverterInterface \| callable \| array
return	Workflow	$this

public addFilter ( array \| callable \| Plum\Plum\Filter\FilterInterface $element ) : Workflow
$element	array \| callable \| Plum\Plum\Filter\FilterInterface
return	Workflow

Inserts an element into the pipeline at the given position.

protected addPipe ( AbstractPipe $pipe ) : Workflow
$pipe	Plum\Plum\Pipe\AbstractPipe
return	Workflow

public addWriter ( Plum\Plum\Writer\WriterInterface \| array $element ) : Workflow
$element	Plum\Plum\Writer\WriterInterface \| array
return	Workflow

Applies the given converter to the given item either if no filter is given or if the filter returns true.

protected convertItem ( mixed $item, ConverterPipe $pipe ) : mixed
$item	mixed
$pipe	Plum\Plum\Pipe\ConverterPipe
return	mixed

Applies the given converter to the given field in the given item if no filter is given or if the filters returns true for the field.

protected convertItemValue ( mixed $item, ConverterPipe $pipe ) : mixed
$item	mixed
$pipe	Plum\Plum\Pipe\ConverterPipe
return	mixed

protected finishWriters ( WriterPipe[] $writers )
$writers	Plum\Plum\Pipe\WriterPipe[]

public getConverters ( ) : ConverterPipe[]
return	Plum\Plum\Pipe\ConverterPipe[]

public getFilters ( ) : FilterPipe[]
return	Plum\Plum\Pipe\FilterPipe[]

public getPipeline ( string \| null $type = null ) : AbstractPipe[]
$type	string \| null
return	Plum\Plum\Pipe\AbstractPipe[]

public getWriters ( ) : WriterPipe[]
return	Plum\Plum\Pipe\WriterPipe[]

protected prepareWriters ( WriterPipe[] $writers )
$writers	Plum\Plum\Pipe\WriterPipe[]

public process ( Plum\Plum\Reader\ReaderInterface[] \| Plum\Plum\Reader\ReaderInterface $readers ) : Result
$readers	Plum\Plum\Reader\ReaderInterface[] \| Plum\Plum\Reader\ReaderInterface
return	Result

protected processItem ( mixed $item, Result $result )
$item	mixed
$result	Result

protected processReader ( Plum\Plum\Reader\ReaderInterface $reader, Result $result )
$reader	Plum\Plum\Reader\ReaderInterface
$result	Result

Writes the given item to the given writer if the no filter is given or the filter returns true.

protected writeItem ( mixed $item, WriterPipe $pipe ) : boolean
$item	mixed
$pipe	Plum\Plum\Pipe\WriterPipe
return	boolean	`true` if the item has been written, `false` if not.