Collaboration diagram for ILIAS\GlobalScreen\Client\Notifications:

Public Member Functions
	__construct ()

	run ()

Data Fields
const	ADDITIONAL_ACTION = 'additional_action'

const	MODE = "mode"
	Name of the GET param used in the async calls. More...

const	MODE_OPENED = "opened"
	Value of the MODE GET param, if the Notification Center has been opened. More...

const	MODE_CLOSED = "closed"
	Value of the MODE GET param, if the Notification Center has been closed. More...

const	MODE_HANDLE_TOAST_ACTION = "toast_action"
	Value of the MODE GET param, if a ToastLik has been klicked. More...

const	MODE_RERENDER = "rerender"
	Value of the MODE GET param, if the Notification Center should be rerendered. More...

const	ITEM_ID = "item_id"
	NAME of the GET param, to indicate the item ID of the closed item. More...

const	NOTIFICATION_IDENTIFIERS = "notification_identifiers"
	Used to read the identifiers out of the GET param later. More...

const	NOTIFY_ENDPOINT = "notify.php"
	Location of the endpoint handling async notification requests. More...

Protected Attributes
Container	$dic

array	$notification_groups
	Collected set of collected notifications. More...

array	$identifiers_to_handle = []

string	$single_identifier_to_handle = null

array	$administrative_notifications = []

Private Member Functions
	handleToastAction ()

	handleOpened ()
	Loops through all available open callable provided by the notification providers. More...

	handleClosed ()
	Runs the closed callable if such a callable is provided. More...

	handleRerender ()

Private Attributes
string	$additional_action = null

array	$toasts = []

Detailed Description

Definition at line 36 of file Notifications.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\GlobalScreen\Client\Notifications::__construct ( )

Definition at line 90 of file Notifications.php.

    {
        global $DIC;
        $this->dic = $DIC;
    }

References $DIC.

Member Function Documentation

◆ handleClosed()

ILIAS\GlobalScreen\Client\Notifications::handleClosed ( )

private

Runs the closed callable if such a callable is provided.

Definition at line 183 of file Notifications.php.

                                   : void
    {
        foreach ($this->notification_groups as $notification_group) {
            foreach ($notification_group->getNotifications() as $notification) {
                if ($this->single_identifier_to_handle !== $this->hash(
                    $notification->getProviderIdentification()->serialize()
                )) {
                    continue;
                }
                if (!$notification->hasClosedCallable()) {
                    continue;
                }
                $notification->getClosedCallable()();
            }
        }
        foreach ($this->administrative_notifications as $administrative_notification) {
            if ($this->single_identifier_to_handle !== $this->hash(
                $administrative_notification->getProviderIdentification()->serialize()
            )) {
                continue;
            }
            if (!$administrative_notification->hasClosedCallable()) {
                continue;
            }
            $administrative_notification->getClosedCallable()();
        }
    }

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

Here is the caller graph for this function:

◆ handleOpened()

ILIAS\GlobalScreen\Client\Notifications::handleOpened ( )

private

Loops through all available open callable provided by the notification providers.

Definition at line 158 of file Notifications.php.

                                   : void
    {
        foreach ($this->notification_groups as $notification_group) {
            foreach ($notification_group->getNotifications() as $notification) {
                if (in_array(
                    $this->hash($notification->getProviderIdentification()->serialize()),
                    $this->identifiers_to_handle,
                    true
                )) {
                    $notification->getOpenedCallable()();
                }
            }
            if (in_array(
                $this->hash($notification_group->getProviderIdentification()->serialize()),
                $this->identifiers_to_handle,
                true
            )) {
                $notification_group->getOpenedCallable()();
            }
        }
    }

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

Here is the caller graph for this function:

◆ handleRerender()

ILIAS\GlobalScreen\Client\Notifications::handleRerender ( )

private

Exceptions

ResponseSendingException
JsonException

Definition at line 215 of file Notifications.php.

                                     : void
    {
        $notifications = [];
        $amount = 0;
        foreach ($this->notification_groups as $group) {
            $notifications[] = $group->getRenderer($this->dic->ui()->factory())->getNotificationComponentForItem(
                $group
            );
            if ($group->getNewNotificationsCount() > 0) {
                $amount++;
            }
        }
        $this->dic->http()->saveResponse(
            $this->dic->http()->response()
                      ->withBody(
                          Streams::ofString(
                              json_encode([
                                  'html' => $this->dic->ui()->renderer()->renderAsync($notifications),
                                  'symbol' => $this->dic->ui()->renderer()->render(
                                      $this->dic->ui()->factory()->symbol()->glyph()->notification()->withCounter(
                                          $this->dic->ui()->factory()->counter()->novelty($amount)
                                      )
                                  )
                              ], JSON_THROW_ON_ERROR)
                          )
                      )
                      ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
        );
        $this->dic->http()->sendResponse();
        $this->dic->http()->close();
    }

References ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE, and ILIAS\Filesystem\Stream\Streams\ofString().

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleToastAction()

ILIAS\GlobalScreen\Client\Notifications::handleToastAction ( )

private

Definition at line 139 of file Notifications.php.

                                        : void
    {
        foreach ($this->toasts as $toast) {
            if ($this->hash($toast->getProviderIdentification()->serialize()) === $this->single_identifier_to_handle) {
                foreach ($toast->getAllToastActions() as $toast_action) {
                    if ($toast_action->getIdentifier() === $this->additional_action) {
                        $callable = $toast_action->getAction();
                        $callable();
                        return;
                    }
                }
            }
        }
    }

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

Here is the caller graph for this function:

