PHP Класс Elgg\Notifications\Notification

С версии: 1.10
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$body The body of the notification. Email body is one use.
$language The language of the notification
$params Additional parameters
$subject The subject of the notification. Email subject is one use.
$summary A single sentence summary string

Защищенные свойства (Protected)

Свойство Тип Описание
$from The entity causing or creating the notification
$to The user receiving the notification

Открытые методы

Метод Описание
__construct ( ElggEntity $from, ElggEntity $to, string $language, string $subject, string $body, string $summary = '', array $params = [] ) Create a notification
getRecipient ( ) : ElggEntity Get the recipient entity
getRecipientGUID ( ) : integer Get the recipient entity guid
getSender ( ) : ElggEntity Get the sender entity
getSenderGUID ( ) : integer Get the sender entity guid
toObject ( ) : stdClass Export notification

Описание методов

__construct() публичный Метод

Create a notification
public __construct ( ElggEntity $from, ElggEntity $to, string $language, string $subject, string $body, string $summary = '', array $params = [] )
$from ElggEntity The entity sending the notification (usually the site)
$to ElggEntity The entity receiving the notification
$language string The language code for the notification
$subject string The subject of the notification
$body string The body of the notification
$summary string Optional summary of the notification
$params array Optional array of parameters

getRecipient() публичный Метод

Get the recipient entity
public getRecipient ( ) : ElggEntity
Результат ElggEntity

getRecipientGUID() публичный Метод

Get the recipient entity guid
public getRecipientGUID ( ) : integer
Результат integer

getSender() публичный Метод

Get the sender entity
public getSender ( ) : ElggEntity
Результат ElggEntity

getSenderGUID() публичный Метод

Get the sender entity guid
public getSenderGUID ( ) : integer
Результат integer

toObject() публичный Метод

Export notification
public toObject ( ) : stdClass
Результат stdClass

Описание свойств

$body публичное свойство

The body of the notification. Email body is one use.
public $body

$from защищенное свойство

The entity causing or creating the notification
protected $from

$language публичное свойство

The language of the notification
public $language

$params публичное свойство

Additional parameters
public $params

$subject публичное свойство

The subject of the notification. Email subject is one use.
public $subject

$summary публичное свойство

A single sentence summary string
public $summary

$to защищенное свойство

The user receiving the notification
protected $to