ILIAS\LegalDocuments\ConsumerToolbox\Blocks Class Reference

Collaboration diagram for ILIAS\LegalDocuments\ConsumerToolbox\Blocks:

Public Member Functions
	__construct (private readonly string $id, private readonly Container $container, private readonly Provide $provide, ?Closure $format_date=null, ?Closure $mail_contact=null)
	slot ()
	defaultMappings ()
	marshal ()
	selectSettingsFrom (KeyValueStore $store)
	readOnlyStore (KeyValueStore $store)
	globalStore ()
	userStore (ilObjUser $user)
	sessionStore ()
	ui ()
	user (Settings $global_settings, UserSettings $user_settings, ilObjUser $user)
	routing ()
	retrieveQueryParameter (string $key, Closure $select)
	userManagementAgreeDateField (callable $build_user, string $lang_key, ?string $module=null)
	withRequest (Form $form, Closure $then)
	notAvailable ()

Private Member Functions
	formatDate (?DateTimeImmutable $date)

Private Attributes
readonly Closure	$format_date
readonly Closure	$mail_contact

Detailed Description

Definition at line 48 of file Blocks.php.

Constructor & Destructor Documentation

__construct()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::__construct	(	private readonly string	$id,
		private readonly Container	$container,
		private readonly Provide	$provide,
		?Closure	$format_date = null,
		?Closure	$mail_contact = null
	)

Parameters

null|Closure(DateTimeImmutable)	string $format_date
null|Closure()	string $mail_contact

Definition at line 59 of file Blocks.php.

References ilDatePresentation\formatDate(), ilSystemSupportContacts\getMailsToAddress(), and IL_CAL_UNIX.

      {
        $this->format_date = $format_date ?? fn(DateTimeImmutable $date): string => ilDatePresentation::formatDate(
            new ilDateTime($date->getTimestamp(), IL_CAL_UNIX)
        );
        $this->mail_contact = $mail_contact ?? ilSystemSupportContacts::getMailsToAddress(...);
    }

Here is the call graph for this function:

Member Function Documentation

defaultMappings()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::defaultMappings

(

)

Definition at line 82 of file Blocks.php.

                                     : DefaultMappings
    {
        return new DefaultMappings($this->id, $this->container);
    }

formatDate()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::formatDate ( ?DateTimeImmutable  $date )

private

Definition at line 202 of file Blocks.php.

References ILIAS\LegalDocuments\ConsumerToolbox\Blocks\$format_date.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\userManagementAgreeDateField().

                                                         : string
    {
        return $date ? ($this->format_date)($date) : '';
    }

Here is the caller graph for this function:

globalStore()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::globalStore

(

)

Definition at line 102 of file Blocks.php.

                                 : KeyValueStore
    {
        return new ILIASSettingStore($this->container->settings());
    }

marshal()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::marshal

(

)

Definition at line 87 of file Blocks.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\selectSettingsFrom().

                             : Marshal
    {
        return new Marshal($this->container->refinery());
    }

Here is the caller graph for this function:

notAvailable()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::notAvailable

(

)

Definition at line 192 of file Blocks.php.

References ILIAS\LegalDocuments\ConsumerToolbox\Blocks\ui().

