Elgg_Notifications_NotificationsService Class Reference

Public Member Functions
	__construct (Elgg_Notifications_SubscriptionsService $subscriptions, Elgg_Queue_Queue $queue, Elgg_PluginHooksService $hooks, Elgg_Access $access)
	Constructor. More...
	registerEvent ($type, $subtype, array $actions=array())
	unregisterEvent ($type, $subtype)
	getEvents ()
	@access private More...
	registerMethod ($name)
	unregisterMethod ($name)
	getMethods ()
	@access private More...
	enqueueEvent ($action, $type, $object)
	Add a notification event to the queue. More...
	processQueue ($stopTime)
	Pull notification events from queue until stop time is reached. More...
	registerDeprecatedHandler ($method, $handler)
	Register a deprecated notification handler. More...
	getDeprecatedHandler ($method)
	Get a deprecated notification handler callback. More...
	getMethodsAsDeprecatedGlobal ()
	Provides a way to incrementally wean Elgg's notifications code from the global $NOTIFICATION_HANDLERS. More...
	setDeprecatedNotificationSubject ($type, $subtype, $subject)
	Set message subject for deprecated notification code. More...

Public Attributes
const	QUEUE_NAME = 'notifications'

Protected Member Functions
	sendNotifications ($event, $subscriptions)
	Sends the notifications based on subscriptions. More...
	sendNotification (Elgg_Notifications_Event $event, $guid, $method)
	Send a notification to a subscriber. More...
	getDeprecatedNotificationBody (Elgg_Notifications_Notification $notification, Elgg_Notifications_Event $event, $method)
	Get the notification body using a pre-Elgg 1.9 plugin hook. More...
	getDeprecatedNotificationSubject ($type, $subtype)
	Get the deprecated subject. More...
	existsDeprecatedNotificationOverride (Elgg_Notifications_Event $event)
	Is someone using the deprecated override. More...

Protected Attributes
	$subscriptions
	$queue
	$hooks
	$access
	$events = array()
	$methods = array()
	$deprHandlers = array()
	$deprSubjects = array()

Detailed Description

Definition at line 12 of file NotificationsService.php.

Constructor & Destructor Documentation

__construct()

Elgg_Notifications_NotificationsService::__construct	(	Elgg_Notifications_SubscriptionsService	$subscriptions,
		Elgg_Queue_Queue	$queue,
		Elgg_PluginHooksService	$hooks,
		Elgg_Access	$access
	)

Constructor.

Parameters

Elgg_Notifications_SubscriptionsService	$subscriptions	Subscription service
Elgg_Queue_Queue	$queue	Queue
Elgg_PluginHooksService	$hooks	Plugin hook service
Elgg_Access	$access	Access control service

Definition at line 48 of file NotificationsService.php.

Member Function Documentation

enqueueEvent()

Elgg_Notifications_NotificationsService::enqueueEvent	(		$action,
			$type,
			$object
	)

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

Returns

void @access private

Definition at line 135 of file NotificationsService.php.

existsDeprecatedNotificationOverride()

Elgg_Notifications_NotificationsService::existsDeprecatedNotificationOverride ( Elgg_Notifications_Event  $event )

protected

Is someone using the deprecated override.

Parameters

Elgg_Notifications_Event

$event

Event

Returns

boolean

Definition at line 426 of file NotificationsService.php.

getDeprecatedHandler()

Elgg_Notifications_NotificationsService::getDeprecatedHandler

(

$method

)

Get a deprecated notification handler callback.

Parameters

string

$method

Method name

Returns

callback|null

Definition at line 322 of file NotificationsService.php.

getDeprecatedNotificationBody()

Elgg_Notifications_NotificationsService::getDeprecatedNotificationBody ( Elgg_Notifications_Notification  $notification, Elgg_Notifications_Event  $event,   $method  )

protected

Get the notification body using a pre-Elgg 1.9 plugin hook.

Parameters

Elgg_Notifications_Notification	$notification	Notification
Elgg_Notifications_Event	$event	Event
string	$method	Method

Returns

Elgg_Notifications_Notification

Definition at line 352 of file NotificationsService.php.

getDeprecatedNotificationSubject()

Elgg_Notifications_NotificationsService::getDeprecatedNotificationSubject (   $type,   $subtype  )

protected

Get the deprecated subject.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype

Returns

string

Definition at line 401 of file NotificationsService.php.

getEvents()

