PHP Класс Plum\Plum\Workflow

Автор: Florian Eckerstorfer ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__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

Защищенные методы

Метод Описание
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.

Описание методов

__construct() публичный Метод

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

addConverter() публичный Метод

public addConverter ( Plum\Plum\Converter\ConverterInterface | callable | array $element ) : Workflow
$element Plum\Plum\Converter\ConverterInterface | callable | array
Результат Workflow $this

addFilter() публичный Метод

public addFilter ( array | callable | Plum\Plum\Filter\FilterInterface $element ) : Workflow
$element array | callable | Plum\Plum\Filter\FilterInterface
Результат Workflow

addPipe() защищенный Метод

Inserts an element into the pipeline at the given position.
protected addPipe ( AbstractPipe $pipe ) : Workflow
$pipe Plum\Plum\Pipe\AbstractPipe
Результат Workflow

addWriter() публичный Метод

public addWriter ( Plum\Plum\Writer\WriterInterface | array $element ) : Workflow
$element Plum\Plum\Writer\WriterInterface | array
Результат Workflow

convertItem() защищенный Метод

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
Результат mixed

convertItemValue() защищенный Метод

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
Результат mixed

finishWriters() защищенный Метод

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

getConverters() публичный Метод

public getConverters ( ) : ConverterPipe[]
Результат Plum\Plum\Pipe\ConverterPipe[]

getFilters() публичный Метод

public getFilters ( ) : FilterPipe[]
Результат Plum\Plum\Pipe\FilterPipe[]

getPipeline() публичный Метод

public getPipeline ( string | null $type = null ) : AbstractPipe[]
$type string | null
Результат Plum\Plum\Pipe\AbstractPipe[]

getWriters() публичный Метод

public getWriters ( ) : WriterPipe[]
Результат Plum\Plum\Pipe\WriterPipe[]

prepareWriters() защищенный Метод

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

process() публичный Метод

public process ( Plum\Plum\Reader\ReaderInterface[] | Plum\Plum\Reader\ReaderInterface $readers ) : Result
$readers Plum\Plum\Reader\ReaderInterface[] | Plum\Plum\Reader\ReaderInterface
Результат Result

processItem() защищенный Метод

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

processReader() защищенный Метод

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

writeItem() защищенный Метод

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
Результат boolean `true` if the item has been written, `false` if not.