class.ilPluginNode.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/nodes/class.ilBaseNode.php';

class ilPluginNode extends ilBaseNode
{
    private $else_emitters;

    private $else_activities;

    private $evaluation_expression = "return null;";

    public function __construct(ilWorkflow $context)
    {
        $this->context = $context;
        $this->detectors = array();
        $this->emitters = array();
        $this->else_emitters = array();
        $this->activities = array();
        $this->else_activities = array();
    }

    public function activate()
    {
        $this->active = true;
        foreach ($this->detectors as $detector) {
            $detector->onActivate();
        }
        $this->onActivate();
        $this->attemptTransition();
    }

    public function deactivate()
    {
        $this->active = false;
        foreach ($this->detectors as $detector) {
            $detector->onDeactivate();
        }
        $this->onDeactivate();
    }

    public function trigger($a_type, $a_params = null)
    {
        if ($this->active == true && count($this->detectors) != 0) {
            foreach ($this->detectors as $detector) {
                if (get_class($detector) == $a_type) {
                    $detector->trigger($a_params);
                }
            }
        }
        $this->attemptTransition();
    }

    public function checkTransitionPreconditions()
    {
        // TODO Call Plugin here.
        $eval_function = function ($detectors) {
            return eval($this->evaluation_expression);
        };

        if ($eval_function($this->detectors) === null) {
            return false;
        }
        
        if ($eval_function($this->detectors) === true) {
            return true;
        } else {
            return true;
        }
    }

    public function attemptTransition()
    {
        // TODO Call Plugin here.
        $eval_function = function ($detectors) {
            return eval($this->evaluation_expression);
        };

        if ($eval_function($this->detectors) === null) {
            return false;
        }
        
        if ($eval_function($this->detectors) === true) {
            $this->executeTransition();
            return true;
        } else {
            $this->executeElseTransition();
            return true;
        }
    }

    private function executeActivities()
    {
        if (count($this->activities) != 0) {
            foreach ($this->activities as $activity) {
                $activity->execute();
            }
        }
    }

    private function executeEmitters()
    {
        if (count($this->emitters) != 0) {
            foreach ($this->emitters as $emitter) {
                $emitter->emit();
            }
        }
    }

    public function executeTransition()
    {
        $this->deactivate();
        $this->executeActivities();
        $this->executeEmitters();
    }

    public function addEmitter(ilEmitter $emitter, $else_emitter = false)
    {
        if (!$else_emitter) {
            $this->emitters[] = $emitter;
        } else {
            $this->else_emitters[] = $emitter;
        }
    }

    public function addActivity(ilActivity $activity, $else_activity = false)
    {
        if (!$else_activity) {
            $this->activities[] = $activity;
        } else {
            $this->else_activities[] = $activity;
        }
    }

    public function setEvaluationExpression($a_expression)
    {
        // TODO Rework to use a Plugin here.
        $this->evaluation_expression = $a_expression;
    }

    public function notifyDetectorSatisfaction(ilDetector $detector)
    {
        if ($this->isActive()) {
            $this->attemptTransition();
        }
    }

    public function getActivities($else = false)
    {
        if ($else) {
            return $this->else_activities;
        }
        return $this->activities;
    }

    public function getEmitters($else = false)
    {
        if ($else) {
            return $this->else_emitters;
        }
        return $this->emitters;
    }
}