PHP Class ezcWorkflowExecutionListenerPlugin, Workflow

Inheritance: extends ezcWorkflowExecutionPlugin
Show file Open project: zetacomponents/workflow

Protected Properties

Property Type Description
$listeners array Listeners.

Public Methods

Method Description
addListener ( ezcWorkflowExecutionListener $listener ) : boolean Adds a listener.
afterExecutionCancelled ( ezcWorkflowExecution $execution ) Called after an execution has been cancelled.
afterExecutionEnded ( ezcWorkflowExecution $execution ) Called after an execution has successfully ended.
afterExecutionResumed ( ezcWorkflowExecution $execution ) Called after an execution has been resumed.
afterExecutionStarted ( ezcWorkflowExecution $execution ) Called after an execution has been started.
afterExecutionSuspended ( ezcWorkflowExecution $execution ) Called after an execution has been suspended.
afterNodeActivated ( ezcWorkflowExecution $execution, ezcWorkflowNode $node ) Called after a node has been activated.
afterNodeExecuted ( ezcWorkflowExecution $execution, ezcWorkflowNode $node ) Called after a node has been executed.
afterThreadEnded ( ezcWorkflowExecution $execution, integer $threadId ) Called after a thread has ended.
afterThreadStarted ( ezcWorkflowExecution $execution, integer $threadId, integer $parentId, integer $numSiblings ) Called after a new thread has been started.
afterVariableSet ( ezcWorkflowExecution $execution, string $variableName, mixed $value ) Called after a variable has been set.
afterVariableUnset ( ezcWorkflowExecution $execution, string $variableName ) Called after a variable has been unset.
removeListener ( ezcWorkflowExecutionListener $listener ) : boolean Removes a listener.

Protected Methods

Method Description
notifyListeners ( string $message, integer $type = ezcWorkflowExecutionListener::INFO ) Notify listeners.

Method Details

addListener() public method

Adds a listener.
public addListener ( ezcWorkflowExecutionListener $listener ) : boolean
$listener ezcWorkflowExecutionListener
return boolean true when the listener was added, false otherwise.

afterExecutionCancelled() public method

Called after an execution has been cancelled.
public afterExecutionCancelled ( ezcWorkflowExecution $execution )
$execution ezcWorkflowExecution

afterExecutionEnded() public method

Called after an execution has successfully ended.
public afterExecutionEnded ( ezcWorkflowExecution $execution )
$execution ezcWorkflowExecution

afterExecutionResumed() public method

Called after an execution has been resumed.
public afterExecutionResumed ( ezcWorkflowExecution $execution )
$execution ezcWorkflowExecution

afterExecutionStarted() public method

Called after an execution has been started.
public afterExecutionStarted ( ezcWorkflowExecution $execution )
$execution ezcWorkflowExecution

afterExecutionSuspended() public method

Called after an execution has been suspended.
public afterExecutionSuspended ( ezcWorkflowExecution $execution )
$execution ezcWorkflowExecution

afterNodeActivated() public method

Called after a node has been activated.
public afterNodeActivated ( ezcWorkflowExecution $execution, ezcWorkflowNode $node )
$execution ezcWorkflowExecution
$node ezcWorkflowNode

afterNodeExecuted() public method

Called after a node has been executed.
public afterNodeExecuted ( ezcWorkflowExecution $execution, ezcWorkflowNode $node )
$execution ezcWorkflowExecution
$node ezcWorkflowNode

afterThreadEnded() public method

Called after a thread has ended.
public afterThreadEnded ( ezcWorkflowExecution $execution, integer $threadId )
$execution ezcWorkflowExecution
$threadId integer

afterThreadStarted() public method

Called after a new thread has been started.
public afterThreadStarted ( ezcWorkflowExecution $execution, integer $threadId, integer $parentId, integer $numSiblings )
$execution ezcWorkflowExecution
$threadId integer
$parentId integer
$numSiblings integer

afterVariableSet() public method

Called after a variable has been set.
public afterVariableSet ( ezcWorkflowExecution $execution, string $variableName, mixed $value )
$execution ezcWorkflowExecution
$variableName string
$value mixed

afterVariableUnset() public method

Called after a variable has been unset.
public afterVariableUnset ( ezcWorkflowExecution $execution, string $variableName )
$execution ezcWorkflowExecution
$variableName string

notifyListeners() protected method

Notify listeners.
protected notifyListeners ( string $message, integer $type = ezcWorkflowExecutionListener::INFO )
$message string
$type integer

removeListener() public method

Removes a listener.
public removeListener ( ezcWorkflowExecutionListener $listener ) : boolean
$listener ezcWorkflowExecutionListener
return boolean true when the listener was removed, false otherwise.

Property Details

$listeners protected property

Listeners.
protected array $listeners
return array