ILIAS\KeyValueStorage\Subject\SubjectId Class Reference

Identifies a subject within the provider that names it. More...

Collaboration diagram for ILIAS\KeyValueStorage\Subject\SubjectId:

Public Member Functions
	__construct (SubjectProvider $provider, private string $id)
	provider ()
	id ()
	providerClass ()

Data Fields
const int	MAX_LENGTH = 128

Private Member Functions
	assertIdentifier (string $value, int $max_length, string $pattern, string $what)

Private Attributes
string	$provider
string	$provider_class

Detailed Description

Identifies a subject within the provider that names it.

KeyValueStorage validates the format only. It does not assign meaning to the id; that is up to the provider.

Definition at line 29 of file SubjectId.php.

Constructor & Destructor Documentation

__construct()

ILIAS\KeyValueStorage\Subject\SubjectId::__construct	(	SubjectProvider	$provider,
		private string	$id
	)

Definition at line 36 of file SubjectId.php.

    {
        $this->provider = $provider->name();
        $this->provider_class = $provider::class;
 
        $this->assertIdentifier(
            $this->provider,
            SubjectProvider::MAX_NAME_LENGTH,
            '/^[a-z][a-z0-9_]*$/',
            'Subject provider name'
        );
        $this->assertIdentifier($id, self::MAX_LENGTH, '/^[a-z0-9_]+$/', 'Subject id');
    }

References ILIAS\KeyValueStorage\Subject\SubjectId\assertIdentifier(), ILIAS\KeyValueStorage\Subject\SubjectProvider\MAX_NAME_LENGTH, ILIAS\KeyValueStorage\Subject\SubjectProvider\name(), and ILIAS\KeyValueStorage\Subject\SubjectId\provider().

Here is the call graph for this function:

Member Function Documentation

assertIdentifier()

ILIAS\KeyValueStorage\Subject\SubjectId::assertIdentifier ( string  $value, int  $max_length, string  $pattern, string  $what  )

private

Definition at line 69 of file SubjectId.php.

                                                                                                    : void
    {
        if ($value === '') {
            throw new \InvalidArgumentException($what . ' must not be empty.');
        }
 
        $length = \mb_strlen($value, 'UTF-8');
        if ($length > $max_length) {
            throw new \InvalidArgumentException(
                $what . ' must not exceed ' . $max_length . ' characters, got ' . $length . '.'
            );
        }
 
        if (!\preg_match($pattern, $value)) {
            throw new \InvalidArgumentException(
                $what . ' must be a lowercase identifier, got "' . $value . '".'
            );
        }
    }

References $pattern.

Referenced by ILIAS\KeyValueStorage\Subject\SubjectId\__construct().

Here is the caller graph for this function:

id()

ILIAS\KeyValueStorage\Subject\SubjectId::id

(

)

Definition at line 55 of file SubjectId.php.

                        : string
    {
        return $this->id;
    }

References $id.

Referenced by ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\keyOf(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readAllFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeAllFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeSubject(), ILIAS\KeyValueStorage\Internal\StorageServices\subjectScope(), ILIAS\Tests\Authentication\KeyValueStorage\AuthenticatedSubjectPurgeTest\testAPositiveUserIdPurgesThatUserOfTheProvider(), and ILIAS\KeyValueStorage\Internal\DatabaseRepository\writeFor().

Here is the caller graph for this function:

provider()

ILIAS\KeyValueStorage\Subject\SubjectId::provider

(

)

Definition at line 50 of file SubjectId.php.

                              : string
    {
        return $this->provider;
    }

References ILIAS\KeyValueStorage\Subject\SubjectId\$provider.

Referenced by ILIAS\KeyValueStorage\Subject\SubjectId\__construct(), ILIAS\KeyValueStorage\Internal\SubjectProviders\assertRegistered(), ILIAS\Tests\KeyValueStorage\InMemorySubjectRepository\keyOf(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readAllFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\readFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeAllFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeFor(), ILIAS\KeyValueStorage\Internal\DatabaseRepository\removeSubject(), ILIAS\KeyValueStorage\Internal\StorageServices\subjectScope(), ILIAS\Tests\Authentication\KeyValueStorage\AuthenticatedSubjectPurgeTest\testAPositiveUserIdPurgesThatUserOfTheProvider(), and ILIAS\KeyValueStorage\Internal\DatabaseRepository\writeFor().

Here is the caller graph for this function:

providerClass()

ILIAS\KeyValueStorage\Subject\SubjectId::providerClass

(

)

Definition at line 64 of file SubjectId.php.

                                   : string
    {
        return $this->provider_class;
    }

References ILIAS\KeyValueStorage\Subject\SubjectId\$provider_class.

Referenced by ILIAS\KeyValueStorage\Internal\SubjectProviders\assertRegistered().

Here is the caller graph for this function:

Field Documentation

$provider

string ILIAS\KeyValueStorage\Subject\SubjectId::$provider

private

Definition at line 33 of file SubjectId.php.

Referenced by ILIAS\KeyValueStorage\Subject\SubjectId\provider().

$provider_class

string ILIAS\KeyValueStorage\Subject\SubjectId::$provider_class

private

Definition at line 34 of file SubjectId.php.

Referenced by ILIAS\KeyValueStorage\Subject\SubjectId\providerClass().

MAX_LENGTH

const int ILIAS\KeyValueStorage\Subject\SubjectId::MAX_LENGTH = 128

Definition at line 31 of file SubjectId.php.

Referenced by ILIAS\Tests\KeyValueStorage\Subject\SubjectIdTest\testAMultibyteIdLongerThanTheLimitIsRejectedByCharacterCount(), ILIAS\Tests\KeyValueStorage\Subject\SubjectIdTest\testAnIdAtTheLimitIsAccepted(), ILIAS\Tests\KeyValueStorage\Subject\SubjectIdTest\testAnIdLongerThanTheLimitIsRejected(), ILIAS\Tests\KeyValueStorage\Setup\DBUpdateStepsTest\testTheColumnsAreWideEnoughForWhatTheValidationAllows(), and ILIAS\KeyValueStorage\Internal\DatabaseRepository\writeRow().

---

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

• components/ILIAS/KeyValueStorage/src/Subject/SubjectId.php