ILIAS\KeyValueStorage\Internal\NamespacedStore Class Reference

A store bound to one namespace of one repository. More...

Inheritance diagram for ILIAS\KeyValueStorage\Internal\NamespacedStore:

Collaboration diagram for ILIAS\KeyValueStorage\Internal\NamespacedStore:

Public Member Functions
	__construct (private readonly StorageNamespace $namespace, private readonly Repository $repository, private readonly KeyRules $key_rules, private readonly Values $values)
	has (string $key)
	Reads the value along, so that a following get() does not read again. More...
	get (string $key, Transformation $transformation)
	Reads a value and applies a Refinery transformation, like HTTP request wrappers. More...
	getMany (array $transformations)
	Reads several known keys, each with its own Refinery transformation. More...
	keys ()
	The keys this namespace currently holds, sorted as strings. More...
	set (string $key, mixed $value)
	delete (string $key)
	clear ()
	Removes every entry of this namespace, and only of this namespace. More...
	has (string $key)
	Reads the value along, so that a following get() does not read again. More...
	get (string $key, Transformation $transformation)
	Reads a value and applies a Refinery transformation, like HTTP request wrappers. More...
	getMany (array $transformations)
	Reads several known keys, each with its own Refinery transformation. More...
	keys ()
	The keys this namespace currently holds, sorted as strings. More...
	set (string $key, mixed $value)
	delete (string $key)
	clear ()
	Removes every entry of this namespace, and only of this namespace. More...

Private Member Functions
	readDecoded (string $key)
	mustLoadNamespaceFor (array $requested)
	loadNamespace ()

Private Attributes
array	$seen = []
bool	$namespace_loaded = false
	True once every entry of the namespace has been read. More...

Detailed Description

A store bound to one namespace of one repository.

Validates the keys, encodes the values and remembers what it has already seen during this request, so that reading the same key twice does not hit the session or the database twice. Reading the keys of the namespace or several keys at once remembers every key of it. This is not a cross-request cache - use ILIAS\Cache for that.

Definition at line 38 of file NamespacedStore.php.

Constructor & Destructor Documentation

__construct()

ILIAS\KeyValueStorage\Internal\NamespacedStore::__construct	(	private readonly StorageNamespace	$namespace,
		private readonly Repository	$repository,
		private readonly KeyRules	$key_rules,
		private readonly Values	$values
	)

Definition at line 53 of file NamespacedStore.php.

      {
    }

Member Function Documentation

clear()

ILIAS\KeyValueStorage\Internal\NamespacedStore::clear

(

)

Removes every entry of this namespace, and only of this namespace.

Implements ILIAS\KeyValueStorage\Store.

