Elgg  Version 4.3
Public Member Functions | Public Attributes | Protected Attributes | List of all members
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 10 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$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

Definition at line 63 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 148 of file Notification.php.

Elgg\Notifications\Notification::getRecipient ( )

Get the recipient entity.

Returns

Definition at line 100 of file Notification.php.

Elgg\Notifications\Notification::getRecipientGUID ( )

Get the recipient entity guid.

Returns
int

Definition at line 109 of file Notification.php.

Elgg\Notifications\Notification::getSender ( )

Get the sender entity.

Returns

Definition at line 82 of file Notification.php.

Elgg\Notifications\Notification::getSenderGUID ( )

Get the sender entity guid.

Returns
int

Definition at line 91 of file Notification.php.

Elgg\Notifications\Notification::toObject ( )

Export notification.

Returns

Definition at line 118 of file Notification.php.

Member Data Documentation

Elgg\Notifications\Notification::$body

Definition at line 35 of file Notification.php.

Elgg\Notifications\Notification::$from
protected

Definition at line 15 of file Notification.php.

Elgg\Notifications\Notification::$language

Definition at line 40 of file Notification.php.

Elgg\Notifications\Notification::$params

Definition at line 45 of file Notification.php.

Elgg\Notifications\Notification::$subject

Definition at line 30 of file Notification.php.

Elgg\Notifications\Notification::$summary

Definition at line 25 of file Notification.php.

Elgg\Notifications\Notification::$to
protected

Definition at line 20 of file Notification.php.

Elgg\Notifications\Notification::$url

Definition at line 50 of file Notification.php.


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