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)

Protected Attributes
	$context

	$detectors

	$emitters

	$activities

	$active = false

	$name

	$runtime_vars

Detailed Description

PhpIncludeInspection

PhpIncludeInspection PhpIncludeInspection PhpIncludeInspection 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.

Referenced by isActive().

Here is the caller graph for this function:

◆ 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.

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

◆ 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.

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

◆ 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.

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

◆ attemptTransition()

ilBaseNode::attemptTransition ( )

abstract

Returns: mixed

Implements ilNode.

Referenced by isActive().

Here is the caller graph for this function:

◆ checkTransitionPreconditions()

ilBaseNode::checkTransitionPreconditions ( )

abstract

Returns: mixed

Implements ilNode.

Referenced by isActive().

Here is the caller graph for this function:

◆ deactivate()

ilBaseNode::deactivate ( )

abstract

Returns: mixed

Implements ilNode.

Referenced by isActive().

Here is the caller graph for this function:

◆ executeTransition()

ilBaseNode::executeTransition ( )

abstract

Returns: mixed

Implements ilNode.

Referenced by isActive().

Here is the caller graph for this function:

◆ getActivities()

ilBaseNode::getActivities ( )

Returns all currently set activities.

Returns: ilActivity[] Array with objects of ilActivity

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

References $activities.

         {
                 return $this->activities;
         }

◆ getContext()

ilBaseNode::getContext ( )

Returns a reference to the parent workflow object.

Returns

Implements ilWorkflowEngineElement.

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

References $context.

         {
                 return $this->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.

References $detectors.

         {
                 return $this->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.

References $emitters.

         {
                 return $this->emitters;
         }

◆ getName()

ilBaseNode::getName ( )

Returns: string

Implements ilWorkflowEngineElement.

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

References $name.

         {
                 return $this->name;
         }

◆ getRuntimeVar()

ilBaseNode::getRuntimeVar ( $name )

Parameters

string $name

Returns: array

Implements ilNode.

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

References $name.

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

◆ getRuntimeVars()

ilBaseNode::getRuntimeVars ( )

Returns: array

Implements ilNode.

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

References $runtime_vars.

         {
                 return $this->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.

References $active, activate(), attemptTransition(), checkTransitionPreconditions(), deactivate(), executeTransition(), and notifyDetectorSatisfaction().

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

         {
                 return $this->active;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ notifyDetectorSatisfaction()

ilBaseNode::notifyDetectorSatisfaction ( ilDetector $detector )

abstract

Parameters

\ilDetector $detector

Returns: mixed

Implements ilNode.

Referenced by isActive().

Here is the caller graph for this function:

◆ onActivate()

ilBaseNode::onActivate ( )

Method called on activation of the node.

Returns: void

Implements ilNode.

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

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

         {
                 return;
         }

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.

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

         {
                 return;
         }

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.

References $name.

         {
                 $this->name = $name;
         }

◆ setRuntimeVar()

ilBaseNode::setRuntimeVar	(	$name,
		$value
	)

Parameters

string	$name
mixed	$value

Implements ilNode.

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

References $name.

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

◆ setRuntimeVars()

ilBaseNode::setRuntimeVars ( $runtime_vars )

Parameters

array $runtime_vars

Implements ilNode.

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

References $runtime_vars.

         {
                 $this->runtime_vars = $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 getActivities(), ilPluginNode\getActivities(), and ilConditionalNode\getActivities().

◆ $context

ilBaseNode::$context

protected

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

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

◆ $detectors

ilBaseNode::$detectors

protected

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

Referenced by getDetectors().

◆ $emitters

ilBaseNode::$emitters

protected

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

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

◆ $name

ilBaseNode::$name

protected

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

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

◆ $runtime_vars

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:

Services/WorkflowEngine/classes/nodes/class.ilBaseNode.php

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ activate()

◆ addActivity()

◆ addDetector()

◆ addEmitter()

◆ attemptTransition()

◆ checkTransitionPreconditions()

◆ deactivate()

◆ executeTransition()

◆ getActivities()

◆ getContext()

◆ getDetectors()

◆ getEmitters()

◆ getName()

◆ getRuntimeVar()

◆ getRuntimeVars()

◆ isActive()

◆ notifyDetectorSatisfaction()

◆ onActivate()

◆ onDeactivate()

◆ setName()

◆ setRuntimeVar()

◆ setRuntimeVars()

Field Documentation

◆ $active

◆ $activities

◆ $context

◆ $detectors

◆ $emitters

◆ $name

◆ $runtime_vars