PHP Class Neos\Neos\EventLog\Domain\Model\Event

Exibir arquivo Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$accountIdentifier string The identifier of the account that triggered this event. Optional.
$childEvents ArrayCollection Child events, of this event
$data array Payload of the event.
$eventType string What was this event about? Is a required string constant.
$parentEvent Event The parent event, if exists. E.g. if a "move node" operation triggered a bunch of other events, or a "publish"
$timestamp DateTime When was this event?
$uid integer We introduce an auto_increment column to be able to sort events at the same timestamp

Public Methods

Method Description
__construct ( string $eventType, array $data, string $user = null, Event $parentEvent = null ) Create a new event
addChildEvent ( Event $childEvent ) : void Add a new child event. Is called from the child event's constructor.
getAccountIdentifier ( ) : string Return the identifier of the account (if any) which triggered this event
getChildEvents ( ) : array Return the child events (if any)
getData ( ) : array Return the payload of this event
getEventType ( ) : string Return the type of this event
getParentEvent ( ) : Event Return the parent event (if any)
getTimestamp ( ) : DateTime Return the timestamp of this event

Method Details

__construct() public method

Create a new event
public __construct ( string $eventType, array $data, string $user = null, Event $parentEvent = null )
$eventType string
$data array
$user string
$parentEvent Event

addChildEvent() public method

Add a new child event. Is called from the child event's constructor.
public addChildEvent ( Event $childEvent ) : void
$childEvent Event
return void

getAccountIdentifier() public method

Return the identifier of the account (if any) which triggered this event
public getAccountIdentifier ( ) : string
return string

getChildEvents() public method

Return the child events (if any)
public getChildEvents ( ) : array
return array

getData() public method

Return the payload of this event
public getData ( ) : array
return array

getEventType() public method

Return the type of this event
public getEventType ( ) : string
return string

getParentEvent() public method

Return the parent event (if any)
public getParentEvent ( ) : Event
return Event

getTimestamp() public method

Return the timestamp of this event
public getTimestamp ( ) : DateTime
return DateTime

Property Details

$accountIdentifier protected_oe property

The identifier of the account that triggered this event. Optional.
protected string $accountIdentifier
return string

$childEvents protected_oe property

Child events, of this event
protected ArrayCollection $childEvents
return ArrayCollection

$data protected_oe property

Payload of the event.
protected array $data
return array

$eventType protected_oe property

What was this event about? Is a required string constant.
protected string $eventType
return string

$parentEvent protected_oe property

The parent event, if exists. E.g. if a "move node" operation triggered a bunch of other events, or a "publish"
protected Event,Neos\Neos\EventLog\Domain\Model $parentEvent
return Event

$timestamp protected_oe property

When was this event?
protected DateTime $timestamp
return DateTime

$uid protected_oe property

We introduce an auto_increment column to be able to sort events at the same timestamp
protected int $uid
return integer