ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess Class Reference

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

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

Public Member Functions
	__construct (private readonly User $user, private readonly UI $ui, private readonly Routing $routing, private readonly Settings $settings, private readonly Closure $query_parameter, private readonly Provide $legal_documents, private readonly Closure $after_user_withdrawal)
	showValidatePasswordMessage ()
	isOnGoing ()
	withdrawalFinished ()
	showWithdraw (string $gui, string $cmd)

Private Member Functions
	withdrawalRequested ()
	withdraw ()
	cancelWithdrawal ()
	showWithdrawConfirmation (string $gui, string $cmd)
	confirmation (string $gui, string $add_to_question='')
	sendMail ()
	query (string $query_parameter)

Detailed Description

Definition at line 37 of file WithdrawProcess.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::__construct	(	private readonly User	$user,
		private readonly UI	$ui,
		private readonly Routing	$routing,
		private readonly Settings	$settings,
		private readonly Closure	$query_parameter,
		private readonly Provide	$legal_documents,
		private readonly Closure	$after_user_withdrawal
	)

Parameters

Closure(string,Closure(Refinery)	Transformation): mixed $query_parameter
Closure()	void $after_user_withdrawal

Definition at line 43 of file WithdrawProcess.php.

      {
    }

Member Function Documentation

cancelWithdrawal()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::cancelWithdrawal ( )

private

Definition at line 125 of file WithdrawProcess.php.

References ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showWithdraw().

                                       : void
    {
        $this->user->withdrawalRequested()->update(false);
        $this->routing->redirectToOriginalTarget();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmation()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::confirmation ( string  $gui, string  $add_to_question = ''  )

private

Definition at line 149 of file WithdrawProcess.php.

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

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showWithdrawConfirmation().

                                                                            : Component
    {
        $lng_suffix = $this->user->neverAgreed() ? '_no_consent_yet' : '';
        $question = 'withdrawal_sure_account' . $add_to_question . $lng_suffix;

        return $this->ui->create()->messageBox()->confirmation($this->ui->txt($question))->withButtons([
            $this->ui->create()->button()->standard(
                $this->ui->txt('confirm'),
                $this->routing->ctrl()->getLinkTargetByClass($gui, 'indeed')
            ),
            $this->ui->create()->button()->standard(
                $this->ui->txt('cancel'),
                $this->routing->ctrl()->getLinkTargetByClass($gui, 'cancel')
            ),
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isOnGoing()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::isOnGoing

(

)

Implements ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess.

Definition at line 68 of file WithdrawProcess.php.

References ILIAS\Repository\user().

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

Here is the call graph for this function:

query()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::query ( string  $query_parameter )

private

Definition at line 173 of file WithdrawProcess.php.

References $r.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\withdrawalFinished().

                                                   : ?string
    {
        return ($this->query_parameter)($query_parameter, fn(Refinery $r) => $r->byTrying([
            $r->null(),
            $r->to()->string(),
        ]));
    }

Here is the caller graph for this function:

sendMail()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::sendMail ( )

private

Definition at line 166 of file WithdrawProcess.php.

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

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\withdraw().

                               : void
    {
        $mail = new Mail();
        $mail->setRecipients([$this->settings->adminEmail()->value()]);
        $mail->sendGeneric($this->ui->txt('withdrawal_mail_subject'), $this->user->format($this->ui->txt('withdrawal_mail_text')));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showValidatePasswordMessage()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::showValidatePasswordMessage

(

)

Returns

list<Component>

Implements ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess.

Definition at line 54 of file WithdrawProcess.php.

References $lng, null, ILIAS\Repository\ui(), and ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\withdrawalRequested().

                                                 : array
    {
        $status = $this->withdrawalRequested();
        if ($status === null) {
            return [];
        }
        $lng = 'withdraw_consent_description_' . ($status === 'external' ? 'external' : 'internal');

        return [
            $this->ui->create()->divider()->horizontal(),
            $this->ui->create()->legacy()->content($this->ui->txt($lng))
        ];
    }

Here is the call graph for this function:

showWithdraw()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::showWithdraw	(	string	$gui,
		string	$cmd
	)

Implements ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess.

Definition at line 97 of file WithdrawProcess.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\cancelWithdrawal(), ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showWithdrawConfirmation(), and ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\withdraw().

                                                          : PageFragment
    {
        return match ($cmd) {
            'indeed' => $this->withdraw(),
            'cancel' => $this->cancelWithdrawal(),
            '' => $this->showWithdrawConfirmation($gui, $cmd),
        };
    }

Here is the call graph for this function:

showWithdrawConfirmation()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::showWithdrawConfirmation ( string  $gui, string  $cmd  )

private

Definition at line 131 of file WithdrawProcess.php.

References ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\confirmation(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showWithdraw().

                                                                       : PageFragment
    {
        $title = $this->ui->txt('refuse_acceptance');

        if ($this->user->isLDAPUser()) {
            return new PageContent($title, [
                $this->ui->create()->panel()->standard($this->ui->txt('withdraw_usr_agreement'), [
                    $this->confirmation($gui),
                    $this->ui->create()->divider()->horizontal(),
                    $this->ui->create()->legacy()->content(nl2br($this->user->format($this->ui->txt('withdrawal_mail_info') . $this->ui->txt('withdrawal_mail_text'))))
                ])
            ]);
        }

        $deletion = $this->settings->deleteUserOnWithdrawal()->value() ? '_deletion' : '';
        return new PageContent($title, [$this->confirmation($gui, $deletion)]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withdraw()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::withdraw ( )

private

Definition at line 106 of file WithdrawProcess.php.

References null, ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\sendMail(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showWithdraw().

                               : void
    {
        $this->user->agreeDate()->update(null);
        $this->user->withdrawalRequested()->update(false);

        $withdrawal_type = 'default';
        if ($this->user->isLDAPUser()) {
            $this->sendMail();
            $withdrawal_type = 'external';
        } elseif ($this->settings->deleteUserOnWithdrawal()->value()) {
            $this->user->raw()->delete();
            $withdrawal_type = 'delete_user';
        }

        ($this->after_user_withdrawal)();

        $this->legal_documents->withdrawal()->finishAndLogout(['tos_withdrawal_type' => $withdrawal_type]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withdrawalFinished()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::withdrawalFinished

(

)

Implements ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess.

Definition at line 86 of file WithdrawProcess.php.

References null, ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\query(), and ILIAS\Repository\ui().

                                        : void
    {
        $type = $this->query('tos_withdrawal_type');

        $this->ui->mainTemplate()->setOnScreenMessage('info', match ($type) {
            'delete_user' => $this->ui->txt('withdrawal_complete_deleted'),
            'external' => $this->ui->txt('withdrawal_complete_redirect'),
            null, 'default' => $this->ui->txt('withdrawal_complete'),
        });
    }

Here is the call graph for this function:

withdrawalRequested()

ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess::withdrawalRequested ( )

private

Definition at line 73 of file WithdrawProcess.php.

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

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\ConsumerSlots\WithdrawProcess\showValidatePasswordMessage().

                                          : ?string
    {
        if ($this->user->cannotAgree() || $this->user->neverAgreed()) {
            return null;
        }

        $this->user->withdrawalRequested()->update(true);

        $external = $this->user->isExternalAccount();

        return $external ? 'external' : 'internal';
    }

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/WithdrawProcess.php