ilSimpleDetector Class Reference

PhpIncludeInspection More...

Inheritance diagram for ilSimpleDetector:

Collaboration diagram for ilSimpleDetector:

Public Member Functions
	__construct (ilNode $context)
	Default constructor. More...
	getContext ()
	Returns the parent object. More...
	trigger ($params)
	Trigger this detector. More...
	getDetectorState ()
	Returns if the current detector state is satisfied or not. More...
	setDetectorState ($new_state)
	Sets a new detector state. More...
	onActivate ()
	Method is called, when the parent node is activated. More...
	onDeactivate ()
	Method is called, when the parent node is deactivated. More...
	getActivated ()
	setName ($name)
	getName ()
	getSourceNode ()
	setSourceNode ($source_node)

Protected Attributes
	$name
	$source_node

Private Attributes
	$context
	$detection_state = false

Detailed Description

PhpIncludeInspection

PhpIncludeInspection ilSimpleDetector of the petri net based workflow engine.

The simple detector does nothing but detect, if it was triggered. Until reset, the trigger method will return false, if the detection state is already fulfilled. (This would be proper behaviour in a petri net, still it has to be fleshed out how the system works out with 'ready-to-transit' nodes the do not transit because of later nodes not accepting ther impulse.

Author

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

Version

$Id$

/

Definition at line 23 of file class.ilSimpleDetector.php.

Constructor & Destructor Documentation

__construct()

ilSimpleDetector::__construct

(

ilNode

$context

)

Default constructor.

Parameters

ilNode

$context

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

References $context.

    {
        $this->context = $context;
    }

Member Function Documentation

getActivated()

ilSimpleDetector::getActivated

(

)

Returns

bool

Definition at line 135 of file class.ilSimpleDetector.php.

References $detection_state.

    {
        return $this->detection_state;
    }

getContext()

ilSimpleDetector::getContext

(

)

Returns the parent object.

Type is ilNode, implements ilWorkflowEngineElement

Returns

ilNode Parent node of this element.

Implements ilWorkflowEngineElement.

Definition at line 59 of file class.ilSimpleDetector.php.

References $context.

Referenced by ilEventDetector\trigger().

    {
        return $this->context;
    }

Here is the caller graph for this function:

getDetectorState()

ilSimpleDetector::getDetectorState

(

)

Returns if the current detector state is satisfied or not.

Returns

boolean

Implements ilDetector.

Definition at line 89 of file class.ilSimpleDetector.php.

References $detection_state.

Referenced by ilTimerDetector\trigger(), and ilEventDetector\trigger().

    {
        return $this->detection_state;
    }

Here is the caller graph for this function:

getName()

ilSimpleDetector::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 151 of file class.ilSimpleDetector.php.

References $name.

    {
        return $this->name;
    }

getSourceNode()

ilSimpleDetector::getSourceNode

(

)

Returns

ilNode

Definition at line 159 of file class.ilSimpleDetector.php.

References $source_node.

    {
        return $this->source_node;
    }

onActivate()

ilSimpleDetector::onActivate

(

)

Method is called, when the parent node is activated.

Returns

void

Implements ilDetector.

Definition at line 118 of file class.ilSimpleDetector.php.

    {
        return;
    }

onDeactivate()

ilSimpleDetector::onDeactivate

(

)

Method is called, when the parent node is deactivated.

Returns

void

Implements ilDetector.

Definition at line 127 of file class.ilSimpleDetector.php.

    {
        return;
    }

setDetectorState()

ilSimpleDetector::setDetectorState

(

$new_state

)

Sets a new detector state.

In this case, the only meaningful param is false, since it should only be set to true, if the detector was triggered. Reason this method exists, is to allow the workflow controller to "fast forward" workflows to set a non-default state. I.e. a workflow has to be set into a state in the middle of running. Use with care.

Parameters

boolean

$new_state

Definition at line 105 of file class.ilSimpleDetector.php.

Referenced by ilTimerDetector\onActivate(), ilEventDetector\onActivate(), ilTimerDetector\onDeactivate(), ilEventDetector\onDeactivate(), trigger(), ilCounterDetector\trigger(), ilTimerDetector\trigger(), and ilEventDetector\trigger().

    {
        $this->detection_state = $new_state;

        if ($new_state == true) {
            $this->context->notifyDetectorSatisfaction($this);
        }
    }

Here is the caller graph for this function:

setName()

ilSimpleDetector::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 143 of file class.ilSimpleDetector.php.

References $name.

    {
        $this->name = $name;
    }

setSourceNode()

ilSimpleDetector::setSourceNode

(

$source_node

)

Parameters

ilNode

$source_node

Definition at line 167 of file class.ilSimpleDetector.php.

References $source_node.

    {
        $this->source_node = $source_node;
    }

trigger()

ilSimpleDetector::trigger

(

$params

)

Trigger this detector.

Params are an array. These are part of the interface but ignored here.

Todo:

Handle ignored $params.

Parameters

array

$params

Returns

boolean False, if detector was already satisfied before.

Implements ilDetector.

Definition at line 74 of file class.ilSimpleDetector.php.

References setDetectorState().

    {
        if ($this->detection_state == false) {
            $this->setDetectorState(true);
            return true;
        } else {
            return false;
        }
    }

Here is the call graph for this function:

Field Documentation

$context

ilSimpleDetector::$context

private

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

Referenced by __construct(), ilTimerDetector\__construct(), ilEventDetector\__construct(), and getContext().

$detection_state

ilSimpleDetector::$detection_state = false

private

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

Referenced by getActivated(), and getDetectorState().

$name

ilSimpleDetector::$name

protected

Definition at line 40 of file class.ilSimpleDetector.php.

Referenced by getName(), and setName().

$source_node

ilSimpleDetector::$source_node

protected

Definition at line 43 of file class.ilSimpleDetector.php.

Referenced by getSourceNode(), and setSourceNode().

---

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

• Services/WorkflowEngine/classes/detectors/class.ilSimpleDetector.php