ilEventDetector Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilEventDetector:

Collaboration diagram for ilEventDetector:

Public Member Functions
	__construct ($context)
	Default constructor, passing the context to the parent constructor. More...
	setEvent ($event_type, $event_content)
	Sets the event type and content (/qualifier) for the detector. More...
	getEvent ()
	Returns the event type and content currently set to the detector. More...
	setEventSubject ($event_subject_type, $event_subject_identifier)
	Set the event subject type to the detector. More...
	getEventSubject ()
	Get the event subject set to the detector. More...
	setEventContext ($event_context_type, $event_context_identifier)
	Set the event context to the detector. More...
	getEventContext ()
	Get the event context set to the detector. More...
	trigger ($params)
	Triggers the detector. More...
	isListening ()
	Returns if the detector is currently listening. More...
	setListeningTimeframe ($listening_start, $listening_end)
	Sets the timeframe, in which the detector is listening. More...
	onActivate ()
	Method called on activation. More...
	onDeactivate ()
	Method called on deactivation. More...
	setDbId ($a_id)
	Sets the database id of the detector. More...
	getDbId ()
	Returns the database id of the detector if set. More...
	hasDbId ()
	Returns, if the detector has a database id. More...
	writeDetectorToDb ()
	Passes this detector to the ilWorkflowDBHelper in order to write or update the detector data to the database. More...
	deleteDetectorFromDb ()
	Passes this detector to the ilWorkflowDbHelper in order to remove the detector data from the database. More...
	getListeningTimeframe ()
	Returns the listening timefrage of the detector. More...
	getActivated ()
Public Member Functions inherited from ilSimpleDetector
	__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)
	trigger ($params)
	getDetectorState ()
	onActivate ()
	onDeactivate ()
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()
	setDbId ($a_id)
	getDbId ()
	hasDbId ()
	writeDetectorToDb ()
	deleteDetectorFromDb ()
	isListening ()
	getListeningTimeframe ()
	setListeningTimeframe ($listening_start, $listening_end)
	getEvent ()
	getEventSubject ()
	getEventContext ()

Data Fields
	$was_activated

Private Attributes
	$event_type
	$event_content
	$event_subject_type
	$event_subject_identifier
	$event_context_type
	$event_context_identifier
	$listening_start = 0
	$listening_end = 0
	$db_id = null

Additional Inherited Members
Protected Attributes inherited from ilSimpleDetector
	$name
	$source_node

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection ilEventDetector is part of the petri net based workflow engine.

The event detector listens to non-timer related outside events. Examples are events raised by Ilias, such as a new member joined a group/course, a test was finished, a learning progress was updated, etc. Please note here the differing handling of the params at the trigger method.

Author

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

Version

$Id$

/

Definition at line 22 of file class.ilEventDetector.php.

Constructor & Destructor Documentation

__construct()

ilEventDetector::__construct

(

$context

)

Default constructor, passing the context to the parent constructor.

Parameters

ilNode

$context

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

    {
        parent::__construct($context);
    }

References ilSimpleDetector\$context, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

deleteDetectorFromDb()

ilEventDetector::deleteDetectorFromDb

(

)

Passes this detector to the ilWorkflowDbHelper in order to remove the detector data from the database.

Implements ilExternalDetector.

Definition at line 376 of file class.ilEventDetector.php.

    {
        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
        ilWorkflowDbHelper::deleteDetector($this);
    }

Referenced by onDeactivate().

Here is the caller graph for this function:

getActivated()

ilEventDetector::getActivated

(

)

Returns

bool

Reimplemented from ilSimpleDetector.

Definition at line 398 of file class.ilEventDetector.php.

    {
        return $this->was_activated;
    }

References $was_activated.

getDbId()

ilEventDetector::getDbId

(

)

Returns the database id of the detector if set.

Returns

int

Exceptions

ilWorkflowObjectStateException

Implements ilExternalDetector.

Definition at line 339 of file class.ilEventDetector.php.

    {
        if ($this->db_id != null) {
            return $this->db_id;
        } else {
            require_once './Services/WorkflowEngine/exceptions/ilWorkflowObjectStateException.php';
            throw new ilWorkflowObjectStateException('No database ID set.');
        }
    }

References $db_id.

getEvent()

ilEventDetector::getEvent

(

)

Returns the event type and content currently set to the detector.

Returns

array array('type' => $this->event_type, 'content' => $this->event_content)

Implements ilExternalDetector.

Definition at line 140 of file class.ilEventDetector.php.

    {
        return array('type' => $this->event_type, 'content' => $this->event_content);
    }

getEventContext()

ilEventDetector::getEventContext

(

)

Get the event context set to the detector.

