Keeps key-value storage in the ILIAS session. More...

Inheritance diagram for ILIAS\Authentication\KeyValueStorage\SessionRepository:

Collaboration diagram for ILIAS\Authentication\KeyValueStorage\SessionRepository:

Public Member Functions
	has (StorageNamespace $namespace, string $key)

	read (StorageNamespace $namespace, string $key)

	readAll (StorageNamespace $namespace)
	Every present entry of one namespace. More...

	write (StorageNamespace $namespace, string $key, string $value)

	remove (StorageNamespace $namespace, string $key)

	removeAll (StorageNamespace $namespace)

	has (StorageNamespace $namespace, string $key)

	read (StorageNamespace $namespace, string $key)

	readAll (StorageNamespace $namespace)
	Every present entry of one namespace. More...

	write (StorageNamespace $namespace, string $key, string $value)

	remove (StorageNamespace $namespace, string $key)

	removeAll (StorageNamespace $namespace)

Private Member Functions
	sessionKey (StorageNamespace $namespace, string $key)

	namespacePrefix (StorageNamespace $namespace)

Private Attributes
const string	PREFIX = 'kvs:'

const string	SEPARATOR = ':'

Detailed Description

Keeps key-value storage in the ILIAS session.

Every entry is a session variable of its own, named "<prefix><namespace>:<key>". ilSession only knows single keys - it can neither list nor clear by prefix - so one nested array per namespace would mean reading and writing the whole array on every single write. Flat keys keep a write to one entry, at the price of scanning the session when a whole namespace is read or dropped, which happens rarely.

The colon is what separates namespace from key: it cannot occur in a namespace, and keys must not contain it, so no pair of namespace and key can ever produce the session key of another pair.

Definition at line 40 of file SessionRepository.php.

Member Function Documentation

◆ has()

ILIAS\Authentication\KeyValueStorage\SessionRepository::has	(	StorageNamespace	$namespace,
		string	$key
	)

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 46 of file SessionRepository.php.

                                                                 : bool
    {
        return \ilSession::has($this->sessionKey($namespace, $key));
    }

References ILIAS\GlobalScreen\has(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\sessionKey().

Here is the call graph for this function:

◆ namespacePrefix()

ILIAS\Authentication\KeyValueStorage\SessionRepository::namespacePrefix ( StorageNamespace $namespace )

private

Definition at line 106 of file SessionRepository.php.

                                                                 : string
    {
        return self::PREFIX . $namespace->value() . self::SEPARATOR;
    }

References ILIAS\Authentication\KeyValueStorage\SessionRepository\SEPARATOR, and ILIAS\KeyValueStorage\Internal\StorageNamespace\value().

Referenced by ILIAS\Authentication\KeyValueStorage\SessionRepository\readAll(), ILIAS\Authentication\KeyValueStorage\SessionRepository\removeAll(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\sessionKey().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ILIAS\Authentication\KeyValueStorage\SessionRepository::read	(	StorageNamespace	$namespace,
		string	$key
	)

Returns: string|null null if the key is not present

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 51 of file SessionRepository.php.

                                                                  : ?string
    {
        $value = \ilSession::get($this->sessionKey($namespace, $key));
 
        return \is_string($value) ? $value : null;
    }

References ilSession\get(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\sessionKey().

Here is the call graph for this function:

◆ readAll()

ILIAS\Authentication\KeyValueStorage\SessionRepository::readAll ( StorageNamespace $namespace )

Every present entry of one namespace.

Returns: array<string, string> key => stored string; empty if the namespace holds nothing

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 58 of file SessionRepository.php.

                                                        : array
    {
        $prefix = $this->namespacePrefix($namespace);
        $prefix_length = \strlen($prefix);
        $entries = [];
 
        foreach (\ilSession::keys() as $session_key) {
            if (!\str_starts_with($session_key, $prefix)) {
                continue;
            }
 
            $value = \ilSession::get($session_key);
            if (!\is_string($value)) {
                continue;
            }
 
            $entries[\substr($session_key, $prefix_length)] = $value;
        }
 
        return $entries;
    }

References ilSession\get(), ilSession\keys(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\namespacePrefix().

Here is the call graph for this function:

◆ remove()

ILIAS\Authentication\KeyValueStorage\SessionRepository::remove	(	StorageNamespace	$namespace,
		string	$key
	)

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 85 of file SessionRepository.php.

                                                                    : void
    {
        \ilSession::clear($this->sessionKey($namespace, $key));
    }

References ilSession\clear(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\sessionKey().

Here is the call graph for this function:

◆ removeAll()

ILIAS\Authentication\KeyValueStorage\SessionRepository::removeAll ( StorageNamespace $namespace )

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 90 of file SessionRepository.php.

                                                          : void
    {
        $prefix = $this->namespacePrefix($namespace);
 
        foreach (\ilSession::keys() as $session_key) {
            if (\str_starts_with($session_key, $prefix)) {
                \ilSession::clear($session_key);
            }
        }
    }

References ilSession\clear(), ilSession\keys(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\namespacePrefix().

Here is the call graph for this function:

◆ sessionKey()

ILIAS\Authentication\KeyValueStorage\SessionRepository::sessionKey	(	StorageNamespace	$namespace,
		string	$key
	)

private

Definition at line 101 of file SessionRepository.php.

                                                                         : string
    {
        return $this->namespacePrefix($namespace) . $key;
    }

References ILIAS\Authentication\KeyValueStorage\SessionRepository\namespacePrefix().

Referenced by ILIAS\Authentication\KeyValueStorage\SessionRepository\has(), ILIAS\Authentication\KeyValueStorage\SessionRepository\read(), ILIAS\Authentication\KeyValueStorage\SessionRepository\remove(), and ILIAS\Authentication\KeyValueStorage\SessionRepository\write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

ILIAS\Authentication\KeyValueStorage\SessionRepository::write	(	StorageNamespace	$namespace,
		string	$key,
		string	$value
	)

Implements ILIAS\KeyValueStorage\Repository.

Definition at line 80 of file SessionRepository.php.

                                                                                  : void
    {
        \ilSession::set($this->sessionKey($namespace, $key), $value);
    }

References ILIAS\Authentication\KeyValueStorage\SessionRepository\sessionKey(), and ilSession\set().

Here is the call graph for this function:

Field Documentation

◆ PREFIX

const string ILIAS\Authentication\KeyValueStorage\SessionRepository::PREFIX = 'kvs:'

private

Definition at line 42 of file SessionRepository.php.

◆ SEPARATOR

const string ILIAS\Authentication\KeyValueStorage\SessionRepository::SEPARATOR = ':'

private

Definition at line 44 of file SessionRepository.php.

Referenced by ILIAS\Authentication\KeyValueStorage\SessionRepository\namespacePrefix().

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

components/ILIAS/Authentication/src/KeyValueStorage/SessionRepository.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ has()

◆ namespacePrefix()

◆ read()

◆ readAll()

◆ remove()

◆ removeAll()

◆ sessionKey()

◆ write()

Field Documentation

◆ PREFIX

◆ SEPARATOR