Elgg_Notifications_NotificationsService::getEvents

(

)

@access private

Definition at line 95 of file NotificationsService.php.

getMethods()

Elgg_Notifications_NotificationsService::getMethods

(

)

@access private

Definition at line 122 of file NotificationsService.php.

getMethodsAsDeprecatedGlobal()

Elgg_Notifications_NotificationsService::getMethodsAsDeprecatedGlobal

(

)

Provides a way to incrementally wean Elgg's notifications code from the global $NOTIFICATION_HANDLERS.

Returns

array

Definition at line 336 of file NotificationsService.php.

processQueue()

Elgg_Notifications_NotificationsService::processQueue

(

$stopTime

)

Pull notification events from queue until stop time is reached.

Parameters

int

$stopTime

The Unix time to stop sending notifications

Returns

int The number of notification events handled @access private

Definition at line 168 of file NotificationsService.php.

registerDeprecatedHandler()

Elgg_Notifications_NotificationsService::registerDeprecatedHandler	(		$method,
			$handler
	)

Register a deprecated notification handler.

Parameters

string	$method	Method name
string	$handler	Handler callback

Returns

void

Definition at line 312 of file NotificationsService.php.

registerEvent()

Elgg_Notifications_NotificationsService::registerEvent	(		$type,
			$subtype,
		array	$actions = array()
	)

See also

elgg_register_notification_event() @access private

Definition at line 60 of file NotificationsService.php.

registerMethod()

Elgg_Notifications_NotificationsService::registerMethod

(

$name

)

See also

elgg_register_notification_method() @access private

Definition at line 103 of file NotificationsService.php.

sendNotification()

Elgg_Notifications_NotificationsService::sendNotification ( Elgg_Notifications_Event  $event,   $guid,   $method  )

protected

Send a notification to a subscriber.

Parameters

Elgg_Notifications_Event	$event	The notification event
int	$guid	The guid of the subscriber
string	$method	The notification method

Returns

bool @access private

Definition at line 244 of file NotificationsService.php.

sendNotifications()

Elgg_Notifications_NotificationsService::sendNotifications (   $event,   $subscriptions  )

protected

Sends the notifications based on subscriptions.

Parameters

Elgg_Notifications_Event	$event	Notification event
array	$subscriptions	Subscriptions for this event

Returns

int The number of notifications handled @access private

Definition at line 216 of file NotificationsService.php.

setDeprecatedNotificationSubject()

Elgg_Notifications_NotificationsService::setDeprecatedNotificationSubject	(		$type,
			$subtype,
			$subject
	)

Set message subject for deprecated notification code.

Parameters

string	$type	Entity type
string	$subtype	Entity subtype
string	$subject	Subject line

Returns

void

Definition at line 379 of file NotificationsService.php.

unregisterEvent()

Elgg_Notifications_NotificationsService::unregisterEvent	(		$type,
			$subtype
	)

See also

elgg_unregister_notification_event() @access private

Definition at line 81 of file NotificationsService.php.

unregisterMethod()

Elgg_Notifications_NotificationsService::unregisterMethod

(

$name

)

See also

elgg_unregister_notification_method() @access private

Definition at line 111 of file NotificationsService.php.

Member Data Documentation

$access

Elgg_Notifications_NotificationsService::$access

protected

Definition at line 26 of file NotificationsService.php.

$deprHandlers

Elgg_Notifications_NotificationsService::$deprHandlers = array()

protected

Definition at line 35 of file NotificationsService.php.

$deprSubjects

Elgg_Notifications_NotificationsService::$deprSubjects = array()

protected

Definition at line 38 of file NotificationsService.php.

$events

Elgg_Notifications_NotificationsService::$events = array()

protected

Definition at line 29 of file NotificationsService.php.

$hooks

Elgg_Notifications_NotificationsService::$hooks

protected

Definition at line 23 of file NotificationsService.php.

$methods

Elgg_Notifications_NotificationsService::$methods = array()

protected

Definition at line 32 of file NotificationsService.php.

$queue

Elgg_Notifications_NotificationsService::$queue

protected

Definition at line 20 of file NotificationsService.php.

$subscriptions

Elgg_Notifications_NotificationsService::$subscriptions

protected

Definition at line 17 of file NotificationsService.php.

QUEUE_NAME

const Elgg_Notifications_NotificationsService::QUEUE_NAME = 'notifications'

Definition at line 14 of file NotificationsService.php.

---

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

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