ilCaseNode Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilCaseNode:

Collaboration diagram for ilCaseNode:

Public Member Functions
	__construct (ilWorkflow $context)
	Default constructor. More...
	setIsExclusiveJoin ($is_exclusive)
	setIsExclusiveFork ($is_exclusive)
	activate ()
	Activates the node. More...
	deactivate ()
	Deactivates the node. More...
	checkTransitionPreconditions ()
	Checks, if the preconditions of the node to transit are met. More...
	attemptTransition ()
	Attempts to transit the node. More...
	executeTransition ()
	Executes the 'then'-transition of the node. More...
	addEmitter (ilEmitter $emitter, $expression='return true;')
	Adds an emitter to one of the lists attached to the node. More...
	notifyDetectorSatisfaction (ilDetector $detector)
	This method is called by detectors, that just switched to being satisfied. More...
Public Member Functions inherited from ilBaseNode
	addDetector (ilDetector $detector)
	Adds a detector to the list of detectors. More...
	getDetectors ()
	Returns all currently set detectors. More...
	addEmitter (ilEmitter $emitter)
	Adds an emitter to the list of emitters. More...
	getEmitters ()
	Returns all currently set emitters. More...
	addActivity (ilActivity $activity)
	Adds an activity to the list of activities. More...
	getActivities ()
	Returns all currently set activities. More...
	getContext ()
	Returns a reference to the parent workflow object. More...
	setName ($name)
	getName ()
	getRuntimeVars ()
	setRuntimeVars ($runtime_vars)
	getRuntimeVar ($name)
	setRuntimeVar ($name, $value)
	onActivate ()
	Method called on activation of the node. More...
	onDeactivate ()
	Method calles on deactivation of the node. More...
	isActive ()
	Returns the activation status of the node. More...
	attemptTransition ()
	checkTransitionPreconditions ()
	executeTransition ()
	activate ()
	deactivate ()
	notifyDetectorSatisfaction (ilDetector $detector)
	attemptTransition ()
	checkTransitionPreconditions ()
	executeTransition ()
	addDetector (ilDetector $detector)
	addEmitter (ilEmitter $emitter)
	addActivity (ilActivity $activity)
	activate ()
	deactivate ()
	onActivate ()
	onDeactivate ()
	notifyDetectorSatisfaction (ilDetector $detector)
	getDetectors ()
	getEmitters ()
	getRuntimeVars ()
	setRuntimeVars ($runtime_vars)
	getRuntimeVar ($name)
	setRuntimeVar ($name, $value)
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()

Data Fields
	$else_emitters
	$is_exclusive

Private Attributes
	$is_exclusive_join
	$is_exclusive_fork

Additional Inherited Members
Protected Attributes inherited from ilBaseNode
	$context
	$detectors
	$emitters
	$activities
	$active = false
	$name
	$runtime_vars

Detailed Description

@noinspection PhpIncludeInspection

Case node of the petri net based workflow engine.

The case node is a deciding node. It features a multiple set of emitters and no activities.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

Definition at line 18 of file class.ilCaseNode.php.

Constructor & Destructor Documentation

__construct()

ilCaseNode::__construct

(

ilWorkflow

$context

)

Default constructor.

Parameters

ilWorkflow

$context

Reference to the parent workflow.

Definition at line 37 of file class.ilCaseNode.php.

    {
        $this->context = $context;
        $this->detectors = array();
        $this->emitters = array();
        $this->else_emitters = array();
        $this->activities = array();
        $this->is_exclusive = false;
    }

References ilBaseNode\$context.

Member Function Documentation

activate()

ilCaseNode::activate

(

)

Activates the node.

Reimplemented from ilBaseNode.

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

    {
        $this->active = true;
        foreach ($this->detectors as $detector) {
            $detector->onActivate();
        }
        $this->onActivate();
        $this->attemptTransition();
    }

References attemptTransition(), and ilBaseNode\onActivate().

Here is the call graph for this function:

addEmitter()

ilCaseNode::addEmitter	(	ilEmitter	$emitter,
			$expression = 'return true;'
	)

Adds an emitter to one of the lists attached to the node.

Parameters

ilEmitter	$emitter
boolean	$else_emitter	True, if the emitter should be an 'else'-emitter.

Definition at line 163 of file class.ilCaseNode.php.

    {
        $this->condition_emitter_pairs[] = array(
            'emitter' => $emitter,
            'expression' => $expression
        );
    }

attemptTransition()

ilCaseNode::attemptTransition

(

)

Attempts to transit the node.

Basically, this checks for preconditions and transits, returning true or false if preconditions are not met, aka detectors are not fully satisfied.

