Elgg
Version 6.2
|
Notification Event Handler for 'object' 'comment' 'create' action. More...
Static Public Member Functions | |
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 Member Functions | |||||||
recipientIsCommentContainerOwner (\ElggUser $recipient) | |||||||
Tells if the recipient is the owner of the entity commented on. More... | |||||||
getNotificationSubject (\ElggUser $recipient, string $method) | |||||||
{Get subject for the notification.Plugins can define a subtype specific subject simply by providing a translation for the string "notification:<action>:<type>:<subtype>:subject".
| |||||||
getNotificationSummary (\ElggUser $recipient, string $method) | |||||||
{Return the summary for a notification.
| |||||||
getNotificationBody (\ElggUser $recipient, string $method) | |||||||
{Get body for the notification.Plugin can define a subtype specific body simply by providing a translation for the string "notification:<action>:<type>:<subtype>:body".The arguments passed into the translation are:
| |||||||
excludeOwnerSubscribers () | |||||||
{Exclude the NotificationEvent object owner_guid when fetching the subscription records for this notification.
| |||||||
![]() | |||||||
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... | |||||||
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 (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... | |||||||
getNotificationURL (\ElggUser $recipient, string $method) | |||||||
Returns the url related to 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... | |||||||
Additional Inherited Members | |
![]() | |
__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... | |
![]() | |
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... | |
![]() | |
$event | |
$service | |
$params = [] | |
Notification Event Handler for 'object' 'comment' 'create' action.
Definition at line 10 of file CreateCommentEventHandler.php.
|
protected |
{Exclude the NotificationEvent object owner_guid when fetching the subscription records for this notification.
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 67 of file CreateCommentEventHandler.php.
|
protected |
{Get body for the notification.Plugin can define a subtype specific body simply by providing a translation for the string "notification:<action>:<type>:<subtype>:body".The arguments passed into the translation are:
\ElggUser | $recipient | Notification recipient |
string | $method | Method |
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 44 of file CreateCommentEventHandler.php.
|
protected |
{Get subject for the notification.Plugins can define a subtype specific subject simply by providing a translation for the string "notification:<action>:<type>:<subtype>:subject".
\ElggUser | $recipient | Notification recipient |
string | $method | Method |
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 26 of file CreateCommentEventHandler.php.
|
protected |
{Return the summary for a notification.
\ElggUser | $recipient | Notification recipient |
string | $method | Method |
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 33 of file CreateCommentEventHandler.php.
|
static |
Is this event configurable by the user on the notification settings page.
Reimplemented from Elgg\Notifications\NotificationEventHandler.
Definition at line 60 of file CreateCommentEventHandler.php.
|
protected |
Tells if the recipient is the owner of the entity commented on.
\ElggUser | $recipient | the recipient to check |
Definition at line 19 of file CreateCommentEventHandler.php.