ilSettingActivity Class Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilSettingActivity:

Collaboration diagram for ilSettingActivity:

Public Member Functions
	__construct (ilNode $context)
	Default constructor. More...
	setSettingName ($name)
	Sets the name of the setting to be written to. More...
	getSettingName ()
	Returns the name of the setting to be written to. More...
	setSettingValue ($value)
	getSettingValue ()
	Returns the value of the setting to be set. More...
	setSetting ($name, $value)
	Sets the setting name and value for this activity. More...
	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
	$name

Private Attributes
	$context
	$setting_name = ''
	$setting_value = ''

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection Class ilSettingActivity

This activity sets a given setting to the $ilSetting object. Design consideration is to configure this object during workflow creation, since this is called only under predictable circumstances.

Author

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

Version

$Id$

/

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

Constructor & Destructor Documentation

__construct()

ilSettingActivity::__construct

(

ilNode

$context

)

Default constructor.

Parameters

ilNode

$context

Definition at line 52 of file class.ilSettingActivity.php.

    {
        $this->context = $context;
    }

References $context.

Member Function Documentation

getContext()

ilSettingActivity::getContext

(

)

Returns a reference to the parent node.

Returns

ilNode Reference to the parent node.

Implements ilWorkflowEngineElement.

Definition at line 144 of file class.ilSettingActivity.php.

    {
        return $this->context;
    }

References $context.

getName()

ilSettingActivity::getName

(

)

Returns

string

Implements ilWorkflowEngineElement.

Definition at line 160 of file class.ilSettingActivity.php.

    {
        return $this->name;
    }

References $name.

getSettingName()

ilSettingActivity::getSettingName

(

)

Returns the name of the setting to be written to.

See also

$setting_name

Returns

string

Definition at line 78 of file class.ilSettingActivity.php.

    {
        return $this->setting_name;
    }

References $setting_name.

getSettingValue()

ilSettingActivity::getSettingValue

(

)

Returns the value of the setting to be set.

See also

$setting_value

Returns

string

Definition at line 104 of file class.ilSettingActivity.php.

    {
        return $this->setting_value;
    }

References $setting_value.

setName()

ilSettingActivity::setName

(

$name

)

Parameters

string

$name

Implements ilWorkflowEngineElement.

Definition at line 152 of file class.ilSettingActivity.php.

    {
        $this->name = $name;
    }

References $name.

setSetting()

ilSettingActivity::setSetting	(		$name,
			$value
	)

Sets the setting name and value for this activity.

Parameters

string	$name	Name of the setting.
string	$value	Value to be set.

Returns

void

Definition at line 117 of file class.ilSettingActivity.php.

    {
        $this->setSettingName($name);
        $this->setSettingValue($value);
    }

References $name, setSettingName(), and setSettingValue().

Here is the call graph for this function:

setSettingName()

ilSettingActivity::setSettingName

(

$name

)

Sets the name of the setting to be written to.

See also

$setting_name

Parameters

string

$name

Name of the setting.

Returns

void

Definition at line 66 of file class.ilSettingActivity.php.

    {
        $this->setting_name = $name;
    }

References $name.

Referenced by setSetting().

Here is the caller graph for this function:

setSettingValue()

ilSettingActivity::setSettingValue

(

$value

)

Definition at line 92 of file class.ilSettingActivity.php.

    {
        $this->setting_value = $value;
    }

Referenced by setSetting().

Here is the caller graph for this function:

Field Documentation

$context

ilSettingActivity::$context

private

Definition at line 24 of file class.ilSettingActivity.php.

Referenced by __construct(), and getContext().

$name

string ilSettingActivity::$name

protected

Definition at line 45 of file class.ilSettingActivity.php.

Referenced by getName(), setName(), setSetting(), and setSettingName().

$setting_name

ilSettingActivity::$setting_name = ''

private

Definition at line 33 of file class.ilSettingActivity.php.

Referenced by getSettingName().

$setting_value

ilSettingActivity::$setting_value = ''

private

Definition at line 42 of file class.ilSettingActivity.php.

Referenced by getSettingValue().

---

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

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