biig/domain

Domain component

, _(*1)

This library is design to help you to build your application with a Domain Design Development approach., _(*2)

It is well integrated with:, _(*3)

• Symfony >= 4.3 (for >=3.3 compatibility, install the version 1.5 of the domain component)
• ApiPlatform >= 2.1
• Doctrine >=2.5

But you can use it with any PHP project., _(*4)

Here are some slides that explain how we get there., _(*5)

Features

Domain Events:, _(*6)

• 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., _(*7)

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., _(*8)

Installation

composer require biig/domain

Basic usage

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

class DomainRule implements DomainRuleInterface
{
    public function on()
    {
        return YourModel::CREATION;
    }

    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., _(*9)

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., _(*10)

Integration to Symfony

Use the bundle :, _(*11)

<?php
// config/bundles.php

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

Learn more about Symfony Integration, _(*12)

Versions