class.ilEventDetector.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 ilEventDetector extends ilSimpleDetector implements ilExternalDetector
{
        private $event_type;

        private $event_content;

        private $event_subject_type;

        private $event_subject_identifier;

        private $event_context_type;

        private $event_context_identifier;

        private $listening_start = 0;

        private $listening_end = 0;

        private $db_id = null;

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

        public function setEvent($event_type, $event_content)
        {
                $this->event_type = (string) $event_type;
                $this->event_content = (string) $event_content;
        }

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

        public function setEventSubject($event_subject_type, $event_subject_identifier)
        {
                $this->event_subject_type = (string) $event_subject_type;
                $this->event_subject_identifier = $event_subject_identifier;
        }

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

        public function setEventContext($event_context_type, $event_context_identifier)
        {
                $this->event_context_type = (string) $event_context_type;
                $this->event_context_identifier = $event_context_identifier;
        }

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

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

        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()
        {
                $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 getListeningTimeframe()
        {
                return array ('listening_start' => $this->listening_start, 'listening_end' => $this->listening_end);
        }

        public $was_activated;

        public function getActivated()
        {
                return $this->was_activated;
        }
}