@noinspection PhpIncludeInspection More...

Inheritance diagram for ilBaseWorkflow:

Collaboration diagram for ilBaseWorkflow:

Public Member Functions
	__construct ()
	Default constructor. More...

	startWorkflow ()
	Starts the workflow, activating the start_node. More...

	stopWorkflow ()
	Stops the workflow, deactivating all nodes. More...

	onStartWorkflow ()
	Method called on start of the workflow, prior to activating the first node. More...

	onStopWorkflow ()
	Method called on stopping of the workflow, after deactivating all nodes. More...

	onWorkflowFinished ()
	Method called after workflow is finished, after detecting no more nodes are active. More...

	isActive ()
	Returns the activation status of the workflow. More...

	handleEvent ($params)
	Handles an event. More...

	registerDetector (ilDetector $detector)

	getWorkflowData ()
	Returns the workflow type and content currently set to the workflow. More...

	getWorkflowSubject ()
	Get the workflow subject set to the workflow. More...

	getWorkflowContext ()
	Get the event context set to the workflow. More...

	setDbId ($id)
	Sets the database id of the detector. More...

	getDbId ()
	Returns the database id of the detector if set. More...

	hasDbId ()
	Returns, if the detector has a database id. More...

	setStartNode (ilNode $node)
	Sets the start node of the workflow. More...

	addNode (ilNode $node)
	This method adds a node to the workflow. More...

	setWorkflowClass ($class)
	Sets the classname of the workflow definition. More...

	getWorkflowClass ()
	Returns the currently set workflow class definition name. More...

	setWorkflowLocation ($path)
	Sets the location of the workflow definition file as relative path. More...

	getWorkflowLocation ()
	Returns the currently set path to the workflow definition. More...

	getNodes ()
	Returns all nodes attached to the workflow. More...

	isDataPersistenceRequired ()

	resetDataPersistenceRequirement ()

	defineInstanceVar ($id, $name, $reference=false, $reference_target='', $type='mixed', $role='undefined')

	hasInstanceVarByName ($name)
	Returns if an instance variable of the given name is set. More...

	hasInstanceVarById ($id)
	Returns if an instance variable of the given id is set. More...

	getInstanceVarByName ($name)
	Returns the given instance variables content More...

	getInstanceVarById ($id)
	Returns the given instance variables content. More...

	setInstanceVarByName ($name, $value)
	Sets the given instance var with the given content. More...

	setInstanceVarById ($id, $value)
	Sets the given instance var with the given content. More...

	setInstanceVarByRole ($role, $value)
	Sets the given instance var with the given content. More...

	getInstanceVars ()
	Returns an array with all set instance variables. More...

	flushInstanceVars ()
	Empties the instance variables. More...

	defineInputVar ($name)

	defineOutputVar ($name)

	readInputVar ($name)

	hasInputVar ($name)

	hasOutputVar ($name)

	writeInputVar ($name, $value)

	readOutputVar ($name)

	writeOutputVar ($name, $value)

	getInputVars ()

	getOutputVars ()

	registerInputVar ($name, $definition)

	registerOutputVar ($name)

Public Member Functions inherited from ilWorkflow
	handleEvent ($params)

	addNode (ilNode $node)

	setStartNode (ilNode $node)

	registerDetector (ilDetector $detector)

	startWorkflow ()

	stopWorkflow ()

	isActive ()

	onStartWorkflow ()

	onStopWorkflow ()

	onWorkflowFinished ()

	getWorkflowData ()

	getWorkflowSubject ()

	getWorkflowContext ()

	getWorkflowClass ()

	getWorkflowLocation ()

	setDbId ($id)

	getDbId ()

	hasDbId ()

	isDataPersistenceRequired ()

	resetDataPersistenceRequirement ()

	defineInstanceVar ($id, $name)

	hasInstanceVarByName ($name)

	hasInstanceVarById ($id)

	getInstanceVarByName ($name)

	getInstanceVarById ($id)

	setInstanceVarByName ($name, $value)

	setInstanceVarById ($id, $value)

	getInstanceVars ()

	flushInstanceVars ()