Returns

array array('type' => $this->event_context_type, 'identifier' => $this->event_context_identifier)

Implements ilExternalDetector.

Definition at line 184 of file class.ilEventDetector.php.

    {
        return array('type' => $this->event_context_type, 'identifier' => $this->event_context_identifier);
    }

getEventSubject()

ilEventDetector::getEventSubject

(

)

Get the event subject set to the detector.

Returns

array array('type' => $this->event_subject_type, 'identifier' => $this->event_subject_identifier)

Implements ilExternalDetector.

Definition at line 162 of file class.ilEventDetector.php.

    {
        return array('type' => $this->event_subject_type, 'identifier' => $this->event_subject_identifier);
    }

getListeningTimeframe()

ilEventDetector::getListeningTimeframe

(

)

Returns the listening timefrage of the detector.

Returns

array array ('listening_start' => $this->listening_start, 'listening_end' => $this->listening_end)

Implements ilExternalDetector.

Definition at line 387 of file class.ilEventDetector.php.

    {
        return array('listening_start' => $this->listening_start, 'listening_end' => $this->listening_end);
    }

hasDbId()

ilEventDetector::hasDbId

(

)

Returns, if the detector has a database id.

Returns

boolean If a database id is set.

Implements ilExternalDetector.

Definition at line 353 of file class.ilEventDetector.php.

    {
        if ($this->db_id == null) {
            return false;
        }
 
        return true;
    }

isListening()

ilEventDetector::isListening

(

)

Returns if the detector is currently listening.

Returns

boolean

Implements ilExternalDetector.

Definition at line 265 of file class.ilEventDetector.php.

    {
        // No listening phase = always listening.
        if ($this->listening_start == 0 && $this->listening_end == 0) {
            return true;
        }
 
        // Listening started?
        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowUtils.php';
        if ($this->listening_start <= ilWorkflowUtils::time()) {
            // Listening not ended or infinite?
            if ($this->listening_end >= ilWorkflowUtils::time()
                || $this->listening_end == 0) {
                return true;
            }
        }
 
        return false;
    }

Referenced by trigger().

Here is the caller graph for this function:

onActivate()

ilEventDetector::onActivate

(

)

Method called on activation.

Reimplemented from ilSimpleDetector.

Definition at line 308 of file class.ilEventDetector.php.

    {
        $this->setDetectorState(false);
        $this->writeDetectorToDb();
    }

References ilSimpleDetector\setDetectorState(), and writeDetectorToDb().

Here is the call graph for this function:

onDeactivate()

ilEventDetector::onDeactivate

(

)

Method called on deactivation.

Reimplemented from ilSimpleDetector.

Definition at line 317 of file class.ilEventDetector.php.

    {
        $this->setDetectorState(false);
        $this->deleteDetectorFromDb();
    }

References deleteDetectorFromDb(), and ilSimpleDetector\setDetectorState().

Here is the call graph for this function:

setDbId()

ilEventDetector::setDbId

(

$a_id

)

Sets the database id of the detector.

Parameters

integer

$a_id

Implements ilExternalDetector.

Definition at line 328 of file class.ilEventDetector.php.

    {
        $this->db_id = $a_id;
    }

setEvent()

ilEventDetector::setEvent	(		$event_type,
			$event_content
	)

Sets the event type and content (/qualifier) for the detector.

'WHAT'

Parameters

string	$event_type
string	$event_content

Definition at line 129 of file class.ilEventDetector.php.

    {
        $this->event_type = (string) $event_type;
        $this->event_content = (string) $event_content;
    }

References $event_content, and $event_type.

setEventContext()

ilEventDetector::setEventContext	(		$event_context_type,
			$event_context_identifier
	)

Set the event context to the detector.

'WHERE' / 'ON WHAT' / 'ON WHOM'

Parameters

string	$event_context_type
integer	$event_context_identifier

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

    {
        $this->event_context_type = (string) $event_context_type;
        $this->event_context_identifier = $event_context_identifier;
    }

References $event_context_identifier, and $event_context_type.

setEventSubject()

ilEventDetector::setEventSubject	(		$event_subject_type,
			$event_subject_identifier
	)

Set the event subject type to the detector.

'WHO'

Parameters

string	$event_subject_type
integer	$event_subject_identifier

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

    {
        $this->event_subject_type = (string) $event_subject_type;
        $this->event_subject_identifier = $event_subject_identifier;
    }

References $event_subject_identifier, and $event_subject_type.

setListeningTimeframe()

ilEventDetector::setListeningTimeframe	(		$listening_start,
			$listening_end
	)

Sets the timeframe, in which the detector is listening.

Parameters

