ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement Class Reference

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

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

Public Member Functions
	__construct (private readonly User $user, private readonly UI $ui, private readonly Routing $routing, private readonly Closure $with_request)
	showAgreement (string $gui, string $cmd)
	showAgreementForm (string $gui, string $cmd)
	needsToAgree ()

Private Member Functions
	showDocument ()
	agreementForm (string $gui, string $cmd)
	logoutLink ()

Detailed Description

Definition at line 37 of file Agreement.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::__construct	(	private readonly User	$user,
		private readonly UI	$ui,
		private readonly Routing	$routing,
		private readonly Closure	$with_request
	)

Parameters

Closure(Form,Closure(array)

void): Form $with_request

Definition at line 42 of file Agreement.php.

      {
    }

Member Function Documentation

agreementForm()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::agreementForm ( string  $gui, string  $cmd  )

private

Definition at line 95 of file Agreement.php.

References $accept, $data, $url, ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showAgreementForm().

                                                            : Component
    {
        $url = $this->routing->ctrl()->getFormActionByClass($gui, $cmd);
        $form = $this->ui->create()->input()->container()->form()->standard($url, [
            'accept?' => $this->ui->create()->input()->field()->radio($this->ui->txt('accept_usr_agreement'))
                                  ->withOption('yes', $this->ui->txt('accept_usr_agreement_btn'))
                                  ->withOption('no', $this->ui->txt('deny_usr_agreement_btn'))
        ]);

        return ($this->with_request)($form, function (array $data) {
            $accept = $data['accept?'] ?? '';
            if ($accept === 'no') {
                $this->routing->ctrl()->redirectToURL($this->routing->logoutUrl());
            } elseif ($accept === 'yes') {
                $this->user->acceptMatchingDocument();
                $this->routing->redirectToOriginalTarget();
            }
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

logoutLink()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::logoutLink ( )

private

Definition at line 115 of file Agreement.php.

References ILIAS\Repository\ui().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showAgreementForm().

                                 : Component
    {
        return $this->ui->create()->button()->standard($this->ui->txt('logout'), $this->routing->logoutUrl());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

needsToAgree()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::needsToAgree

(

)

Implements ILIAS\LegalDocuments\ConsumerSlots\Agreement.

Definition at line 78 of file Agreement.php.

References ILIAS\Repository\user().

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

Here is the call graph for this function:

showAgreement()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::showAgreement	(	string	$gui,
		string	$cmd
	)

Implements ILIAS\LegalDocuments\ConsumerSlots\Agreement.

Definition at line 50 of file Agreement.php.

References $info, ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showDocument(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

                                                           : PageFragment
    {
        $title = 'accept_usr_agreement_anonymous';
        $info = 'accept_usr_agreement_anonymous_intro';
        if ($this->user->isLoggedIn()) {
            $title = 'usr_agreement';
            $info = 'usr_agreement_footer_intro';
        }
        return (new PageContent($this->ui->txt($title), [$this->showDocument()]))->withOnScreenMessage('info', $this->ui->txt($info));
    }

Here is the call graph for this function:

showAgreementForm()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::showAgreementForm	(	string	$gui,
		string	$cmd
	)

Implements ILIAS\LegalDocuments\ConsumerSlots\Agreement.

Definition at line 61 of file Agreement.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\agreementForm(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\logoutLink(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showDocument(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

                                                               : PageFragment
    {
        $form = $this->user->matchingDocument()->isOk() ?
              $this->agreementForm($gui, $cmd) :
              $this->ui->create()->divider()->horizontal();

        $content = (new PageContent($this->ui->txt('accept_usr_agreement'), [
            $this->showDocument(),
            $form,
            $this->logoutLink(),
        ]));

        return $this->user->matchingDocument()->isOk() ?
            $content->withOnScreenMessage('info', $this->ui->txt('accept_usr_agreement_intro')) :
            $content;
    }

Here is the call graph for this function:

showDocument()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement::showDocument ( )

private

Definition at line 84 of file Agreement.php.

References ILIAS\LegalDocuments\Value\Document\content(), ilSystemSupportContacts\getMailsToAddress(), ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showAgreement(), and ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\Agreement\showAgreementForm().

                                   : Component
    {
        return $this->user
            ->matchingDocument()
            ->map(fn(Document $document) => $this->ui->create()->legacy()->content($document->content()->value()))
            ->except(fn() => new Ok($this->ui->create()->legacy()->content(sprintf(
                $this->ui->txt('no_agreement_description'),
                'mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(ilSystemSupportContacts::getMailsToAddress())
            ))))->value();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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