Static Public Member Functions
static	autoload ($class_name)
	Autoloader function to dynamically include files for instantiation of objects during deserialization. More...

Protected Attributes
	$nodes

	$detectors

	$start_node

	$active
	Holds the activation state of the workflow. More...

	$db_id
	This holds the database id of the workflow. More...

	$workflow_type

	$workflow_content

	$workflow_class

	$workflow_location

	$workflow_subject_type

	$workflow_subject_identifier

	$workflow_context_type

	$workflow_context_identifier

	$instance_vars = array()

	$data_inputs

	$data_outputs

	$require_data_persistence = false

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection @noinspection PhpIncludeInspection ilBaseWorkflow is part of the petri net based workflow engine.

The base workflow class is the ancestor for all concrete workflow implementations.

Author: Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

/

Definition at line 21 of file class.ilBaseWorkflow.php.

Constructor & Destructor Documentation

◆ __construct()

ilBaseWorkflow::__construct ( )

Default constructor.

Here the definition of the workflow is to be done.

Reimplemented in ilEmptyWorkflow, StartEvent_Blank, StartEvent_Message, StartEvent_Multistart, StartEvent_Signal, StartEvent_Timer_Date, ParallelGateway_Forking, ParallelGateway_Joining, ParallelGateway_Simple, InclusiveGateway_Simple, ExclusiveGateway_Fork_Simple, ExclusiveGateway_Join_Simple, Task_CallActivity_Simple, Task_ManualTask_Simple, Task_ReadLearnersFromCourse, Task_ScriptTask_Simple, Task_Simple, IntermediateCatchEvent_Message_Simple, IntermediateCatchEvent_Signal_Simple, IntermediateCatchEvent_Timer_Simple, IntermediateThrowEvent_Message_Simple, IntermediateThrowEvent_Signal_Simple, EndEvent_Blanko_Simple, EndEvent_Message_Simple, EndEvent_Signal_Simple, EndEvent_Terminate_Simple, ComplexGateway_Blanko_Simple, EventBasedGateway_Blanko_Simple, DataInput_RepositoryObjectSelector, DataInput_Simple, DataInput_WithProperties, DataOutput_Simple, DataObject_Role, DataObject_Simple, Data_Wiring_Input_Task, DataObject_Wiring_Input_Object_Output, and Booking_System_FullDiagram.

Definition at line 149 of file class.ilBaseWorkflow.php.

150 {

151 }

Member Function Documentation

◆ addNode()

ilBaseWorkflow::addNode ( ilNode $node )

This method adds a node to the workflow.

Parameters

ilNode $node

Implements ilWorkflow.

Definition at line 367 of file class.ilBaseWorkflow.php.

        {
                $this->nodes[] = $node;
        }

Here is the caller graph for this function:

◆ autoload()

static ilBaseWorkflow::autoload ( $class_name )

static

Autoloader function to dynamically include files for instantiation of objects during deserialization.

Parameters

string $class_name

Definition at line 436 of file class.ilBaseWorkflow.php.

        {
                switch(true)
                {
                        case strtolower(substr($class_name, strlen($class_name) - 8, 8)) == 'activity':
                                $componentDirectory = 'activities';
                                break;
 
                        case strtolower(substr($class_name, strlen($class_name) - 8, 8)) == 'detector':
                                $componentDirectory = 'detectors';
                                break;
 
                        case strtolower(substr($class_name, strlen($class_name) - 7, 7)) == 'emitter':
                                $componentDirectory = 'emitters';
                                break;
 
                        case strtolower(substr($class_name, strlen($class_name) - 4, 4)) == 'node':
                                $componentDirectory = 'node';
                                break;
                                
                        default:
                                return;
                }
 
                $filename = './Services/WorkflowEngine/classes/' . $componentDirectory . '/class.'.$class_name.'.php';
                if(file_exists($filename))
                {
                        require_once $filename;
                }
        }

