fmasa/doctrine-yaml-annotations

Custom annotations for YAML mapping

Doctrine YAML annotations

, _(*1)

One of the great features of Doctrine 2 is extensibility. Doctrine offers multiple ways to specify mapping information, but the most of the extensions only supports Annotations configuration., _(*2)

This package adds custom annotations to your YAML mapping files., _(*3)

What is currently supported: - property annotations (fields and embeddables) - class annotations, _(*4)

Installation

The best way to install fmasa/doctrine-yaml-annotations is using Composer:, _(*5)

$ composer require fmasa/doctrine-yaml-annotations

For example let's configure the Consistence extension for Doctrine., _(*6)

First we have to create annotation reader:, _(*7)

use Fmasa\DoctrineYamlAnnotations\YamlReader;

$configuration = $entityManager->getConfiguration();
$reader = new YamlReader($configuration, [
    'enum' => EnumAnnotation::class
]);

Second argument for AnnotationReader is optional map with entity aliases., _(*8)

Add annotations to your mapping files:, _(*9)

Some\Entity:

    ...

    fields:
        state:
            type: enum_string
            annotations:
                Consistence\Doctrine\Enum\EnumAnnotation: # or just enum
                    class: StateEnum

Now you can read annotations just using Doctrine\Common\Annotations\Reader API:, _(*10)

$reader->getPropertyAnnotation(
    (new \ReflectionClass(Some\Entity::class))->getProperty('state'),
    EnumAnnotation::class
); // returns instance of EnumAnnotation { class => "StateEnum" }