ilBasicNode Class Reference

PhpIncludeInspection More...

Inheritance diagram for ilBasicNode:

Collaboration diagram for ilBasicNode:

Public Member Functions
	__construct (ilWorkflow $context)
	Default constructor. More...
	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 transition, calls all activities and emitters to execute. More...
	notifyDetectorSatisfaction (ilDetector $detector)
	This method is called by detectors, that just switched to being satisfied. More...
	isForwardConditionNode ()
	setIsForwardConditionNode ($is_forward_condition_node)
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)

Data Fields
	$is_forward_condition_event
	$ident

Private Member Functions
	executeActivities ()
	Executes all attached activities. More...
	executeEmitters ()
	Executes all attached emitters. More...

Private Attributes
	$is_forward_condition_node

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

Detailed Description

PhpIncludeInspection

Workflow Node of the petri net based workflow engine.

Author

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

Version

$Id$

/

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

Constructor & Destructor Documentation

__construct()

ilBasicNode::__construct

(

ilWorkflow

$context

)

Default constructor.

Parameters

ilWorkflow

$context

Reference to the workflow the node is attached to.

Definition at line 41 of file class.ilBasicNode.php.

References ilBaseNode\$context, and array.

    {
        $this->context = $context;
        $this->detectors = array();
        $this->emitters = array();
        $this->activities = array();
        $this->active = false;
        $this->is_forward_condition_node = false;
        $this->is_forward_condition_event = false;
        $this->ident = strtoupper(substr(md5(spl_object_hash($this)), 0, 6));
    }

Member Function Documentation

activate()

ilBasicNode::activate

(

)

Activates the node.

Implements ilNode.

Definition at line 56 of file class.ilBasicNode.php.

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

    {
        if ($this->isActive()) {
            return;
        }
        
        $this->active = true;

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

Here is the call graph for this function:

attemptTransition()

ilBasicNode::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 108 of file class.ilBasicNode.php.

References checkTransitionPreconditions(), and executeTransition().

Referenced by activate(), and notifyDetectorSatisfaction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

checkTransitionPreconditions()

ilBasicNode::checkTransitionPreconditions

(

)

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

Returns

boolean True, if node is ready to transit.

Implements ilNode.

Definition at line 88 of file class.ilBasicNode.php.

Referenced by attemptTransition().

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

Here is the caller graph for this function:

deactivate()

ilBasicNode::deactivate

(

)

Deactivates the node.

Implements ilNode.

Definition at line 74 of file class.ilBasicNode.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()

ilBasicNode::executeActivities ( )

private

Executes all attached activities.

Definition at line 121 of file class.ilBasicNode.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()

ilBasicNode::executeEmitters ( )

private

Executes all attached emitters.

Definition at line 133 of file class.ilBasicNode.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()

ilBasicNode::executeTransition

(

)

Executes the transition, calls all activities and emitters to execute.

Implements ilNode.

Definition at line 145 of file class.ilBasicNode.php.

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

Referenced by attemptTransition().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isForwardConditionNode()

ilBasicNode::isForwardConditionNode

(

)

Returns

boolean

Definition at line 170 of file class.ilBasicNode.php.

References $is_forward_condition_node.

    {
        return $this->is_forward_condition_node;
    }

notifyDetectorSatisfaction()

ilBasicNode::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 160 of file class.ilBasicNode.php.

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

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

Here is the call graph for this function:

setIsForwardConditionNode()

ilBasicNode::setIsForwardConditionNode

(

$is_forward_condition_node

)

Parameters

boolean

$is_forward_condition_node

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

References $is_forward_condition_node.

    {
        $this->is_forward_condition_node = $is_forward_condition_node;
    }

Field Documentation

$ident

ilBasicNode::$ident

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

$is_forward_condition_event

ilBasicNode::$is_forward_condition_event

Definition at line 31 of file class.ilBasicNode.php.

$is_forward_condition_node

ilBasicNode::$is_forward_condition_node

private

Definition at line 28 of file class.ilBasicNode.php.

Referenced by isForwardConditionNode(), and setIsForwardConditionNode().

---

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

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