References $filename.

◆ defineInputVar()

ilBaseWorkflow::defineInputVar ( $name )

Deprecated:

Definition at line 702 of file class.ilBaseWorkflow.php.

        {
                $this->data_inputs[$name] = null;
                $this->require_data_persistence = true;
        }

◆ defineInstanceVar()

ilBaseWorkflow::defineInstanceVar	(	$id,
		$name,
		$reference = `false`,
		$reference_target = `''`,
		$type = `'mixed'`,
		$role = `'undefined'`
	)

Parameters

string	$id
string	$name
bool	$reference
string	$reference_target
string	$type
string	$role

Definition at line 503 of file class.ilBaseWorkflow.php.

        {
                $this->instance_vars[] = array(
                        'id' => $id, 
                        'name' => $name, 
                        'value' => null, 
                        'reference' => $reference, 
                        'target' => $reference_target,
                        'type' => $type,
                        'role' => $role
                );
        }

Referenced by Task_ReadLearnersFromCourse\__construct(), DataInput_RepositoryObjectSelector\__construct(), DataInput_Simple\__construct(), DataInput_WithProperties\__construct(), DataOutput_Simple\__construct(), DataObject_Role\__construct(), DataObject_Simple\__construct(), Data_Wiring_Input_Task\__construct(), DataObject_Wiring_Input_Object_Output\__construct(), and Booking_System_FullDiagram\__construct().

Here is the caller graph for this function:

◆ defineOutputVar()

ilBaseWorkflow::defineOutputVar ( $name )

Deprecated:

Definition at line 711 of file class.ilBaseWorkflow.php.

        {
                $this->data_outputs[$name] = null;
                $this->require_data_persistence = true;
        }

◆ flushInstanceVars()

ilBaseWorkflow::flushInstanceVars ( )

Empties the instance variables.

Implements ilWorkflow.

Definition at line 690 of file class.ilBaseWorkflow.php.

        {
                $this->instance_vars = array();
        }

◆ getDbId()

ilBaseWorkflow::getDbId ( )

Returns the database id of the detector if set.

Returns: int

Exceptions

ilWorkflowObjectStateException

Implements ilWorkflow.

Definition at line 325 of file class.ilBaseWorkflow.php.

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

References $db_id.

◆ getInputVars()

ilBaseWorkflow::getInputVars ( )

Definition at line 775 of file class.ilBaseWorkflow.php.

        {
                return (array)$this->data_inputs;
        }

References $data_inputs.

◆ getInstanceVarById()

ilBaseWorkflow::getInstanceVarById ( $id )

Returns the given instance variables content.

Parameters

string $name Name of the variable.

Returns: mixed Content of the variable.

Implements ilWorkflow.

Definition at line 585 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as $instance_var)
                {
                        if($instance_var['id'] == $id)
                        {
                                if($instance_var['reference'] === true)
                                {
                                        return $this->getInstanceVarById($instance_var['target']);
                                }
                                else
                                {
                                        return $instance_var['value'];
                                }
                        }
                }
                return false;
        }

References getInstanceVarById().

Referenced by getInstanceVarById().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceVarByName()

ilBaseWorkflow::getInstanceVarByName ( $name )

Returns the given instance variables content

Parameters

string $name Name of the variable.

Returns: mixed Content of the variable.

Implements ilWorkflow.

Definition at line 560 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as &$instance_var)
                {
                        if($instance_var['name'] == $name)
                        {
                                if($instance_var['reference'] === true)
                                {
                                        return $this->getInstanceVarByName($instance_var['target']);
                                }
                                else
                                {
                                        return $instance_var['value'];
                                }
                        }
                }
                return false;
        }

References getInstanceVarByName().

Referenced by getInstanceVarByName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceVars()

ilBaseWorkflow::getInstanceVars ( )

Returns an array with all set instance variables.

