ILIAS\KeyValueStorage\Internal\StorageNamespace Class Reference

Isolates the keys of one consumer from every other consumer of a storage. More...

Inheritance diagram for ILIAS\KeyValueStorage\Internal\StorageNamespace:

Collaboration diagram for ILIAS\KeyValueStorage\Internal\StorageNamespace:

Public Member Functions
	__construct (array $segments)
	value ()
	__toString ()

Data Fields
const int	MAX_LENGTH = 128

Private Attributes
const string	SEPARATOR = '.'
const string	FORBIDDEN_PATTERN = '/[\x00-\x1F\x7F' . self::SEPARATOR . KeyRules::SEPARATOR . ']/'
	Characters that must not appear inside a segment: the segment separator, {. More...
string	$value

Detailed Description

Isolates the keys of one consumer from every other consumer of a storage.

Built from namespace segments so consumers of {

See also

\ILIAS\KeyValueStorage\Services} never choose the delimiter. Repositories receive this value object on the port boundary.

Segments are otherwise permissive: the only characters rejected are those that would break composition — the segment separator, the namespace/key separator used by repositories, and control characters.

Definition at line 36 of file StorageNamespace.php.

Constructor & Destructor Documentation

__construct()

ILIAS\KeyValueStorage\Internal\StorageNamespace::__construct

(

array

$segments

)

Parameters

list<string>

$segments

Definition at line 53 of file StorageNamespace.php.

    {
        if ($segments === []) {
            throw new \InvalidArgumentException('A storage namespace must not be empty.');
        }
 
        foreach ($segments as $index => $segment) {
            if (!\is_string($segment)) {
                throw new \InvalidArgumentException(
                    'A storage namespace segment must be a string, got ' . \get_debug_type($segment)
                    . ' at position ' . $index . '.'
                );
            }
 
            if ($segment === '') {
                throw new \InvalidArgumentException('A storage namespace segment must not be empty.');
            }
 
            if (\preg_match(self::FORBIDDEN_PATTERN, $segment) === 1) {
                throw new \InvalidArgumentException(
                    'A storage namespace segment must not contain "' . self::SEPARATOR . '", "'
                    . KeyRules::SEPARATOR . '" or control characters, got "' . $segment . '".'
                );
            }
        }
 
        $value = \implode(self::SEPARATOR, $segments);
 
        $length = \mb_strlen($value, 'UTF-8');
        if ($length > self::MAX_LENGTH) {
            throw new \InvalidArgumentException(
                'A storage namespace must not be longer than ' . self::MAX_LENGTH
                . ' characters, got ' . $length . '.'
            );
        }
 
        $this->value = $value;
    }

References ILIAS\KeyValueStorage\Internal\StorageNamespace\$value, ILIAS\KeyValueStorage\Internal\KeyRules\SEPARATOR, and ILIAS\KeyValueStorage\Internal\StorageNamespace\value().

Here is the call graph for this function:

Member Function Documentation

__toString()

ILIAS\KeyValueStorage\Internal\StorageNamespace::__toString

(

)

Definition at line 97 of file StorageNamespace.php.

                                : string
    {
        return $this->value;
    }

References ILIAS\KeyValueStorage\Internal\StorageNamespace\$value.

value()

ILIAS\KeyValueStorage\Internal\StorageNamespace::value

(

)

Definition at line 92 of file StorageNamespace.php.

                           : string
    {
        return $this->value;
    }

References ILIAS\KeyValueStorage\Internal\StorageNamespace\$value.

Referenced by ILIAS\KeyValueStorage\Internal\StorageNamespace\__construct(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\has(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\hasFor(), ILIAS\Authentication\KeyValueStorage\SessionRepository\namespacePrefix(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\read(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\readAll(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\readAllFor(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\readFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readRow(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readRows(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\remove(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\removeAll(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\removeAllFor(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\removeFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeRow(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeRows(), ILIAS\KeyValueStorage\Internal\StorageServices\store(), ILIAS\Tests\KeyValueStorage\InMemoryRepository\write(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\writeFor(), and ILIAS\KeyValueStorage\Internal\DatabaseRepository\writeRow().

Here is the caller graph for this function:

Field Documentation

$value

string ILIAS\KeyValueStorage\Internal\StorageNamespace::$value

private

Definition at line 48 of file StorageNamespace.php.

Referenced by ILIAS\KeyValueStorage\Internal\StorageNamespace\__construct(), ILIAS\KeyValueStorage\Internal\StorageNamespace\__toString(), and ILIAS\KeyValueStorage\Internal\StorageNamespace\value().

FORBIDDEN_PATTERN

const string ILIAS\KeyValueStorage\Internal\StorageNamespace::FORBIDDEN_PATTERN = '/[\x00-\x1F\x7F' . self::SEPARATOR . KeyRules::SEPARATOR . ']/'

private

Characters that must not appear inside a segment: the segment separator, {.

See also

KeyRules::SEPARATOR}, and ASCII control characters.

Definition at line 46 of file StorageNamespace.php.

MAX_LENGTH

const int ILIAS\KeyValueStorage\Internal\StorageNamespace::MAX_LENGTH = 128

Definition at line 38 of file StorageNamespace.php.

Referenced by ILIAS\Tests\KeyValueStorage\Internal\StorageNamespaceTest\invalidNamespaces(), ILIAS\Tests\KeyValueStorage\Setup\DBUpdateStepsTest\testTheColumnsAreWideEnoughForWhatTheValidationAllows(), ILIAS\Tests\KeyValueStorage\Internal\DatabaseRepositoryTest\testWriteRejectsANamespaceLongerThanTheColumn(), ILIAS\Tests\KeyValueStorage\Internal\StorageNamespaceTest\validNamespaces(), and ILIAS\KeyValueStorage\Internal\DatabaseRepository\writeRow().

SEPARATOR

const string ILIAS\KeyValueStorage\Internal\StorageNamespace::SEPARATOR = '.'

private

Definition at line 40 of file StorageNamespace.php.

---

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

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