Path

ez components / documentation / api reference / 2007.2 / workflow

Workflow: ezcWorkflowNodeVariableSub

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

Class: ezcWorkflowNodeVariableSub

Subtracts a workflow variable from another variable or a constant value. [source]
An object of the ezcWorkflowNodeVariableSub class subtracts a given operand, either a constant or the value of another workflow variable, from a specifled workflow variable.
This example will subtract the contents of the workflow variable 'wfVar' by five and put the result back in 'wfVar'. 
1.   $op = 5;
2.   $sub = new ezcWorkflowNodeVariableSub (
3.            array ( 'name' = > 'wfVar' , 'operand' = > $op )
4.             );
If operand is a string, the value of the workflow variable identified by that string is used.
Incoming nodes: 1 Outgoing nodes: 1

Parents

ezcWorkflowNode
   |
   --ezcWorkflowNodeArithmeticBase
      |
      --ezcWorkflowNodeVariableSub

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 ezcWorkflowNodeArithmeticBase:
protected  ezcWorkflowNodeArithmeticBase::$operand
protected  ezcWorkflowNodeArithmeticBase::$variable
From ezcWorkflowNode:
protected  ezcWorkflowNode::$activatedFrom
protected  ezcWorkflowNode::$activationState
protected  ezcWorkflowNode::$configuration
protected  ezcWorkflowNode::$id
protected  ezcWorkflowNode::$inNodes
protected  ezcWorkflowNode::$internalCall
protected  ezcWorkflowNode::$maxInNodes
protected  ezcWorkflowNode::$maxOutNodes
protected  ezcWorkflowNode::$minInNodes
protected  ezcWorkflowNode::$minOutNodes
protected  ezcWorkflowNode::$numInNodes
protected  ezcWorkflowNode::$numOutNodes
protected  ezcWorkflowNode::$outNodes
protected  ezcWorkflowNode::$state
protected  ezcWorkflowNode::$threadId

Method Summary

public static void configurationFromXML( $element )
Generate node configuration from XML representation.
public void configurationToXML( $element )
Generate XML representation of this node's configuration.
protected void doExecute( )
Perform variable modification.

Inherited Methods

From ezcWorkflowNodeArithmeticBase :
public ezcWorkflowNodeArithmeticBase ezcWorkflowNodeArithmeticBase::__construct()
Constructs a new action node with the configuration $configuration.
protected abstract void ezcWorkflowNodeArithmeticBase::doExecute()
Implementors should perform the variable computation in this method.
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.

Methods

configurationFromXML

void configurationFromXML( $element )
Generate node configuration from XML representation.

Parameters

Name Type Description
$element DOMElement  

Redefinition of

Method Description
ezcWorkflowNode::configurationFromXML() Generate node configuration from XML representation.

configurationToXML

void configurationToXML( $element )
Generate XML representation of this node's configuration.

Parameters

Name Type Description
$element DOMElement  

Redefinition of

Method Description
ezcWorkflowNode::configurationToXML() Generate XML representation of this node's configuration.

doExecute

void doExecute( )
Perform variable modification.

Redefinition of

Method Description
ezcWorkflowNodeArithmeticBase::doExecute() Implementors should perform the variable computation in this method.

Last updated: Mon, 17 Dec 2007