Returns: array Associative array of mixed.

Implements ilWorkflow.

Definition at line 682 of file class.ilBaseWorkflow.php.

        {
                return (array) $this->instance_vars;
        }

References $instance_vars.

◆ getNodes()

ilBaseWorkflow::getNodes ( )

Returns all nodes attached to the workflow.

Returns: ilNode[]

Definition at line 425 of file class.ilBaseWorkflow.php.

        {
                return $this->nodes;
        }

References $nodes.

◆ getOutputVars()

ilBaseWorkflow::getOutputVars ( )

Deprecated:

Definition at line 783 of file class.ilBaseWorkflow.php.

        {
                return (array)$this->data_outputs;
        }

References $data_outputs.

◆ getWorkflowClass()

ilBaseWorkflow::getWorkflowClass ( )

Returns the currently set workflow class definition name.

See also: $this->workflow_class

Returns: string Class name

Implements ilWorkflow.

Definition at line 391 of file class.ilBaseWorkflow.php.

        {
                return $this->workflow_class;
        }

References $workflow_class.

◆ getWorkflowContext()

ilBaseWorkflow::getWorkflowContext ( )

Get the event context set to the workflow.

Returns: array array('type' => $this->workflow_context_type, 'identifier' => $this->workflow_context_identifier)

Implements ilWorkflow.

Definition at line 304 of file class.ilBaseWorkflow.php.

        {
                return array('type' => $this->workflow_context_type, 'identifier' => $this->workflow_context_identifier);
        }

◆ getWorkflowData()

ilBaseWorkflow::getWorkflowData ( )

Returns the workflow type and content currently set to the workflow.

Returns: array array('type' => $this->workflow_type, 'content' => $this->workflow_content)

Implements ilWorkflow.

Definition at line 284 of file class.ilBaseWorkflow.php.

        {
                return array('type' => $this->workflow_type, 'content' => $this->workflow_content);
        }

◆ getWorkflowLocation()

ilBaseWorkflow::getWorkflowLocation ( )

Returns the currently set path to the workflow definition.

See also: $this->workflow_location

Returns: string

Implements ilWorkflow.

Definition at line 415 of file class.ilBaseWorkflow.php.

        {
                return $this->workflow_location;
        }

References $workflow_location.

◆ getWorkflowSubject()

ilBaseWorkflow::getWorkflowSubject ( )

Get the workflow subject set to the workflow.

Returns: array array('type' => $this->workflow_subject_type, 'identifier' => $this->workflow_subject_identifier)

Implements ilWorkflow.

Definition at line 294 of file class.ilBaseWorkflow.php.

        {
                return array('type' => $this->workflow_subject_type, 'identifier' => $this->workflow_subject_identifier);
        }

◆ handleEvent()

ilBaseWorkflow::handleEvent ( $params )

Handles an event.

The event is passed to all active event handlers.

Parameters

string[] $params

Implements ilWorkflow.

Definition at line 242 of file class.ilBaseWorkflow.php.

        {
                $active_nodes_available = false;
                // Hier nur an aktive Nodes dispatchen.
                foreach ((array)$this->detectors as $detector)
                {
                        $node = $detector->getContext();
                        if ($node->isActive())
                        {
                                $detector->trigger($params);
                                $node = $detector->getContext();
                                if ($node->isActive())
                                {
                                        $active_nodes_available = true;
                                }
                        }
                }
 
                if ($active_nodes_available == false)
                {
                        $this->active = false;
                        $this->onWorkflowFinished();
                }
        }

References $params, and onWorkflowFinished().

Here is the call graph for this function:

◆ hasDbId()

ilBaseWorkflow::hasDbId ( )

Returns, if the detector has a database id.

Returns: boolean If a database id is set.

Implements ilWorkflow.

Definition at line 342 of file class.ilBaseWorkflow.php.

        {
                if ($this->db_id == null)
                {
                        return false;
                }
                return true;
        }

◆ hasInputVar()

