Elgg_Notifications_Notification Class Reference

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...

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

Protected Attributes
	$from
	$to

Detailed Description

Definition at line 9 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

InvalidArgumentException

Definition at line 43 of file Notification.php.

Member Function Documentation

Elgg_Notifications_Notification::getRecipient

(

)

Get the recipient entity.

Returns

ElggEntity

Definition at line 82 of file Notification.php.

Elgg_Notifications_Notification::getRecipientGUID

(

)

Get the recipient entity guid.

Returns

int

Definition at line 91 of file Notification.php.

Elgg_Notifications_Notification::getSender

(

)

Get the sender entity.

Returns

ElggEntity

Definition at line 64 of file Notification.php.

Elgg_Notifications_Notification::getSenderGUID

(

)

Get the sender entity guid.

Returns

int

Definition at line 73 of file Notification.php.

Member Data Documentation

Elgg_Notifications_Notification::$body

Definition at line 23 of file Notification.php.

Elgg_Notifications_Notification::$from

protected

Definition at line 11 of file Notification.php.

Elgg_Notifications_Notification::$language

Definition at line 26 of file Notification.php.

Elgg_Notifications_Notification::$params

Definition at line 29 of file Notification.php.

Elgg_Notifications_Notification::$subject

Definition at line 20 of file Notification.php.

Elgg_Notifications_Notification::$summary

Definition at line 17 of file Notification.php.

Elgg_Notifications_Notification::$to

protected

Definition at line 14 of file Notification.php.

---

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

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