Names the fully authenticated ILIAS users as KeyValueStorage subjects; the subject id is the user id. More...

Inheritance diagram for ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider:

Collaboration diagram for ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider:

Public Member Functions
	name ()
	Unique among all providers, a lowercase identifier, e.g. More...

	subjectFor (int $user_id)

	name ()
	Unique among all providers, a lowercase identifier, e.g. More...

Data Fields
const string	NAME = 'authentication'

Data Fields inherited from ILIAS\KeyValueStorage\Subject\SubjectProvider
const int	MAX_NAME_LENGTH = 64

Detailed Description

Names the fully authenticated ILIAS users as KeyValueStorage subjects; the subject id is the user id.

This names a subject. It does not discover who is logged in; that answer is {

See also: \ILIAS\Authentication\Domain\AuthenticatedUserid()}.

Definition at line 33 of file AuthenticatedUserSubjectProvider.php.

Member Function Documentation

◆ name()

ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider::name ( )

Unique among all providers, a lowercase identifier, e.g.

"authentication".

Implements ILIAS\KeyValueStorage\Subject\SubjectProvider.

Definition at line 37 of file AuthenticatedUserSubjectProvider.php.

                          : string
    {
        return self::NAME;
    }

References ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider\NAME.

◆ subjectFor()

ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider::subjectFor ( int $user_id )

Definition at line 42 of file AuthenticatedUserSubjectProvider.php.

                                            : SubjectId
    {
        if ($user_id <= 0) {
            throw new \InvalidArgumentException('User ID must be positive, got ' . $user_id . '.');
        }
 
        return new SubjectId($this, (string) $user_id);
    }

References $user_id.

Field Documentation

◆ NAME

const string ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider::NAME = 'authentication'

Definition at line 35 of file AuthenticatedUserSubjectProvider.php.

Referenced by ILIAS\Authentication\KeyValueStorage\AuthenticatedUserSubjectProvider\name(), ILIAS\Tests\Authentication\KeyValueStorage\SessionAuthenticatedSubjectResolverTest\testALoggedInUserBecomesTheSubjectOfItsIdAndMayPersist(), and ILIAS\Tests\Authentication\KeyValueStorage\AuthenticatedSubjectPurgeTest\testAPositiveUserIdPurgesThatUserOfTheProvider().

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

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