ILIAS\KioskMode\State Class Reference

Keeps the state of a view in a simple stringly type key-value store. More...

Collaboration diagram for ILIAS\KioskMode\State:

Public Member Functions
	withValueFor (string $key, string $value)
	Set a value for a key of the state. More...
	withoutKey (string $key)
	Remove the key-value-pair. More...
	getValueFor (string $key)
	Get the value for the given key. More...
	serialize ()
	Get the key-value store as string. More...

Protected Attributes
array	$store = null

Detailed Description

Keeps the state of a view in a simple stringly type key-value store.

Definition at line 26 of file State.php.

Member Function Documentation

getValueFor()

ILIAS\KioskMode\State::getValueFor

(

string

$key

)

Get the value for the given key.

Definition at line 56 of file State.php.

                                            : ?string
    {
        if (!$this->store) {
            return null;
        }
        return $this->store[$key];
    }

Referenced by StateTest\testValue().

Here is the caller graph for this function:

serialize()

ILIAS\KioskMode\State::serialize

(

)

Get the key-value store as string.

Definition at line 67 of file State.php.

                               : string
    {
        return json_encode($this->store, JSON_THROW_ON_ERROR);
    }

Referenced by StateTest\testRemoveValue(), and StateTest\testSerialize().

Here is the caller graph for this function:

withoutKey()

ILIAS\KioskMode\State::withoutKey

(

string

$key

)

Remove the key-value-pair.

Definition at line 46 of file State.php.

                                           : State
    {
        $clone = clone $this;
        unset($clone->store[$key]);
        return $clone;
    }

Referenced by StateTest\testRemoveValue().

Here is the caller graph for this function:

withValueFor()

ILIAS\KioskMode\State::withValueFor	(	string	$key,
		string	$value
	)

Set a value for a key of the state.

Definition at line 36 of file State.php.

                                                            : State
    {
        $clone = clone $this;
        $clone->store[$key] = $value;
        return $clone;
    }

Referenced by ilLearningModuleKioskModeView\buildInitialState(), StateTest\testRemoveValue(), StateTest\testValue(), and ilLearningModuleKioskModeView\updateGet().

Here is the caller graph for this function:

Field Documentation

$store

array ILIAS\KioskMode\State::$store = null

protected

Definition at line 31 of file State.php.

---

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

• components/ILIAS/KioskMode/src/State.php