README

This library is design to help you to build your application with a Domain Design Development approach.

It is well integrated with:

• Symfony >= 5.5 (for >=4.4 compatibility, install the version 2.2 of Doctrine domain events)
• ApiPlatform >= 2.1
• Doctrine >= 2.5
• PHP >= 7.4

But you can use it with any PHP project.

Here are some slides that explain how we get there.

Features

Domain Events:

• 🔔 Domain event dispatcher
• ⚡ Injection of the dispatcher in Doctrine entities
• 🔧 Symfony serializer integration
• ⭐ Learn how do more with our cookbooks

Drawbacks

This library is build to allow you to use Doctrine models as Domain model. This has some cost: you can't instantiate domain model by hand anymore. This means that you need a factory for any of the usage of your domain model.

This component provides the implementation for Symfony serializer and Doctrine. For your own needs you should use the class (service if you use the bundle) Biig\Component\Domain\Model\Instantiator\Instantiator.

Installation

composer require swag-industries/doctrine-domain-events

Basic usage

class YourModel extends DomainModel
{
    public const CREATION = 'creation';
    public function __construct()
    {
        $this->dispatch(new DomainEvent($this), self::CREATION);
    }
}

/**
 * @implements DomainRuleInterface<DomainEvent>
 */
class DomainRule implements DomainRuleInterface
{
    public function on(): string|array
    {
        return YourModel::CREATION; // Or YourCustomEvent::class that extends DomainEvent
    }
    
    public function execute(DomainEvent $event)
    {
        // Do Something on your model creation
    }
}

As your model needs a dispatcher you need to call the setDispatcher() method any time you create a new instance of your model. To avoid doing this manually you can use the Instantiator that the library provides.

It doesn't use the constructor to add the dispatcher because in PHP you can create objects without the constructor. For instance, that's what Doctrine does.

use Biig\Component\Domain\Model\Instantiator\Instantiator;
use Doctrine\ORM\EntityManager;

class SomeController
{
    public function index(Instantiator $instantiator, EntityManager $entityManager)
    {
        $model = $instantiator->instantiate(YourModel::class);
        $entityManager->persist($model);
        $entityManager->flush();
    }
}

Integration to Symfony

Use the bundle :

<?php
// config/bundles.php

return [
    // ...
    Biig\Component\Domain\Integration\Symfony\DomainBundle::class => ['all' => true],
];

Learn more about Symfony Integration

Versions