ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
Public Member Functions | Protected Attributes
ilBaseNode Class Reference

@noinspection PhpIncludeInspection More...

+ Inheritance diagram for ilBaseNode:
+ Collaboration diagram for ilBaseNode:

Public Member Functions

 addDetector (ilDetector $detector)
 Adds a detector to the list of detectors. More...
 
 getDetectors ()
 Returns all currently set detectors. More...
 
 addEmitter (ilEmitter $emitter)
 Adds an emitter to the list of emitters. More...
 
 getEmitters ()
 Returns all currently set emitters. More...
 
 addActivity (ilActivity $activity)
 Adds an activity to the list of activities. More...
 
 getActivities ()
 Returns all currently set activities. More...
 
 getContext ()
 Returns a reference to the parent workflow object. More...
 
 setName ($name)
 
 getName ()
 
 getRuntimeVars ()
 
 setRuntimeVars ($runtime_vars)
 
 getRuntimeVar ($name)
 
 setRuntimeVar ($name, $value)
 
 onActivate ()
 Method called on activation of the node. More...
 
 onDeactivate ()
 Method calles on deactivation of the node. More...
 
 isActive ()
 Returns the activation status of the node. More...
 
 attemptTransition ()
 
 checkTransitionPreconditions ()
 
 executeTransition ()
 
 activate ()
 
 deactivate ()
 
 notifyDetectorSatisfaction (ilDetector $detector)
 
 attemptTransition ()
 
 checkTransitionPreconditions ()
 
 executeTransition ()
 
 addDetector (ilDetector $detector)
 
 addEmitter (ilEmitter $emitter)
 
 addActivity (ilActivity $activity)
 
 activate ()
 
 deactivate ()
 
 onActivate ()
 
 onDeactivate ()
 
 notifyDetectorSatisfaction (ilDetector $detector)
 
 getDetectors ()
 
 getEmitters ()
 
 getRuntimeVars ()
 
 setRuntimeVars ($runtime_vars)
 
 getRuntimeVar ($name)
 
 setRuntimeVar ($name, $value)
 
 getContext ()
 This method returns the context of the element. More...
 
 setName ($name)
 
 getName ()
 

Protected Attributes

 $context
 
 $detectors
 
 $emitters
 
 $activities
 
 $active = false
 
 $name
 
 $runtime_vars
 

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection @noinspection PhpIncludeInspection @noinspection PhpIncludeInspection @noinspection PhpIncludeInspection Class ilBaseNode

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

Definition at line 22 of file class.ilBaseNode.php.

Member Function Documentation

◆ activate()

ilBaseNode::activate ( )
abstract
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ addActivity()

ilBaseNode::addActivity ( ilActivity  $activity)

Adds an activity to the list of activities.

Parameters
ilActivity$activity

Implements ilNode.

Definition at line 111 of file class.ilBaseNode.php.

112 {
113 $this->activities[] = $activity;
114 }

◆ addDetector()

ilBaseNode::addDetector ( ilDetector  $detector)

Adds a detector to the list of detectors.

Parameters
ilDetector$detector

Implements ilNode.

Definition at line 70 of file class.ilBaseNode.php.

71 {
72 $this->detectors[] = $detector;
73 $this->context->registerDetector($detector);
74 }

◆ addEmitter()

ilBaseNode::addEmitter ( ilEmitter  $emitter)

Adds an emitter to the list of emitters.

Parameters
ilEmitter$emitter

Implements ilNode.

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

92 {
93 $this->emitters[] = $emitter;
94 }

◆ attemptTransition()

ilBaseNode::attemptTransition ( )
abstract
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ checkTransitionPreconditions()

ilBaseNode::checkTransitionPreconditions ( )
abstract
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ deactivate()

ilBaseNode::deactivate ( )
abstract
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ executeTransition()

ilBaseNode::executeTransition ( )
abstract
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ getActivities()

ilBaseNode::getActivities ( )

Returns all currently set activities.

Returns
ilActivity[] Array with objects of ilActivity

Definition at line 121 of file class.ilBaseNode.php.

122 {
123 return $this->activities;
124 }

References $activities.

◆ getContext()

ilBaseNode::getContext ( )

Returns a reference to the parent workflow object.

Returns
\ilWorkflow

Implements ilWorkflowEngineElement.

Definition at line 131 of file class.ilBaseNode.php.

132 {
133 return $this->context;
134 }

References $context.

◆ getDetectors()

ilBaseNode::getDetectors ( )

Returns all currently set detectors.

Returns
ilDetector[] Array with objects of ilDetector

Implements ilNode.

Definition at line 81 of file class.ilBaseNode.php.

82 {
83 return $this->detectors;
84 }

References $detectors.

◆ getEmitters()

ilBaseNode::getEmitters ( )

Returns all currently set emitters.

Returns
ilEmitter[] Array with objects of ilEmitter

Implements ilNode.

Definition at line 101 of file class.ilBaseNode.php.

