SessionRepository.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Authentication\KeyValueStorage;
 
use ILIAS\KeyValueStorage\SessionRepository as KeyValueSessionRepository;
use ILIAS\KeyValueStorage\Internal\StorageNamespace;
 
final readonly class SessionRepository implements KeyValueSessionRepository
{
    private const string PREFIX = 'kvs:';
 
    private const string SEPARATOR = ':';
 
    public function has(StorageNamespace $namespace, string $key): bool
    {
        return \ilSession::has($this->sessionKey($namespace, $key));
    }
 
    public function read(StorageNamespace $namespace, string $key): ?string
    {
        $value = \ilSession::get($this->sessionKey($namespace, $key));
 
        return \is_string($value) ? $value : null;
    }
 
    public function readAll(StorageNamespace $namespace): 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;
    }
 
    public function write(StorageNamespace $namespace, string $key, string $value): void
    {
        \ilSession::set($this->sessionKey($namespace, $key), $value);
    }
 
    public function remove(StorageNamespace $namespace, string $key): void
    {
        \ilSession::clear($this->sessionKey($namespace, $key));
    }
 
    public function removeAll(StorageNamespace $namespace): void
    {
        $prefix = $this->namespacePrefix($namespace);
 
        foreach (\ilSession::keys() as $session_key) {
            if (\str_starts_with($session_key, $prefix)) {
                \ilSession::clear($session_key);
            }
        }
    }
 
    private function sessionKey(StorageNamespace $namespace, string $key): string
    {
        return $this->namespacePrefix($namespace) . $key;
    }
 
    private function namespacePrefix(StorageNamespace $namespace): string
    {
        return self::PREFIX . $namespace->value() . self::SEPARATOR;
    }
}