ilBaseWorkflow::hasInputVar ( $name )

Deprecated:

Definition at line 732 of file class.ilBaseWorkflow.php.

        {
                return array_key_exists($name, (array)$this->data_inputs);
        }

◆ hasInstanceVarById()

ilBaseWorkflow::hasInstanceVarById ( $id )

Returns if an instance variable of the given id is set.

Parameters

string $id

Returns: boolean True, if a variable by that id is set.

Implements ilWorkflow.

Definition at line 542 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as $instance_var)
                {
                        if($instance_var['id'] == $id)
                        {
                                return true;
                        }
                }
                return false;
        }

◆ hasInstanceVarByName()

ilBaseWorkflow::hasInstanceVarByName ( $name )

Returns if an instance variable of the given name is set.

Parameters

string $name

Returns: boolean True, if a variable by that name is set.

Implements ilWorkflow.

Definition at line 523 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as $instance_var)
                {
                        if($instance_var['name'] == $name)
                        {
                                return true;
                        }
                }
                return false;
        }

◆ hasOutputVar()

ilBaseWorkflow::hasOutputVar ( $name )

Deprecated:

Definition at line 740 of file class.ilBaseWorkflow.php.

        {
                return array_key_exists($name, (array)$this->data_outputs);
        }

◆ isActive()

ilBaseWorkflow::isActive ( )

Returns the activation status of the workflow.

Returns: boolean

Implements ilWorkflow.

Definition at line 230 of file class.ilBaseWorkflow.php.

        {
                return (bool)$this->active;
        }

References $active.

◆ isDataPersistenceRequired()

ilBaseWorkflow::isDataPersistenceRequired ( )

Returns: bool

Implements ilWorkflow.

Definition at line 470 of file class.ilBaseWorkflow.php.

        {
                return $this->require_data_persistence;
        }

References $require_data_persistence.

◆ onStartWorkflow()

ilBaseWorkflow::onStartWorkflow ( )

Method called on start of the workflow, prior to activating the first node.

Returns: void

Implements ilWorkflow.

Definition at line 196 of file class.ilBaseWorkflow.php.

        {
                return;
        }

Referenced by startWorkflow().

Here is the caller graph for this function:

◆ onStopWorkflow()

ilBaseWorkflow::onStopWorkflow ( )

Method called on stopping of the workflow, after deactivating all nodes.

Please note: Stopping a workflow 'cancels' the execution. The graceful end of a workflow is handled with

See also: onWorkflowFinished().

Returns: void

Implements ilWorkflow.

Definition at line 208 of file class.ilBaseWorkflow.php.

        {
                return;
        }

Referenced by stopWorkflow().

Here is the caller graph for this function:

◆ onWorkflowFinished()

ilBaseWorkflow::onWorkflowFinished ( )

Method called after workflow is finished, after detecting no more nodes are active.

This is the graceful end of the workflow. Forced shutdown of a workflow is handled in

See also: onStopWorkflow().

Returns: void

Implements ilWorkflow.

Definition at line 220 of file class.ilBaseWorkflow.php.

        {
                return;
        }

Referenced by handleEvent().

Here is the caller graph for this function:

◆ readInputVar()

ilBaseWorkflow::readInputVar ( $name )

Deprecated:

Definition at line 720 of file class.ilBaseWorkflow.php.

        {
                if($this->data_inputs[$name])
                {
                        return $this->data_inputs[$name];
                }
                return null;
        }

◆ readOutputVar()

ilBaseWorkflow::readOutputVar ( $name )

Deprecated:

Definition at line 757 of file class.ilBaseWorkflow.php.

        {
                if($this->data_outputs[$name])
                {
                        return $this->data_outputs[$name];
                }
                return null;
        }

◆ registerDetector()

ilBaseWorkflow::registerDetector ( ilDetector $detector )

Parameters

\ilDetector $detector

Implements ilWorkflow.

