ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi Class Reference

Inheritance diagram for ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi:

Collaboration diagram for ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi:

Public Member Functions
	__construct (private readonly bool $active, private readonly Closure $build_user)
	active ()
	Returns wether or not the corresponding consumer is active. More...
	agreed (ilObjUser $user)
	agreedToCurrentlyMatchingDocument (ilObjUser $user)
	everAgreed (ilObjUser $user)
	canAgree (ilObjUser $user)
	needsToAgree (ilObjUser $user)
	agreeDate (ilObjUser $user)

Private Member Functions
	user (ilObjUser $user)

Private Attributes
readonly WeakMap	$cache

Detailed Description

Definition at line 30 of file PublicApi.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::__construct	(	private readonly bool	$active,
		private readonly Closure	$build_user
	)

Definition at line 37 of file PublicApi.php.

    {
        $this->cache = new WeakMap();
    }

Member Function Documentation

active()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::active

(

)

Returns wether or not the corresponding consumer is active.

Please note that this doesn't influence the other methods.

Implements ILIAS\LegalDocuments\ConsumerSlots\PublicApi.

Definition at line 46 of file PublicApi.php.

                            : bool
    {
        return $this->active;
    }

agreed()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::agreed

(

ilObjUser

$user

)

Implements ILIAS\LegalDocuments\ConsumerSlots\PublicApi.

Definition at line 51 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\everAgreed().

                                           : bool
    {
        return $this->everAgreed($user);
    }

Here is the call graph for this function:

agreeDate()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::agreeDate

(

ilObjUser

$user

)

Definition at line 77 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\user().

                                              : ?DateTimeImmutable
    {
        return $this->user($user)->agreeDate()->value();
    }

Here is the call graph for this function:

agreedToCurrentlyMatchingDocument()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::agreedToCurrentlyMatchingDocument

(

ilObjUser

$user

)

Definition at line 56 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\user().

                                                                      : bool
    {
        return !$this->user($user)->needsToAcceptNewDocument();
    }

Here is the call graph for this function:

canAgree()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::canAgree

(

ilObjUser

$user

)

Definition at line 66 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\needsToAgree().

                                             : bool
    {
        return !$this->user($user)->cannotAgree();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

everAgreed()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::everAgreed

(

ilObjUser

$user

)

Definition at line 61 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\agreed().

                                               : bool
    {
        return !$this->user($user)->neverAgreed();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

needsToAgree()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::needsToAgree

(

ilObjUser

$user

)

Definition at line 71 of file PublicApi.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\canAgree(), and ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\user().

                                                 : bool
    {
        return $this->canAgree($user)
            && $this->user($user)->needsToAcceptNewDocument();
    }

Here is the call graph for this function:

user()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::user ( ilObjUser  $user )

private

Definition at line 82 of file PublicApi.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\agreeDate(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\agreedToCurrentlyMatchingDocument(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\canAgree(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\everAgreed(), and ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi\needsToAgree().

                                          : User
    {
        if (!isset($this->cache[$user])) {
            $this->cache[$user] = ($this->build_user)($user);
        }

        return $this->cache[$user];
    }

Here is the caller graph for this function:

Field Documentation

$cache

readonly WeakMap ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\PublicApi::$cache

private

Definition at line 35 of file PublicApi.php.

---

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

• components/ILIAS/LegalDocuments/classes/ConsumerToolbox/ConsumerSlots/PublicApi.php