Download the PHP package lingoda/domain-events without Composer

Domain Events Bundle

Installation

Bundle configuration

Usage

IMPORTANT NOTE: Never record domain events in doctrine lifecycle hooks!

Example of simple User entity that triggers a Domain Event.

Sample Domain Event

Sample User entity that records the event

In action

Dispatching domain events with Messenger Worker

First configure the outbox messenger transport

After that we can consume the Outbox table and dispatch domain events from it with the below command

Scheduling events

We can schedule Domain Events to be published in the future

Replacing/Re-scheduling events in the event_store

We can replace/re-schedule unpublished events by implementing the ReplaceableEventInterface for the Domain Event If you implement this interface, before the OutboxRecord persister stores a new domain event, it will check if there is any previously stored but unpublished events from the same entity id, if yes it will delete them and add the new one only.

Enriching Domain Events

While domain events should be immutable, sometimes it's inevitable that you need to enrich with additional information but you don't want to assign at creation time because the service is not accessible inside the entity.

You can listen to the PreAppendEvent in a subscriber/listener that is dispatched right before the Domain Event gets persisted. At this point you can enrich with additional information.

Simple example would be injecting and actorId which corresponds to the user id that is currently interacting with the app.

Testing

Install dev dependencies

Run tests

TODO

• Add functional tests
• Improve OutboxTransportFactory with additional options in the DSN
• Add instructions for doctrine mapping and routing DomainEvent
• Fix issues around Carbon serialization