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

Mentions notification handler. More...

Inheritance diagram for Elgg\Notifications\MentionsEventHandler:
Elgg\Notifications\NotificationEventHandler

Public Member Functions

 getSubscriptions ()
 {} More...
 
- Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 __construct (NotificationEvent $event, 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

 getNotificationSubject (\ElggUser $recipient, string $method)
 {} More...
 
 getNotificationBody (\ElggUser $recipient, string $method)
 {} More...
 
 addMuteLink ()
 {} More...
 
 getMetadataFields ()
 Get the metadata fields to check for mentions. More...
 
 getMentions ()
 Get usernames which are mentioned in the configured metadata fields. More...
 
 filterMentions (array $mentions)
 Filter mentions. More...
 
- Protected Member Functions inherited from Elgg\Notifications\NotificationEventHandler
 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 ($subscriptions, array $params=[])
 Sends the notifications based on subscriptions. More...
 
 sendNotification (int $guid, 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...
 
 addMuteLink ()
 Add a mute link in the email notification. More...
 

Static Protected Member Functions

static isConfigurableForUser (\ElggUser $user)
 {} More...
 
static isConfigurableForGroup (\ElggGroup $group)
 {} More...
 
- Static Protected Member Functions inherited from Elgg\Notifications\NotificationEventHandler
static isConfigurableForUser (\ElggUser $user)
 Can this event be configured for a specific user. More...
 
static isConfigurableForGroup (\ElggGroup $group)
 Can this event be configured for a specific group. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Elgg\Notifications\NotificationEventHandler
static isConfigurableByUser ()
 Is this event configurable by the user on the notification settings page. More...
 
static isConfigurableForEntity (\ElggEntity $entity)
 Can this event be configured for a specific entity. More...
 
- Protected Attributes inherited from Elgg\Notifications\NotificationEventHandler
 $event
 
 $service
 
 $params = []
 

Detailed Description

Mentions notification handler.

Since
5.0

Definition at line 12 of file MentionsEventHandler.php.

Member Function Documentation

Elgg\Notifications\MentionsEventHandler::addMuteLink ( )
protected

{}

Definition at line 116 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::filterMentions ( array  $mentions)
protected

Filter mentions.

  • previous detected mentions
Parameters
array$mentionsthe detected mentions from the text
Returns
array

Definition at line 191 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::getMentions ( )
protected

Get usernames which are mentioned in the configured metadata fields.

Returns
string[]

Definition at line 134 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::getMetadataFields ( )
protected

Get the metadata fields to check for mentions.

Returns
string[]

Definition at line 125 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::getNotificationBody ( \ElggUser  $recipient,
string  $method 
)
protected

{}

Definition at line 82 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::getNotificationSubject ( \ElggUser  $recipient,
string  $method 
)
protected

{}

Definition at line 67 of file MentionsEventHandler.php.

Elgg\Notifications\MentionsEventHandler::getSubscriptions ( )

{}

Definition at line 17 of file MentionsEventHandler.php.

static Elgg\Notifications\MentionsEventHandler::isConfigurableForGroup ( \ElggGroup  $group)
staticprotected

{}

Definition at line 109 of file MentionsEventHandler.php.

static Elgg\Notifications\MentionsEventHandler::isConfigurableForUser ( \ElggUser  $user)
staticprotected

{}

Definition at line 102 of file MentionsEventHandler.php.


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