ilNotificationGUI Class Reference

Inheritance diagram for ilNotificationGUI:

Collaboration diagram for ilNotificationGUI:

Public Member Functions
	__construct (?ilObjUser $user=null, ?ilGlobalTemplateInterface $template=null, ?ilCtrlInterface $controller=null, ?ilLanguage $language=null, ?Container $dic=null)
	executeCommand ()
	getHandler (string $type)
	getOSDNotificationsObject ()
	addHandler (string $channel, ilNotificationHandler $handler)
	showSettingsObject ()

Private Member Functions
	getAvailableTypes (array $types=[])
	getAvailableChannels (array $types=[])

Private Attributes
array	$handler = []
readonly Container	$dic
readonly ilObjUser	$user
readonly ilGlobalTemplateInterface	$template
readonly ilCtrlInterface	$controller
readonly ilLanguage	$language

Detailed Description

Author

Ingmar Szmais iszma.nosp@m.is@d.nosp@m.ataba.nosp@m.y.de

Definition at line 30 of file class.ilNotificationGUI.php.

Constructor & Destructor Documentation

__construct()

ilNotificationGUI::__construct	(	?ilObjUser	$user = null,
		?ilGlobalTemplateInterface	$template = null,
		?ilCtrlInterface	$controller = null,
		?ilLanguage	$language = null,
		?Container	$dic = null
	)

Definition at line 40 of file class.ilNotificationGUI.php.

References $controller, $DIC, $dic, $language, $template, $user, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\user(), and ILIAS\DI\Container\user().

      {
        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;
    }

Here is the call graph for this function:

Member Function Documentation

addHandler()

ilNotificationGUI::addHandler	(	string	$channel,
		ilNotificationHandler	$handler
	)

Definition at line 130 of file class.ilNotificationGUI.php.

References $handler.

                                                                               : void
    {
        if (!array_key_exists($channel, $this->handler)) {
            $this->handler[$channel] = [];
        }

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

executeCommand()

ilNotificationGUI::executeCommand

(

)

Definition at line 74 of file class.ilNotificationGUI.php.

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

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

getAvailableChannels()

ilNotificationGUI::getAvailableChannels ( array  $types = [] )

private

Parameters

list<string>

$types

Returns

array<string, array<string, mixed>>

Definition at line 105 of file class.ilNotificationGUI.php.

Referenced by showSettingsObject().

                                                            : array
    {
        return ilNotificationDatabaseHandler::getAvailableChannels($types);
    }

Here is the caller graph for this function:

getAvailableTypes()

ilNotificationGUI::getAvailableTypes ( array  $types = [] )

private

Parameters

list<string>

$types

Returns

array<string, array<string, mixed>>

Definition at line 96 of file class.ilNotificationGUI.php.

Referenced by showSettingsObject().

                                                         : array
    {
        return ilNotificationDatabaseHandler::getAvailableTypes($types);
    }

Here is the caller graph for this function:

getHandler()

ilNotificationGUI::getHandler

(

string

$type

)

Returns

list<ilNotificationHandler>|null

Definition at line 87 of file class.ilNotificationGUI.php.

                                            : ?array
    {
        return $this->handler[$type] ?? null;
    }

getOSDNotificationsObject()

ilNotificationGUI::getOSDNotificationsObject

(

)

Definition at line 110 of file class.ilNotificationGUI.php.

References $renderer, and ilSession\enableWebAccessWithoutSession().

                                               : 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();
    }

Here is the call graph for this function:

showSettingsObject()

ilNotificationGUI::showSettingsObject

(

)

Definition at line 139 of file class.ilNotificationGUI.php.

References getAvailableChannels(), getAvailableTypes(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\user().

                                        : 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());
    }

Here is the call graph for this function:

Field Documentation

$controller

readonly ilCtrlInterface ilNotificationGUI::$controller

private

Definition at line 37 of file class.ilNotificationGUI.php.

Referenced by __construct().

$dic

readonly Container ilNotificationGUI::$dic

private

Definition at line 34 of file class.ilNotificationGUI.php.

Referenced by __construct().

$handler

array ilNotificationGUI::$handler = []

private

Definition at line 33 of file class.ilNotificationGUI.php.

Referenced by addHandler().

$language

readonly ilLanguage ilNotificationGUI::$language

private

Definition at line 38 of file class.ilNotificationGUI.php.

Referenced by __construct().

$template

readonly ilGlobalTemplateInterface ilNotificationGUI::$template

private

Definition at line 36 of file class.ilNotificationGUI.php.

Referenced by __construct().

$user

readonly ilObjUser ilNotificationGUI::$user

private

Definition at line 35 of file class.ilNotificationGUI.php.

Referenced by __construct().

---

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

• components/ILIAS/Notifications/classes/class.ilNotificationGUI.php