class.ilWorkflowEngine.php

Go to the documentation of this file.

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

class ilWorkflowEngine
{
        private $mass_action;

        public function __construct($a_mass_action = false)
        {
                $this->mass_action = (bool) $a_mass_action;
        }

        public function processEvent(
                $type,
                $content,
                $subject_type,
                $subject_id,
                $context_type,
                $context_id
        )
        {
                global $DIC;
                $ilSetting = $DIC['ilSetting'];

                if(0 == $ilSetting->get('wfe_activation', 0))
                {
                        return;
                }

                // Get listening event-detectors.
                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                $workflows = ilWorkflowDbHelper::getDetectors(
                        $type,
                        $content,
                        $subject_type,
                        $subject_id,
                        $context_type,
                        $context_id
                );

                if (count($workflows) != 0)
                {
                        foreach ($workflows as $workflow_id)
                        {
                                $wf_instance = ilWorkflowDbHelper::wakeupWorkflow($workflow_id);
                                if($wf_instance == null)
                                {
                                        continue;
                                }

                                $wf_instance->handleEvent(
                                        array(
                                                $type,
                                                $content,
                                                $subject_type,
                                                $subject_id,
                                                $context_type,
                                                $context_id
                                        )
                                );
                                ilWorkflowDbHelper::writeWorkflow($wf_instance);
                        }
                }
        }

        public function handleEvent($component, $event, $parameter)
        {
                global $DIC;
                $ilSetting = $DIC['ilSetting'];

                if(0 == $ilSetting->get('wfe_activation', 0))
                {
                        return;
                }

                // Event incoming, check ServiceDisco (TODO, for now we're using a non-disco factory), call appropriate extractors.

                require_once './Services/WorkflowEngine/classes/extractors/class.ilExtractorFactory.php';
                require_once './Services/WorkflowEngine/interfaces/ilExtractor.php';

                $extractor = ilExtractorFactory::getExtractorByEventDescriptor($component);

                if($extractor instanceof ilExtractor)
                {
                        $extracted_params = $extractor->extract($event, $parameter);

                        $ilLocalSetting = new ilSetting('wfe');
                        $mappers = json_decode($ilLocalSetting->get('custom_mapper',json_encode(array())), true);
                        foreach((array)$mappers as $mapper)
                        {
                                if(!file_exists($mapper['location']))
                                {
                                        continue;
                                }

                                include_once $mapper['location'];
                                if(!class_exists($mapper['class']))
                                {
                                        continue;
                                }

                                $mapper_class = $mapper['class'];
                                $extracted_params       = $mapper_class::mapParams($component, $event, $parameter, $extracted_params);
                                $component                      = $mapper_class::mapComponent($component, $event, $parameter, $extracted_params);
                                $event                          = $mapper_class::mapEvent($component, $event, $parameter, $extracted_params);
                        }

                        $this->processEvent(
                                $component,
                                $event,
                                $extracted_params->getSubjectType(),
                                $extracted_params->getSubjectId(),
                                $extracted_params->getContextType(),
                                $extracted_params->getContextId()
                        );

                        $this->launchArmedWorkflows($component, $event, $extracted_params);
                }
        }

        public function launchArmedWorkflows($component, $event, $extractedParams)
        {

                global $DIC;
                $ilSetting = $DIC['ilSetting'];

                if(0 == $ilSetting->get('wfe_activation', 0))
                {
                        return;
                }

                $workflows = ilWorkflowDbHelper::findApplicableWorkflows($component, $event, $extractedParams);

                foreach($workflows as $workflow)
                {
                        $data = ilWorkflowDbHelper::getStaticInputDataForEvent($workflow['event']);

                        require_once './Services/WorkflowEngine/classes/class.ilObjWorkflowEngine.php';

                        require_once ilObjWorkflowEngine::getRepositoryDir() . $workflow['workflow'] . '.php';
                        $class = substr($workflow['workflow'],4);
                        $workflow_instance = new $class;

                        $workflow_instance->setWorkflowClass('wfd.'.$class.'.php');
                        $workflow_instance->setWorkflowLocation(ilObjWorkflowEngine::getRepositoryDir());

                        if(count($workflow_instance->getInputVars()))
                        {
                                foreach ($workflow_instance->getInputVars() as $input_var)
                                {
                                        $workflow_instance->setInstanceVarById($input_var['name'], $data[ $input_var['name'] ]);
                                }
                        }

                        $workflow_instance->setInstanceVarByRole($extractedParams->getContextType(), $extractedParams->getContextId());
                        $workflow_instance->setInstanceVarByRole($extractedParams->getSubjectType(), $extractedParams->getSubjectId());

                        require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                        ilWorkflowDbHelper::writeWorkflow( $workflow_instance );

                        $workflow_instance->startWorkflow();
                        $workflow_instance->handleEvent(
                                array(
                                        'time_passed',
                                        'time_passed',
                                        'none',
                                        0,
                                        'none',
                                        0
                                )
                        );

                        ilWorkflowDbHelper::writeWorkflow( $workflow_instance );
                }
        }
}