PHP 클래스 Elgg\Notifications\Event

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

보호된 프로퍼티들

프로퍼티 타입 설명
$action * @var string The name of the action/event
$actor * @var ElggEntity User who triggered the event
$object * @var string Action's object

공개 메소드들

메소드 설명
__construct ( ElggDat\ElggData $object, string $action, ElggEntit\ElggEntity $actor = null ) Create a notification event
getAction ( ) : string Get the name of the action
getActor ( ) : ElggEntit\ElggEntity | false | null Get the actor of the event
getActorGUID ( ) : integer Get the GUID of the actor
getDescription ( ) : string Get a description of the event
getObject ( ) : ElggDat\ElggData | false | null Get the object of the event
toObject ( ) : stdClas\stdClass Export the notification event into a serializable object This method is mainly used for logging purposes

메소드 상세

__construct() 공개 메소드

Create a notification event
public __construct ( ElggDat\ElggData $object, string $action, ElggEntit\ElggEntity $actor = null )
$object ElggDat\ElggData The object of the event (ElggEntity)
$action string The name of the action (default: create)
$actor ElggEntit\ElggEntity The entity that caused the event (default: logged in user)

getAction() 공개 메소드

Get the name of the action
public getAction ( ) : string
리턴 string

getActor() 공개 메소드

Get the actor of the event
public getActor ( ) : ElggEntit\ElggEntity | false | null
리턴 ElggEntit\ElggEntity | false | null

getActorGUID() 공개 메소드

Get the GUID of the actor
public getActorGUID ( ) : integer
리턴 integer

getDescription() 공개 메소드

Get a description of the event
public getDescription ( ) : string
리턴 string

getObject() 공개 메소드

Get the object of the event
public getObject ( ) : ElggDat\ElggData | false | null
리턴 ElggDat\ElggData | false | null

toObject() 공개 메소드

Export the notification event into a serializable object This method is mainly used for logging purposes
public toObject ( ) : stdClas\stdClass
리턴 stdClas\stdClass

프로퍼티 상세

$action 보호되어 있는 프로퍼티

* @var string The name of the action/event
protected $action

$actor 보호되어 있는 프로퍼티

* @var ElggEntity User who triggered the event
protected $actor

$object 보호되어 있는 프로퍼티

* @var string Action's object
protected $object