ILIAS\Contact\Provider\ContactNotificationProvider Class Reference

Class ContactNotificationProvider. More...

Inheritance diagram for ILIAS\Contact\Provider\ContactNotificationProvider:

Collaboration diagram for ILIAS\Contact\Provider\ContactNotificationProvider:

Public Member Functions
	getNotifications ()
Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Notification\Provider\AbstractNotificationProvider
	__construct (Container $dic)
	getAdministrativeNotifications ()
Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (protected Container $dic)
	getFullyQualifiedClassName ()
	getProviderNameForPresentation ()

Data Fields
final const string	MUTED_UNTIL_PREFERENCE_KEY = 'bs_nc_muted_until'
final const string	NOTIFICATION_TYPE = 'buddysystem_request'

Private Member Functions
	getIdentifier (string $id)

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()
Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Notification\Provider\AbstractNotificationProvider
Container	$dic
IdentificationProviderInterface	$if
NotificationFactory	$notification_factory

Detailed Description

Class ContactNotificationProvider.

Author

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

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 42 of file ContactNotificationProvider.php.

Member Function Documentation

getIdentifier()

ILIAS\Contact\Provider\ContactNotificationProvider::getIdentifier ( string  $id )

private

Definition at line 47 of file ContactNotificationProvider.php.

Referenced by ILIAS\Contact\Provider\ContactNotificationProvider\getNotifications().

                                              : IdentificationInterface
    {
        return $this->if->identifier($id);
    }

Here is the caller graph for this function:

getNotifications()

ILIAS\Contact\Provider\ContactNotificationProvider::getNotifications

(

)

Implements ILIAS\GlobalScreen\Scope\Notification\Provider\NotificationProvider.

Definition at line 55 of file ContactNotificationProvider.php.

References $relation, ilObjUser\_lookupActive(), ilDatePresentation\formatDate(), ILIAS\Contact\Provider\ContactNotificationProvider\getIdentifier(), ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilBuddySystemRelation\getTimestamp(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), IL_CAL_UNIX, and null.

                                      : array
    {
        if (
            0 === $this->dic->user()->getId() ||
            $this->dic->user()->isAnonymous() ||
            !ilBuddySystem::getInstance()->isEnabled()
        ) {
            return [];
        }

        $leftIntervalTimestamp = $this->dic->user()->getPref(self::MUTED_UNTIL_PREFERENCE_KEY);
        $latestRequestTimestamp = null;

        $relations = ilBuddyList::getInstanceByGlobalUser()->getRequestRelationsForOwner();

        $openRequests = $relations->filter(
            function (ilBuddySystemRelation $relation) use ($leftIntervalTimestamp, &$latestRequestTimestamp, $relations): bool {
                $timeStamp = $relation->getTimestamp();

                if ($timeStamp > $latestRequestTimestamp) {
                    $latestRequestTimestamp = $timeStamp;
                }

                $usrId = $relations->getKey($relation);

                if (!ilObjUser::_lookupActive($usrId)) {
                    return false;
                }

                if (!is_numeric($leftIntervalTimestamp)) {
                    return true;
                }

                return $timeStamp > $leftIntervalTimestamp;
            }
        );

        $contactRequestsCount = count($openRequests->getKeys());
        if ($contactRequestsCount === 0) {
            return [];
        }

        $factory = $this->globalScreen()->notifications()->factory();

        $icon = $this->dic->ui()->factory()
                          ->symbol()
                          ->icon()
                          ->standard(Standard::CADM, 'contacts');

        $title = $this->dic->ui()->factory()
            ->link()
            ->standard(
                $this->dic->language()->txt('nc_contact_requests_headline'),
                $this->dic->ctrl()->getLinkTargetByClass([ilDashboardGUI::class, ilContactGUI::class], 'showContactRequests')
            );
        $description = sprintf(
            $this->dic->language()->txt(
                'nc_contact_requests_number' . (($contactRequestsCount > 1) ? '_p' : '_s')
            ),
            $contactRequestsCount
        );
        $notificationItem = $this->dic->ui()->factory()
            ->item()
            ->notification($title, $icon)
            ->withDescription($description)
            ->withProperties([
                $this->dic->language()->txt('nc_contact_requests_prop_time') => ilDatePresentation::formatDate(
                    new ilDateTime($latestRequestTimestamp, IL_CAL_UNIX)
                )
            ]);

        $osd_notification_handler = new ilNotificationOSDHandler(new ilNotificationOSDRepository($this->dic->database()));

        $group = $factory
            ->standardGroup($this->getIdentifier('contact_bucket_group'))
            ->withTitle($this->dic->language()->txt('nc_contact_requests_headline'))
            ->addNotification(
                $factory->standard($this->getIdentifier('contact_bucket'))
                    ->withNotificationItem($notificationItem)
                    ->withClosedCallable(
                        function () use ($osd_notification_handler): void {
                            $this->dic->user()->writePref(self::MUTED_UNTIL_PREFERENCE_KEY, (string) time());

                            $osd_notification_handler->deleteStaleNotificationsForUserAndType(
                                $this->dic->user()->getId(),
                                self::NOTIFICATION_TYPE
                            );
                        }
                    )->withNewAmount(1)
            );

        return [
            $group
        ];
    }

Here is the call graph for this function:

Field Documentation

MUTED_UNTIL_PREFERENCE_KEY

final const string ILIAS\Contact\Provider\ContactNotificationProvider::MUTED_UNTIL_PREFERENCE_KEY = 'bs_nc_muted_until'

Definition at line 44 of file ContactNotificationProvider.php.

NOTIFICATION_TYPE

final const string ILIAS\Contact\Provider\ContactNotificationProvider::NOTIFICATION_TYPE = 'buddysystem_request'

Definition at line 45 of file ContactNotificationProvider.php.

---

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

• components/ILIAS/Contact/classes/Provider/ContactNotificationProvider.php