@noinspection PhpIncludeInspection More...

Inheritance diagram for ilTimerDetector:

Collaboration diagram for ilTimerDetector:

Public Member Functions
	__construct ($context)
	Default constructor, passing the context to the parent constructor. More...

	setTimerStart ($timer_start)
	Sets the timers start datetime. More...

	getTimerStart ()
	Returns the currently set timer start. More...

	setTimerLimit ($timer_limit)
	Sets the timers limit. More...

	getTimerLimit ()
	Returns the currently set timers limit. More...

	trigger ($params)
	Trigger this 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...

	getEvent ()
	Returns the event type and content currently set to the detector. More...

	getEventSubject ()
	Get the event subject set to the detector. More...

	getEventContext ()
	Get the event context set to the detector. More...

	getListeningTimeframe ()
	Returns the listening timefrage of the detector. More...

	isTimerRelative ()

	setTimerRelative ($timer_relative)

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 ()

Private Attributes
	$event_type = 'time_passed'
	Holds the type of the event to listen for. More...

	$event_content = 'time_passed'

	$event_subject_type = 'none'

	$event_subject_identifier = '0'

	$event_context_type = 'none'

	$event_context_identifier = '0'

	$timer_relative

	$timer_start = 0

	$timer_limit = 0

	$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 ilTimerDetector is part of the petri net based workflow engine.

This detector implements a timer-feature. It has a start (date)time and a time limit.

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

Version: $Id$

/

Definition at line 20 of file class.ilTimerDetector.php.

Constructor & Destructor Documentation

◆ __construct()

ilTimerDetector::__construct ( $context )

Default constructor, passing the context to the parent constructor.

Parameters

ilNode $context

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

    {
        parent::__construct($context);
    }

References ilSimpleDetector\$context.

Member Function Documentation

◆ deleteDetectorFromDb()

ilTimerDetector::deleteDetectorFromDb ( )

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

Implements ilExternalDetector.

Definition at line 284 of file class.ilTimerDetector.php.

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

Referenced by onDeactivate().

Here is the caller graph for this function:

◆ getDbId()

ilTimerDetector::getDbId ( )

Returns the database id of the detector if set.

Returns: integer

Implements ilExternalDetector.

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

ilTimerDetector::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 295 of file class.ilTimerDetector.php.

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

◆ getEventContext()

ilTimerDetector::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 315 of file class.ilTimerDetector.php.

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

◆ getEventSubject()

ilTimerDetector::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 305 of file class.ilTimerDetector.php.

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

◆ getListeningTimeframe()

ilTimerDetector::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 324 of file class.ilTimerDetector.php.

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

◆ getTimerLimit()

ilTimerDetector::getTimerLimit ( )

Returns the currently set timers limit.

Returns: integer Seconds of the timers limit.

Definition at line 128 of file class.ilTimerDetector.php.

    {
        return $this->timer_limit;
    }

References $timer_limit.

◆ getTimerStart()

ilTimerDetector::getTimerStart ( )

Returns the currently set timer start.

Returns: integer Unix timestamp of the timers start.

Definition at line 108 of file class.ilTimerDetector.php.

    {
        return $this->timer_start;
    }

References $timer_start.

◆ hasDbId()

ilTimerDetector::hasDbId ( )

Returns, if the detector has a database id.

Returns: boolean If a database id is set.

Implements ilExternalDetector.

Definition at line 261 of file class.ilTimerDetector.php.

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

◆ isListening()

ilTimerDetector::isListening ( )

Returns if the detector is currently listening.

Returns: boolean

Implements ilExternalDetector.

Definition at line 161 of file class.ilTimerDetector.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;
    }

◆ isTimerRelative()

ilTimerDetector::isTimerRelative ( )

Returns: bool

Definition at line 332 of file class.ilTimerDetector.php.

    {
        return $this->timer_relative;
    }

References $timer_relative.

◆ onActivate()

ilTimerDetector::onActivate ( )

Method called on activation.

Reimplemented from ilSimpleDetector.

Definition at line 204 of file class.ilTimerDetector.php.

    {
        if ($this->timer_relative) {
            if ($this->timer_start == 0) {
                $this->listening_start = time();
            } else {
                $this->listening_start = $this->timer_start;
            }
            if ($this->timer_limit != 0) {
                $this->listening_end = $this->listening_start + $this->timer_limit;
            } else {
                $this->listening_end = 0;
            }
        }
        $this->setDetectorState(false);
        $this->writeDetectorToDb();
    }

References $timer_limit, $timer_start, ilSimpleDetector\setDetectorState(), and writeDetectorToDb().

Here is the call graph for this function:

◆ onDeactivate()

ilTimerDetector::onDeactivate ( )

Method called on deactivation.

