class.ilNotificationGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\DI\Container;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\GlobalScreen\Scope\Toast\Collector\ToastCollector;
use ILIAS\Notifications\ilNotificationDatabaseHandler;
use ILIAS\Notifications\ilNotificationHandler;
use ILIAS\Notifications\ilNotificationOSDHandler;
use ILIAS\Notifications\ilNotificationSettingsTable;

class ilNotificationGUI implements ilCtrlBaseClassInterface
{
    private array $handler = [];
    private Container $dic;
    private ilObjUser $user;
    private ilGlobalTemplateInterface $template;
    private ilCtrlInterface $controller;
    private ilLanguage $language;

    public function __construct(
        ?ilObjUser $user = null,
        ?ilGlobalTemplateInterface $template = null,
        ?ilCtrlInterface $controller = null,
        ?ilLanguage $language = null,
        ?Container $dic = null
    ) {
        if ($dic === null) {
            global $DIC;
            $dic = $DIC;
        }
        $this->dic = $dic;

        if ($user === null) {
            $user = $dic->user();
        }
        $this->user = $user;

        if ($template === null) {
            $template = $dic->ui()->mainTemplate();
        }
        $this->template = $template;

        if ($controller === null) {
            $controller = $dic->ctrl();
        }
        $this->controller = $controller;

        if ($language === null) {
            $language = $dic->language();
        }
        $this->language = $language;
    }

    public static function _forwards(): array
    {
        return [];
    }

    public function executeCommand(): void
    {
        if (!$this->controller->getCmd()) {
            return;
        }

        $cmd = $this->controller->getCmd() . 'Object';
        $this->$cmd();
    }

    public function getHandler(string $type)
    {
        return $this->handler[$type];
    }

    private function getAvailableTypes(array $types = []): array
    {
        return ilNotificationDatabaseHandler::getAvailableTypes($types);
    }

    private function getAvailableChannels(array $types = []): array
    {
        return ilNotificationDatabaseHandler::getAvailableChannels($types);
    }

    public function getOSDNotificationsObject(): void
    {
        ilSession::enableWebAccessWithoutSession(true);
        $toasts = [];
        foreach ($this->dic->globalScreen()->collector()->toasts()->getToasts() as $toast) {
            $renderer = $toast->getRenderer();
            $toasts[] = $renderer->getToastComponentForItem($toast);
        }

        $this->dic->http()->saveResponse(
            $this->dic->http()->response()
                ->withBody(Streams::ofString(
                    $this->dic->ui()->renderer()->renderAsync($toasts)
                ))
        );
        $this->dic->http()->sendResponse();
        $this->dic->http()->close();
    }

    public function addHandler(string $channel, ilNotificationHandler $handler): void
    {
        if (!array_key_exists($channel, $this->handler) || !is_array($this->handler[$channel])) {
            $this->handler[$channel] = [];
        }

        $this->handler[$channel][] = $handler;
    }

    public function showSettingsObject(): void
    {
        $userTypes = ilNotificationDatabaseHandler::loadUserConfig($this->user->getId());

        $this->language->loadLanguageModule('notification');

        $form = new ilPropertyFormGUI();
        $chk = new ilCheckboxInputGUI($this->language->txt('enable_custom_notification_configuration'), 'enable_custom_notification_configuration');
        $chk->setValue('1');
        $chk->setChecked($this->dic->refinery()->kindlyTo()->int()->transform($this->user->getPref('use_custom_notification_setting')) === 1);
        $form->addItem($chk);

        $form->setFormAction($this->controller->getFormAction($this, 'showSettingsObject'));
        $form->addCommandButton('saveCustomizingOption', $this->language->txt('save'));
        $form->addCommandButton('showSettings', $this->language->txt('cancel'));

        $table = new ilNotificationSettingsTable($this, 'a title', $this->getAvailableChannels(['set_by_user']), $userTypes);

        $table->setFormAction($this->controller->getFormAction($this, 'saveSettings'));
        $table->setData($this->getAvailableTypes(['set_by_user']));

        if (
            $this->dic->refinery()->kindlyTo()->int()->transform(
                $this->user->getPref('use_custom_notification_setting')
            ) === 1
        ) {
            $table->addCommandButton('saveSettings', $this->language->txt('save'));
            $table->addCommandButton('showSettings', $this->language->txt('cancel'));
            $table->setEditable(true);
        } else {
            $table->setEditable(false);
        }

        $this->template->setContent($form->getHtml() . $table->getHTML());
    }
}