ilPluginNode Class Reference

PhpIncludeInspection More...

Inheritance diagram for ilPluginNode:

Collaboration diagram for ilPluginNode:

Public Member Functions
	__construct (ilWorkflow $context)
	Default constructor. More...
	activate ()
	Activates the node. More...
	deactivate ()
	Deactivates the node. More...
	trigger ($a_type, $a_params=null)
	Passes a trigger to attached detectors. 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, $else_emitter=false)
	Adds an emitter to one of the lists attached to the node. More...
	addActivity (ilActivity $activity, $else_activity=false)
	Adds an activity to one of the lists attached to the node. More...
	setEvaluationExpression ($a_expression)
	notifyDetectorSatisfaction (ilDetector $detector)
	This method is called by detectors, that just switched to being satisfied. More...
	getActivities ($else=false)
	Returns all currently set activites. More...
	getEmitters ($else=false)
	Returns all currently set emitters. 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)

Private Member Functions
	executeActivities ()
	Executes all 'then'-activities attached to the node. More...
	executeEmitters ()
	Executes all 'then'-emitters attached to the node. More...

Private Attributes
	$else_emitters
	$else_activities
	$evaluation_expression = "return null;"

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

Detailed Description

PhpIncludeInspection

Plugin node of the petri net based workflow engine.

The plugin node is a deciding node. It features a multiple set of emitters and 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.ilPluginNode.php.

Constructor & Destructor Documentation

__construct()

ilPluginNode::__construct

(

ilWorkflow

$context

)

Default constructor.

Parameters

ilWorkflow

$context

Reference to the parent workflow.

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

References ilBaseNode\$context, and array.

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

Member Function Documentation

activate()

ilPluginNode::activate

(

)

Activates the node.

Implements ilNode.

Definition at line 62 of file class.ilPluginNode.php.

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

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

Here is the call graph for this function:

addActivity()

ilPluginNode::addActivity	(	ilActivity	$activity,
			$else_activity = false
	)

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

Parameters

ilActivity	$activity
boolean	$else_activity	True, if the activity should be an 'else'-activity.

Definition at line 213 of file class.ilPluginNode.php.

    {
        if (!$else_activity) {
            $this->activities[] = $activity;
        } else {
            $this->else_activities[] = $activity;
        }
    }

addEmitter()

ilPluginNode::addEmitter	(	ilEmitter	$emitter,
			$else_emitter = false
	)

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 198 of file class.ilPluginNode.php.

    {
        if (!$else_emitter) {
            $this->emitters[] = $emitter;
        } else {
            $this->else_emitters[] = $emitter;
        }
    }

attemptTransition()

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

Implements ilNode.

Definition at line 138 of file class.ilPluginNode.php.

References ilBaseNode\$detectors, and executeTransition().

Referenced by activate(), notifyDetectorSatisfaction(), and trigger().

    {
        // TODO Call Plugin here.
        $eval_function = function ($detectors) {
            return eval($this->evaluation_expression);
        };

        if ($eval_function($this->detectors) === null) {
            return false;
        }
        
        if ($eval_function($this->detectors) === true) {
            $this->executeTransition();
            return true;
        } else {
            $this->executeElseTransition();
            return true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTransitionPreconditions()

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

Implements ilNode.

Definition at line 112 of file class.ilPluginNode.php.

References ilBaseNode\$detectors.

    {
        // TODO Call Plugin here.
        $eval_function = function ($detectors) {
            return eval($this->evaluation_expression);
        };

        if ($eval_function($this->detectors) === null) {
            return false;
        }
        
        if ($eval_function($this->detectors) === true) {
            return true;
        } else {
            return true;
        }
    }

deactivate()

ilPluginNode::deactivate

(

)

Deactivates the node.

Implements ilNode.

Definition at line 75 of file class.ilPluginNode.php.

References ilBaseNode\onDeactivate().

Referenced by executeTransition().

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeActivities()

ilPluginNode::executeActivities ( )

private

Executes all 'then'-activities attached to the node.

Definition at line 161 of file class.ilPluginNode.php.

Referenced by executeTransition().

    {
        if (count($this->activities) != 0) {
            foreach ($this->activities as $activity) {
                $activity->execute();
            }
        }
    }

Here is the caller graph for this function:

executeEmitters()

ilPluginNode::executeEmitters ( )

private

Executes all 'then'-emitters attached to the node.

Definition at line 173 of file class.ilPluginNode.php.

Referenced by executeTransition().

    {
        if (count($this->emitters) != 0) {
            foreach ($this->emitters as $emitter) {
                $emitter->emit();
            }
        }
    }

Here is the caller graph for this function:

executeTransition()

ilPluginNode::executeTransition

(

)

Executes the 'then'-transition of the node.

Implements ilNode.

Definition at line 185 of file class.ilPluginNode.php.

References deactivate(), executeActivities(), and executeEmitters().

Referenced by attemptTransition().

    {
        $this->deactivate();
        $this->executeActivities();
        $this->executeEmitters();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActivities()

ilPluginNode::getActivities

(

$else = false

)

Returns all currently set activites.

Parameters

boolean

$else

True, if else activities should be returned.

Returns

Array Array with objects of ilActivity

Definition at line 285 of file class.ilPluginNode.php.

References ilBaseNode\$activities, and $else_activities.

    {
        if ($else) {
            return $this->else_activities;
        }
        return $this->activities;
    }

getEmitters()

ilPluginNode::getEmitters

(

$else = false

)

Returns all currently set emitters.

Parameters

boolean

$else

True, if else emitters should be returned.

Returns

Array Array with objects of ilEmitter

Definition at line 300 of file class.ilPluginNode.php.

References $else_emitters, and ilBaseNode\$emitters.

    {
        if ($else) {
            return $this->else_emitters;
        }
        return $this->emitters;
    }

notifyDetectorSatisfaction()

ilPluginNode::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

Implements ilNode.

Definition at line 271 of file class.ilPluginNode.php.

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

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

Here is the call graph for this function:

setEvaluationExpression()

ilPluginNode::setEvaluationExpression

(

$a_expression

)

Definition at line 258 of file class.ilPluginNode.php.

    {
        // TODO Rework to use a Plugin here.
        $this->evaluation_expression = $a_expression;
    }

trigger()

ilPluginNode::trigger	(		$a_type,
			$a_params = null
	)

Passes a trigger to attached detectors.

Deprecated:

Parameters

type	$a_type
type	$a_params

Definition at line 91 of file class.ilPluginNode.php.

References $a_type, and attemptTransition().

    {
        if ($this->active == true && count($this->detectors) != 0) {
            foreach ($this->detectors as $detector) {
                if (get_class($detector) == $a_type) {
                    $detector->trigger($a_params);
                }
            }
        }
        $this->attemptTransition();
    }

Here is the call graph for this function:

Field Documentation

$else_activities

ilPluginNode::$else_activities

private

Definition at line 34 of file class.ilPluginNode.php.

Referenced by getActivities().

$else_emitters

ilPluginNode::$else_emitters

private

Definition at line 26 of file class.ilPluginNode.php.

Referenced by getEmitters().

$evaluation_expression

ilPluginNode::$evaluation_expression = "return null;"

private

Definition at line 42 of file class.ilPluginNode.php.

---

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

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