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

A notification event handler which isn't configurable by a user. More...

Inheritance diagram for Elgg\Notifications\NonConfigurableNotificationEventHandler:
Elgg\Notifications\NotificationEventHandler Elgg\Notifications\CreateCommentEventHandler Elgg\Notifications\Handlers\AdminValidation Elgg\Notifications\InstantNotificationEventHandler Elgg\Notifications\MakeAdminUserEventHandler Elgg\Notifications\MentionsEventHandler Elgg\Notifications\RemoveAdminUserEventHandler Elgg\Notifications\UnbanUserEventHandler 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

Static Public Member Functions

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

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...
 

Additional Inherited Members

- Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 __construct (protected NotificationEvent $event, protected NotificationsService $service, array $params=[])
 Constructor. More...
 
 send ()
 Process the event. More...
 
 getSubscriptions ()
 Returns subscriptions for the event. More...
 
 getMethods ()
 Returns methods to be used for this notification. 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...
 
 filterMutedSubscriptions ()
 Should muted subscribers be filtered. 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...
 
 addMuteLink ()
 Add a mute link in the email notification. More...
 
 getParam (string $param, mixed $default=null)
 Get a parameter from the notification parameters. More...
 
- Protected Attributes inherited from Elgg\Notifications\NotificationEventHandler
array $params = []
 
array $methods_override = []
 

Detailed Description

A notification event handler which isn't configurable by a user.

Since
6.3

Definition at line 10 of file NonConfigurableNotificationEventHandler.php.

Member Function Documentation

◆ isConfigurableByUser()

static Elgg\Notifications\NonConfigurableNotificationEventHandler::isConfigurableByUser ( )
staticfinal

{Is this event configurable by the user on the notification settings page.

Returns
bool
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 15 of file NonConfigurableNotificationEventHandler.php.

◆ isConfigurableForGroup()

static Elgg\Notifications\NonConfigurableNotificationEventHandler::isConfigurableForGroup ( \ElggGroup  $group)
staticfinalprotected

{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
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 29 of file NonConfigurableNotificationEventHandler.php.

◆ isConfigurableForUser()

static Elgg\Notifications\NonConfigurableNotificationEventHandler::isConfigurableForUser ( \ElggUser  $user)
staticfinalprotected

{Can this event be configured for a specific user.

Parameters
\ElggUser$userthe user to check for
Returns
bool
Since
4.1
}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 22 of file NonConfigurableNotificationEventHandler.php.


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