feat: add AsDbalType attribute by syl20b · Pull Request #2197 · doctrine/DoctrineBundle

syl20b · 2026-01-30T13:59:11Z

Description

This PR add a new AsDbalType attribute to automatically register the related class as a DBAL type.

Problem Solved

Currently, to register a custom DBAL type, it must be manually declared in the Doctrine configuration file:

# config/packages/doctrine.yaml

doctrine:
    dbal:
        types:
            my_custom_type: App\Type\MyCustomType

This approach is verbose and requires the developer to manage configuration in addition to the type class itself.

Feature Added

The addition of the #[AsDbalType] attribute allows the application to automatically detect and register any class that uses this attribute.

Concrete Usage Example

Here is how you can register a custom type directly via the attribute, without touching the YAML configuration:

1. Creating the Custom Type

<?php

namespace App\Type;

use Doctrine\DBAL\Types\Type;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\Bundle\DoctrineBundle\Attribute\AsDoctrineType;

#[AsDbalType(name: 'my_custom_type')]
final class MyCustomType extends Type
{
    // ... implementation of methods
}

2. Usage in an Entity

You can then use this type directly in your entities:

<?php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

class Product
{
    #[ORM\Column(type: 'my_custom_type', length: 255)]
    private ?string $name = null;
    
    // ...
}

Advantages

Zero Configuration: No need to modify doctrine.yaml for every new custom type.
Discoverability: The DBAL type and its name are declared in the same location as its implementation.

Jean-Beru · 2026-01-30T14:07:42Z

src/DependencyInjection/Compiler/RegisterAsDoctrineTypeAttributePass.php

+        $types = $container->getParameter('doctrine.dbal.connection_factory.types');
+
+        foreach ($container->findTaggedServiceIds('doctrine.dbal.type') as $id => $tags) {
+            $types[$tags[0]['name']] = ['class' => $container->getDefinition($id)->getClass()];


Should we have to loop over every tags? Even if the attribute is not repeatable, the service can be tagged directly using AutoconfigureTag.

We should indeed process all tags, and throw a proper exception when the name is not provided in the tag instead of producing a notice.

Jean-Beru · 2026-01-30T14:09:30Z

src/DependencyInjection/Compiler/RegisterAsDoctrineTypeAttributePass.php

+        $types = $container->getParameter('doctrine.dbal.connection_factory.types');
+
+        foreach ($container->findTaggedServiceIds('doctrine.dbal.type') as $id => $tags) {
+            $types[$tags[0]['name']] = ['class' => $container->getDefinition($id)->getClass()];


Maybe it could be interesting to check if the name property exists.

👌

I would also check if the class extends Doctrine\DBAL\Types\Type

stof · 2026-01-30T14:21:16Z

src/Attribute/AsDoctrineType.php

+use Attribute;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+final readonly class AsDoctrineType


Suggested change

final readonly class AsDoctrineType

final readonly class AsDbalType

Other doctrine projects might have a concept of type as well.

stof · 2026-01-30T14:23:18Z

src/DependencyInjection/Compiler/RegisterAsDoctrineTypeAttributePass.php

+        $types = $container->getParameter('doctrine.dbal.connection_factory.types');
+
+        foreach ($container->findTaggedServiceIds('doctrine.dbal.type') as $id => $tags) {
+            $types[$tags[0]['name']] = ['class' => $container->getDefinition($id)->getClass()];


We should indeed process all tags, and throw a proper exception when the name is not provided in the tag instead of producing a notice.

stof · 2026-01-30T14:26:26Z

src/DependencyInjection/Compiler/RegisterAsDoctrineTypeAttributePass.php

+            $types[$tags[0]['name']] = ['class' => $container->getDefinition($id)->getClass()];
+        }
+
+        $container->setParameter('doctrine.dbal.connection_factory.types', $types);


I'm not sure this is the right approach currently. The proposed API would make people think they can use DI in their types by registering them as services, while the implementation won't use those services.

There is 2 possible ways there:

implement proper support for using the services for the type instances, thanks to the DBAL 4.x feature allowing that

register only the class as done here, but build that feature using resource tags (which helps a bit with the intent)

Indeed, I missed it.
I change the implementation to use resource tags.
Thanks

@stof @Jean-Beru I changed the first implementation to use resource tags when available (e.g symfony/dependency-injection >= 7.3), and fallback to tags otherwise.
Let me know if this is a good way.

Jean-Beru · 2026-02-13T06:57:36Z

tests/DependencyInjection/DoctrineExtensionTest.php

+
+        /** @phpstan-ignore function.alreadyNarrowedType */
+        $attributes = method_exists($container, 'getAttributeAutoconfigurators')
+            ? array_map(static fn (array $arr) => $arr[0], $container->getAttributeAutoconfigurators())


Suggested change

? array_map(static fn (array $arr) => $arr[0], $container->getAttributeAutoconfigurators())

? array_column($container->getAttributeAutoconfigurators(), 0)

?

@Jean-Beru I used array_map to be consistent with the others similar tests.

Plus, the return type of the getAttributeAutoconfigurators() method is an array with the attribute FQCN as a key and the closure as first entry of the sub array :

array:2 [ "Doctrine\Bundle\DoctrineBundle\Attribute\AsDbalType" => array:1 [ 0 => Closure(ChildDefinition $definition, AsDbalType $type): void^ {#4186 returnType: "void" class: "Doctrine\Bundle\DoctrineBundle\DependencyInjection\DoctrineExtension" } ] "Doctrine\Bundle\DoctrineBundle\Attribute\AsMiddleware" => array:1 [ 0 => Closure(ChildDefinition $definition, AsMiddleware $attribute): void^ {#7886 returnType: "void" class: "Doctrine\Bundle\DoctrineBundle\DependencyInjection\DoctrineExtension" } ] ]

So calling array_column as is would not give us the expected behavior.

WDYT?

You're right, my bad 🙂

feat: add AsDoctrineType attribute

c20d4c5

Jean-Beru reviewed Jan 30, 2026

View reviewed changes

stof reviewed Jan 30, 2026

View reviewed changes

syl20b added 4 commits January 30, 2026 16:15

rename AsDoctrineType to AsDbalType

822ae08

use resources tags

4e2dd40

fix phpstan

ba7b961

rename compiler pass

82ce149

syl20b force-pushed the add-as-doctrine-type-attribute branch from 3304bbe to 8f59bd1 Compare January 30, 2026 23:55

add tests

9996357

syl20b force-pushed the add-as-doctrine-type-attribute branch 2 times, most recently from 8d6c4f7 to e26bfe1 Compare February 1, 2026 21:15

add compatibility with Symfony < 7.3

ea214eb

syl20b force-pushed the add-as-doctrine-type-attribute branch from e26bfe1 to ea214eb Compare February 1, 2026 22:08

syl20b changed the title ~~feat: add AsDoctrineType attribute~~ feat: add AsDbalType attribute Feb 1, 2026

syl20b requested a review from stof February 12, 2026 08:28

Jean-Beru reviewed Feb 13, 2026

View reviewed changes

Jean-Beru approved these changes Feb 13, 2026

View reviewed changes

	final readonly class AsDoctrineType
	final readonly class AsDbalType

	? array_map(static fn (array $arr) => $arr[0], $container->getAttributeAutoconfigurators())
	? array_column($container->getAttributeAutoconfigurators(), 0)

Uh oh!

Comments

Conversation

syl20b commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

syl20b commented Jan 30, 2026 •

edited

Loading