[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcWorkflowNode

Abstract base class for workflow nodes. [source]

Implemented Interfaces

• ezcWorkflowVisitable

Descendents

Child Class	Description
ezcWorkflowNodeBranch	Base class for nodes that branch multiple threads of execution.
ezcWorkflowNodeMerge	Base class for nodes that merge multiple threads of execution.
ezcWorkflowNodeArithmeticBase	Base class for nodes that implement simple integer arithmetic.
ezcWorkflowNodeEnd	An object of the ezcWorkflowNodeEnd class represents an end node of a workflow.
ezcWorkflowNodeAction	An object of the ezcWorkflowNodeAction class represents an activity node holding business logic.
ezcWorkflowNodeVariableSet	An object of the ezcWorkflowNodeVariableSet class sets the specified workflow variable to a given value.
ezcWorkflowNodeInput	An object of the ezcWorkflowNodeInput class represents an input (from the application) node.
ezcWorkflowNodeVariableUnset	An object of the ezcWorkflowNodeVariableUnset class unset the specified workflow variable.
ezcWorkflowNodeStart	An object of the ezcWorkflowNodeStart class represents the one and only tart node of a workflow. The execution of the workflow starts here.
ezcWorkflowNodeSubWorkflow	An object of the ezcWorkflowNodeSubWorkflow class represents a sub-workflow.

Constants

WAITING_FOR_ACTIVATION = 0	The node is waiting to be activated.
WAITING_FOR_EXECUTION = 1	The node is activated and waiting to be executed.

Member Variables

protected ezcWorkflowNode[]	$activatedFrom = array() The node(s) that activated this node.
protected integer	$activationState The state of this node.
protected mixed	$configuration The configuration of this node.
protected integer	$id = false Unique ID of this node.
protected array	$inNodes = array() The incoming nodes of this node.
protected boolean	$internalCall = false Flag that indicates whether an add*Node() or remove*Node() call is internal.
protected integer	$maxInNodes = 1 Constraint: The maximum number of incoming nodes this node has to have to be valid. Set to false to disable this constraint.
protected integer	$maxOutNodes = 1 Constraint: The maximum number of outgoing nodes this node has to have to be valid. Set to false to disable this constraint.
protected integer	$minInNodes = 1 Constraint: The minimum number of incoming nodes this node has to have to be valid. Set to false to disable this constraint.
protected integer	$minOutNodes = 1 Constraint: The minimum number of outgoing nodes this node has to have to be valid. Set to false to disable this constraint.
protected integer	$numInNodes = 0 The number of incoming nodes.
protected integer	$numOutNodes = 0 The number of outgoing nodes.
protected array	$outNodes = array() The outgoing nodes of this node.
protected mixed	$state The state of this node.
protected integer	$threadId = null The id of the thread this node is executing in.

Method Summary

public ezcWorkflowNode	__construct( [$configuration = null] ) Constructs a new node with the configuration $configuration.
public void	accept( $visitor ) Reimplementation of accept() calls accept on all out nodes.
protected void	activateNode( $execution, $node ) Convenience method for activating an (outgoing) node.
public ezcWorkflowNode	addInNode( $node ) Adds a node to the incoming nodes of this node.
public ezcWorkflowNode	addOutNode( $node ) Adds a node to the outgoing nodes of this node.
public static void	configurationFromXML( $element ) Generate node configuration from XML representation.
public void	configurationToXML( $element ) Generate XML representation of this node's configuration.
public mixed	getConfiguration( ) Returns the configuration of this node.
public ezcWorkflowNode[]	getInNodes( ) Returns the incoming nodes of this node.
public ezcWorkflowNode[]	getOutNodes( ) Returns the outgoing nodes of this node.
protected void	initState( ) Initializes the state of this node.
public boolean	removeInNode( $node ) Removes a node from the incoming nodes of this node.
public boolean	removeOutNode( $node ) Removes a node from the outgoing nodes of this node.
public void	verify( ) Checks this node's constraints.

Methods

__construct

Parameters

Name	Type	Description
$configuration	mixed

Redefined in descendants as

Method	Description
ezcWorkflowNodeArithmeticBase::__construct()	Constructs a new action node with the configuration $configuration.
ezcWorkflowNodeAction::__construct()	Constructs a new action node with the configuration $configuration.
ezcWorkflowNodeVariableSet::__construct()	Constructs a new variable set node with the configuration $configuration.
ezcWorkflowNodeInput::__construct()	Constructs a new input node.
ezcWorkflowNodeVariableUnset::__construct()	Constructs a new unset node.
ezcWorkflowNodeSubWorkflow::__construct()	Constructs a new sub workflow with the configuration $configuration.

accept

Parameters

Name	Type	Description
$visitor	ezcWorkflowVisitor

activateNode

Parameters

Name	Type	Description
$execution	ezcWorkflowExecution
$node	ezcWorkflowNode

addInNode

Parameters

Name	Type	Description
$node	ezcWorkflowNode	The node that is to be added as incoming node.

Throws

Class	Description
ezcWorkflowInvalidWorkflowException	if the operation violates the constraints of the nodes involved.

addOutNode

Parameters

Name	Type	Description
$node	ezcWorkflowNode	The node that is to be added as outgoing node.

Throws

Class	Description
ezcWorkflowInvalidWorkflowException	if the operation violates the constraints of the nodes involved.

configurationFromXML

Parameters

Name	Type	Description
$element	DOMElement

Redefined in descendants as

Method	Description
ezcWorkflowNodeVariableDiv::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableSub::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableDecrement::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableMul::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableAdd::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableIncrement::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeAction::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableSet::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeInput::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeVariableUnset::configurationFromXML()	Generate node configuration from XML representation.
ezcWorkflowNodeSubWorkflow::configurationFromXML()	Generate node configuration from XML representation.

configurationToXML

Parameters

Name	Type	Description
$element	DOMElement

Redefined in descendants as

Method	Description
ezcWorkflowNodeVariableDiv::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableSub::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableDecrement::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableMul::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableAdd::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableIncrement::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeAction::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableSet::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeInput::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeVariableUnset::configurationToXML()	Generate XML representation of this node's configuration.
ezcWorkflowNodeSubWorkflow::configurationToXML()	Generate XML representation of this node's configuration.

getConfiguration

getInNodes

getOutNodes

initState

Redefined in descendants as

Method	Description
ezcWorkflowNodeMerge::initState()	Initializes the state of this node.

removeInNode

Parameters

Name	Type	Description
$node	ezcWorkflowNode	The node that is to be removed as incoming node.

Throws

Class	Description
ezcWorkflowInvalidWorkflowException	if the operation violates the constraints of the nodes involved.

removeOutNode

Parameters

Name	Type	Description
$node	ezcWorkflowNode	The node that is to be removed as outgoing node.

Throws

Class	Description
ezcWorkflowInvalidWorkflowException	if the operation violates the constraints of the nodes involved.

verify

Throws

Class	Description
ezcWorkflowInvalidWorkflowException	if the constraints of this node are not met.

Redefined in descendants as

Method	Description
ezcWorkflowNodeConditionalBranch::verify()	Checks this node's constraints.