Elgg\Notifications\Notification Class Reference

Notification container. More...

Public Member Functions
	__construct (\ElggEntity $from,\ElggEntity $to, $language, $subject, $body, $summary= '', array $params=[])
	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...
	__serialize ()
	Called when the object is serialized. More...

Public Attributes
	$summary
	$subject
	$body
	$language
	$params
	$url

Protected Attributes
	$from
	$to

Detailed Description

Notification container.

Since

1.10

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 = []
	)

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

Definition at line 64 of file Notification.php.

Member Function Documentation

Elgg\Notifications\Notification::__serialize

(

)

Called when the object is serialized.

Returns

array

See also

serialize()

Definition at line 149 of file Notification.php.

Elgg\Notifications\Notification::getRecipient

(

)

Get the recipient entity.

Returns

Definition at line 101 of file Notification.php.

Elgg\Notifications\Notification::getRecipientGUID

(

)

Get the recipient entity guid.

Returns

int

Definition at line 110 of file Notification.php.

Elgg\Notifications\Notification::getSender

(

)

Get the sender entity.

Returns

Definition at line 83 of file Notification.php.

Elgg\Notifications\Notification::getSenderGUID

(

)

Get the sender entity guid.

Returns

int

Definition at line 92 of file Notification.php.

Elgg\Notifications\Notification::toObject

(

)

Export notification.

Returns

Definition at line 119 of file Notification.php.

Member Data Documentation

Elgg\Notifications\Notification::$body

Definition at line 36 of file Notification.php.

Elgg\Notifications\Notification::$from

protected

Definition at line 16 of file Notification.php.

Elgg\Notifications\Notification::$language

Definition at line 41 of file Notification.php.

Elgg\Notifications\Notification::$params

Definition at line 46 of file Notification.php.

Elgg\Notifications\Notification::$subject

Definition at line 31 of file Notification.php.

Elgg\Notifications\Notification::$summary

Definition at line 26 of file Notification.php.

Elgg\Notifications\Notification::$to

protected

Definition at line 21 of file Notification.php.

Elgg\Notifications\Notification::$url

Definition at line 51 of file Notification.php.

---

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

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