notification.php File Reference

Go to the source code of this file.

Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Functions
	elgg_register_notification_event ($object_type, $object_subtype, array $actions=array())
	Register a notification event. More...
	elgg_unregister_notification_event ($object_type, $object_subtype)
	Unregister a notification event. More...
	elgg_register_notification_method ($name)
	Register a delivery method for notifications. More...
	elgg_unregister_notification_method ($name)
	Unregister a delivery method for notifications. More...
	elgg_add_subscription ($user_guid, $method, $target_guid)
	Subscribe a user to notifications about a target entity. More...
	elgg_remove_subscription ($user_guid, $method, $target_guid)
	Unsubscribe a user to notifications about a target entity. More...
	elgg_get_subscriptions_for_container ($container_guid)
	Get the subscriptions for the content created inside this container. More...
	_elgg_enqueue_notification_event ($action, $type, $object)
	Queue a notification event for later handling. More...
	_elgg_notifications_cron ()
	@access private More...
	_elgg_send_email_notification ($hook, $type, $result, $params)
	Send an email notification. More...
	_elgg_notifications_smtp_default_message_id_header ($hook, $type, $returnvalue, $params)
	Adds default Message-ID header to all e-mails. More...
	_elgg_notifications_init ()
	@access private More...
	_elgg_notify_user ($to, $from, $subject, $message, array $params=null, $methods_override="")
	Notify a user via their preferences. More...
	notify_user ($to, $from, $subject, $message, array $params=array(), $methods_override="")
	Notify a user via their preferences. More...
	get_user_notification_settings ($user_guid=0)
	Get the notification settings for a given user. More...
	set_user_notification_setting ($user_guid, $method, $value)
	Set a user notification pref. More...
	elgg_send_email ($from, $to, $subject, $body, array $params=null)
	Send an email to any email address. More...
	_elgg_save_notification_user_settings ()
	Save personal notification settings - input comes from request. More...
	_elgg_notifications_test ($hook, $type, $tests)
	@access private More...

Variables
return	function (\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks)

Function Documentation

_elgg_enqueue_notification_event()

_elgg_enqueue_notification_event	(		$action,
			$type,
			$object
	)

Queue a notification event for later handling.

Checks to see if this event has been registered for notifications. If so, it adds the event to a notification queue.

This function triggers the 'enqueue', 'notification' hook.

Parameters

string	$action	The name of the action
string	$type	The type of the object
\ElggData	$object	The object of the event

Returns

void @access private

Since

1.9

Definition at line 173 of file notification.php.

_elgg_notifications_cron()

_elgg_notifications_cron

(

)

@access private

Definition at line 180 of file notification.php.

_elgg_notifications_init()

_elgg_notifications_init

(

)

@access private

Definition at line 324 of file notification.php.

_elgg_notifications_smtp_default_message_id_header()

_elgg_notifications_smtp_default_message_id_header	(		$hook,
			$type,
			$returnvalue,
			$params
	)

Adds default Message-ID header to all e-mails.

Parameters

string	$hook	Equals to 'email'
string	$type	Equals to 'system'
array	$returnvalue	Array containing fields: 'to', 'from', 'subject', 'body', 'headers', 'params'
array	$params	The same value as $returnvalue

See also

https://tools.ietf.org/html/rfc5322#section-3.6.4

Returns

array

@access private

Definition at line 248 of file notification.php.

_elgg_notifications_test()

_elgg_notifications_test	(		$hook,
			$type,
			$tests
	)

@access private

Definition at line 759 of file notification.php.

_elgg_notify_user()

_elgg_notify_user	(		$to,
			$from,
			$subject,
			$message,
		array	$params = null,
			$methods_override = ""
	)

Notify a user via their preferences.

Parameters

mixed	$to	Either a guid or an array of guid's to notify.
int	$from	GUID of the sender, which may be a user, site or object.
string	$subject	Message subject.
string	$message	Message body.
array	$params	Misc additional parameters specific to various methods.
mixed	$methods_override	A string, or an array of strings specifying the delivery methods to use - or leave blank for delivery using the user's chosen delivery methods.

Returns

array Compound array of each delivery user/delivery method's success or failure. @access private

Definition at line 354 of file notification.php.

_elgg_save_notification_user_settings()

_elgg_save_notification_user_settings

(

)

Save personal notification settings - input comes from request.

Returns

void @access private

Definition at line 732 of file notification.php.

_elgg_send_email_notification()

_elgg_send_email_notification	(		$hook,
			$type,
			$result,
			$params
	)

Send an email notification.

Parameters

string	$hook	Hook name
string	$type	Hook type
bool	$result	Has anyone sent a message yet?
array	$params	Hook parameters

Returns

bool @access private

Definition at line 197 of file notification.php.

elgg_add_subscription()

elgg_add_subscription	(		$user_guid,
			$method,
			$target_guid
	)

Subscribe a user to notifications about a target entity.