Returns

boolean True, if transition succeeded.

Reimplemented from ilBaseNode.

Definition at line 120 of file class.ilCaseNode.php.

    {
        if ($this->checkTransitionPreconditions() == true) {
            $this->executeTransition();
            return true;
        } else {
            return false;
        }
    }

References checkTransitionPreconditions(), and executeTransition().

Referenced by activate(), and notifyDetectorSatisfaction().

Here is the call graph for this function:

Here is the caller graph for this function:

checkTransitionPreconditions()

ilCaseNode::checkTransitionPreconditions

(

)

Checks, if the preconditions of the node to transit are met.

Please note, that in a conditional node, this means the node can transit to one or another outcome. This method only returns false, if the return value of the method is neither true nor false.

Returns

boolean True, if node is ready to transit.

Reimplemented from ilBaseNode.

Definition at line 97 of file class.ilCaseNode.php.

    {
        // queries the $detectors if their conditions are met.
        $isPreconditionMet = true;
        foreach ($this->detectors as $detector) {
            if ($isPreconditionMet == true) {
                $isPreconditionMet = $detector->getDetectorState();
                if ($isPreconditionMet && ($this->is_exclusive_join || $this->is_exclusive_fork || $this->is_exclusive)) {
                    break;
                }
            }
        }
        return $isPreconditionMet;
    }

Referenced by attemptTransition().

Here is the caller graph for this function:

deactivate()

ilCaseNode::deactivate

(

)

Deactivates the node.

Reimplemented from ilBaseNode.

Definition at line 79 of file class.ilCaseNode.php.

    {
        $this->active = false;
        foreach ($this->detectors as $detector) {
            $detector->onDeactivate();
        }
        $this->onDeactivate();
    }

References ilBaseNode\onDeactivate().

Referenced by executeTransition().

Here is the call graph for this function:

Here is the caller graph for this function:

executeTransition()

ilCaseNode::executeTransition

(

)

Executes the 'then'-transition of the node.

Reimplemented from ilBaseNode.

Definition at line 133 of file class.ilCaseNode.php.

    {
        $this->deactivate();
        if (count($this->activities) != 0) {
            foreach ($this->activities as $activity) {
                $activity->execute();
            }
        }
 
        foreach ((array) $this->condition_emitter_pairs as $pair) {
            $eval_function = function ($that) use ($pair) {
                return eval($pair['expression']);
            };
 
            if ($eval_function($this->detectors) === true) {
                $emitter = $pair['emitter'];
                $emitter->emit();
                if ($this->is_exclusive_fork || $this->is_exclusive_join) {
                    return;
                }
            }
        }
    }

References deactivate().

Referenced by attemptTransition().

Here is the call graph for this function:

Here is the caller graph for this function:

notifyDetectorSatisfaction()

ilCaseNode::notifyDetectorSatisfaction

(

ilDetector

$detector

)

This method is called by detectors, that just switched to being satisfied.

Parameters

ilDetector

$detector

ilDetector which is now satisfied.

Returns

mixed|void

Reimplemented from ilBaseNode.

Definition at line 178 of file class.ilCaseNode.php.

    {
        if ($this->isActive()) {
            $this->attemptTransition();
        }
    }

References attemptTransition(), and ilBaseNode\isActive().

Here is the call graph for this function:

setIsExclusiveFork()

ilCaseNode::setIsExclusiveFork

(

$is_exclusive

)

Parameters

mixed

$is_exclusive

Definition at line 58 of file class.ilCaseNode.php.

    {
        $this->is_exclusive_fork = $is_exclusive;
    }

References $is_exclusive.

setIsExclusiveJoin()

ilCaseNode::setIsExclusiveJoin

(

$is_exclusive

)

Parameters

mixed

$is_exclusive

Definition at line 50 of file class.ilCaseNode.php.

    {
        $this->is_exclusive_join = $is_exclusive;
    }

References $is_exclusive.

Field Documentation

$else_emitters

ilEmitter[] ilCaseNode::$else_emitters

Definition at line 27 of file class.ilCaseNode.php.

$is_exclusive

bool ilCaseNode::$is_exclusive

Definition at line 30 of file class.ilCaseNode.php.

Referenced by setIsExclusiveFork(), and setIsExclusiveJoin().

$is_exclusive_fork

bool ilCaseNode::$is_exclusive_fork

private

Definition at line 24 of file class.ilCaseNode.php.

$is_exclusive_join

bool ilCaseNode::$is_exclusive_join

private

Definition at line 21 of file class.ilCaseNode.php.

---

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

• Services/WorkflowEngine/classes/nodes/class.ilCaseNode.php