integer	$listening_start	Unix timestamp start of listening period.
integer	$listening_end	Unix timestamp end of listening period.

Exceptions

ilWorkflowInvalidArgumentException

Implements ilExternalDetector.

Definition at line 293 of file class.ilEventDetector.php.

    {
        $this->listening_start = $listening_start;
 
        if ($this->listening_start > $listening_end && $listening_end != 0) {
            require_once './Services/WorkflowEngine/exceptions/ilWorkflowInvalidArgumentException.php';
            throw new ilWorkflowInvalidArgumentException('Listening timeframe is (start vs. end) is invalid.');
        }
 
        $this->listening_end = $listening_end;
    }

References $listening_end, and $listening_start.

trigger()

ilEventDetector::trigger

(

$params

)

Triggers the detector.

The params for this trigger have to be assembled like this: array ( 'event_type' => 'course_join', 'event_content' => 'member_join', 'event_subject_type => 'usr', 'event_subject_identifier' => '6', 'event_context_type' => 'crs', 'event_context_identifier' => '48' )

This would describe an event, in which a user joined a course as member. If an identifier is '0', they are meant as 'for all'.

Parameters

array

$params

Associative array with params, see docs for details.

Returns

bool|void

Reimplemented from ilSimpleDetector.

Definition at line 209 of file class.ilEventDetector.php.

    {
        if (!$this->isListening()) {
            return;
        }
 
        if ($this->event_type !== $params[0]) {
            // Wrong event type -> no action here.
            return;
        }
 
        if ($this->event_content !== $params[1]) {
            // Wrong event content -> no action here.
            return;
        }
 
        if ($this->event_subject_type !== $params[2]) {
            // Wrong event subject type -> no action here.
            return;
        }
 
        if ($this->event_subject_identifier !== $params[3] && $this->event_subject_identifier != 0) {
            // Wrong event subject identifier and identifier here not 0 (not *all*) -> no action.
            return;
        }
        
        if ($this->event_context_type !== $params[4]) {
            // Wrong event context type -> no action.
            return;
        }
 
        if ($this->event_context_identifier !== $params[5] && $this->event_context_identifier != 0) {
            // Wrong event context identifier and identifier here not 0 (not *all*) -> no action.
            return;
        }
 
        // We're through checks now, let's see if this detector is already satisfied.
        if ($this->getDetectorState() == false) {
            // X -> ilNode     -> ilWorkflow -> Method...
            foreach ($params as $key => $value) {
                $this->getContext()->setRuntimeVar($key, $value);
            }
            $this->getContext()->setRuntimeVar('current_event', $params);
            $this->was_activated = true;
            $this->setDetectorState(true);
            return true;
        }
 
        return false;
    }

References ilSimpleDetector\getContext(), ilSimpleDetector\getDetectorState(), isListening(), and ilSimpleDetector\setDetectorState().

Here is the call graph for this function:

writeDetectorToDb()

ilEventDetector::writeDetectorToDb

(

)

Passes this detector to the ilWorkflowDBHelper in order to write or update the detector data to the database.

Implements ilExternalDetector.

Definition at line 366 of file class.ilEventDetector.php.

    {
        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
        ilWorkflowDbHelper::writeDetector($this);
    }

Referenced by onActivate().

Here is the caller graph for this function:

Field Documentation

$db_id

ilEventDetector::$db_id = null

private

Definition at line 111 of file class.ilEventDetector.php.

Referenced by getDbId().

$event_content

ilEventDetector::$event_content

private

Definition at line 52 of file class.ilEventDetector.php.

Referenced by setEvent().

$event_context_identifier

ilEventDetector::$event_context_identifier

private

Definition at line 92 of file class.ilEventDetector.php.

Referenced by setEventContext().

$event_context_type

ilEventDetector::$event_context_type

private

Definition at line 83 of file class.ilEventDetector.php.

Referenced by setEventContext().

$event_subject_identifier

ilEventDetector::$event_subject_identifier

private

Definition at line 71 of file class.ilEventDetector.php.

Referenced by setEventSubject().

$event_subject_type

ilEventDetector::$event_subject_type

private

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

Referenced by setEventSubject().

$event_type

ilEventDetector::$event_type

private

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

Referenced by setEvent().

$listening_end

ilEventDetector::$listening_end = 0

private

Definition at line 104 of file class.ilEventDetector.php.

Referenced by setListeningTimeframe().

$listening_start

ilEventDetector::$listening_start = 0

private

Definition at line 98 of file class.ilEventDetector.php.

Referenced by setListeningTimeframe().

$was_activated

bool ilEventDetector::$was_activated

Definition at line 393 of file class.ilEventDetector.php.

Referenced by getActivated().

---

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

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