PHP Class Ddeboer\DataImport\Workflow\StepAggregator

Author: David de Boer ([email protected])
Inheritance: implements Ddeboer\DataImport\Workflow, implements Psr\Log\LoggerAwareInterface, use trait Psr\Log\LoggerAwareTrait
Datei anzeigen Open project: ddeboer/data-import Class Usage Examples

Protected Properties

Property Type Description
$shouldStop boolean

Public Methods

Method Description
__construct ( Ddeboer\DataImport\Reader $reader, string $name = null )
addStep ( Ddeboer\DataImport\Step $step, integer | null $priority = null ) Add a step to the current workflow
addWriter ( Ddeboer\DataImport\Writer $writer ) Add a new writer to the current workflow
getName ( ) : string
process ( )
setSkipItemOnFailure ( boolean $skipItemOnFailure ) Sets the value which determines whether the item should be skipped when error occures
stop ( ) Stops processing and force return Result from process() function

Method Details

__construct() public method

public __construct ( Ddeboer\DataImport\Reader $reader, string $name = null )
$reader Ddeboer\DataImport\Reader
$name string

addStep() public method

Add a step to the current workflow
public addStep ( Ddeboer\DataImport\Step $step, integer | null $priority = null )
$step Ddeboer\DataImport\Step
$priority integer | null

addWriter() public method

Add a new writer to the current workflow
public addWriter ( Ddeboer\DataImport\Writer $writer )
$writer Ddeboer\DataImport\Writer

getName() public method

public getName ( ) : string
return string

process() public method

public process ( )

setSkipItemOnFailure() public method

Sets the value which determines whether the item should be skipped when error occures
public setSkipItemOnFailure ( boolean $skipItemOnFailure )
$skipItemOnFailure boolean When true skip current item on process exception and log the error

stop() public method

Stops processing and force return Result from process() function
public stop ( )

Property Details

$shouldStop protected_oe property

protected bool $shouldStop
return boolean