https://github.com/rekalogika/domain-event-outbox
Implementation of the transactional outbox pattern on top of rekalogika/domain-event
https://github.com/rekalogika/domain-event-outbox
cqrs ddd doctrine domain domain-driven-design domain-event event event-dispatcher event-listener microservice outbox symfony
Last synced: 2 months ago
JSON representation
Implementation of the transactional outbox pattern on top of rekalogika/domain-event
- Host: GitHub
- URL: https://github.com/rekalogika/domain-event-outbox
- Owner: rekalogika
- License: mit
- Created: 2024-03-09T18:54:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T15:47:35.000Z (about 1 year ago)
- Last Synced: 2024-11-15T20:07:19.609Z (11 months ago)
- Topics: cqrs, ddd, doctrine, domain, domain-driven-design, domain-event, event, event-dispatcher, event-listener, microservice, outbox, symfony
- Language: PHP
- Homepage: https://rekalogika.dev/domain-event
- Size: 56.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rekalogika/domain-event-outbox
Implementation of the transactional outbox pattern on top of the
`rekalogika/domain-event` package.
Full documentation is available at
[rekalogika.dev/domain-event](https://rekalogika.dev/domain-event).
## Synopsis
```php
//
// The event
//
final readonly class PostChanged
{
public function __construct(public string $postId) {}
}
//
// The entity
//
use Rekalogika\Contracts\DomainEvent\DomainEventEmitterInterface;
use Rekalogika\Contracts\DomainEvent\DomainEventEmitterTrait;
class Post implements DomainEventEmitterInterface
{
use DomainEventEmitterTrait;
// ...
public function setTitle(string $title): void
{
$this->title = $title;
// highlight-next-line
$this->recordEvent(new PostChanged($this->id));
}
// ...
}
//
// The listener
//
use Psr\Log\LoggerInterface;
use Rekalogika\Contracts\DomainEvent\Attribute\AsPublishedDomainEventListener;
class PostEventListener
{
public function __construct(private LoggerInterface $logger) {}
// highlight-next-line
#[AsPublishedDomainEventListener]
public function onPostChanged(PostChanged $event) {
$postId = $event->postId;
$this->logger->info("Post $postId has been changed.");
}
}
//
// The caller
//
use Doctrine\ORM\EntityManagerInterface;
/** @var Post $post */
/** @var EntityManagerInterface $entityManager */
$post->setTitle('New title');
$entityManager->flush();
// During the flush above, the event will be recorded in the outbox table in the
// database. Then the message relay service is executed, and will publish the
// events on the event bus. When the event bus announces the event, the listener
// will be executed.
```
## Documentation
[rekalogika.dev/domain-event](https://rekalogika.dev/domain-event).
## License
MIT
## Contributing
The `rekalogika/domain-event-outbox` repository is a read-only repo split from
the main repo. Issues and pull requests should be submitted to the
[rekalogika/domain-event-src](https://github.com/rekalogika/domain-event-src)
monorepo.