Definition at line 270 of file class.ilBaseWorkflow.php.

        {
                $reflection_class = new ReflectionClass($detector);
                if (in_array('ilExternalDetector', $reflection_class->getInterfaceNames()))
                {
                        $this->detectors[] = $detector;
                }
        }

◆ registerInputVar()

ilBaseWorkflow::registerInputVar	(	$name,
		$definition
	)

Parameters

string	$name
mixed	$definition

Definition at line 792 of file class.ilBaseWorkflow.php.

        {
                $definition['name'] = $name;
                $this->data_inputs[$name] = $definition;
        }

Referenced by Task_ReadLearnersFromCourse\__construct(), DataInput_RepositoryObjectSelector\__construct(), DataInput_Simple\__construct(), DataInput_WithProperties\__construct(), Data_Wiring_Input_Task\__construct(), and DataObject_Wiring_Input_Object_Output\__construct().

Here is the caller graph for this function:

◆ registerOutputVar()

ilBaseWorkflow::registerOutputVar ( $name )

Parameters

string $name

Definition at line 801 of file class.ilBaseWorkflow.php.

        {
                $this->data_outputs[] = $name;
        }

Referenced by DataOutput_Simple\__construct(), and DataObject_Wiring_Input_Object_Output\__construct().

Here is the caller graph for this function:

◆ resetDataPersistenceRequirement()

ilBaseWorkflow::resetDataPersistenceRequirement ( )

Returns: void

Implements ilWorkflow.

Definition at line 478 of file class.ilBaseWorkflow.php.

        {
                $this->require_data_persistence = false;
        }

◆ setDbId()

ilBaseWorkflow::setDbId ( $id )

Sets the database id of the detector.

Parameters

integer $id

Implements ilWorkflow.

Definition at line 314 of file class.ilBaseWorkflow.php.

        {
                $this->db_id = $id;
        }

◆ setInstanceVarById()

ilBaseWorkflow::setInstanceVarById	(	$id,
		$value
	)

Sets the given instance var with the given content.

Parameters

string	$id	Name of the variable
mixed	$value

Implements ilWorkflow.

Definition at line 633 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as &$instance_var)
                {
                        if($instance_var['id'] == $id)
                        {
                                if($instance_var['reference'] === true)
                                {
                                        $this->setInstanceVarById($instance_var['target'], $value);
                                }
                                else
                                {
                                        $instance_var['value'] = $value;
                                        return;
                                }
                        }
                }
        }

References setInstanceVarById().

Referenced by setInstanceVarById(), setInstanceVarByName(), and setInstanceVarByRole().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInstanceVarByName()

ilBaseWorkflow::setInstanceVarByName	(	$name,
		$value
	)

Sets the given instance var with the given content.

Parameters

string	$name	Name of the variable
mixed	$value

Implements ilWorkflow.

Definition at line 609 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as &$instance_var)
                {
                        if($instance_var['name'] == $name)
                        {
                                if($instance_var['reference'] === true)
                                {
                                        $this->setInstanceVarById($instance_var['target'], $value);
                                } 
                                else 
                                {
                                        $instance_var['value'] = $value;
                                }
                        }
                }
        }

References setInstanceVarById().

Here is the call graph for this function:

◆ setInstanceVarByRole()

ilBaseWorkflow::setInstanceVarByRole	(	$role,
		$value
	)

Sets the given instance var with the given content.

only during startup to write event params

Parameters

string	$role	Role of the variable
mixed	$value

Definition at line 658 of file class.ilBaseWorkflow.php.

        {
                foreach($this->instance_vars as &$instance_var)
                {
                        if($instance_var['role'] == $role)
                        {
                                if($instance_var['reference'] === true)
                                {
                                        $this->setInstanceVarById($instance_var['target'], $value);
                                }
                                else
                                {
                                        $instance_var['value'] = $value;
                                        return;
                                }
                        }
                }
        }

References setInstanceVarById().

Here is the call graph for this function:

◆ setStartNode()

ilBaseWorkflow::setStartNode ( ilNode $node )

