NotificationService

NotificationService.php : 23 Copy path

Interface

Service to manager user notifications. It works in the context of a current User (obtained from the PermissionResolver).

Methods¶

createNotification() ¶

NotificationService.php : 84 Copy path

Creates a new notification.

public createNotification(CreateStruct $createStruct) : Notification

Parameters

Name	Type	Default value	Description
$createStruct	CreateStruct	-	-

Return values

Notification

Tags

deleteNotification() ¶

NotificationService.php : 91 Copy path

Deletes a notification.

public deleteNotification(Notification $notification) : void

Parameters

Name	Type	Default value	Description
$notification	Notification	-	-

findNotifications() ¶

NotificationService.php : 30 Copy path

public findNotifications([NotificationQuery|null $query = null ]) : NotificationList

Parameters

Name	Type	Default value	Description
$query	NotificationQuery\|null	null	-

Return values

NotificationList

getNotification() ¶

NotificationService.php : 41 Copy path

Load single notification (by ID).

public getNotification(int $notificationId) : Notification

Parameters

Name	Type	Default value	Description
$notificationId	int	-	Notification ID

Return values

Notification

Tags

getNotificationCount() ¶

NotificationService.php : 73 Copy path

public getNotificationCount([NotificationQuery|null $query = null ]) : int

Parameters

Name	Type	Default value	Description
$query	NotificationQuery\|null	null	-

Return values

int

getPendingNotificationCount() ¶

NotificationService.php : 71 Copy path

Get count of unread users notifications.

public getPendingNotificationCount() : int

Return values

int

loadNotifications() ¶

NotificationService.php : 25 Copy path

public loadNotifications(int $offset, int $limit) : NotificationList

Parameters

Name	Type	Default value	Description
$offset	int	-	-
$limit	int	-	-

Return values

NotificationList

markNotificationAsRead() ¶

NotificationService.php : 56 Copy path

Mark notification as read so it no longer bother the user.

public markNotificationAsRead(Notification $notification) : void

Parameters

Name	Type	Default value	Description
$notification	Notification	-	-

Tags

markNotificationAsUnread() ¶

NotificationService.php : 64 Copy path

Marks the given notification as unread so it is shown again as new to the user.

public markNotificationAsUnread(Notification $notification) : void

Parameters

Name	Type	Default value	Description
$notification	Notification	-	-

Tags

markUserNotificationsAsRead() ¶

NotificationService.php : 46 Copy path

    
                        public markUserNotificationsAsRead([array<string|int, int> $notificationIds = [] ]) : void

Parameters

Name	Type	Default value	Description
$notificationIds	array<string\|int, int>	[]	-