Path

ez components / documentation / api reference / 2009.2.1 / workflow


eZ Components 2009.2.1

Workflow: ezcWorkflowVisitor

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

Class: ezcWorkflowVisitor

Base class for visitor implementations that want to process a workflow using the Visitor design pattern. [source]

Implemented Interfaces

  • Countable (internal interface)

visit() is called on each of the nodes in the workflow in a top-down, depth-first fashion.
Start the processing of the workflow by calling accept() on the workflow passing the visitor object as the sole parameter.

Descendents

Child Class Description
ezcWorkflowVisitorVerification An implementation of the ezcWorkflowVisitor interface that verifies a workflow specification.
ezcWorkflowVisitorVisualization An implementation of the ezcWorkflowVisitor interface that generates GraphViz/dot markup for a workflow definition.
ezcWorkflowVisitorReset An implementation of the ezcWorkflowVisitor interface that resets all the nodes of a workflow.

Member Variables

protected SplObjectStorage $visited
Holds the visited nodes.

Method Summary

public ezcWorkflowVisitor __construct( )
Constructor.
public integer count( )
Returns the number of visited nodes.
protected void doVisit( $visitable )
Perform the visit.
public bool visit( $visitable )
Visit the $visitable.

Methods

__construct

ezcWorkflowVisitor __construct( )
Constructor.

Redefined in descendants as

Method Description
ezcWorkflowVisitorVisualization::__construct() Constructor.

count

integer count( )
Returns the number of visited nodes.

doVisit

void doVisit( ezcWorkflowVisitable $visitable )
Perform the visit.

Parameters

Name Type Description
$visitable ezcWorkflowVisitable  

Redefined in descendants as

Method Description
ezcWorkflowVisitorVerification::doVisit() Perform the visit.
ezcWorkflowVisitorVisualization::doVisit() Perform the visit.
ezcWorkflowVisitorReset::doVisit() Perform the visit.

visit

bool visit( ezcWorkflowVisitable $visitable )
Visit the $visitable.
Each node in the graph is visited once.

Parameters

Name Type Description
$visitable ezcWorkflowVisitable  

Last updated: Tue, 23 Mar 2010