Path

ez components / documentation / api reference / 2007.2 / workflow

Workflow: ezcWorkflowNodeSynchronizingMerge

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

Class: ezcWorkflowNodeSynchronizingMerge

This node implements the Synchronizing Merge workflow pattern. [source]
The Synchronizing Merge workflow pattern is to be used to synchronize multiple parallel threads of execution that are activated by a preceding Multi-Choice.
Incoming nodes: 2..* Outgoing nodes: 1
This example displays how you can use ezcWorkflowNodeMultiChoice to activate one or more branches depending on the input and how you can use a synchronizing merge to merge them together again. Execution will not contiue until all activated branches have been completed. 
 1.  $workflow = new ezcWorkflow( 'Test' );
 2.  
 3.  // wait for input into the workflow variable value.
 4.   $input = new ezcWorkflowNodeInput( array( 'value' => new ezcWorkflowConditionIsInt ) );
 5.  $workflow->startNode->addOutNode( $input );
 6.  
 7.  // create the exclusive choice branching node
 8.   $choice = new ezcWorkflowNodeMultiChoice;
 9.  $intput->addOutNode( $choice );
10.  
11.  $branch1 = ....; // create nodes for the first branch of execution here..
12.   $branch2 = ....; // create nodes for the second branch of execution here..
13.  
14.  // add the outnodes and set the conditions on the exclusive choice
15.   $choice->addConditionalOutNode( new ezcWorkflowConditionVariable( 'value',
16.                                                                   new ezcWorkflowConditionGreaterThan( 1 ) ),
17.                                 $branch1 );
18.  $choice->addConditionalOutNode( new ezcWorkflowConditionVariable( 'value',
19.                                                                   new ezcWorkflowConditionGreaterThan( 10 ) ),
20.                                 $branch2 );
21.  
22.  // Merge the two branches together and continue execution.
23.   $merge = new ezcWorkflowNodeSynchronizingMerge();
24.  $merge->addInNode( $branch1 );
25.  $merge->addInNode( $branch2 );
26.  $merge->addOutNode( $workflow->endNode );

Parents

ezcWorkflowNode
   |
   --ezcWorkflowNodeMerge
      |
      --ezcWorkflowNodeSynchronization
         |
         --ezcWorkflowNodeSynchronizingMerge

Inherited Constants

From ezcWorkflowNode:
ezcWorkflowNode::WAITING_FOR_ACTIVATION    The node is waiting to be activated.
ezcWorkflowNode::WAITING_FOR_EXECUTION    The node is activated and waiting to be executed.

Inherited Member Variables

From ezcWorkflowNodeMerge:
protected  ezcWorkflowNodeMerge::$maxInNodes
protected  ezcWorkflowNodeMerge::$minInNodes
protected  ezcWorkflowNodeMerge::$state
From ezcWorkflowNode:
protected  ezcWorkflowNode::$activatedFrom
protected  ezcWorkflowNode::$activationState
protected  ezcWorkflowNode::$configuration
protected  ezcWorkflowNode::$id
protected  ezcWorkflowNode::$inNodes
protected  ezcWorkflowNode::$internalCall
protected  ezcWorkflowNode::$maxOutNodes
protected  ezcWorkflowNode::$minOutNodes
protected  ezcWorkflowNode::$numInNodes
protected  ezcWorkflowNode::$numOutNodes
protected  ezcWorkflowNode::$outNodes
protected  ezcWorkflowNode::$threadId

Inherited Methods

From ezcWorkflowNodeMerge :
protected void ezcWorkflowNodeMerge::doMerge()
Performs the merge by ending the incoming threads and activating the outgoing node.
protected void ezcWorkflowNodeMerge::initState()
Initializes the state of this node.
protected void ezcWorkflowNodeMerge::prepareActivate()
Prepares this node for activation.
From ezcWorkflowNode :
public ezcWorkflowNode ezcWorkflowNode::__construct()
Constructs a new node with the configuration $configuration.
public void ezcWorkflowNode::accept()
Reimplementation of accept() calls accept on all out nodes.
protected void ezcWorkflowNode::activateNode()
Convenience method for activating an (outgoing) node.
public ezcWorkflowNode ezcWorkflowNode::addInNode()
Adds a node to the incoming nodes of this node.
public ezcWorkflowNode ezcWorkflowNode::addOutNode()
Adds a node to the outgoing nodes of this node.
public static void ezcWorkflowNode::configurationFromXML()
Generate node configuration from XML representation.
public void ezcWorkflowNode::configurationToXML()
Generate XML representation of this node's configuration.
public mixed ezcWorkflowNode::getConfiguration()
Returns the configuration of this node.
public ezcWorkflowNode[] ezcWorkflowNode::getInNodes()
Returns the incoming nodes of this node.
public ezcWorkflowNode[] ezcWorkflowNode::getOutNodes()
Returns the outgoing nodes of this node.
protected void ezcWorkflowNode::initState()
Initializes the state of this node.
public boolean ezcWorkflowNode::removeInNode()
Removes a node from the incoming nodes of this node.
public boolean ezcWorkflowNode::removeOutNode()
Removes a node from the outgoing nodes of this node.
public void ezcWorkflowNode::verify()
Checks this node's constraints.
Last updated: Mon, 17 Dec 2007