E-mail the user that their account got banned. More...

Inheritance diagram for Elgg\Notifications\Handlers\BanUser:

Protected Member Functions

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

Parameters

\ElggUser	$recipient	Notification recipient
string	$method	Method

Returns: string Notification subject in the recipient's language

} More...

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:

Recipient's name
Name of the user who triggered the notification
Title of the content
Name of the content's container
The actual content (entity's 'description' field)
URL to the content

Argument swapping can be used to change the order of the parameters. See http://php.net/manual/en/function.sprintf.php#example-5427

Parameters

\ElggUser	$recipient	Notification recipient
string	$method	Method

Returns: string Notification body in the recipient's language

} More...

getNotificationMethods ()

{Get the notification methods to use.

Returns: array

Since: 6.3

} More...

Protected Member Functions inherited from Elgg\Notifications\InstantNotificationEventHandler

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

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

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

Additional Inherited Members

Public Member Functions inherited from Elgg\Notifications\InstantNotificationEventHandler

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

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 $user the 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 $group the group to check for

Returns: bool

Since: 4.1

} More...

Protected Attributes inherited from Elgg\Notifications\InstantNotificationEventHandler

array $recipients = []

Protected Attributes inherited from Elgg\Notifications\NotificationEventHandler

array $params = []

array $methods_override = []

Detailed Description

E-mail the user that their account got banned.

Since: 6.3

Definition at line 12 of file BanUser.php.

Member Function Documentation

◆ getNotificationBody()

Elgg\Notifications\Handlers\BanUser::getNotificationBody	(	\ElggUser	$recipient,
		string	$method
	)

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:

Recipient's name
Name of the user who triggered the notification
Title of the content
Name of the content's container
The actual content (entity's 'description' field)
URL to the content

Argument swapping can be used to change the order of the parameters. See http://php.net/manual/en/function.sprintf.php#example-5427

Parameters

\ElggUser	$recipient	Notification recipient
string	$method	Method

Returns: string Notification body in the recipient's language

}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 26 of file BanUser.php.

◆ getNotificationMethods()

Elgg\Notifications\Handlers\BanUser::getNotificationMethods ( )

protected

{Get the notification methods to use.

Returns: array

Since: 6.3

}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 38 of file BanUser.php.

◆ getNotificationSubject()

Elgg\Notifications\Handlers\BanUser::getNotificationSubject	(	\ElggUser	$recipient,
		string	$method
	)

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

Parameters

\ElggUser	$recipient	Notification recipient
string	$method	Method

Returns: string Notification subject in the recipient's language

}

Reimplemented from Elgg\Notifications\NotificationEventHandler.

Definition at line 17 of file BanUser.php.

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

engine/classes/Elgg/Notifications/Handlers/BanUser.php