class.ilCaseNode.php

Go to the documentation of this file.

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

require_once './Services/WorkflowEngine/classes/nodes/class.ilBaseNode.php';

class ilCaseNode extends ilBaseNode
{
    private $is_exclusive_join;

    private $is_exclusive_fork;

    public $else_emitters;

    public $is_exclusive;

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

    public function setIsExclusiveJoin($is_exclusive)
    {
        $this->is_exclusive_join = $is_exclusive;
    }

    public function setIsExclusiveFork($is_exclusive)
    {
        $this->is_exclusive_fork = $is_exclusive;
    }

    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 checkTransitionPreconditions()
    {
        // queries the $detectors if their conditions are met.
        $isPreconditionMet = true;
        foreach ($this->detectors as $detector) {
            if ($isPreconditionMet == true) {
                $isPreconditionMet = $detector->getDetectorState();
                if ($isPreconditionMet && ($this->is_exclusive_join || $this->is_exclusive_fork || $this->is_exclusive)) {
                    break;
                }
            }
        }
        return $isPreconditionMet;
    }

    public function attemptTransition()
    {
        if ($this->checkTransitionPreconditions() == true) {
            $this->executeTransition();
            return true;
        } else {
            return false;
        }
    }

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

        foreach ((array) $this->condition_emitter_pairs as $pair) {
            $eval_function = function ($that) use ($pair) {
                return eval($pair['expression']);
            };

            if ($eval_function($this->detectors) === true) {
                $emitter = $pair['emitter'];
                $emitter->emit();
                if ($this->is_exclusive_fork || $this->is_exclusive_join) {
                    return;
                }
            }
        }
    }

    public function addEmitter(ilEmitter $emitter, $expression = 'return true;')
    {
        $this->condition_emitter_pairs[] = array(
            'emitter' => $emitter,
            'expression' => $expression
        );
    }

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