StartEvent_Message Class Reference
Inheritance diagram for StartEvent_Message:
Collaboration diagram for StartEvent_Message:
Public Member Functions | |
| __construct () | |
| Default 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 | |
| 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 | getStartEventInfo () |
| static | getMessageDefinition ($id) |
| Static Public Member Functions inherited from ilBaseWorkflow | |
| static | autoload ($class_name) |
| Autoloader function to dynamically include files for instantiation of objects during deserialization. More... | |
Static Public Attributes | |
| static | $startEventRequired = true |
Additional Inherited Members | |
| 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
Definition at line 6 of file StartEvent_Message_goldsample.php.
Constructor & Destructor Documentation
◆ __construct()
| StartEvent_Message::__construct | ( | ) |
Default constructor.
Here the definition of the workflow is to be done.
Reimplemented from ilBaseWorkflow.
Definition at line 25 of file StartEvent_Message_goldsample.php.
26 {
27
29 $this->addNode($_v_StartEvent_2);
30 $_v_StartEvent_2->setName('$_v_StartEvent_2');
31
33 $_v_StartEvent_2_detector->setName('$_v_StartEvent_2_detector');
34 $_v_StartEvent_2_detector->setEvent( "Course", "UserWasAssigned");
35 $_v_StartEvent_2_detector->setEventSubject( "usr", "0");
36 $_v_StartEvent_2_detector->setEventContext( "crs", "0");
37 $_v_StartEvent_2_detector->setListeningTimeframe(0, 0);
38 }
addNode(ilNode $node)
This method adds a node to the workflow.
Definition: class.ilBaseWorkflow.php:355
References ilBaseWorkflow\addNode().
Here is the call graph for this function:
Member Function Documentation
◆ getMessageDefinition()
|
static |
Definition at line 41 of file StartEvent_Message_goldsample.php.
42 {
43 $definitions = array( 'Message_3' => array(
44 'name' => 'ILIASEvent::Course::UserWasAssigned',
45 'content' => '')
46 );
48 }
References $id.
◆ getStartEventInfo()
|
static |
Definition at line 11 of file StartEvent_Message_goldsample.php.
12 {
13 $events[] = array(
14 'type' => 'Course',
15 'content' => 'UserWasAssigned',
16 'subject_type' => 'usr',
17 'subject_id' => '0',
18 'context_type' => 'crs',
19 'context_id' => '0',
20 );
21
23 }
References $events.
Field Documentation
◆ $startEventRequired
|
static |
Definition at line 9 of file StartEvent_Message_goldsample.php.
The documentation for this class was generated from the following file:
- Services/WorkflowEngine/test/parser/002_StartEvent/StartEvent_Message_goldsample.php
