ILIAS\Notifications\Provider\AwarenessToastProvider Class Reference

Inheritance diagram for ILIAS\Notifications\Provider\AwarenessToastProvider:

Collaboration diagram for ILIAS\Notifications\Provider\AwarenessToastProvider:

Public Member Functions
	getToasts ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Toast\Provider\AbstractToastProvider
	__construct (Container $dic)
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Data Fields
const	MAX_ONLINE_USER_COUNT = 20

Private Attributes
const	PROVIDER_KEY = 'awareness'

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Toast\Provider\AbstractToastProvider
Container	$dic
ILIAS UI Factory	$ui_factory
IdentificationProviderInterface	$if
ToastFactory	$toast_factory
Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Author

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

Definition at line 34 of file AwarenessToastProvider.php.

Member Function Documentation

getToasts()

ILIAS\Notifications\Provider\AwarenessToastProvider::getToasts

(

)

Implements ILIAS\GlobalScreen\Scope\Toast\Provider\ToastProvider.

Definition at line 43 of file AwarenessToastProvider.php.

References $id, ILIAS\$setting, ILIAS\LTI\ToolProvider\$settings, ANONYMOUS_USER_ID, ILIAS\UI\Implementation\Component\Toast\Toast\DEFAULT_DELAY_TIME, ILIAS\UI\Implementation\Component\Toast\Toast\DEFAULT_VANISH_TIME, ilSetting\get(), ilUserUtil\getNamePresentation(), ILIAS\Awareness\User\Collector\getOnlineUsers(), if, and IL_CAL_DATETIME.

                               : array
    {
        $this->dic->language()->loadLanguageModule('awrn');
        $settings = new ilSetting('awrn');

        $toasts = [];
        if (
            $settings->get('awrn_enabled', '0') !== '1' ||
            $settings->get('use_osd', '0') !== '1' ||
            0 === $this->dic->user()->getId() ||
            $this->dic->user()->isAnonymous()
        ) {
            return $toasts;
        }

        $users = Collector::getOnlineUsers();
        unset($users[$this->dic->user()->getId()], $users[ANONYMOUS_USER_ID]);
        $users = array_slice($users, 0, self::MAX_ONLINE_USER_COUNT, true);

        $new_user_ids = [];
        foreach ($users as $id => $user) {
            $time = (new ilDateTime($user['last_login'], IL_CAL_DATETIME, $this->dic->user()->getTimeZone()))->getUnixTime();
            if ($time >= (time() - ($this->dic->http()->request()->getQueryParams()['max_age'] ?? 0))) {
                $new_user_ids[] = $id;
            }
        }

        $new_users = ilUserUtil::getNamePresentation(
            $new_user_ids,
            true,
            false,
            "",
            false,
            false,
            true,
            true
        );

        if ($new_users !== []) {
            $setting = new ilSetting('notifications');
            $toast = $this->toast_factory
                ->standard(
                    $this->if->identifier(self::PROVIDER_KEY . '_' . $this->dic->user()->getId()),
                    $this->dic->language()->txt('awareness_now_online')
                )
                ->withIcon($this->dic->ui()->factory()->symbol()->icon()->standard(Standard::USR, ''))
                ->withVanishTime((int) $setting->get('osd_vanish', (string) Toast::DEFAULT_VANISH_TIME))
                ->withDelayTime((int) $setting->get('osd_delay', (string) Toast::DEFAULT_DELAY_TIME));
            $links = [];
            foreach ($new_users as $user) {
                $uname = "[" . $user['login'] . "]";
                if ($user['public_profile']) {
                    $uname = $user['lastname'] . ", " . $user['firstname'] . " " . $uname;
                }

                $toast = $toast->withAdditionToastAction(
                    $this->toast_factory->action(
                        self::PROVIDER_KEY . '_' . $user['id'],
                        $uname,
                        function () use ($user): void {
                            $this->dic->ctrl()->redirectToURL('/goto.php?target=usr_' . $user['id']);
                        }
                    )
                );
            }

            $toasts = [$toast];
        }

        return $toasts;
    }

Here is the call graph for this function:

Field Documentation

MAX_ONLINE_USER_COUNT

const ILIAS\Notifications\Provider\AwarenessToastProvider::MAX_ONLINE_USER_COUNT = 20

Definition at line 38 of file AwarenessToastProvider.php.

PROVIDER_KEY

const ILIAS\Notifications\Provider\AwarenessToastProvider::PROVIDER_KEY = 'awareness'

private

Definition at line 36 of file AwarenessToastProvider.php.

---

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

• Services/Awareness/classes/Provider/AwarenessToastProvider.php