ilEventRaisingActivity Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilEventRaisingActivity:

Collaboration diagram for ilEventRaisingActivity:

Public Member Functions
	addFixedParam ($key, $value)
	getEventName ()
	setEventName ($event_name)
	getEventType ()
	setEventType ($event_type)
	__construct (ilNode $a_context)
	Default constructor. More...
	getParamsArray ()
	getContext ()
	Returns a reference to the parent node. More...
	setName ($name)
	getName ()
Public Member Functions inherited from ilActivity
	execute ()
	getContext ()
	This method returns the context of the element. More...
	setName ($name)
	getName ()

Protected Attributes
	$event_type
	$event_name
	$fixed_params
	$name

Private Attributes
	$context

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection Class ilEventRaisingActivity

Author

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

Version

$Id$

/

Definition at line 17 of file class.ilEventRaisingActivity.php.

Constructor & Destructor Documentation

__construct()

ilEventRaisingActivity::__construct

(

ilNode

$a_context

)

Default constructor.

Parameters

ilNode

$a_context

Definition at line 80 of file class.ilEventRaisingActivity.php.

    {
        $this->context = $a_context;
        $this->event_type = 'Services/WorkflowEngine';
        $this->event_name = 'nondescript';
    }

Member Function Documentation

addFixedParam()

ilEventRaisingActivity::addFixedParam	(		$key,
			$value
	)

Parameters

string	$key
mixed	$value

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

    {
        $this->fixed_params[] = array('key' => $key, 'value' => $value);
    }

References $key.

getContext()

ilEventRaisingActivity::getContext

(

)

Returns a reference to the parent node.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 125 of file class.ilEventRaisingActivity.php.

    {
        return $this->context;
    }

References $context.

getEventName()

ilEventRaisingActivity::getEventName

(

)

Returns

string

Definition at line 46 of file class.ilEventRaisingActivity.php.

    {
        return $this->event_name;
    }

References $event_name.

getEventType()

ilEventRaisingActivity::getEventType

(

)

Returns

string

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

    {
        return $this->event_type;
    }

References $event_type.

getName()

ilEventRaisingActivity::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 141 of file class.ilEventRaisingActivity.php.

    {
        return $this->name;
    }

References $name.

getParamsArray()

ilEventRaisingActivity::getParamsArray

(

)

Returns

array

Definition at line 110 of file class.ilEventRaisingActivity.php.

    {
        // TODO: Get logic for getting values from incoming data associations.
 
        $params = array();
        $params[] = array('key' => 'context', 'value' => $this);
 
        return array_merge((array) $this->fixed_params, $params);
    }

References $params.

setEventName()

ilEventRaisingActivity::setEventName

(

$event_name

)

Parameters

string

$event_name

Definition at line 54 of file class.ilEventRaisingActivity.php.

    {
        $this->event_name = $event_name;
    }

References $event_name.

setEventType()

ilEventRaisingActivity::setEventType

(

$event_type

)

Parameters

string

$event_type

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

    {
        $this->event_type = $event_type;
    }

References $event_type.

setName()

ilEventRaisingActivity::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 133 of file class.ilEventRaisingActivity.php.

    {
        $this->name = $name;
    }

References $name.

Field Documentation

$context

ilEventRaisingActivity::$context

private

Definition at line 20 of file class.ilEventRaisingActivity.php.

Referenced by getContext().

$event_name

ilEventRaisingActivity::$event_name

protected

Definition at line 26 of file class.ilEventRaisingActivity.php.

Referenced by getEventName(), and setEventName().

$event_type

ilEventRaisingActivity::$event_type

protected

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

Referenced by getEventType(), and setEventType().

$fixed_params

ilEventRaisingActivity::$fixed_params

protected

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

$name

string ilEventRaisingActivity::$name

protected

Definition at line 32 of file class.ilEventRaisingActivity.php.

Referenced by getName(), and setName().

---

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

• Services/WorkflowEngine/classes/activities/class.ilEventRaisingActivity.php