ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilEmptyWorkflow Class Reference

PhpIncludeInspection More...

+ Inheritance diagram for ilEmptyWorkflow:
+ Collaboration diagram for ilEmptyWorkflow:

Public Member Functions

 __construct ()
 ilEmptyWorkflow constructor. More...
 
- Public Member Functions inherited from ilBaseWorkflow
 __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
 defineInstanceVar ($id, $name)
 

Additional Inherited Members

- Static Public Member Functions inherited from ilBaseWorkflow
static autoload ($class_name)
 Autoloader function to dynamically include files for instantiation of objects during deserialization. More...
 
- Protected Attributes inherited from ilBaseWorkflow
 $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

PhpIncludeInspection

ilEmptyWorkflow is part of the petri net based workflow engine.

The empty workflow class is used for workflows with completely runtime generated configurations, such as workflows for use in tests.

Author
Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
$Id$

/

Definition at line 18 of file class.ilEmptyWorkflow.php.

Constructor & Destructor Documentation

◆ __construct()

ilEmptyWorkflow::__construct ( )

ilEmptyWorkflow constructor.

Definition at line 23 of file class.ilEmptyWorkflow.php.

24  {
25  $this->workflow_type = 'Empty';
26  $this->workflow_content = 'nothing';
27  $this->workflow_subject_type = 'none';
28  $this->workflow_subject_identifier = '0';
29  $this->workflow_context_type = 'none';
30  $this->workflow_context_id = '0';
31  $this->workflow_class = 'class.ilEmptyWorkflow.php';
32  $this->workflow_location = 'Services/WorkflowEngine/classes/workflows';
33  }

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