PHP Class Prooph\EventSourcing\AggregateChanged

Author: Alexander Miertsch ([email protected])

Inheritance: extends Prooph\Common\Messaging\DomainEvent

Show file Open project: prooph/event-sourcing Class Usage Examples

Protected Properties

Property	Type	Description
$payload	array

Public Methods

Method	Description
aggregateId ( ) : string
occur ( string $aggregateId, array $payload = [] ) : static
payload ( ) : array	Return message payload as array

Protected Methods

Method	Description
__construct ( string $aggregateId, array $payload, array $metadata = [] )
setAggregateId ( string $aggregateId )
setPayload ( array $payload ) : void	This method is called when message is instantiated named constructor fromArray

Method Details

__construct() protected method

protected __construct ( string $aggregateId, array $payload, array $metadata = [] )
$aggregateId	string
$payload	array
$metadata	array

aggregateId() public method

public aggregateId ( ) : string
return	string

occur() public static method

public static occur ( string $aggregateId, array $payload = [] ) : static
$aggregateId	string
$payload	array
return	static

payload() public method

The payload should only contain scalar types and sub arrays. The payload is normally passed to json_encode to persist the message or push it into a message queue.

public payload ( ) : array
return	array

setAggregateId() protected method

protected setAggregateId ( string $aggregateId )
$aggregateId	string

setPayload() protected method

This method is called when message is instantiated named constructor fromArray

protected setPayload ( array $payload ) : void
$payload	array
return	void

Property Details

$payload protected property

protected array $payload
return	array