Reimplemented from ilSimpleDetector.

Definition at line 225 of file class.ilTimerDetector.php.

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

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

Here is the call graph for this function:

◆ setDbId()

ilTimerDetector::setDbId ( $a_id )

Sets the database id of the detector.

Parameters

integer $a_id

Implements ilExternalDetector.

Definition at line 236 of file class.ilTimerDetector.php.

    {
        $this->db_id = $a_id;
    }

◆ setListeningTimeframe()

ilTimerDetector::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 189 of file class.ilTimerDetector.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.

◆ setTimerLimit()

ilTimerDetector::setTimerLimit ( $timer_limit )

Sets the timers limit.

Parameters

integer $timer_limit Seconds of the timers runtime.

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

    {
        $this->timer_limit = (int) $timer_limit;
    }

References $timer_limit.

◆ setTimerRelative()

ilTimerDetector::setTimerRelative ( $timer_relative )

Parameters

bool $timer_relative

Definition at line 340 of file class.ilTimerDetector.php.

    {
        $this->timer_relative = $timer_relative;
    }

References $timer_relative.

◆ setTimerStart()

ilTimerDetector::setTimerStart ( $timer_start )

Sets the timers start datetime.

Parameters

integer $timer_start Unix timestamp.

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

    {
        $this->timer_start = (int) $timer_start;
    }

References $timer_start.

◆ trigger()

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

Reimplemented from ilSimpleDetector.

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

    {
        if ($this->getDetectorState() == true) {
            return false;
        }
 
        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowUtils.php';
        if ($this->timer_limit + $this->timer_start <= ilWorkflowUtils::time()) {
            $this->setDetectorState(true);
        }
        return true;
    }

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

Here is the call graph for this function:

◆ writeDetectorToDb()

ilTimerDetector::writeDetectorToDb ( )

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

Implements ilExternalDetector.

Definition at line 274 of file class.ilTimerDetector.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

ilTimerDetector::$db_id = null

private

Definition at line 81 of file class.ilTimerDetector.php.

Referenced by getDbId().

◆ $event_content

string ilTimerDetector::$event_content = 'time_passed'

private

Definition at line 33 of file class.ilTimerDetector.php.

◆ $event_context_identifier

ilTimerDetector::$event_context_identifier = '0'

private

Definition at line 45 of file class.ilTimerDetector.php.

◆ $event_context_type

string ilTimerDetector::$event_context_type = 'none'

private

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

◆ $event_subject_identifier

ilTimerDetector::$event_subject_identifier = '0'

private

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

◆ $event_subject_type

string ilTimerDetector::$event_subject_type = 'none'

private

Definition at line 36 of file class.ilTimerDetector.php.

◆ $event_type

string ilTimerDetector::$event_type = 'time_passed'

private

Holds the type of the event to listen for.

In case of this detector class, it is set up to listen to a default 'time passed' event. It has no means of modifying it.

See also: class.ilEventDetector for detailed information on these values.

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

◆ $listening_end

ilTimerDetector::$listening_end = 0

private

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

Referenced by setListeningTimeframe().

◆ $listening_start

ilTimerDetector::$listening_start = 0

private

Definition at line 68 of file class.ilTimerDetector.php.

Referenced by setListeningTimeframe().

◆ $timer_limit

ilTimerDetector::$timer_limit = 0

private

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

Referenced by getTimerLimit(), onActivate(), and setTimerLimit().

◆ $timer_relative

ilTimerDetector::$timer_relative

private

Definition at line 48 of file class.ilTimerDetector.php.

Referenced by isTimerRelative(), and setTimerRelative().

◆ $timer_start

ilTimerDetector::$timer_start = 0

private

Definition at line 55 of file class.ilTimerDetector.php.

Referenced by getTimerStart(), onActivate(), and setTimerStart().

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

Services/WorkflowEngine/classes/detectors/class.ilTimerDetector.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteDetectorFromDb()

◆ getDbId()

◆ getEvent()

◆ getEventContext()

◆ getEventSubject()

◆ getListeningTimeframe()

◆ getTimerLimit()

◆ getTimerStart()

◆ hasDbId()

◆ isListening()

◆ isTimerRelative()

◆ onActivate()

◆ onDeactivate()

◆ setDbId()

◆ setListeningTimeframe()

◆ setTimerLimit()

◆ setTimerRelative()

◆ setTimerStart()

◆ trigger()

◆ writeDetectorToDb()

Field Documentation

◆ $db_id

◆ $event_content

◆ $event_context_identifier

◆ $event_context_type

◆ $event_subject_identifier

◆ $event_subject_type

◆ $event_type

◆ $listening_end

◆ $listening_start

◆ $timer_limit

◆ $timer_relative

◆ $timer_start