Remove final constructor for Type

[ruudk]

Q	A
Type	improvement
Fixed issues	#6704

Summary

This allows people to define a constructor when creating custom Doctrine\DBAL\Types\Type implementations.

They can be registered by passing an instance to Type::addType.

When a class string is passed, and the Type cannot be instantiated, an helpful error message will be thrown.

[greg0ire]

Note: this is another take on #5528

[morozov]

I've never used custom types as besides schema management, they are primarily designed for the ORM. I'll defer to Alexander.

[derrabus]

If we do that, we turn Type::addType() into a potential footgun. Maybe it's time to deprecate the static methods on the Type class in favor of the TypeRegistry?

[ruudk]

If we do that, we turn Type::addType() into a potential footgun.

How will it be a potential footgun? The current desired behavior is guarded, so I don't see how.

Maybe it's time to deprecate the static methods on the Type class in favor of the TypeRegistry?

I agree, but that can be done independently from this PR, no?

[derrabus]

If we do that, we turn Type::addType() into a potential footgun.

How will it be a potential footgun? The current desired behavior is guarded, so I don't see how.

Yes, you've done all you could to give the developer proper feedback. Yet, we're about to create a class of types that cannot be registered with Type::addType() anymore, an issue which is only discoverable at runtime.

Maybe it's time to deprecate the static methods on the Type class in favor of the TypeRegistry?

I agree, but that can be done independently from this PR, no?

Sure, but still we should talk about it. We somehow ended up with an only partially implemented feature and I want us to work towards a proper solution this time instead of adding a small hack on top to make it somewhat work.

[ruudk]

@derrabus @greg0ire You're right. Let's deprecate Type::addType immediately. Updated the PR.

[greg0ire]

It seems the tests I wrote in my initial PR were not sufficient to prove it's possible to do what's in the documentation. Maybe they should be improved?

[greg0ire]

Suggested change

	Use Type::getTypeRegistry()->register() instead.
	Use `Type::getTypeRegistry()->register()` instead.

[greg0ire]

The docs should be updated, they mention addType.

[ruudk]

@greg0ire I made some changes. Could you approve the workflow so we can see the test results?

[GromNaN]

Added some suggestion to keep the API consistent.

Injecting the TypeRegistry everywhere might be a long-term project that involves a lot of changes in other Doctrine packages.

[GromNaN]

We could keep this method if the arg type were widened.

Suggested change

	public static function addType(string $name, string $className): void
	public static function addType(string $name, string|Type $type): void

Either we keep this API, or we deprecate all the static methods of this class (getType, hasType, lookupName, overrideType, getTypesMap), which would have a large impact on the Doctrine related packages.

If you don't want to change the signature of this method, you can add setType(string $name, Type $type, bool $override = false).

Note that the DoctrineBundle would use the optional "override" in ConnectionFactory.

[ruudk]

I like it, I pushed the changes. Much simpler now!

[GromNaN]

The API could be as simple as this:

Suggested change

	Type::getTypeRegistry()->register(MoneyType::NAME, new MoneyType);
	Type::addType(MoneyType::NAME, new MoneyType());

[ruudk]

@GromNaN @greg0ire Updated the PR. I think this is a simpler approach. WDYT?

[GromNaN]

The approach seems correct at first.

Ideally, someone should take care of injecting the TypeRegistry everywhere the Type::getType() is used.

[ruudk]

@GromNaN thanks, applied your feedback!

[greg0ire]

@ruudk static analysis is failing

[ruudk]

@greg0ire Fixed them, please approve the workflow.

[SenseException]

Okay, but what happened to the deprecation?

[ruudk]

@SenseException See #6705 (comment). There a solution was proposed that would allow me to not deal with the depreciation.

Deprecating it yes or no is now a task for the future. Not required for this feature.

[greg0ire]

Thanks @ruudk !

[ruudk]

@greg0ire Is there an ETA for 4.3.0? I see the milestone is 100%. I would really like to use this constructor 😁

[derrabus]

Not yet, but I wouldn't want to wait too much longer either. 😃

[SerafimArts]

Thank you a lot guys! This finally made it possible to register custom Doctrine types in the Symfony Container and use them from there. I can't express my gratitude for the work done!

[ruudk]

Thanks!

I wish DoctrineBundle would make it a lot easier to register types as services now that this is in place.

[GromNaN]

For the MongoDB ODM Bundle, I'm adding a new attribute #[AsFieldType]: https://github.com/docine/DoctrineMongoDBBundle/pull/963

This is something that could be done in the same way in Doctrine bundle; with a new tag and an attribute #[AsColumnType].

[ruudk]

That would be amazing!