102 {
103 return $this->emitters;
104 }

References $emitters.

◆ getName()

ilBaseNode::getName ( )
Returns
string

Implements ilWorkflowEngineElement.

Definition at line 147 of file class.ilBaseNode.php.

148 {
149 return $this->name;
150 }

References $name.

◆ getRuntimeVar()

ilBaseNode::getRuntimeVar (   $name)
Parameters
string$name
Returns
array

Implements ilNode.

Definition at line 173 of file class.ilBaseNode.php.

174 {
175 return $this->runtime_vars[$name];
176 }

References $name.

◆ getRuntimeVars()

ilBaseNode::getRuntimeVars ( )
Returns
array

Implements ilNode.

Definition at line 155 of file class.ilBaseNode.php.

156 {
157 return $this->runtime_vars;
158 }

References $runtime_vars.

◆ isActive()

ilBaseNode::isActive ( )

Returns the activation status of the node.

Returns
boolean Activation status of the node.

Definition at line 212 of file class.ilBaseNode.php.

213 {
214 return $this->active;
215 }

References $active.

Referenced by ilBasicNode\activate(), ilBasicNode\notifyDetectorSatisfaction(), ilCaseNode\notifyDetectorSatisfaction(), ilConditionalNode\notifyDetectorSatisfaction(), and ilPluginNode\notifyDetectorSatisfaction().

+ Here is the caller graph for this function:

◆ notifyDetectorSatisfaction()

ilBaseNode::notifyDetectorSatisfaction ( ilDetector  $detector)
abstract
Parameters
\ilDetector$detector
Returns
mixed

Implements ilNode.

Reimplemented in ilBasicNode, ilCaseNode, ilConditionalNode, and ilPluginNode.

◆ onActivate()

ilBaseNode::onActivate ( )

Method called on activation of the node.

Returns
void

Implements ilNode.

Definition at line 192 of file class.ilBaseNode.php.

193 {
194 return;
195 }

Referenced by ilBasicNode\activate(), ilCaseNode\activate(), ilConditionalNode\activate(), and ilPluginNode\activate().

+ Here is the caller graph for this function:

◆ onDeactivate()

ilBaseNode::onDeactivate ( )

Method calles on deactivation of the node.

Returns
void

Implements ilNode.

Definition at line 202 of file class.ilBaseNode.php.

203 {
204 return;
205 }

Referenced by ilBasicNode\deactivate(), ilCaseNode\deactivate(), ilConditionalNode\deactivate(), and ilPluginNode\deactivate().

+ Here is the caller graph for this function:

◆ setName()

ilBaseNode::setName (   $name)
Parameters
string$name
Returns
mixed

Implements ilWorkflowEngineElement.

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

140 {
141 $this->name = $name;
142 }

References $name.

◆ setRuntimeVar()

ilBaseNode::setRuntimeVar (   $name,
  $value 
)
Parameters
string$name
mixed$value

Implements ilNode.

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

183 {
184 $this->runtime_vars[$name] = $value;
185 }

References $name.

◆ setRuntimeVars()

ilBaseNode::setRuntimeVars (   $runtime_vars)
Parameters
array$runtime_vars

Implements ilNode.

Definition at line 163 of file class.ilBaseNode.php.

164 {
165 $this->runtime_vars = $runtime_vars;
166 }

References $runtime_vars.

Field Documentation

◆ $active

ilBaseNode::$active = false
protected

Definition at line 57 of file class.ilBaseNode.php.

Referenced by isActive().

◆ $activities

ilBaseNode::$activities
protected

Definition at line 50 of file class.ilBaseNode.php.

Referenced by ilConditionalNode\getActivities(), ilPluginNode\getActivities(), and getActivities().

◆ $context

ilBaseNode::$context
protected

Definition at line 29 of file class.ilBaseNode.php.

Referenced by ilBasicNode\__construct(), ilCaseNode\__construct(), ilPluginNode\__construct(), and getContext().

◆ $detectors

ilBaseNode::$detectors
protected

Definition at line 36 of file class.ilBaseNode.php.

Referenced by ilConditionalNode\attemptTransition(), ilPluginNode\attemptTransition(), ilConditionalNode\checkTransitionPreconditions(), ilPluginNode\checkTransitionPreconditions(), and getDetectors().

◆ $emitters

ilBaseNode::$emitters
protected

Definition at line 43 of file class.ilBaseNode.php.

Referenced by ilConditionalNode\getEmitters(), ilPluginNode\getEmitters(), and getEmitters().

◆ $name

string ilBaseNode::$name
protected

Definition at line 60 of file class.ilBaseNode.php.

Referenced by getName(), getRuntimeVar(), setName(), and setRuntimeVar().

◆ $runtime_vars

array ilBaseNode::$runtime_vars
protected

Definition at line 63 of file class.ilBaseNode.php.

Referenced by getRuntimeVars(), and setRuntimeVars().

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