Property | Type | Description | |
---|---|---|---|
$activatedFrom | ezcWorkflowNode[] | The node(s) that activated this node. | |
$activationState | integer | The state of this node. | |
$configuration | The configuration is a structured (hash) array with the various options of the implemented node. This functionality is implemented as an array to make it possible to have the storage engines unaware of the node classes. | ||
$id | integer | Only available when the workflow this node belongs to has been loaded from or saved to the data storage. | |
$inNodes | The incoming nodes of this node. | ||
$internalCall | boolean | Flag that indicates whether an add*Node() or remove*Node() call is internal. This is necessary to avoid unlimited loops. | |
$maxInNodes | integer | Constraint: The maximum number of incoming nodes this node has to have to be valid. Set to false to disable this constraint. | |
$maxOutNodes | integer | Constraint: The maximum number of outgoing nodes this node has to have to be valid. Set to false to disable this constraint. | |
$minInNodes | integer | Constraint: The minimum number of incoming nodes this node has to have to be valid. Set to false to disable this constraint. | |
$minOutNodes | integer | Constraint: The minimum number of outgoing nodes this node has to have to be valid. Set to false to disable this constraint. | |
$numInNodes | integer | The number of incoming nodes. | |
$numOutNodes | integer | The number of outgoing nodes. | |
$outNodes | The outgoing nodes of this node. | ||
$state | mixed | The state of this node. | |
$threadId | integer | The id of the thread this node is executing in. |
Method | Description | |
---|---|---|
__construct ( mixed $configuration = null ) | Constructs a new node with the configuration $configuration. | |
__toString ( ) : string | Returns a textual representation of this node. | |
accept ( ezcWorkflowVisitor $visitor ) | Reimplementation of accept() calls accept on all out nodes. | |
activate ( ezcWorkflowExecution $execution, ezcWorkflowNode $activatedFrom = null, integer $threadId ) | Activate this node in the execution environment $execution. | |
addInNode ( ezcWorkflowNode $node ) : ezcWorkflowNode | Adds a node to the incoming nodes of this node. | |
addOutNode ( ezcWorkflowNode $node ) : ezcWorkflowNode | Adds a node to the outgoing nodes of this node. | |
configurationFromXML ( DOMElement $element ) | Generate node configuration from XML representation. | |
configurationToXML ( DOMElement $element ) | Generate XML representation of this node's configuration. | |
execute ( ezcWorkflowExecution $execution ) : boolean | Executes and performs the workflow duties of this node and returns true if the node completed execution. | |
getActivatedFrom ( ) : array | Returns the node(s) that activated this node. | |
getConfiguration ( ) : mixed | Returns the configuration of this node. | |
getId ( ) : integer | Returns the Id of this node. | |
getInNodes ( ) : ezcWorkflowNode[] | Returns the incoming nodes of this node. | |
getOutNodes ( ) : ezcWorkflowNode[] | Returns the outgoing nodes of this node. | |
getState ( ) : mixed | Returns the state of this node. | |
getThreadId ( ) : integer | Returns the id of the thread this node is executing in. | |
initState ( ) | Initializes the state of this node. | |
isExecutable ( ) : boolean | Returns true if this node is ready for execution and false if it is not. | |
removeInNode ( ezcWorkflowNode $node ) : boolean | Removes a node from the incoming nodes of this node. | |
removeOutNode ( ezcWorkflowNode $node ) : boolean | Removes a node from the outgoing nodes of this node. | |
setActivatedFrom ( array $activatedFrom ) | Sets the node(s) that activated this node. | |
setActivationState ( integer $activationState ) | Sets the activation state for this node. | |
setId ( integer $id ) | Sets the Id of this node. | |
setState ( mixed $state ) | Sets the state of this node. | |
setThreadId ( integer $threadId ) | Sets the id of the thread this node is executing in. | |
verify ( ) | Checks this node's constraints. |
Method | Description | |
---|---|---|
activateNode ( ezcWorkflowExecution $execution, ezcWorkflowNode $node ) | Convenience method for activating an (outgoing) node. |
public __construct ( mixed $configuration = null ) | ||
$configuration | mixed |
public __toString ( ) : string | ||
return | string |
public accept ( ezcWorkflowVisitor $visitor ) | ||
$visitor | ezcWorkflowVisitor |
protected activateNode ( ezcWorkflowExecution $execution, ezcWorkflowNode $node ) | ||
$execution | ezcWorkflowExecution | |
$node | ezcWorkflowNode |
public addInNode ( ezcWorkflowNode $node ) : ezcWorkflowNode | ||
$node | ezcWorkflowNode | The node that is to be added as incoming node. |
return | ezcWorkflowNode |
public addOutNode ( ezcWorkflowNode $node ) : ezcWorkflowNode | ||
$node | ezcWorkflowNode | The node that is to be added as outgoing node. |
return | ezcWorkflowNode |
public static configurationFromXML ( DOMElement $element ) | ||
$element | DOMElement |
public configurationToXML ( DOMElement $element ) | ||
$element | DOMElement |
public getActivatedFrom ( ) : array | ||
return | array |
public getConfiguration ( ) : mixed | ||
return | mixed |
public getInNodes ( ) : ezcWorkflowNode[] | ||
return | ezcWorkflowNode[] |
public getOutNodes ( ) : ezcWorkflowNode[] | ||
return | ezcWorkflowNode[] |
public getThreadId ( ) : integer | ||
return | integer |
public isExecutable ( ) : boolean | ||
return | boolean |
public removeInNode ( ezcWorkflowNode $node ) : boolean | ||
$node | ezcWorkflowNode | The node that is to be removed as incoming node. |
return | boolean |
public removeOutNode ( ezcWorkflowNode $node ) : boolean | ||
$node | ezcWorkflowNode | The node that is to be removed as outgoing node. |
return | boolean |
public setActivatedFrom ( array $activatedFrom ) | ||
$activatedFrom | array |
public setActivationState ( integer $activationState ) | ||
$activationState | integer |
public setThreadId ( integer $threadId ) | ||
$threadId | integer |
public verify ( ) |
protected ezcWorkflowNode[] $activatedFrom | ||
return | ezcWorkflowNode[] |
protected int $activationState | ||
return | integer |
protected $configuration |
protected int $id | ||
return | integer |
protected static bool $internalCall | ||
return | boolean |
protected int $maxInNodes | ||
return | integer |
protected int $maxOutNodes | ||
return | integer |
protected int $minInNodes | ||
return | integer |
protected int $minOutNodes | ||
return | integer |
protected int $numInNodes | ||
return | integer |
protected int $numOutNodes | ||
return | integer |
protected int $threadId | ||
return | integer |