Elgg
Version 6.3
|
Notification Event Handler for instant notifications. More...
Public Member Functions | |
__construct (NotificationEvent $event, NotificationsService $service, array $params=[]) | |
{} More... | |
setRecipients (array $recipients) | |
Set the recipients of the notification. More... | |
getSubscriptions () | |
{Returns subscriptions for the event.
| |
![]() | |
__construct (protected NotificationEvent $event, protected NotificationsService $service, array $params=[]) | |
Constructor. More... | |
send () | |
Process the event. More... | |
getMethods () | |
Returns methods to be used for this notification. More... | |
Protected Member Functions | |
filterMutedSubscriptions () | |
{Should muted subscribers be filtered.
| |
addMuteLink () | |
{Add a mute link in the email notification.
| |
![]() | |
setMethodsOverride (array $methods) | |
Override the default user preferred delivery methods with the given methods. More... | |
getMethodsOverride () | |
Get the delivery methods override. More... | |
getNotificationMethods () | |
Get the notification methods to use. More... | |
prepareSubscriptions () | |
Returns subscriptions. More... | |
getNotificationSubsciptionExclusionGUIDs () | |
Get an array of GUIDs to not get the subscription records for. More... | |
excludeOwnerSubscribers () | |
Exclude the NotificationEvent object owner_guid when fetching the subscription records for this notification. More... | |
excludeContainerSubscribers () | |
Exclude the NotificationEvent object container_guid when fetching the subscription records for this notification. More... | |
excludeEntitySubscribers () | |
Exclude the NotificationEvent object guid when fetching the subscription records for this notification. More... | |
sendNotifications (array $subscriptions, array $params=[]) | |
Sends the notifications based on subscriptions. More... | |
sendNotification (\ElggEntity $recipient, string $method, array $params=[]) | |
Send a notification to a subscriber. More... | |
deliverNotification (Notification $notification, string $method) | |
Deliver a notification. More... | |
prepareNotification (array $params) | |
Prepares a notification for delivery. More... | |
getNotificationSubject (\ElggUser $recipient, string $method) | |
Get subject for the notification. More... | |
getNotificationBody (\ElggUser $recipient, string $method) | |
Get body for the notification. More... | |
getNotificationSummary (\ElggUser $recipient, string $method) | |
Return the summary for a notification. More... | |
getNotificationURL (\ElggUser $recipient, string $method) | |
Returns the url related to this notification. More... | |
getNotificationAttachments (\ElggUser $recipient, string $method) | |
Get the attachments for this notification. More... | |
getEventActor () | |
Get the acting user from the notification event. More... | |
getEventEntity () | |
Get the entity from the notification event. More... | |
getParam (string $param, mixed $default=null) | |
Get a parameter from the notification parameters. More... | |
Protected Attributes | |
array | $recipients = [] |
![]() | |
array | $params = [] |
array | $methods_override = [] |
Additional Inherited Members | ||||
![]() | ||||
static | isConfigurableByUser () | |||
{Is this event configurable by the user on the notification settings page.
| ||||
![]() | ||||
static | isConfigurableForEntity (\ElggEntity $entity) | |||
Can this event be configured for a specific entity. More... | ||||
![]() | ||||
static | isConfigurableForUser (\ElggUser $user) | |||
{Can this event be configured for a specific user.
| ||||
static | isConfigurableForGroup (\ElggGroup $group) | |||
{Can this event be configured for a specific group.For example this can be based on a group tools option which is enabled or not
| ||||
Notification Event Handler for instant notifications.
Definition at line 10 of file InstantNotificationEventHandler.php.
Elgg\Notifications\InstantNotificationEventHandler::__construct | ( | NotificationEvent | $event, |
NotificationsService | $service, | ||
array | $params = [] |
||
) |
{}
Definition at line 20 of file InstantNotificationEventHandler.php.
|
finalprotected |
{Add a mute link in the email notification.
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 75 of file InstantNotificationEventHandler.php.
|
finalprotected |
{Should muted subscribers be filtered.
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 68 of file InstantNotificationEventHandler.php.
Elgg\Notifications\InstantNotificationEventHandler::getSubscriptions | ( | ) |
{Returns subscriptions for the event.
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 47 of file InstantNotificationEventHandler.php.
|
final |
Set the recipients of the notification.
\ElggUser[] | $recipients | array recipients |
Definition at line 38 of file InstantNotificationEventHandler.php.
|
protected |
Definition at line 15 of file InstantNotificationEventHandler.php.