ILIAS\LegalDocuments\ConsumerToolbox\User Class Reference

Collaboration diagram for ILIAS\LegalDocuments\ConsumerToolbox\User:

Public Member Functions
	__construct (private readonly ilObjUser $user, private readonly Settings $settings, private readonly UserSettings $user_settings, private readonly Provide $legal_documents, private readonly Clock $clock)
	isLoggedIn ()
	cannotAgree ()
	neverAgreed ()
	withdrawalRequested ()
	agreeDate ()
	didNotAcceptCurrentVersion ()
	needsToAcceptNewDocument ()
	doesntMatch (Document $document)
	matchingDocument ()
	acceptedVersion ()
	acceptMatchingDocument ()
	acceptAnyDocument ()
	isLDAPUser ()
	isExternalAccount ()
	format (string $format_string)
	raw ()

Private Member Functions
	authMode ()
	didNotAccept (Document $document)
	lazy (callable $create_value)
	A More...

Private Attributes
readonly Closure	$matching_document

Detailed Description

Definition at line 35 of file User.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\ConsumerToolbox\User::__construct	(	private readonly ilObjUser	$user,
		private readonly Settings	$settings,
		private readonly UserSettings	$user_settings,
		private readonly Provide	$legal_documents,
		private readonly Clock	$clock
	)

Definition at line 40 of file User.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\lazy(), and ILIAS\Repository\user().

      {
        $this->matching_document = $this->lazy(fn() => $this->legal_documents->document()->chooseDocumentFor($this->user));
    }

Here is the call graph for this function:

Member Function Documentation

acceptAnyDocument()

ILIAS\LegalDocuments\ConsumerToolbox\User::acceptAnyDocument

(

)

Definition at line 126 of file User.php.

References ILIAS\Repository\user().

                                       : void
    {
        $this->legal_documents->history()->acceptDocument(
            $this->user,
            current($this->legal_documents->document()->repository()->all())
        );
    }

Here is the call graph for this function:

acceptedVersion()

ILIAS\LegalDocuments\ConsumerToolbox\User::acceptedVersion

(

)

Definition at line 110 of file User.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\cannotAgree(), ILIAS\LegalDocuments\ConsumerToolbox\User\neverAgreed(), and ILIAS\Repository\user().

                                     : Result
    {
        return $this->cannotAgree() || $this->neverAgreed() ?
            new Error('User never agreed.') :
            $this->legal_documents->history()->acceptedVersion($this->user);
    }

Here is the call graph for this function:

acceptMatchingDocument()

ILIAS\LegalDocuments\ConsumerToolbox\User::acceptMatchingDocument

(

)

Definition at line 117 of file User.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\agreeDate(), ILIAS\LegalDocuments\ConsumerToolbox\User\matchingDocument(), and ILIAS\Repository\user().

                                            : void
    {
        $this->legal_documents->history()->acceptDocument(
            $this->user,
            $this->matchingDocument()->value()
        );
        $this->agreeDate()->update($this->clock->now());
    }

Here is the call graph for this function:

agreeDate()

ILIAS\LegalDocuments\ConsumerToolbox\User::agreeDate

(

)

Returns

Setting<?DateTimeImmutable>

Definition at line 76 of file User.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\acceptMatchingDocument(), and ILIAS\LegalDocuments\ConsumerToolbox\User\neverAgreed().

                               : Setting
    {
        return $this->user_settings->agreeDate();
    }

Here is the caller graph for this function:

authMode()

ILIAS\LegalDocuments\ConsumerToolbox\User::authMode ( )

private

Definition at line 159 of file User.php.

References ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\isExternalAccount(), and ILIAS\LegalDocuments\ConsumerToolbox\User\isLDAPUser().

                               : string
    {
        $auth_mode = $this->user->getAuthMode();
        return $auth_mode === 'default' ?
                          $this->settings->authMode()->value() :
                          $auth_mode;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cannotAgree()

ILIAS\LegalDocuments\ConsumerToolbox\User::cannotAgree

(

)

Definition at line 55 of file User.php.

References ANONYMOUS_USER_ID, SYSTEM_USER_ID, and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\acceptedVersion(), and ILIAS\DataProtection\Consumer\showMatchingDocument().

                                 : bool
    {
        return in_array($this->user->getId(), [ANONYMOUS_USER_ID, SYSTEM_USER_ID, 0], true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

didNotAccept()

ILIAS\LegalDocuments\ConsumerToolbox\User::didNotAccept ( Document  $document )

private

Definition at line 167 of file User.php.

References ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\didNotAcceptCurrentVersion().

                                                     : bool
    {
        return !$this->legal_documents->history()->alreadyAccepted($this->user, $document);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

didNotAcceptCurrentVersion()

ILIAS\LegalDocuments\ConsumerToolbox\User::didNotAcceptCurrentVersion

(

)

Definition at line 81 of file User.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\didNotAccept(), ILIAS\LegalDocuments\ConsumerToolbox\User\matchingDocument(), and ILIAS\Repository\settings().

                                                : bool
    {
        $false = fn() => new Ok(false);
        return $this->settings->validateOnLogin()->value() && $this->matchingDocument()->map($this->didNotAccept(...))->except($false)->value();
    }

Here is the call graph for this function:

doesntMatch()

ILIAS\LegalDocuments\ConsumerToolbox\User::doesntMatch

(

Document

$document

)

Definition at line 100 of file User.php.

References ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\needsToAcceptNewDocument().

                                                   : bool
    {
        return !$this->legal_documents->document()->documentMatches($document, $this->user);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

format()

ILIAS\LegalDocuments\ConsumerToolbox\User::format

(

string

$format_string

)

Definition at line 144 of file User.php.

References ILIAS\Repository\user().

                                                 : string
    {
        return str_ireplace('[BR]', "\n", sprintf(
            $format_string,
            $this->user->getFullname(),
            $this->user->getLogin(),
            $this->user->getExternalAccount()
        ));
    }

Here is the call graph for this function:

isExternalAccount()

ILIAS\LegalDocuments\ConsumerToolbox\User::isExternalAccount

(

)

Definition at line 139 of file User.php.

References ilAuthUtils\AUTH_ECS, ilAuthUtils\AUTH_PROVIDER_LTI, and ILIAS\LegalDocuments\ConsumerToolbox\User\authMode().

                                       : bool
    {
        return in_array((int) $this->authMode(), [ilAuthUtils::AUTH_PROVIDER_LTI, ilAuthUtils::AUTH_ECS], true);
    }

Here is the call graph for this function:

isLDAPUser()

ILIAS\LegalDocuments\ConsumerToolbox\User::isLDAPUser

(

)

Definition at line 134 of file User.php.

References ilAuthUtils\AUTH_LDAP, and ILIAS\LegalDocuments\ConsumerToolbox\User\authMode().

                                : bool
    {
        return $this->authMode() === (string) ilAuthUtils::AUTH_LDAP;
    }

Here is the call graph for this function:

isLoggedIn()

ILIAS\LegalDocuments\ConsumerToolbox\User::isLoggedIn

(

)

Definition at line 50 of file User.php.

References ANONYMOUS_USER_ID, and ILIAS\Repository\user().

Referenced by ILIAS\DataProtection\Consumer\showMatchingDocument().

                                : bool
    {
        return !in_array($this->user->getId(), [ANONYMOUS_USER_ID, 0], true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lazy()

ILIAS\LegalDocuments\ConsumerToolbox\User::lazy ( callable  $create_value )

private

A

Parameters

callable()

A $create_value

Returns

Closure(): A

Definition at line 177 of file User.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\__construct().

                                                 : Closure
    {
        $proc = function () use (&$proc, $create_value) {
            $value = $create_value();
            $proc = fn() => $value;
            return $value;
        };
        return function () use (&$proc) {
            return $proc();
        };
    }

Here is the caller graph for this function:

matchingDocument()

ILIAS\LegalDocuments\ConsumerToolbox\User::matchingDocument

(

)

Definition at line 105 of file User.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\acceptMatchingDocument(), ILIAS\LegalDocuments\ConsumerToolbox\User\didNotAcceptCurrentVersion(), and ILIAS\DataProtection\Consumer\showMatchingDocument().

                                      : Result
    {
        return ($this->matching_document)();
    }

Here is the caller graph for this function:

needsToAcceptNewDocument()

ILIAS\LegalDocuments\ConsumerToolbox\User::needsToAcceptNewDocument

(

)

Definition at line 87 of file User.php.

References ILIAS\$db, ILIAS\LegalDocuments\ConsumerToolbox\User\doesntMatch(), ILIAS\LegalDocuments\ConsumerToolbox\User\neverAgreed(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

                                              : bool
    {
        if ($this->neverAgreed()) {
            return true;
        }

        $true = fn() => new Ok(true);
        $db = $this->legal_documents->history();

        return $this->settings->validateOnLogin()->value()
            && $db->currentDocumentOfAcceptedVersion($this->user)->map($this->doesntMatch(...))->except($true)->value();
    }

Here is the call graph for this function:

neverAgreed()

ILIAS\LegalDocuments\ConsumerToolbox\User::neverAgreed

(

)

Definition at line 60 of file User.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\agreeDate().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\User\acceptedVersion(), and ILIAS\LegalDocuments\ConsumerToolbox\User\needsToAcceptNewDocument().

                                 : bool
    {
        return null === $this->agreeDate()->value();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

raw()

ILIAS\LegalDocuments\ConsumerToolbox\User::raw

(

)

Definition at line 154 of file User.php.

                         : ilObjUser
    {
        return $this->user;
    }

withdrawalRequested()

ILIAS\LegalDocuments\ConsumerToolbox\User::withdrawalRequested

(

)

Returns

Setting<bool>

Definition at line 68 of file User.php.

                                         : Setting
    {
        return $this->user_settings->withdrawalRequested();
    }

Field Documentation

$matching_document

readonly Closure ILIAS\LegalDocuments\ConsumerToolbox\User::$matching_document

private

Definition at line 38 of file User.php.

---

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

• components/ILIAS/LegalDocuments/classes/ConsumerToolbox/User.php