PHP 클래스 Elgg\Notifications\Notification

부터: 1.10
파일 보기 프로젝트 열기: elgg/elgg 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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

보호된 프로퍼티들

프로퍼티 타입 설명
$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