Zeta Components - high quality PHP components

Zeta Components Manual :: Docs For Class ezcWorkflowNodeVariableUnset

Workflow::ezcWorkflowNodeVariableUnset

Class ezcWorkflowNodeVariableUnset

An object of the ezcWorkflowNodeVariableUnset class unset the specified workflow variable.

<?php
$unset = new ezcWorkflowNodeVariableUnset( 'variable name' );
?>

Incoming nodes: 1 Outgoing nodes: 1

Source for this file: /Workflow/src/nodes/variables/unset.php

ezcWorkflowNode
   |
   --ezcWorkflowNodeVariableUnset

Version:

//autogen//

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 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 ezcWorkflowNodeVariableUnset


              __construct(
                                                                  [                  $configuration
                   = '']                               )

Constructs a new unset node.

Inherited Methods

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 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.
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

__construct

ezcWorkflowNodeVariableUnset __construct( [mixed $configuration = ''] )

Constructs a new unset node.

Configuration format: String: The name of the workflow variable to unset.

Array: An array of names of the workflow variables to unset.

Parameters:

Name	Type	Description
`$configuration`	mixed

Exceptions:

Type	Description
`ezcBaseValueException`

Redefinition of:

Method	Description
`ezcWorkflowNode::__construct()`	Constructs a new node with the configuration $configuration.

Documentation generated by phpDocumentor 1.4.3