Elgg\Notifications\NotificationsService Class Reference

Notifications service. More...

Public Member Functions
	__construct (Queue $queue, PluginHooksService $hooks,\ElggSession $session, EventsService $elgg_events)
	Constructor. More...
	registerEvent ($type, $subtype, array $actions=[], string $handler=NotificationEventHandler::class)
	Register a notification event. More...
	unregisterEvent ($type, $subtype, array $actions=[])
	Unregister a notification event. More...
	getEvents ()
	Return the notification events. More...
	registerMethod ($name)
	Register a delivery method for notifications. More...
	unregisterMethod ($name)
	Unregister a delivery method for notifications. More...
	getMethods ()
	Returns registered delivery methods for notifications. More...
	isRegisteredMethod (string $method)
	Check if a notification method is registed. More...
	enqueueEvent ($action, $type, $object,\ElggEntity $actor=null)
	Add a notification event to the queue. More...
	processQueue ($stopTime, $matrix=false)
	Pull notification events from queue until stop time is reached. More...
	sendInstantNotifications (\ElggEntity $sender, array $recipients=[], array $params=[])
	Notify a user via their preferences. More...

Protected Member Functions
	getNotificationHandler (NotificationEvent $event)
	Returns notification event handler based on event. More...

Protected Attributes
	$queue
	$hooks
	$elgg_events
	$session
	$events = []
	$methods = []

Detailed Description

Notifications service.

Definition at line 17 of file NotificationsService.php.

Constructor & Destructor Documentation

Elgg\Notifications\NotificationsService::__construct	(	Queue	$queue,
		PluginHooksService	$hooks,
		\ElggSession	$session,
		EventsService	$elgg_events
	)

Constructor.

Parameters

Queue	$queue	Queue
PluginHooksService	$hooks	Plugin hook service
\ElggSession	$session	Session service
EventsService	$elgg_events	Events service

Definition at line 47 of file NotificationsService.php.

Member Function Documentation

Elgg\Notifications\NotificationsService::enqueueEvent	(		$action,
			$type,
			$object,
		\ElggEntity	$actor = null
	)

Add a notification event to the queue.

Parameters

string	$action	Action name
string	$type	Type of the object of the action
\ElggData	$object	The object of the action
\ElggEntity	$actor	(optional) The actor of the notification (default: logged in user or owner of $object)

Returns

void

Definition at line 197 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::getEvents

(

)

Return the notification events.

Returns

array

Definition at line 132 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::getMethods

(

)

Returns registered delivery methods for notifications.

Returns

string[]

See also

elgg_get_notification_methods()

Definition at line 172 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::getNotificationHandler ( NotificationEvent  $event )

protected

Returns notification event handler based on event.

Parameters

NotificationEvent

$event

event to get event handler for

Returns

NotificationEventHandler

Definition at line 237 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::isRegisteredMethod

(

string

$method

)

Check if a notification method is registed.

Parameters

string

$method

the notification method

Returns

bool

Definition at line 183 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::processQueue	(		$stopTime,
			$matrix = false
	)

Pull notification events from queue until stop time is reached.

Parameters

int	$stopTime	The Unix time to stop sending notifications
bool	$matrix	If true, will return delivery matrix instead of a notifications event count

Returns

int|array The number of notification events handled, or a delivery matrix

Definition at line 256 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::registerEvent	(		$type,
			$subtype,
		array	$actions = [],
		string	$handler = NotificationEventHandler::class
	)

Register a notification event.

Parameters

string	$type	'object', 'user', 'group', 'site'
string	$subtype	The subtype or name of the entity
array	$actions	Array of actions or empty array for the action event. An event is usually described by the first string passed to elgg_trigger_event(). Examples include 'create', 'update', and 'publish'. The default is 'create'.
string	$handler	NotificationEventHandler classname

Returns

void

Exceptions

InvalidArgumentException

See also

elgg_register_notification_event()

Definition at line 75 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::registerMethod

(

$name

)

Register a delivery method for notifications.

Parameters

string

$name

The notification method name

Returns

void

See also

elgg_register_notification_method()

Definition at line 144 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::sendInstantNotifications	(	\ElggEntity	$sender,
		array	$recipients = [],
		array	$params = []
	)

Notify a user via their preferences.

Returns an array in the form: [ 25 => [ 'email' => true, 'sms' => false, ], 55 => [], ]

Parameters

\ElggEntity	$sender	Sender of the notification

Definition at line 330 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::unregisterEvent	(		$type,
			$subtype,
		array	$actions = []
	)

Unregister a notification event.

Parameters

string	$type	'object', 'user', 'group', 'site'
string	$subtype	The type of the entity
array	$actions	The notification action to unregister, leave empty for all actions

Returns

bool

See also

elgg_unregister_notification_event()

Definition at line 106 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::unregisterMethod

(

$name

)

Unregister a delivery method for notifications.

Parameters

string

$name

The notification method name

Returns

bool

See also

elgg_unregister_notification_method()

Definition at line 156 of file NotificationsService.php.

Member Data Documentation

Elgg\Notifications\NotificationsService::$elgg_events

protected

Definition at line 28 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::$events = []

protected

Definition at line 34 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::$hooks

protected

Definition at line 25 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::$methods = []

protected

Definition at line 37 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::$queue

protected

Definition at line 22 of file NotificationsService.php.

Elgg\Notifications\NotificationsService::$session

protected

Definition at line 31 of file NotificationsService.php.

---

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

• engine/classes/Elgg/Notifications/NotificationsService.php