consistence/consistence-doctrine

Integration of Consistence library with Doctrine ORM

Integration of Consistence library with Doctrine ORM

This library provides integration of Consistence value objects for Doctrine ORM so that you can use them in your entities., _(*1)

For now, the only integration which is needed is for Enums, see the examples below., _(*2)

Usage

Enums represent predefined set of values and of course, you will want to store these values in your database as well. Since Enums are objects and you only want to store the represented value, there has to be some mapping., _(*3)

You can see it in this example where you want to store sex for your Users:, _(*4)

<?php

namespace Consistence\Doctrine\Example\User;

class Sex extends \Consistence\Enum\Enum
{

    public const FEMALE = 'female';
    public const MALE = 'male';

}

To use the Sex enum in your User entity notice the type="enum<Consistence\Doctrine\Example\User\Sex>" in ORM\Column - this will be used for mapping the value to and from your database. You can specify any other parameters for ORM\Column as you would usually (nullability, length...)., _(*5)

<?php

namespace Consistence\Doctrine\Example\User;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class User extends \Consistence\ObjectPrototype
{

    // ...

    /**
     * @ORM\Column(type="enum<Consistence\Doctrine\Example\User\Sex>", nullable=true)
     * @var \Consistence\Doctrine\Example\User\Sex|null
     */
    private $sex;

    // ...

    public function __construct(
        // ...
        Sex $sex = null
        // ...
    )
    {
        // ...
        $this->sex = $sex;
        // ...
    }

    // ...

}

Before this will work with database, we need to register Doctrine DBAL type for each enum., _(*6)

If you are using Symfony, you can use consistence/consistence-doctrine-symfony, where you can just configure which types should be registered., _(*7)

If you do this in code, note that this step contains static calls which have global effect. I recommend putting them inside a bootstrap file (usually where you register the Composer autoloader now), which is run or included when the application starts., _(*8)

<?php

use Consistence\Doctrine\Enum\Type\StringEnumType;
use Consistence\Doctrine\Example\User\Sex;
use Doctrine\DBAL\Types\Type as DoctrineType;

foreach ([
    StringEnumType::create(Sex::class),
] as $type) {
    DoctrineType::getTypeRegistry()->register($type->getName(), $type);
}

We used StringEnumType because the Sex enum uses strings for its values. There are also IntegerEnumType, FloatEnumType and BooleanEnumType - depending on what scalar values are used in the enum., _(*9)

If you use the same enum in multiple places register it only once., _(*10)

Now everything is ready to be used, when you call flush, only female will be saved:, _(*11)

<?php

namespace Consistence\Doctrine\Example\User;

$user = new User(
    // ...
    Sex::get(Sex::FEMALE)
    // ...
);
/** @var \Doctrine\ORM\EntityManager $entityManager */
$entityManager->persist($user);

// when persisting User::$sex to database, `female` will be saved
$entityManager->flush();

And when you retrieve the entity back from database, you will receive the Sex enum object again:, _(*12)

<?php

namespace Consistence\Doctrine\Example\User;

/** @var \Doctrine\ORM\EntityManager $entityManager */
$user = $entityManager->find(User::class, 1);
var_dump($user->getSex());

/*

class Consistence\Doctrine\Example\User\Sex#5740 (1) {
  private $value =>
  string(6) "female"
}

*/

This means that the objects API is symmetrical (you get the same type as you set) and you can start benefiting from Enums advantages such as being sure, that what you get is already a valid value and having the possibility to define methods on top of the represented values., _(*13)

Installation

If you are using Symfony, you can use consistence/consistence-doctrine-symfony, which will take care of the integration., _(*14)

1) Install package consistence/consistence-doctrine with Composer:, _(*15)

composer require consistence/consistence-doctrine

2) Register needed DBAL types (see Usage section above)., _(*16)

That's all, you are good to go!, _(*17)