ILIAS\DataProtection\Consumer Class Reference

Inheritance diagram for ILIAS\DataProtection\Consumer:

Collaboration diagram for ILIAS\DataProtection\Consumer:

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

Data Fields
const	ID = 'dpro'
const	GOTO_NAME = 'data_protection'

Private Member Functions
	showMatchingDocument (User $user, UI $ui, Provide $legal_documents)
	userHasWithdrawn ()
	usersWhoDidntAgree (ilDBInterface $database)

Private Attributes
readonly Container	$container

Detailed Description

Definition at line 42 of file Consumer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\DataProtection\Consumer::__construct

(

?Container

$container = null

)

Definition at line 49 of file Consumer.php.

References $GLOBALS.

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

Member Function Documentation

id()

ILIAS\DataProtection\Consumer::id

(

)

Implements ILIAS\LegalDocuments\Consumer.

Definition at line 54 of file Consumer.php.

                        : string
    {
        return self::ID;
    }

showMatchingDocument()

ILIAS\DataProtection\Consumer::showMatchingDocument ( User  $user, UI  $ui, Provide  $legal_documents  )

private

Definition at line 101 of file Consumer.php.

References ILIAS\LegalDocuments\ConsumerToolbox\User\cannotAgree(), ILIAS\LegalDocuments\Value\Document\content(), ILIAS\LegalDocuments\ConsumerToolbox\UI\create(), ILIAS\LegalDocuments\Provide\document(), ILIAS\LegalDocuments\ConsumerToolbox\User\isLoggedIn(), ILIAS\LegalDocuments\ConsumerToolbox\User\matchingDocument(), null, and ILIAS\LegalDocuments\ConsumerToolbox\UI\txt().

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

                                                                                       : Closure
    {
        return function (Closure $footer) use ($user, $ui, $legal_documents) {
            $in_footer = fn($v) => $footer('usr_agreement', $ui->txt('usr_agreement'), $v);
            if (!$user->isLoggedIn()) {
                return $in_footer(new URI(ilLink::_getLink(null, 'usr', [], self::GOTO_NAME)));
            }
            if ($user->cannotAgree()) {
                return $footer;
            }

            $render = fn(Document $document): Closure => $in_footer($ui->create()->modal()->roundtrip(
                $document->content()->title(),
                [$legal_documents->document()->contentAsComponent($document->content())]
            ));

            return $user->matchingDocument()
                        ->map($render)
                        ->except(fn() => new Ok($footer))->value();
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userHasWithdrawn()

ILIAS\DataProtection\Consumer::userHasWithdrawn ( )

private

Definition at line 123 of file Consumer.php.

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

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

Here is the caller graph for this function:

usersWhoDidntAgree()

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

private

Definition at line 132 of file Consumer.php.

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

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

                                                                : 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_pref WHERE keyword = "dpro_agree_date" AND (value IS NULL OR value = "false" OR value = "") AND ' . $users
            );

            return array_map(intval(...), array_column($database->fetchAll($result), 'usr_id'));
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uses()

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

A

Parameters

UseSlot<A>

$slot

Returns

UseSlot

Implements ILIAS\LegalDocuments\Consumer.

Definition at line 59 of file Consumer.php.

References ILIAS\LegalDocuments\UseSlot\hasDocuments(), ILIAS\LegalDocuments\UseSlot\hasPublicPage(), ILIAS\DataProtection\Consumer\showMatchingDocument(), ILIAS\LegalDocuments\UseSlot\showOnLoginPage(), ILIAS\DataProtection\Consumer\userHasWithdrawn(), and ILIAS\DataProtection\Consumer\usersWhoDidntAgree().

                                                             : 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(
            $blocks->selectSettingsFrom($blocks->userStore($user))
        ), $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());

        $slot = $slot->showOnLoginPage($blocks->slot()->showOnLoginPage());

        $agreement = $blocks->slot()->agreement($user);
        $constraint = $this->container->refinery()->custom()->constraint(...);

        if ($global_settings->noAcceptance()->value()) {
            $slot = $slot->showInFooter($this->showMatchingDocument($user, $blocks->ui(), $provide))
                         ->hasPublicPage($agreement->showAgreement(...), self::GOTO_NAME);
        } else {
            $slot = $slot->canWithdraw($blocks->slot()->withdrawProcess($user, $global_settings, $this->userHasWithdrawn(...)))
                         ->hasAgreement($agreement, self::GOTO_NAME)
                         ->showInFooter($blocks->slot()->modifyFooter($user, self::GOTO_NAME))
                         ->onSelfRegistration($blocks->slot()->selfRegistration($user, $build_user))
                         ->hasOnlineStatusFilter($blocks->slot()->onlineStatusFilter($this->usersWhoDidntAgree($this->container->database())))
                         ->hasUserManagementFields($blocks->userManagementAgreeDateField($build_user, 'dpro_agree_date', 'dpro'))
                         ->canReadInternalMails($blocks->slot()->canReadInternalMails($build_user))
                         ->canUseSoapApi($constraint(fn($u) => !$public_api->needsToAgree($u), 'Data Protection not agreed.'));
        }

        return $slot;
    }

Here is the call graph for this function:

Field Documentation

$container

readonly Container ILIAS\DataProtection\Consumer::$container

private

Definition at line 47 of file Consumer.php.

GOTO_NAME

const ILIAS\DataProtection\Consumer::GOTO_NAME = 'data_protection'

Definition at line 45 of file Consumer.php.

ID

const ILIAS\DataProtection\Consumer::ID = 'dpro'

Definition at line 44 of file Consumer.php.

Referenced by ILIAS\DataProtection\test\ConsumerTest\testId().

---

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

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