ilDataEmitter Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilDataEmitter:

Collaboration diagram for ilDataEmitter:

Public Member Functions
	__construct (ilNode $context)
	Default constructor. More...
	setTargetDetector (ilDetector $target_detector)
	Sets the target detector for this emitter. More...
	getTargetDetector ()
	Gets the currently set target detector of this emitter. More...
	getContext ()
	Returns a reference to the parent node of this emitter. More...
	emit ()
	Executes this emitter after activating the target node. More...
	getActivated ()
	setName ($name)
	getName ()
	getVarName ()
	setVarName ($var_name)
	emit ()
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()

Protected Attributes
	$name
	$var_name

Private Attributes
	$target_detector
	$context
	$emitted

Detailed Description

@noinspection PhpIncludeInspection

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

Author

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

Version

$Id$

/

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

Constructor & Destructor Documentation

__construct()

ilDataEmitter::__construct

(

ilNode

$context

)

Default constructor.

Parameters

ilNode

$context

Reference to the parent node.

Definition at line 51 of file class.ilDataEmitter.php.

        {
                $this->context = $context;
                $this->emitted = false;
        }

References $context.

Member Function Documentation

emit()

ilDataEmitter::emit

(

)

Executes this emitter after activating the target node.

Implements ilEmitter.

Definition at line 90 of file class.ilDataEmitter.php.

        {
                $instance_vars = $this->context->getContext()->getInstanceVars();
 
                $target = $this->var_name;
                foreach($instance_vars as $instance_var)
                {
                        if($instance_var['id'] == $this->var_name)
                        {
                                if($instance_var['reference'])
                                {
                                        $target    = $instance_var['target'];
                                }
                        }
                }
 
                foreach((array)$this->context->getContext()->getInstanceVars() as $value)
                {
                        if($value['id'] == $target)
                        {
                                $this->getContext()->getContext()->setInstanceVarById($target, $value['value']);
                        }
                }
 
                if($this->target_detector instanceof ilDetector)
                {
                        $this->target_detector->trigger(array());
                }
                $this->emitted = true;
        }

References $target, $var_name, and getContext().

Here is the call graph for this function:

getActivated()

ilDataEmitter::getActivated

(

)

Returns

bool

Definition at line 124 of file class.ilDataEmitter.php.

        {
                return $this->emitted;
        }

References $emitted.

getContext()

ilDataEmitter::getContext

(

)

Returns a reference to the parent node of this emitter.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 82 of file class.ilDataEmitter.php.

        {
                return $this->context;
        }

References $context.

Referenced by emit().

Here is the caller graph for this function:

getName()

ilDataEmitter::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 140 of file class.ilDataEmitter.php.

        {
                return $this->name;
        }

References $name.

getTargetDetector()

ilDataEmitter::getTargetDetector

(

)

Gets the currently set target detector of this emitter.

Returns

ilDetector Reference to the target detector.

Definition at line 72 of file class.ilDataEmitter.php.

        {
                return $this->target_detector;
        }

References $target_detector.

getVarName()

ilDataEmitter::getVarName

(

)

Returns

string

Definition at line 148 of file class.ilDataEmitter.php.

        {
                return $this->var_name;
        }

References $var_name.

setName()

ilDataEmitter::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 132 of file class.ilDataEmitter.php.

        {
                $this->name = $name;
        }

References $name.

setTargetDetector()

ilDataEmitter::setTargetDetector

(

ilDetector

$target_detector

)

Sets the target detector for this emitter.

Parameters

ilDetector

$target_detector

Definition at line 62 of file class.ilDataEmitter.php.

        {
                $this->target_detector = $target_detector;
        }

References $target_detector.

setVarName()

ilDataEmitter::setVarName

(

$var_name

)

Parameters

string

$var_name

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

        {
                $this->var_name = $var_name;
        }

References $var_name.

Field Documentation

$context

ilDataEmitter::$context

private

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

Referenced by __construct(), and getContext().

$emitted

ilDataEmitter::$emitted

private

Definition at line 38 of file class.ilDataEmitter.php.

Referenced by getActivated().

$name

string ilDataEmitter::$name

protected

Definition at line 41 of file class.ilDataEmitter.php.

Referenced by getName(), and setName().

$target_detector

ilDataEmitter::$target_detector

private

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

Referenced by getTargetDetector(), and setTargetDetector().

$var_name

string ilDataEmitter::$var_name

protected

Definition at line 44 of file class.ilDataEmitter.php.

Referenced by emit(), getVarName(), and setVarName().

---

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

• Services/WorkflowEngine/classes/emitters/class.ilDataEmitter.php