Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | Protected Attributes | List of all members
Elgg\Notifications\Notification Class Reference
Inheritance diagram for Elgg\Notifications\Notification:
Elgg\Notifications\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...
 

Public Attributes

 $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$fromThe entity sending the notification (usually the site)
\ElggEntity$toThe entity receiving the notification
string$languageThe language code for the notification
string$subjectThe subject of the notification
string$bodyThe body of the notification
string$summaryOptional summary of the notification
array$paramsOptional array of parameters
Exceptions
\InvalidArgumentException

Definition at line 45 of file Notification.php.

Member Function Documentation

Elgg\Notifications\Notification::getRecipient ( )

Get the recipient entity.

Returns

Definition at line 84 of file Notification.php.

Elgg\Notifications\Notification::getRecipientGUID ( )

Get the recipient entity guid.

Returns
int

Definition at line 93 of file Notification.php.

Elgg\Notifications\Notification::getSender ( )

Get the sender entity.

Returns

Definition at line 66 of file Notification.php.

Elgg\Notifications\Notification::getSenderGUID ( )

Get the sender entity guid.

Returns
int

Definition at line 75 of file Notification.php.

Member Data Documentation

Elgg\Notifications\Notification::$body

Definition at line 25 of file Notification.php.

Elgg\Notifications\Notification::$from
protected

Definition at line 13 of file Notification.php.

Elgg\Notifications\Notification::$language

Definition at line 28 of file Notification.php.

Elgg\Notifications\Notification::$params

Definition at line 31 of file Notification.php.

Elgg\Notifications\Notification::$subject

Definition at line 22 of file Notification.php.

Elgg\Notifications\Notification::$summary

Definition at line 19 of file Notification.php.

Elgg\Notifications\Notification::$to
protected

Definition at line 16 of file Notification.php.


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