Parameters

int	$user_guid	The GUID of the user to subscribe to notifications
string	$method	The delivery method of the notifications
int	$target_guid	The entity to receive notifications about

Returns

bool

Since

1.9

Definition at line 114 of file notification.php.

elgg_get_subscriptions_for_container()

elgg_get_subscriptions_for_container

(

$container_guid

)

Get the subscriptions for the content created inside this container.

The return array is of the form:

array( <user guid> => array('email', 'sms', 'ajax'), );

Parameters

int

$container_guid

GUID of the entity acting as a container

Returns

array User GUIDs (keys) and their subscription types (values).

Since

1.9

Definition at line 151 of file notification.php.

elgg_register_notification_event()

elgg_register_notification_event	(		$object_type,
			$object_subtype,
		array	$actions = array()
	)

Register a notification event.

Elgg sends notifications for the items that have been registered with this function. For example, if you want notifications to be sent when a bookmark has been created or updated, call the function like this:

   elgg_register_notification_event('object', 'bookmarks', array('create', 'update'));

Parameters

string	$object_type	'object', 'user', 'group', 'site'
string	$object_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'.

Returns

void

Since

1.9

Definition at line 61 of file notification.php.

elgg_register_notification_method()

elgg_register_notification_method

(

$name

)

Register a delivery method for notifications.

Register for the 'send', 'notification:[method name]' plugin hook to handle sending a notification. A notification object is in the params array for the hook with the key 'notification'. See \Elgg\Notifications\Notification.

Parameters

string

$name

The notification method name

Returns

void

See also

elgg_unregister_notification_method()

Since

1.9

Definition at line 89 of file notification.php.

elgg_remove_subscription()

elgg_remove_subscription	(		$user_guid,
			$method,
			$target_guid
	)

Unsubscribe a user to notifications about a target entity.

Parameters

int	$user_guid	The GUID of the user to unsubscribe to notifications
string	$method	The delivery method of the notifications to stop
int	$target_guid	The entity to stop receiving notifications about

Returns

bool

Since

1.9

Definition at line 130 of file notification.php.

elgg_send_email()

elgg_send_email	(		$from,
			$to,
			$subject,
			$body,
		array	$params = null
	)

Send an email to any email address.

Parameters

string	$from	Email address or string: "name <email>"
string	$to	Email address or string: "name <email>"
string	$subject	The subject of the message
string	$body	The message body
array	$params	Optional parameters (none used in this function)

Returns

bool

Exceptions

NotificationException

Since

1.7.2

Definition at line 635 of file notification.php.

elgg_unregister_notification_event()

elgg_unregister_notification_event	(		$object_type,
			$object_subtype
	)

Unregister a notification event.

Parameters

string	$object_type	'object', 'user', 'group', 'site'
string	$object_subtype	The type of the entity

Returns

bool

Since

1.9

Definition at line 73 of file notification.php.

elgg_unregister_notification_method()

elgg_unregister_notification_method

(

$name

)

Unregister a delivery method for notifications.

Parameters

string

$name

The notification method name

Returns

bool

See also

elgg_register_notification_method()

Since

1.9

Definition at line 101 of file notification.php.

get_user_notification_settings()

get_user_notification_settings

(

$user_guid = 0

)

Get the notification settings for a given user.

Parameters

int

$user_guid

The user id

Returns

\stdClass|false

Definition at line 561 of file notification.php.

notify_user()

notify_user	(		$to,
			$from,
			$subject,
			$message,
		array	$params = array(),
			$methods_override = ""
	)

Notify a user via their preferences.

Parameters

mixed	$to	Either a guid or an array of guid's to notify.
int	$from	GUID of the sender, which may be a user, site or object.
string	$subject	Message subject.
string	$message	Message body.
array	$params	Misc additional parameters specific to various methods. By default Elgg core supports three parameters, which give notification plugins more control over the notifications: object => null|\ElggEntity|\ElggAnnotation The object that is triggering the notification. action => null|string Word that describes the action that is triggering the notification (e.g. "create" or "update"). summary => null|string Summary that notification plugins can use alongside the notification title and body.
mixed	$methods_override	A string, or an array of strings specifying the delivery methods to use - or leave blank for delivery using the user's chosen delivery methods.

Returns

array Compound array of each delivery user/delivery method's success or failure.

Exceptions

NotificationException

Definition at line 476 of file notification.php.

set_user_notification_setting()

set_user_notification_setting	(		$user_guid,
			$method,
			$value
	)

Set a user notification pref.

Parameters

int	$user_guid	The user id.
string	$method	The delivery method (eg. email)
bool	$value	On(true) or off(false).

Returns

bool

Definition at line 602 of file notification.php.

Variable Documentation

function

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks)	(	\Elgg\EventsService	$events,
		\Elgg\HooksRegistrationService	$hooks
	)

Definition at line 765 of file notification.php.