ilWorkflow Class Reference

Workflow. More...

Collaboration diagram for ilWorkflow:

Public Member Functions
	__construct ()
	Constructor. More...
	setTitle ($a_val)
	Set title. More...
	getTitle ()
	Get title. More...
	addStep ($a_step)
	Add a workflow step. More...
	getSteps ()
	Get workflow steps. More...
	determineNextStep ()
	Determine next step. More...

Data Fields
	$steps = array()

Detailed Description

Workflow.

A Workflow manages a series of steps that are needed to fulfill a certain task. You may overwrite this class, e.g. to change the default behaviour that determines the next step.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 13 of file class.ilWorkflow.php.

Constructor & Destructor Documentation

__construct()

ilWorkflow::__construct

(

)

Constructor.

Definition at line 20 of file class.ilWorkflow.php.

        {
        }

Member Function Documentation

addStep()

ilWorkflow::addStep

(

$a_step

)

Add a workflow step.

Parameters

object

workflow step

Definition at line 49 of file class.ilWorkflow.php.

        {
                $this->steps[] = $a_step;
        }

determineNextStep()

ilWorkflow::determineNextStep

(

)

Determine next step.

The standard behaviour looks for the first step that either has not run yet or is not fulfilled.

Definition at line 66 of file class.ilWorkflow.php.

        {
                foreach ($this->steps as $step)
                {
                        if (!$step->hasRun())
                        {
                                return $step;
                        }
                        
                        if (!$step->isFulfilled())
                        {
                                return $step;
                        }
                }
                return null;
        }

getSteps()

ilWorkflow::getSteps

(

)

Get workflow steps.

Definition at line 57 of file class.ilWorkflow.php.

References $steps.

        {
                return $this->steps;
        }

getTitle()

ilWorkflow::getTitle

(

)

Get title.

Returns

string title

Definition at line 39 of file class.ilWorkflow.php.

        {
                return $this->title;
        }

setTitle()

ilWorkflow::setTitle

(

$a_val

)

Set title.

Parameters

string

title

Definition at line 29 of file class.ilWorkflow.php.

        {
                $this->title = $a_val;
        }

Field Documentation

$steps

ilWorkflow::$steps = array()

Definition at line 15 of file class.ilWorkflow.php.

Referenced by getSteps().

---

The documentation for this class was generated from the following file:

• Services/Workflow/classes/class.ilWorkflow.php