Definition at line 151 of file NamespacedStore.php.

                           : void
    {
        $this->repository->removeAll($this->namespace);
        $this->seen = [];
        $this->namespace_loaded = false;
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

delete()

ILIAS\KeyValueStorage\Internal\NamespacedStore::delete

(

string

$key

)

Exceptions

InvalidArgumentException if the key is invalid

Implements ILIAS\KeyValueStorage\Store.

Definition at line 143 of file NamespacedStore.php.

                                       : void
    {
        $this->key_rules->check($key);
 
        $this->repository->remove($this->namespace, $key);
        $this->seen[$key] = [false, null];
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

get()

ILIAS\KeyValueStorage\Internal\NamespacedStore::get	(	string	$key,
		Transformation	$transformation
	)

Reads a value and applies a Refinery transformation, like HTTP request wrappers.

Absent keys are passed to the transformation as null.

Exceptions

InvalidArgumentException if the key is invalid

Exceptions

Exception

InvalidStoredValueException if the stored value cannot be read back

Implements ILIAS\KeyValueStorage\Store.

Definition at line 70 of file NamespacedStore.php.

                                                                    : mixed
    {
        $this->key_rules->check($key);
 
        [$is_present, $value] = $this->readDecoded($key);
 
        return $transformation->transform($is_present ? $value : null);
    }

References ILIAS\KeyValueStorage\Internal\NamespacedStore\readDecoded().

Here is the call graph for this function:

getMany()

ILIAS\KeyValueStorage\Internal\NamespacedStore::getMany

(

array

$transformations

)

Reads several known keys, each with its own Refinery transformation.

The result has the same keys as the given map, in the same order. Absent keys are passed to their transformation as null, like {

See also

self::get()}. Keys that the namespace holds besides those named here are left out.

Parameters

array<string,Transformation>

$transformations

Returns

array<string, mixed>

Exceptions

InvalidArgumentException if a key is invalid or an entry is not a transformation

Exceptions

Exception

InvalidStoredValueException if a stored value cannot be read back

Implements ILIAS\KeyValueStorage\Store.

Definition at line 79 of file NamespacedStore.php.

                                                   : array
    {
        $requested = [];
        foreach ($transformations as $key => $transformation) {
            $key = (string) $key;
            if (!$transformation instanceof Transformation) {
                throw new \InvalidArgumentException(
                    'Each getMany() entry must be a ' . Transformation::class . ', got '
                    . \get_debug_type($transformation) . ' for key "' . $key . '".'
                );
            }
            $this->key_rules->check($key);
            $requested[$key] = $transformation;
        }
 
        if ($this->mustLoadNamespaceFor($requested)) {
            $this->loadNamespace();
        }
 
        $entries = [];
        foreach ($requested as $key => $transformation) {
            $key = (string) $key;
            [$is_present, $value] = $this->readDecoded($key);
            $entries[$key] = $transformation->transform($is_present ? $value : null);
        }
 
        return $entries;
    }

References ILIAS\KeyValueStorage\Internal\NamespacedStore\loadNamespace(), ILIAS\KeyValueStorage\Internal\NamespacedStore\mustLoadNamespaceFor(), and ILIAS\KeyValueStorage\Internal\NamespacedStore\readDecoded().

Here is the call graph for this function:

has()

ILIAS\KeyValueStorage\Internal\NamespacedStore::has

(

string

$key

)

Reads the value along, so that a following get() does not read again.

Exceptions

InvalidArgumentException if the key is invalid

Exceptions

Exception

InvalidStoredValueException if the stored value cannot be read back

Implements ILIAS\KeyValueStorage\Store.

Definition at line 61 of file NamespacedStore.php.

                                    : bool
    {
        $this->key_rules->check($key);
 
        // reads the value along, since consumers like `$storage[$key] ?? null`
        // ask has() right before get().
        return $this->readDecoded($key)[0];
    }

References ILIAS\KeyValueStorage\Internal\NamespacedStore\readDecoded().

Here is the call graph for this function:

keys()

ILIAS\KeyValueStorage\Internal\NamespacedStore::keys

(

)

The keys this namespace currently holds, sorted as strings.

Returns

list<string>

Implements ILIAS\KeyValueStorage\Store.

Definition at line 108 of file NamespacedStore.php.

                          : array
    {
        $this->loadNamespace();
 
        $keys = [];
        foreach ($this->seen as $key => [$is_present]) {
            if ($is_present) {
                $keys[] = (string) $key;
            }
        }
 
        \sort($keys, \SORT_STRING);
 
        return $keys;
    }

References ILIAS\KeyValueStorage\Internal\NamespacedStore\loadNamespace(), and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

loadNamespace()

ILIAS\KeyValueStorage\Internal\NamespacedStore::loadNamespace ( )

private

Definition at line 195 of file NamespacedStore.php.

                                    : void
    {
        if ($this->namespace_loaded) {
            return;
        }
 
        $decoded = [];
        foreach ($this->repository->readAll($this->namespace) as $key => $stored) {
            $key = (string) $key;
            if (isset($this->seen[$key])) {
                continue;
            }
 
            $decoded[$key] = [true, $this->values->decode($stored)];
        }
 
        $this->seen += $decoded;
        $this->namespace_loaded = true;
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by ILIAS\KeyValueStorage\Internal\NamespacedStore\getMany(), and ILIAS\KeyValueStorage\Internal\NamespacedStore\keys().

Here is the call graph for this function:

Here is the caller graph for this function:

mustLoadNamespaceFor()

ILIAS\KeyValueStorage\Internal\NamespacedStore::mustLoadNamespaceFor ( array  $requested )

private

Parameters

array<string,Transformation>

$requested

Definition at line 180 of file NamespacedStore.php.

                                                           : bool
    {
        if ($requested === [] || $this->namespace_loaded) {
            return false;
        }
 
        foreach ($requested as $key => $_) {
            if (!isset($this->seen[(string) $key])) {
                return true;
            }
        }
 
        return false;
    }

Referenced by ILIAS\KeyValueStorage\Internal\NamespacedStore\getMany().

Here is the caller graph for this function:

readDecoded()

ILIAS\KeyValueStorage\Internal\NamespacedStore::readDecoded ( string  $key )

private

Returns

array{bool, mixed}

Definition at line 161 of file NamespacedStore.php.

                                             : array
    {
        if (!isset($this->seen[$key])) {
            if ($this->namespace_loaded) {
                $this->seen[$key] = [false, null];
            } else {
                $stored = $this->repository->read($this->namespace, $key);
                $this->seen[$key] = $stored === null
                    ? [false, null]
                    : [true, $this->values->decode($stored)];
            }
        }
 
        return $this->seen[$key];
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by ILIAS\KeyValueStorage\Internal\NamespacedStore\get(), ILIAS\KeyValueStorage\Internal\NamespacedStore\getMany(), and ILIAS\KeyValueStorage\Internal\NamespacedStore\has().

Here is the call graph for this function:

Here is the caller graph for this function:

set()

ILIAS\KeyValueStorage\Internal\NamespacedStore::set	(	string	$key,
		mixed	$value
	)

Exceptions

InvalidArgumentException if the key is invalid or the value cannot be stored

Implements ILIAS\KeyValueStorage\Store.

Definition at line 124 of file NamespacedStore.php.

                                                  : void
    {
        $this->key_rules->check($key);
 
        $encoded = $this->values->encode($value);
        // the decoded form is remembered, so that reading a value back within
        // this request yields exactly what a later request would read.
        $decoded = $this->values->decode($encoded);
 
        // consumers like the UI tables store their state on every rendering, which
        // must not become a write per page view when nothing changed.
        if (($this->seen[$key] ?? null) === [true, $decoded]) {
            return;
        }
 
        $this->repository->write($this->namespace, $key, $encoded);
        $this->seen[$key] = [true, $decoded];
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Field Documentation

$namespace_loaded

bool ILIAS\KeyValueStorage\Internal\NamespacedStore::$namespace_loaded = false

private

True once every entry of the namespace has been read.

Later lookups of keys this request has not touched can then be answered without the backend.

Definition at line 51 of file NamespacedStore.php.

$seen

array ILIAS\KeyValueStorage\Internal\NamespacedStore::$seen = []

private

Definition at line 45 of file NamespacedStore.php.

---

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

• components/ILIAS/KeyValueStorage/src/Internal/NamespacedStore.php