ILIAS\TermsOfService\Consumer Class Reference

Inheritance diagram for ILIAS\TermsOfService\Consumer:

Collaboration diagram for ILIAS\TermsOfService\Consumer:

Public Member Functions
	__construct (?Container $container=null)
	id ()
	uses (UseSlot $slot, LazyProvide $provide)
	@template A More...
	uses (UseSlot $slot, LazyProvide $provide)
	@template A More...
	id ()

Data Fields
const	ID = 'tos'
const	GOTO_NAME = 'agreement'

Private Member Functions
	userHasWithdrawn ()
	usersWhoDidntAgree (ilDBInterface $database)

Private Attributes
readonly Container	$container

Detailed Description

Definition at line 34 of file Consumer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\TermsOfService\Consumer::__construct

(

?Container

$container = null

)

Definition at line 41 of file Consumer.php.

    {
        $this->container = $container ?? $GLOBALS['DIC'] ?? new Container();
    }

References ILIAS\TermsOfService\Consumer\$container, and $GLOBALS.

Member Function Documentation

id()

ILIAS\TermsOfService\Consumer::id

(

)

Implements ILIAS\LegalDocuments\Consumer.

Definition at line 46 of file Consumer.php.

                        : string
    {
        return self::ID;
    }

References ILIAS\TermsOfService\Consumer\ID.

userHasWithdrawn()

ILIAS\TermsOfService\Consumer::userHasWithdrawn ( )

private

Definition at line 83 of file Consumer.php.

                                       : void
    {
        $this->container['ilAppEventHandler']->raise(
            'components/ILIAS/TermsOfService',
            'withdraw',
            ['event' => $this->container->user()]
        );
    }

usersWhoDidntAgree()

ILIAS\TermsOfService\Consumer::usersWhoDidntAgree ( ilDBInterface  $database )

private

Definition at line 92 of file Consumer.php.

                                                                : Closure
    {
        return function (array $users) use ($database): array {
            $users = $database->in('usr_id', $users, false, ilDBConstants::T_INTEGER);
            $result = $database->query('SELECT usr_id FROM usr_data WHERE agree_date IS NULL AND ' . $users);
 
            return array_map(intval(...), array_column($database->fetchAll($result), 'usr_id'));
        };
    }

References ilDBInterface\fetchAll(), ilDBInterface\in(), ilDBInterface\query(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

uses()

ILIAS\TermsOfService\Consumer::uses	(	UseSlot	$slot,
		LazyProvide	$provide
	)

@template A

Parameters

UseSlot<A>

$slot

Returns

UseSlot

Implements ILIAS\LegalDocuments\Consumer.

Definition at line 51 of file Consumer.php.

                                                             : UseSlot
    {
        $blocks = new Blocks($this->id(), $this->container, $provide);
        $default = $blocks->defaultMappings();
        $global_settings = new Settings($blocks->selectSettingsFrom($blocks->readOnlyStore($blocks->globalStore())));
        $is_active = $global_settings->enabled()->value();
        $build_user = fn(ilObjUser $user) => $blocks->user($global_settings, new UserSettings($user, $blocks->selectSettingsFrom(
            $blocks->userStore($user)
        ), $this->container->refinery()), $user);
        $public_api = new PublicApi($is_active, $build_user);
        $slot = $slot->hasDocuments($default->contentAsComponent(), $default->conditionDefinitions())
                     ->hasHistory()
                     ->hasPublicApi($public_api);
 
        if (!$is_active) {
            return $slot->hasPublicPage($blocks->notAvailable(...), self::GOTO_NAME);
        }
 
        $user = $build_user($this->container->user());
        $constraint = $this->container->refinery()->custom()->constraint(...);
 
        return $slot->canWithdraw($blocks->slot()->withdrawProcess($user, $global_settings, $this->userHasWithdrawn(...)))
                    ->hasAgreement($blocks->slot()->agreement($user), self::GOTO_NAME)
                    ->showInFooter($blocks->slot()->modifyFooter($user, self::GOTO_NAME))
                    ->showOnLoginPage($blocks->slot()->showOnLoginPage())
                    ->onSelfRegistration($blocks->slot()->selfRegistration($user, $build_user))
                    ->hasOnlineStatusFilter($blocks->slot()->onlineStatusFilter($this->usersWhoDidntAgree($this->container->database())))
                    ->hasUserManagementFields($blocks->userManagementAgreeDateField($build_user, 'tos_agree_date', 'tos'))
                    ->canReadInternalMails($blocks->slot()->canReadInternalMails($build_user))
                    ->canUseSoapApi($constraint(fn($u) => !$public_api->needsToAgree($u), 'TOS not accepted.'));
    }

References ILIAS\LegalDocuments\UseSlot\canWithdraw(), ILIAS\LegalDocuments\UseSlot\hasDocuments(), and ILIAS\LegalDocuments\UseSlot\hasPublicPage().

Here is the call graph for this function:

Field Documentation

$container

readonly Container ILIAS\TermsOfService\Consumer::$container

private

Definition at line 36 of file Consumer.php.

Referenced by ILIAS\TermsOfService\Consumer\__construct().

GOTO_NAME

const ILIAS\TermsOfService\Consumer::GOTO_NAME = 'agreement'

Definition at line 39 of file Consumer.php.

ID

const ILIAS\TermsOfService\Consumer::ID = 'tos'

Definition at line 38 of file Consumer.php.

Referenced by ILIAS\TermsOfService\Consumer\id(), and ILIAS\TermsOfService\test\ConsumerTest\testId().

---

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

• components/ILIAS/TermsOfService/classes/Consumer.php