Referenced by ILIAS\LegalDocuments\test\ConsumerToolbox\BlocksTest\testNotAvailable().

                                  : PageFragment
    {
        return new PageContent($this->ui()->txt('accept_usr_agreement_anonymous'), [
            $this->container->ui()->factory()->legacy()->content(sprintf(
                $this->ui()->txt('no_agreement_description'),
                'mailto:' . htmlspecialchars(($this->mail_contact)(), ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8')
            )),
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readOnlyStore()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::readOnlyStore

(

KeyValueStore

$store

)

Definition at line 97 of file Blocks.php.

                                                       : KeyValueStore
    {
        return new ReadOnlyStore($store);
    }

retrieveQueryParameter()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::retrieveQueryParameter	(	string	$key,
		Closure	$select
	)

Parameters

Closure(Refinery)

Transformation $select

Definition at line 140 of file Blocks.php.

    {
        return $this->container->http()->wrapper()->query()->retrieve($key, $select($this->container->refinery()));
    }

routing()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::routing

(

)

Definition at line 127 of file Blocks.php.

References ilStartUpGUI\logoutUrl(), ilInitialisation\redirectToStartingPage(), ILIAS\LegalDocuments\ConsumerToolbox\Blocks\selectSettingsFrom(), and ILIAS\LegalDocuments\ConsumerToolbox\Blocks\sessionStore().

                             : Routing
    {
        return new Routing(
            $this->container->ctrl(),
            $this->selectSettingsFrom($this->sessionStore()),
            ilInitialisation::redirectToStartingPage(...),
            ilStartUpGUI::logoutUrl(...)
        );
    }

Here is the call graph for this function:

selectSettingsFrom()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::selectSettingsFrom

(

KeyValueStore

$store

)

Definition at line 92 of file Blocks.php.

References ILIAS\LegalDocuments\ConsumerToolbox\Blocks\marshal().

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\routing().

                                                            : SelectSetting
    {
        return new SelectSetting($store, $this->marshal());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sessionStore()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::sessionStore

(

)

Definition at line 112 of file Blocks.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\routing().

                                  : KeyValueStore
    {
        return new SessionStore();
    }

Here is the caller graph for this function:

slot()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::slot

(

)

Definition at line 72 of file Blocks.php.

                          : Slot
    {
        return new Slot(
            $this->id,
            $this,
            $this->provide,
            $this->container
        );
    }

ui()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::ui

(

)

Definition at line 117 of file Blocks.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\notAvailable(), and ILIAS\LegalDocuments\ConsumerToolbox\Blocks\userManagementAgreeDateField().

                        : UI
    {
        return new UI($this->id, $this->container->ui(), $this->container->language());
    }

Here is the caller graph for this function:

user()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::user	(	Settings	$global_settings,
		UserSettings	$user_settings,
		ilObjUser	$user
	)

Definition at line 122 of file Blocks.php.

                                                                                                 : User
    {
        return new User($user, $global_settings, $user_settings, $this->provide, (new DataFactory())->clock()->system());
    }

userManagementAgreeDateField()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::userManagementAgreeDateField	(	callable	$build_user,
		string	$lang_key,
		?string	$module = null
	)

Definition at line 145 of file Blocks.php.

References ILIAS\LegalDocuments\ConsumerToolbox\Blocks\formatDate(), ILIAS\Repository\modal(), ILIAS\LegalDocuments\Value\DocumentContent\title(), ILIAS\LegalDocuments\ConsumerToolbox\Blocks\ui(), and ILIAS\LegalDocuments\Value\DocumentContent\value().

Referenced by ILIAS\LegalDocuments\test\ConsumerToolbox\BlocksTest\testUserManagementAgreeDateField().

                                                                                                                : Closure
    {
        return function (ilObjUser $user) use ($build_user, $lang_key, $module) {
            if ($module) {
                $this->container->language()->loadLanguageModule($module);
            }
            $this->container->language()->loadLanguageModule('ldoc');
            $user = $build_user($user);

            $value = $user->acceptedVersion()->map(function (DocumentContent $content) use ($lang_key, $user): array {
                $input = new ilNonEditableValueGUI($this->ui()->txt($lang_key), $lang_key);
                $input->setValue($this->formatDate($user->agreeDate()->value()));
                $modal = $this->ui()->create()->modal()->lightbox([
                    $this->ui()->create()->modal()->lightboxTextPage($content->value(), $content->title())
                ]);

                $titleLink = $this->ui()->create()->button()->shy($content->title(), '#')->withOnClick($modal->getShowSignal());
                $sub = new ilNonEditableValueGUI($this->ui()->txt('agreement_document'), '', true);
                $sub->setValue($this->container->ui()->renderer()->render($titleLink));
                $input->addSubItem($sub);

                return [$input, $modal];
            })->except(fn() => new Ok($this->ui()->txt('never')))->value();

            return [$lang_key => $value];
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userStore()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::userStore

(

ilObjUser

$user

)

Definition at line 107 of file Blocks.php.

                                              : KeyValueStore
    {
        return new UserPreferenceStore($user);
    }

withRequest()

ILIAS\LegalDocuments\ConsumerToolbox\Blocks::withRequest	(	Form	$form,
		Closure	$then
	)

Parameters

Closure(array)

void $then

Definition at line 176 of file Blocks.php.

References $data, ILIAS\UI\Component\Input\Container\Container\getData(), and ILIAS\UI\Component\Input\Container\Container\withRequest().

                                                          : Form
    {
        if ($this->container->http()->request()->getMethod() !== 'POST') {
            return $form;
        }

        $form = $form->withRequest($this->container->http()->request());
        $data = $form->getData();

        if ($data) {
            $then($data);
        }

        return $form;
    }

Here is the call graph for this function:

Field Documentation

$format_date

readonly Closure ILIAS\LegalDocuments\ConsumerToolbox\Blocks::$format_date

private

Definition at line 51 of file Blocks.php.

Referenced by ILIAS\LegalDocuments\ConsumerToolbox\Blocks\formatDate().

$mail_contact

readonly Closure ILIAS\LegalDocuments\ConsumerToolbox\Blocks::$mail_contact

private

Definition at line 53 of file Blocks.php.

---

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

• components/ILIAS/LegalDocuments/classes/ConsumerToolbox/Blocks.php