ILIAS\Mail\Provider\MailNotificationProvider Class Reference

Class MailNotificationProvider. More...

Inheritance diagram for ILIAS\Mail\Provider\MailNotificationProvider:

Collaboration diagram for ILIAS\Mail\Provider\MailNotificationProvider:

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

Data Fields
const	MUTED_UNTIL_PREFERENCE_KEY = 'mail_nc_muted_until'

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

Detailed Description

Class MailNotificationProvider.

Author

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

Definition at line 14 of file MailNotificationProvider.php.

Member Function Documentation

getNotifications()

ILIAS\Mail\Provider\MailNotificationProvider::getNotifications

(

)

@inheritDoc

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

Definition at line 21 of file MailNotificationProvider.php.

                                       : array
    {
        $id = function (string $id) : IdentificationInterface {
            return $this->if->identifier($id);
        };
 
        if (0 === (int) $this->dic->user()->getId() || $this->dic->user()->isAnonymous()) {
            return [];
        }
 
        $hasInternalMailAccess = $this->dic->rbac()->system()->checkAccess(
            'internal_mail',
            \ilMailGlobalServices::getMailObjectRefId()
        );
        if (!$hasInternalMailAccess) {
            return [];
        }
 
        $leftIntervalTimestamp = $this->dic->user()->getPref(self::MUTED_UNTIL_PREFERENCE_KEY);
        $newMailData = \ilMailGlobalServices::getNewMailsData(
            (int) $this->dic->user()->getId(),
            is_numeric($leftIntervalTimestamp) ? (int) $leftIntervalTimestamp : 0
        );
 
        $numberOfNewMessages = (int) $newMailData['count'];
        if (0 === $numberOfNewMessages) {
            return [];
        }
 
        $this->dic->language()->loadLanguageModule('mail');
 
        $factory = $this->globalScreen()->notifications()->factory();
 
        $mailUrl = 'ilias.php?baseClass=ilMailGUI';
 
        if (1 === $numberOfNewMessages) {
            $linkText = $this->dic->language()->txt('nc_mail_unread_messages_number_s');
        } else {
            $linkText = sprintf(
                $this->dic->language()->txt('nc_mail_unread_messages_number_p'),
                $numberOfNewMessages
            );
        }
 
        $body = sprintf(
            $this->dic->language()->txt('nc_mail_unread_messages'),
            $this->dic->ui()->renderer()->render(
                $this->dic->ui()->factory()
                ->link()
                ->standard($linkText, $mailUrl)
            )
        );
 
        $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::MAIL, 'mail')
                          ->withIsOutlined(true);
        $title = $this->dic->ui()->factory()->link()->standard(
            $this->dic->language()->txt('nc_mail_noti_item_title'),
            $mailUrl
        );
 
        $notificationItem = $this->dic->ui()->factory()
            ->item()
            ->notification($title, $icon)
            ->withDescription($body);
 
        try {
            $dateTime = \DateTimeImmutable::createFromFormat('Y-m-d H:i:s', $newMailData['max_time']);
            $notificationItem = $notificationItem->withProperties([
                $this->dic->language()->txt('nc_mail_prop_time') => \ilDatePresentation::formatDate(
                    new \ilDateTime($dateTime->getTimestamp(), IL_CAL_UNIX)
                )
            ]);
        } catch (\Throwable $e) {
        }
 
        $group = $factory->standardGroup($id('mail_bucket_group'))
            ->withTitle($this->dic->language()->txt('mail'))
            ->addNotification(
                $factory->standard($id('mail_bucket'))
                    ->withNotificationItem($notificationItem)
                    ->withClosedCallable(
                        function () {
                            $this->dic->user()->writePref(self::MUTED_UNTIL_PREFERENCE_KEY, time());
                        }
                    )
                    ->withNewAmount(1)
            );
 
        return [
            $group,
        ];
    }

References Vendor\Package\$e, $factory, ilDatePresentation\formatDate(), ilMailGlobalServices\getMailObjectRefId(), ilMailGlobalServices\getNewMailsData(), ILIAS\GlobalScreen\Provider\AbstractProvider\globalScreen(), IL_CAL_UNIX, and ILIAS\UI\Component\Symbol\Icon\Standard\MAIL.

Here is the call graph for this function:

Field Documentation

MUTED_UNTIL_PREFERENCE_KEY

const ILIAS\Mail\Provider\MailNotificationProvider::MUTED_UNTIL_PREFERENCE_KEY = 'mail_nc_muted_until'

Definition at line 16 of file MailNotificationProvider.php.

---

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

• Services/Mail/classes/Provider/MailNotificationProvider.php