Sets the start node of the workflow.

This node is activated, when the workflow is started.

Parameters

ilNode $node

Implements ilWorkflow.

Definition at line 357 of file class.ilBaseWorkflow.php.

        {
                $this->start_node = $node;
        }

Here is the caller graph for this function:

◆ setWorkflowClass()

ilBaseWorkflow::setWorkflowClass ( $class )

Sets the classname of the workflow definition.

See also: $this->workflow_class

Parameters

string $class

Definition at line 379 of file class.ilBaseWorkflow.php.

        {
                $this->workflow_class = $class;
        }

◆ setWorkflowLocation()

ilBaseWorkflow::setWorkflowLocation ( $path )

Sets the location of the workflow definition file as relative path.

See also: $this->workflow_location

Parameters

string $path e.g. Services/WorkflowEngine

Definition at line 403 of file class.ilBaseWorkflow.php.

        {
                $this->workflow_location = $path;
        }

References $path.

◆ startWorkflow()

ilBaseWorkflow::startWorkflow ( )

Starts the workflow, activating the start_node.

Implements ilWorkflow.

Definition at line 156 of file class.ilBaseWorkflow.php.

        {
                // Write the workflow to the database, so detectors find a parent id to save with them.
                require_once './Services/WorkflowEngine/classes/utils/class.ilWorkflowDbHelper.php';
                $this->active = true;
                ilWorkflowDbHelper::writeWorkflow($this);
                $this->onStartWorkflow();
 
                // Figure out, if there is a start-node set - or nodes at all.
                if ($this->start_node == null)
                {
                        if (count($this->nodes) != 0)
                        {
                                $this->start_node = $this->nodes[0];
                        } else {
                                //ilWorkflowDbHelper::deleteWorkflow($this);
                                throw new Exception ('No start_node, no node, no start. Doh.');
                        }
                }
                $this->start_node->activate();
                ilWorkflowDbHelper::writeWorkflow($this);
        }

References onStartWorkflow().

Here is the call graph for this function:

◆ stopWorkflow()

ilBaseWorkflow::stopWorkflow ( )

Stops the workflow, deactivating all nodes.

Implements ilWorkflow.

Definition at line 182 of file class.ilBaseWorkflow.php.

        {
                $this->active = false;
                foreach ($this->nodes as $node)
                {
                        $node->deactivate();
                }
                $this->onStopWorkflow();
        }

References onStopWorkflow().

Here is the call graph for this function:

◆ writeInputVar()

ilBaseWorkflow::writeInputVar	(	$name,
		$value
	)

Deprecated:

Definition at line 748 of file class.ilBaseWorkflow.php.

        {
                $this->data_inputs[$name] = $value;
                $this->require_data_persistence = true;
        }

◆ writeOutputVar()

ilBaseWorkflow::writeOutputVar	(	$name,
		$value
	)

Deprecated:

Definition at line 769 of file class.ilBaseWorkflow.php.

        {
                $this->data_outputs[$name] = $value;
                $this->require_data_persistence = true;
        }

Field Documentation

◆ $active

boolean ilBaseWorkflow::$active

protected

Holds the activation state of the workflow.

Definition at line 49 of file class.ilBaseWorkflow.php.

Referenced by isActive().

◆ $data_inputs

ilBaseWorkflow::$data_inputs

protected

Definition at line 136 of file class.ilBaseWorkflow.php.

Referenced by getInputVars().

◆ $data_outputs

ilBaseWorkflow::$data_outputs

protected

Definition at line 139 of file class.ilBaseWorkflow.php.

Referenced by getOutputVars().

◆ $db_id

integer ilBaseWorkflow::$db_id

protected

This holds the database id of the workflow.

Definition at line 56 of file class.ilBaseWorkflow.php.

Referenced by getDbId().

◆ $detectors

ilBaseWorkflow::$detectors

protected

Definition at line 35 of file class.ilBaseWorkflow.php.