◆ run()

ILIAS\GlobalScreen\Client\Notifications::run ( )

@DI $DI

Definition at line 96 of file Notifications.php.

                         : void
    {
        global $DIC;
        $this->notification_groups = $DIC->globalScreen()->collector()->notifications()->getNotifications();
        $this->administrative_notifications = $DIC->globalScreen()->collector()->notifications(
        )->getAdministrativeNotifications();
        $this->identifiers_to_handle = $DIC->http()->request()->getQueryParams()[self::NOTIFICATION_IDENTIFIERS] ?? [];
        $this->single_identifier_to_handle = $DIC->http()->request()->getQueryParams()[self::ITEM_ID] ?? null;
        $this->toasts = $DIC->globalScreen()->collector()->toasts()->getToasts();
 
        $query = $DIC->http()->wrapper()->query();
 
        $this->additional_action = $query->has(self::ADDITIONAL_ACTION)
            ? $query->retrieve(
                self::ADDITIONAL_ACTION,
                $DIC->refinery()->kindlyTo()->string()
            )
            : null;
 
        $mode = 'none';
        if ($query->has(self::MODE)) {
            $mode = $query->retrieve(self::MODE, $DIC->refinery()->to()->string());
        }
 
        switch ($mode) {
            case self::MODE_OPENED:
                $this->handleOpened();
                break;
            case self::MODE_CLOSED:
                $this->handleClosed();
                break;
            case self::MODE_RERENDER:
                $this->handleRerender();
                break;
            case self::MODE_HANDLE_TOAST_ACTION:
                $this->handleToastAction();
                break;
        }
    }

Here is the call graph for this function:

Field Documentation

◆ $additional_action

string ILIAS\GlobalScreen\Client\Notifications::$additional_action = null

private

Definition at line 44 of file Notifications.php.

◆ $administrative_notifications

array ILIAS\GlobalScreen\Client\Notifications::$administrative_notifications = []

protected

Definition at line 84 of file Notifications.php.

◆ $dic

Container ILIAS\GlobalScreen\Client\Notifications::$dic

protected

Definition at line 45 of file Notifications.php.

◆ $identifiers_to_handle

array ILIAS\GlobalScreen\Client\Notifications::$identifiers_to_handle = []

protected

Definition at line 82 of file Notifications.php.

◆ $notification_groups

array ILIAS\GlobalScreen\Client\Notifications::$notification_groups

protected

Collected set of collected notifications.

Definition at line 49 of file Notifications.php.

◆ $single_identifier_to_handle

string ILIAS\GlobalScreen\Client\Notifications::$single_identifier_to_handle = null

protected

Definition at line 83 of file Notifications.php.

◆ $toasts

array ILIAS\GlobalScreen\Client\Notifications::$toasts = []

private

Definition at line 88 of file Notifications.php.

◆ ADDITIONAL_ACTION

const ILIAS\GlobalScreen\Client\Notifications::ADDITIONAL_ACTION = 'additional_action'

Definition at line 40 of file Notifications.php.

◆ ITEM_ID

const ILIAS\GlobalScreen\Client\Notifications::ITEM_ID = "item_id"

NAME of the GET param, to indicate the item ID of the closed item.

Definition at line 73 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ MODE

const ILIAS\GlobalScreen\Client\Notifications::MODE = "mode"

Name of the GET param used in the async calls.

Definition at line 53 of file Notifications.php.

◆ MODE_CLOSED

const ILIAS\GlobalScreen\Client\Notifications::MODE_CLOSED = "closed"

Value of the MODE GET param, if the Notification Center has been closed.

Definition at line 61 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ MODE_HANDLE_TOAST_ACTION

const ILIAS\GlobalScreen\Client\Notifications::MODE_HANDLE_TOAST_ACTION = "toast_action"

Value of the MODE GET param, if a ToastLik has been klicked.

Definition at line 65 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ MODE_OPENED

const ILIAS\GlobalScreen\Client\Notifications::MODE_OPENED = "opened"

Value of the MODE GET param, if the Notification Center has been opened.

Definition at line 57 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ MODE_RERENDER

const ILIAS\GlobalScreen\Client\Notifications::MODE_RERENDER = "rerender"

Value of the MODE GET param, if the Notification Center should be rerendered.

Definition at line 69 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ NOTIFICATION_IDENTIFIERS

const ILIAS\GlobalScreen\Client\Notifications::NOTIFICATION_IDENTIFIERS = "notification_identifiers"

Used to read the identifiers out of the GET param later.

Definition at line 77 of file Notifications.php.

Referenced by ILIAS\GlobalScreen\Client\Notifications\run().

◆ NOTIFY_ENDPOINT

const ILIAS\GlobalScreen\Client\Notifications::NOTIFY_ENDPOINT = "notify.php"

Location of the endpoint handling async notification requests.

Definition at line 81 of file Notifications.php.

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

components/ILIAS/GlobalScreen/src/Client/Notifications.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ handleClosed()

◆ handleOpened()

◆ handleRerender()

◆ handleToastAction()

◆ run()

Field Documentation

◆ $additional_action

◆ $administrative_notifications

◆ $dic

◆ $identifiers_to_handle

◆ $notification_groups

◆ $single_identifier_to_handle

◆ $toasts

◆ ADDITIONAL_ACTION

◆ ITEM_ID

◆ MODE

◆ MODE_CLOSED

◆ MODE_HANDLE_TOAST_ACTION

◆ MODE_OPENED

◆ MODE_RERENDER

◆ NOTIFICATION_IDENTIFIERS

◆ NOTIFY_ENDPOINT