Elgg  Version 6.3
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Elgg\Notifications\InstantNotificationEventHandler Class Reference

Notification Event Handler for instant notifications. More...

Inheritance diagram for Elgg\Notifications\InstantNotificationEventHandler:
Elgg\Notifications\NonConfigurableNotificationEventHandler Elgg\Notifications\NotificationEventHandler Elgg\Notifications\Handlers\AddUser Elgg\Notifications\Handlers\BanUser Elgg\Notifications\Handlers\ChangeUserPassword Elgg\Notifications\Handlers\ConfirmEmailChange Elgg\Notifications\Handlers\ConfirmPasswordChange Elgg\Notifications\Handlers\RequestUserPassword Elgg\Notifications\Handlers\ResetUserPassword Elgg\Notifications\Handlers\ValidateUser

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.
Returns
array
} More...
 
- Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 __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.
Returns
bool
Since
4.1
} More...
 
 addMuteLink ()
 {Add a mute link in the email notification.
Returns
bool
} More...
 
- Protected Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 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 = []
 
- Protected Attributes inherited from Elgg\Notifications\NotificationEventHandler
array $params = []
 
array $methods_override = []
 

Additional Inherited Members

- Static Public Member Functions inherited from Elgg\Notifications\NonConfigurableNotificationEventHandler
static isConfigurableByUser ()
 {Is this event configurable by the user on the notification settings page.
Returns
bool
} More...
 
- Static Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
static isConfigurableForEntity (\ElggEntity $entity)
 Can this event be configured for a specific entity. More...
 
- Static Protected Member Functions inherited from Elgg\Notifications\NonConfigurableNotificationEventHandler
static isConfigurableForUser (\ElggUser $user)
 {Can this event be configured for a specific user.
Parameters
\ElggUser$userthe user to check for
Returns
bool
Since
4.1
} More...
 
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
Parameters
\ElggGroup$groupthe group to check for
Returns
bool
Since
4.1
} More...
 

Detailed Description

Notification Event Handler for instant notifications.

Since
4.0

Definition at line 10 of file InstantNotificationEventHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Notifications\InstantNotificationEventHandler::__construct ( NotificationEvent  $event,
NotificationsService  $service,
array  $params = [] 
)

{}

Definition at line 20 of file InstantNotificationEventHandler.php.

Member Function Documentation

◆ addMuteLink()

Elgg\Notifications\InstantNotificationEventHandler::addMuteLink ( )
finalprotected

{Add a mute link in the email notification.

Returns
bool
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 75 of file InstantNotificationEventHandler.php.

◆ filterMutedSubscriptions()

Elgg\Notifications\InstantNotificationEventHandler::filterMutedSubscriptions ( )
finalprotected

{Should muted subscribers be filtered.

Returns
bool
Since
4.1
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 68 of file InstantNotificationEventHandler.php.

◆ getSubscriptions()

Elgg\Notifications\InstantNotificationEventHandler::getSubscriptions ( )

{Returns subscriptions for the event.

Returns
array
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 47 of file InstantNotificationEventHandler.php.

◆ setRecipients()

Elgg\Notifications\InstantNotificationEventHandler::setRecipients ( array  $recipients)
final

Set the recipients of the notification.

Parameters
\ElggUser[]$recipientsarray recipients
Returns
void

Definition at line 38 of file InstantNotificationEventHandler.php.

Member Data Documentation

◆ $recipients

array Elgg\Notifications\InstantNotificationEventHandler::$recipients = []
protected

Definition at line 15 of file InstantNotificationEventHandler.php.


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