class.ilTimerDetector.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once './Services/WorkflowEngine/classes/detectors/class.ilSimpleDetector.php';
require_once './Services/WorkflowEngine/interfaces/ilExternalDetector.php';

class ilTimerDetector extends ilSimpleDetector implements ilExternalDetector
{
        private $event_type                                     = 'time_passed';

        private $event_content                          = 'time_passed';

        private $event_subject_type                     = 'none';

        private $event_subject_identifier       = '0';

        private $event_context_type                     = 'none';

        private $event_context_identifier       = '0';

        private $timer_relative;

        private $timer_start = 0;

        private $timer_limit = 0;

        private $listening_start = 0;

        private $listening_end = 0;

        private $db_id = null;

        public function __construct($context)
        {
                parent::__construct($context);
        }

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

        public function getTimerStart()
        {
                return $this->timer_start;
        }

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

        public function getTimerLimit()
        {
                return $this->timer_limit;
        }

        public function trigger($params)
        {
                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;
        }

        public function isListening()
        {
                // 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;
        }

        public function setListeningTimeframe($listening_start, $listening_end)
        {
                $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;
        }

        public function onActivate()
        {
                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();
        }

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

        public function setDbId($a_id)
        {
                $this->db_id = $a_id;
        }

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

        public function hasDbId()
        {
                if ($this->db_id == null)
                {
                        return false;
                }

                return true;
        }

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

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

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

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

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

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

        public function isTimerRelative()
        {
                return $this->timer_relative;
        }

        public function setTimerRelative($timer_relative)
        {
                $this->timer_relative = $timer_relative;
        }
}