◆ $instance_vars

ilBaseWorkflow::$instance_vars = array()

protected

Definition at line 133 of file class.ilBaseWorkflow.php.

Referenced by getInstanceVars().

◆ $nodes

ilBaseWorkflow::$nodes

protected

Definition at line 28 of file class.ilBaseWorkflow.php.

Referenced by getNodes().

◆ $require_data_persistence

ilBaseWorkflow::$require_data_persistence = false

protected

Definition at line 142 of file class.ilBaseWorkflow.php.

Referenced by isDataPersistenceRequired().

◆ $start_node

ilBaseWorkflow::$start_node

protected

Definition at line 42 of file class.ilBaseWorkflow.php.

◆ $workflow_class

ilBaseWorkflow::$workflow_class

protected

Definition at line 85 of file class.ilBaseWorkflow.php.

Referenced by getWorkflowClass().

◆ $workflow_content

ilBaseWorkflow::$workflow_content

protected

Definition at line 79 of file class.ilBaseWorkflow.php.

◆ $workflow_context_identifier

ilBaseWorkflow::$workflow_context_identifier

protected

Definition at line 126 of file class.ilBaseWorkflow.php.

◆ $workflow_context_type

ilBaseWorkflow::$workflow_context_type

protected

Definition at line 117 of file class.ilBaseWorkflow.php.

◆ $workflow_location

ilBaseWorkflow::$workflow_location

protected

Definition at line 91 of file class.ilBaseWorkflow.php.

Referenced by getWorkflowLocation().

◆ $workflow_subject_identifier

ilBaseWorkflow::$workflow_subject_identifier

protected

Definition at line 108 of file class.ilBaseWorkflow.php.

◆ $workflow_subject_type

ilBaseWorkflow::$workflow_subject_type

protected

Definition at line 100 of file class.ilBaseWorkflow.php.

◆ $workflow_type

ilBaseWorkflow::$workflow_type

protected

Definition at line 68 of file class.ilBaseWorkflow.php.

The documentation for this class was generated from the following file:

Services/WorkflowEngine/classes/workflows/class.ilBaseWorkflow.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNode()

◆ autoload()

◆ defineInputVar()

◆ defineInstanceVar()

◆ defineOutputVar()

◆ flushInstanceVars()

◆ getDbId()

◆ getInputVars()

◆ getInstanceVarById()

◆ getInstanceVarByName()

◆ getInstanceVars()

◆ getNodes()

◆ getOutputVars()

◆ getWorkflowClass()

◆ getWorkflowContext()

◆ getWorkflowData()

◆ getWorkflowLocation()

◆ getWorkflowSubject()

◆ handleEvent()

◆ hasDbId()

◆ hasInputVar()

◆ hasInstanceVarById()

◆ hasInstanceVarByName()

◆ hasOutputVar()

◆ isActive()

◆ isDataPersistenceRequired()

◆ onStartWorkflow()

◆ onStopWorkflow()

◆ onWorkflowFinished()

◆ readInputVar()

◆ readOutputVar()

◆ registerDetector()

◆ registerInputVar()

◆ registerOutputVar()

◆ resetDataPersistenceRequirement()

◆ setDbId()

◆ setInstanceVarById()

◆ setInstanceVarByName()

◆ setInstanceVarByRole()

◆ setStartNode()

◆ setWorkflowClass()

◆ setWorkflowLocation()

◆ startWorkflow()

◆ stopWorkflow()

◆ writeInputVar()

◆ writeOutputVar()

Field Documentation

◆ $active

◆ $data_inputs

◆ $data_outputs

◆ $db_id

◆ $detectors

◆ $instance_vars

◆ $nodes

◆ $require_data_persistence

◆ $start_node

◆ $workflow_class

◆ $workflow_content

◆ $workflow_context_identifier

◆ $workflow_context_type

◆ $workflow_location

◆ $workflow_subject_identifier

◆ $workflow_subject_type

◆ $workflow_type