Blocks.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\LegalDocuments\ConsumerToolbox;

use ILIAS\Data\Result\Ok;
use ILIAS\LegalDocuments\Value\DocumentContent;
use ilNonEditableValueGUI;
use ILIAS\Refinery\Transformation;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\DI\Container;
use ILIAS\UI\Component\Input\Container\Form\Form;
use ILIAS\LegalDocuments\DefaultMappings;
use ILIAS\LegalDocuments\Provide;
use ILIAS\LegalDocuments\ConsumerToolbox\KeyValueStore\ILIASSettingStore;
use ILIAS\LegalDocuments\ConsumerToolbox\KeyValueStore\UserPreferenceStore;
use ILIAS\LegalDocuments\ConsumerToolbox\KeyValueStore\ReadOnlyStore;
use ILIAS\LegalDocuments\ConsumerToolbox\KeyValueStore\SessionStore;
use ilInitialisation;
use Closure;
use ilObjUser;
use ilDateTime;
use ilDatePresentation;
use DateTimeImmutable;
use ILIAS\Data\Factory as DataFactory;
use ilStartUpGUI;
use ILIAS\LegalDocuments\PageFragment;
use ILIAS\LegalDocuments\PageFragment\PageContent;
use ilSystemSupportContacts;

class Blocks
{
    private readonly Closure $format_date;
    private readonly Closure $mail_contact;

    public function __construct(
        private readonly string $id,
        private readonly Container $container,
        private readonly Provide $provide,
        ?Closure $format_date = null,
        ?Closure $mail_contact = null
    ) {
        $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(...);
    }

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

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

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

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

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

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

    public function userStore(ilObjUser $user): KeyValueStore
    {
        return new UserPreferenceStore($user);
    }

    public function sessionStore(): KeyValueStore
    {
        return new SessionStore();
    }

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

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

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

    public function retrieveQueryParameter(string $key, Closure $select)
    {
        return $this->container->http()->wrapper()->query()->retrieve($key, $select($this->container->refinery()));
    }

    public function userManagementAgreeDateField(callable $build_user, string $lang_key, ?string $module = null): 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): ilNonEditableValueGUI {
                $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, $modal]));
                $input->addSubItem($sub);

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

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

    public function withRequest(Form $form, Closure $then): 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;
    }

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

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