Elgg\Notifications\Notification Class Reference

Inheritance diagram for Elgg\Notifications\Notification:

Public Member Functions
	__construct (\ElggEntity $from,\ElggEntity $to, $language, $subject, $body, $summary= '', array $params=array())
	Create a notification. More...
	getSender ()
	Get the sender entity. More...
	getSenderGUID ()
	Get the sender entity guid. More...
	getRecipient ()
	Get the recipient entity. More...
	getRecipientGUID ()
	Get the recipient entity guid. More...
	toObject ()
	Export notification. More...

Public Attributes
const	ORIGIN_SUBSCRIPTIONS = 'subscriptions_service'
const	ORIGIN_INSTANT = 'instant_notifications'
	$summary
	$subject
	$body
	$language
	$params

Protected Attributes
	$from
	$to

Detailed Description

Definition at line 11 of file Notification.php.

Constructor & Destructor Documentation

Elgg\Notifications\Notification::__construct	(	\ElggEntity	$from,
		\ElggEntity	$to,
			$language,
			$subject,
			$body,
			$summary = '',
		array	$params = array()
	)

Create a notification.

Parameters

\ElggEntity	$from	The entity sending the notification (usually the site)
\ElggEntity	$to	The entity receiving the notification
string	$language	The language code for the notification
string	$subject	The subject of the notification
string	$body	The body of the notification
string	$summary	Optional summary of the notification
array	$params	Optional array of parameters

Exceptions

Definition at line 49 of file Notification.php.

Member Function Documentation

Elgg\Notifications\Notification::getRecipient

(

)

Get the recipient entity.

Returns

Definition at line 88 of file Notification.php.

Elgg\Notifications\Notification::getRecipientGUID

(

)

Get the recipient entity guid.

Returns

int

Definition at line 97 of file Notification.php.

Elgg\Notifications\Notification::getSender

(

)

Get the sender entity.

Returns

Definition at line 70 of file Notification.php.

Elgg\Notifications\Notification::getSenderGUID

(

)

Get the sender entity guid.

Returns

int

Definition at line 79 of file Notification.php.

Elgg\Notifications\Notification::toObject

(

)

Export notification.

Returns

Definition at line 105 of file Notification.php.

Member Data Documentation

Elgg\Notifications\Notification::$body

Definition at line 29 of file Notification.php.

Elgg\Notifications\Notification::$from

protected

Definition at line 17 of file Notification.php.

Elgg\Notifications\Notification::$language

Definition at line 32 of file Notification.php.

Elgg\Notifications\Notification::$params

Definition at line 35 of file Notification.php.

Elgg\Notifications\Notification::$subject

Definition at line 26 of file Notification.php.

Elgg\Notifications\Notification::$summary

Definition at line 23 of file Notification.php.

Elgg\Notifications\Notification::$to

protected

Definition at line 20 of file Notification.php.

const Elgg\Notifications\Notification::ORIGIN_INSTANT = 'instant_notifications'

Definition at line 14 of file Notification.php.

const Elgg\Notifications\Notification::ORIGIN_SUBSCRIPTIONS = 'subscriptions_service'

Definition at line 13 of file Notification.php.

---

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

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