Resolve types through the DBAL TypeProvider interface

GromNaN · GromNaN · commit f4dd7a11d590 · 2026-08-05T13:02:57.000+02:00
DBAL 4.5 exposes Configuration::getTypeProvider() returning the new Doctrine\DBAL\Types\TypeProvider interface rather than the final TypeRegistry, so the type source is no longer required to be that concrete class. Renamed TypeRegistryLocator to TypeProviderLocator accordingly, along with the $typeRegistry properties and locals it feeds. The declared types are unions of TypeProvider and TypeRegistry, because the interface only exists as of DBAL 4.5 while these code paths still support older versions. PHP matches the first applicable member of a union and never loads the other, so the union resolves fine when TypeProvider is absent, whereas a sole TypeProvider type would raise a TypeError. Every such union sits on a private property, a private parameter, or the @internal locator, so none of it reaches the public API. DatabaseDriver now reads Column::getTypeName() instead of looking a name back up from an instance, which drops two deprecated calls at once. SqlWalker's deprecated TypedExpression branch keeps using Type::lookupName(), since a Type instance is all it has; both are deprecated and will be removed together.
diff --git a/src/Internal/Hydration/AbstractHydrator.php b/src/Internal/Hydration/AbstractHydrator.php
@@ -7,10 +7,11 @@
 use BackedEnum;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Result;
+use Doctrine\DBAL\Types\TypeProvider;
 use Doctrine\DBAL\Types\TypeRegistry;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Events;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Query\ResultSetMapping;
 use Doctrine\ORM\Tools\Pagination\LimitSubqueryWalker;
@@ -55,7 +56,7 @@ abstract class AbstractHydrator
      */
     protected UnitOfWork $uow;
 
-    private readonly TypeRegistry $typeRegistry;
+    private readonly TypeProvider|TypeRegistry $typeProvider;
 
     /**
      * Local ClassMetadata cache to avoid going to the EntityManager all the time.
@@ -90,7 +91,7 @@ public function __construct(protected EntityManagerInterface $em)
     {
         $this->platform     = $em->getConnection()->getDatabasePlatform();
         $this->uow          = $em->getUnitOfWork();
-        $this->typeRegistry = TypeRegistryLocator::fromConnection($em->getConnection());
+        $this->typeProvider = TypeProviderLocator::fromConnection($em->getConnection());
     }
 
     /**
@@ -462,7 +463,7 @@ protected function hydrateColumnInfo(string $key): array|null
                 $columnInfo    = [
                     'isIdentifier' => in_array($fieldName, $classMetadata->identifier, true),
                     'fieldName'    => $fieldName,
-                    'type'         => $this->typeRegistry->get($fieldMapping->type),
+                    'type'         => $this->typeProvider->get($fieldMapping->type),
                     'dqlAlias'     => $ownerMap,
                     'enumType'     => $this->rsm->enumMappings[$key] ?? null,
                 ];
@@ -490,7 +491,7 @@ protected function hydrateColumnInfo(string $key): array|null
                     'isScalar'             => true,
                     'isNewObjectParameter' => true,
                     'fieldName'            => $this->rsm->scalarMappings[$key],
-                    'type'                 => $this->typeRegistry->get($this->rsm->typeMappings[$key]),
+                    'type'                 => $this->typeProvider->get($this->rsm->typeMappings[$key]),
                     'argIndex'             => $mapping['argIndex'],
                     'objIndex'             => $mapping['objIndex'],
                     'enumType'             => $this->rsm->enumMappings[$key] ?? null,
@@ -499,7 +500,7 @@ protected function hydrateColumnInfo(string $key): array|null
             case isset($this->rsm->scalarMappings[$key], $this->hints[LimitSubqueryWalker::FORCE_DBAL_TYPE_CONVERSION]):
                 return $this->cache[$key] = [
                     'fieldName' => $this->rsm->scalarMappings[$key],
-                    'type'      => $this->typeRegistry->get($this->rsm->typeMappings[$key]),
+                    'type'      => $this->typeProvider->get($this->rsm->typeMappings[$key]),
                     'dqlAlias'  => '',
                     'enumType'  => $this->rsm->enumMappings[$key] ?? null,
                 ];
@@ -508,7 +509,7 @@ protected function hydrateColumnInfo(string $key): array|null
                 return $this->cache[$key] = [
                     'isScalar'  => true,
                     'fieldName' => $this->rsm->scalarMappings[$key],
-                    'type'      => $this->typeRegistry->get($this->rsm->typeMappings[$key]),
+                    'type'      => $this->typeProvider->get($this->rsm->typeMappings[$key]),
                     'enumType'  => $this->rsm->enumMappings[$key] ?? null,
                 ];
 
@@ -517,7 +518,7 @@ protected function hydrateColumnInfo(string $key): array|null
                 $fieldName = $this->rsm->metaMappings[$key];
                 $dqlAlias  = $this->rsm->columnOwnerMap[$key];
                 $type      = isset($this->rsm->typeMappings[$key])
-                    ? $this->typeRegistry->get($this->rsm->typeMappings[$key])
+                    ? $this->typeProvider->get($this->rsm->typeMappings[$key])
                     : null;
 
                 // Cache metadata fetch
diff --git a/src/Internal/TypeProviderLocator.php b/src/Internal/TypeProviderLocator.php
@@ -6,24 +6,26 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\TypeProvider;
 use Doctrine\DBAL\Types\TypeRegistry;
 
 use function method_exists;
 
 /**
- * Resolves the {@see TypeRegistry} owned by a DBAL connection.
+ * Resolves the {@see TypeProvider} owned by a DBAL connection.
  *
  * @internal
  */
-final class TypeRegistryLocator
+final class TypeProviderLocator
 {
-    public static function fromConnection(Connection $connection): TypeRegistry
+    public static function fromConnection(Connection $connection): TypeProvider|TypeRegistry
     {
         $configuration = $connection->getConfiguration();
 
-        // The method_exists() check is for DBAL < 4.5 compatibility, where Configuration::getTypeRegistry() does not exist yet.
-        if (method_exists($configuration, 'getTypeRegistry')) {
-            return $configuration->getTypeRegistry();
+        // The method_exists() check is for DBAL < 4.5 compatibility, where Configuration::getTypeProvider() does not exist yet.
+        // @phpstan-ignore function.alreadyNarrowedType (DBAL < 4.5 compatibility)
+        if (method_exists($configuration, 'getTypeProvider')) {
+            return $configuration->getTypeProvider();
         }
 
         return Type::getTypeRegistry();
diff --git a/src/Mapping/Driver/DatabaseDriver.php b/src/Mapping/Driver/DatabaseDriver.php
@@ -422,7 +422,9 @@ private function buildFieldMapping(string $tableName, Column $column): array
         $fieldMapping = [
             'fieldName'  => $this->getFieldNameForColumn($tableName, self::getAssetName($column), false),
             'columnName' => self::getAssetName($column),
-            'type'       => Type::getTypeRegistry()->lookupName($column->getType()),
+            'type'       => method_exists($column, 'getTypeName')
+                ? $column->getTypeName()
+                : Type::getTypeRegistry()->lookupName($column->getType()),
             'nullable'   => ! $column->getNotnull(),
             'options'    => [
                 'comment' => $column->getComment(),
diff --git a/src/Persisters/Collection/OneToManyPersister.php b/src/Persisters/Collection/OneToManyPersister.php
@@ -8,7 +8,7 @@
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\DBAL\Exception as DBALException;
 use Doctrine\ORM\EntityNotFoundException;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Mapping\MappingException;
 use Doctrine\ORM\Mapping\OneToManyAssociationMapping;
 use Doctrine\ORM\PersistentCollection;
@@ -219,13 +219,13 @@ private function deleteJoinedEntityCollection(PersistentCollection $collection):
         $idColumnNames     = $rootClass->getIdentifierColumnNames();
         $idColumnList      = implode(', ', $idColumnNames);
         $columnDefinitions = [];
-        $typeRegistry      = TypeRegistryLocator::fromConnection($this->em->getConnection());
+        $typeProvider      = TypeProviderLocator::fromConnection($this->em->getConnection());
 
         foreach ($idColumnNames as $idColumnName) {
             $columnDefinitions[$idColumnName] = [
                 'name'    => $idColumnName,
                 'notnull' => true,
-                'type'    => $typeRegistry->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $this->em)),
+                'type'    => $typeProvider->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $this->em)),
             ];
         }
 
diff --git a/src/Persisters/Entity/BasicEntityPersister.php b/src/Persisters/Entity/BasicEntityPersister.php
@@ -14,11 +14,12 @@
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Result;
 use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\TypeProvider;
 use Doctrine\DBAL\Types\TypeRegistry;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Cache\Persister\CompatOrderings;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Mapping\AssociationMapping;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\JoinColumnMapping;
@@ -122,7 +123,7 @@ class BasicEntityPersister implements EntityPersister
      */
     protected Connection $conn;
 
-    private readonly TypeRegistry $typeRegistry;
+    private readonly TypeProvider|TypeRegistry $typeProvider;
 
     /**
      * The database platform.
@@ -185,7 +186,7 @@ public function __construct(
     ) {
         $this->conn                  = $em->getConnection();
         $this->platform              = $this->conn->getDatabasePlatform();
-        $this->typeRegistry          = TypeRegistryLocator::fromConnection($this->conn);
+        $this->typeProvider          = TypeProviderLocator::fromConnection($this->conn);
         $this->quoteStrategy         = $em->getConfiguration()->getQuoteStrategy();
         $this->identifierFlattener   = new IdentifierFlattener($em->getUnitOfWork(), $em->getMetadataFactory());
         $this->noLimitsContext       = $this->currentPersisterContext = new CachedPersisterContext(
@@ -212,7 +213,7 @@ final protected function updateFilterHash(): void
 
     final protected function getType(string $name): Type
     {
-        return $this->typeRegistry->get($name);
+        return $this->typeProvider->get($name);
     }
 
     public function getClassMetadata(): ClassMetadata
diff --git a/src/Query/Exec/MultiTableDeleteExecutor.php b/src/Query/Exec/MultiTableDeleteExecutor.php
@@ -6,7 +6,7 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Query\AST;
 use Doctrine\ORM\Query\AST\DeleteStatement;
 use Doctrine\ORM\Query\SqlWalker;
@@ -86,12 +86,12 @@ public function __construct(AST\Node $AST, SqlWalker $sqlWalker)
 
         // 4. Store DDL for temporary identifier table.
         $columnDefinitions = [];
-        $typeRegistry      = TypeRegistryLocator::fromConnection($em->getConnection());
+        $typeProvider      = TypeProviderLocator::fromConnection($em->getConnection());
         foreach ($idColumnNames as $idColumnName) {
             $columnDefinitions[$idColumnName] = [
                 'name'    => $idColumnName,
                 'notnull' => true,
-                'type'    => $typeRegistry->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $em)),
+                'type'    => $typeProvider->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $em)),
             ];
         }
 
diff --git a/src/Query/Exec/MultiTableUpdateExecutor.php b/src/Query/Exec/MultiTableUpdateExecutor.php
@@ -6,7 +6,7 @@
 
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Query\AST;
 use Doctrine\ORM\Query\AST\UpdateStatement;
 use Doctrine\ORM\Query\ParameterTypeInferer;
@@ -125,13 +125,13 @@ public function __construct(AST\Node $AST, SqlWalker $sqlWalker)
 
         // 4. Store DDL for temporary identifier table.
         $columnDefinitions = [];
-        $typeRegistry      = TypeRegistryLocator::fromConnection($em->getConnection());
+        $typeProvider      = TypeProviderLocator::fromConnection($em->getConnection());
 
         foreach ($idColumnNames as $idColumnName) {
             $columnDefinitions[$idColumnName] = [
                 'name'    => $idColumnName,
                 'notnull' => true,
-                'type'    => $typeRegistry->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $em)),
+                'type'    => $typeProvider->get(PersisterHelper::getTypeOfColumn($idColumnName, $rootClass, $em)),
             ];
         }
 
diff --git a/src/Query/ResultSetMappingBuilder.php b/src/Query/ResultSetMappingBuilder.php
@@ -6,7 +6,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Internal\SQLResultCasing;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Utility\PersisterHelper;
 use InvalidArgumentException;
@@ -239,7 +239,7 @@ private function getColumnAliasMap(
     public function generateSelectClause(array $tableAliases = []): string
     {
         $sql          = '';
-        $typeRegistry = TypeRegistryLocator::fromConnection($this->em->getConnection());
+        $typeProvider = TypeProviderLocator::fromConnection($this->em->getConnection());
 
         foreach ($this->columnOwnerMap as $columnName => $dqlAlias) {
             $tableAlias = $tableAliases[$dqlAlias] ?? $dqlAlias;
@@ -254,7 +254,7 @@ public function generateSelectClause(array $tableAliases = []): string
                 $classFieldMapping = $class->fieldMappings[$fieldName];
                 $columnSql         = $tableAlias . '.' . $classFieldMapping->columnName;
 
-                $type      = $typeRegistry->get($classFieldMapping->type);
+                $type      = $typeProvider->get($classFieldMapping->type);
                 $columnSql = $type->convertToPHPValueSQL($columnSql, $this->em->getConnection()->getDatabasePlatform());
 
                 $sql .= $columnSql;
diff --git a/src/Query/SqlWalker.php b/src/Query/SqlWalker.php
@@ -8,11 +8,13 @@
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\LockMode;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+use Doctrine\DBAL\Types\TypeProvider;
 use Doctrine\DBAL\Types\TypeRegistry;
 use Doctrine\DBAL\Types\Types;
 use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\QuoteStrategy;
 use Doctrine\ORM\OptimisticLockException;
@@ -143,7 +145,7 @@ class SqlWalker
      */
     private readonly QuoteStrategy $quoteStrategy;
 
-    private readonly TypeRegistry $typeRegistry;
+    private readonly TypeProvider|TypeRegistry $typeProvider;
 
     /** @phpstan-param array<string, QueryComponent> $queryComponents The query components (symbol table). */
     public function __construct(
@@ -156,7 +158,7 @@ public function __construct(
         $this->conn          = $this->em->getConnection();
         $this->platform      = $this->conn->getDatabasePlatform();
         $this->quoteStrategy = $this->em->getConfiguration()->getQuoteStrategy();
-        $this->typeRegistry  = TypeRegistryLocator::fromConnection($this->conn);
+        $this->typeProvider  = TypeProviderLocator::fromConnection($this->conn);
     }
 
     /**
@@ -1302,7 +1304,7 @@ public function walkSelectExpression(AST\SelectExpression $selectExpression): st
                 $columnAlias   = $this->getSQLColumnAlias($fieldMapping->columnName);
                 $col           = $sqlTableAlias . '.' . $columnName;
 
-                $type = $this->typeRegistry->get($fieldMapping->type);
+                $type = $this->typeProvider->get($fieldMapping->type);
                 $col  = $type->convertToPHPValueSQL($col, $this->conn->getDatabasePlatform());
 
                 $sql .= $col . ' AS ' . $columnAlias;
@@ -1357,8 +1359,10 @@ public function walkSelectExpression(AST\SelectExpression $selectExpression): st
                         Query\AST\ExpressionWithReturnType::class,
                     );
 
-                    // @phpstan-ignore method.deprecatedInterface
-                    $this->rsm->addScalarResult($columnAlias, $resultAlias, $this->typeRegistry->lookupName($expr->getReturnType()));
+                    // TypedExpression only exposes a Type instance, so the name has to be looked up.
+                    // This branch and Type::lookupName() are both deprecated and go away together.
+                    // @phpstan-ignore method.deprecatedInterface, staticMethod.deprecated
+                    $this->rsm->addScalarResult($columnAlias, $resultAlias, Type::lookupName($expr->getReturnType()));
 
                     break;
                 }
@@ -1443,7 +1447,7 @@ public function walkObjectExpression(string $dqlAlias, array $partialFieldSet, s
 
             $col = $sqlTableAlias . '.' . $quotedColumnName;
 
-            $type = $this->typeRegistry->get($mapping->type);
+            $type = $this->typeProvider->get($mapping->type);
             $col  = $type->convertToPHPValueSQL($col, $this->platform);
 
             $sqlParts[] = $col . ' AS ' . $columnAlias;
@@ -1478,7 +1482,7 @@ public function walkObjectExpression(string $dqlAlias, array $partialFieldSet, s
 
                     $col = $sqlTableAlias . '.' . $quotedColumnName;
 
-                    $type = $this->typeRegistry->get($mapping->type);
+                    $type = $this->typeProvider->get($mapping->type);
                     $col  = $type->convertToPHPValueSQL($col, $this->platform);
 
                     $sqlParts[] = $col . ' AS ' . $columnAlias;
@@ -1583,7 +1587,7 @@ public function walkNewObject(AST\NewObjectExpression $newObjectExpression, stri
                     $fieldType    = $fieldMapping->type;
                     $col          = trim($e->dispatch($this));
 
-                    $type = $this->typeRegistry->get($fieldType);
+                    $type = $this->typeProvider->get($fieldType);
                     $col  = $type->convertToPHPValueSQL($col, $this->platform);
 
                     $sqlSelectExpressions[] = $col . ' AS ' . $columnAlias;
@@ -2217,8 +2221,8 @@ public function walkInputParameter(AST\InputParameter $inputParam): string
 
         if ($parameter) {
             $type = $parameter->getType();
-            if (is_string($type) && $this->typeRegistry->has($type)) {
-                return $this->typeRegistry->get($type)->convertToDatabaseValueSQL('?', $this->platform);
+            if (is_string($type) && $this->typeProvider->has($type)) {
+                return $this->typeProvider->get($type)->convertToDatabaseValueSQL('?', $this->platform);
             }
         }
 
diff --git a/src/Tools/Pagination/LimitSubqueryWalker.php b/src/Tools/Pagination/LimitSubqueryWalker.php
@@ -4,7 +4,7 @@
 
 namespace Doctrine\ORM\Tools\Pagination;
 
-use Doctrine\ORM\Internal\TypeRegistryLocator;
+use Doctrine\ORM\Internal\TypeProviderLocator;
 use Doctrine\ORM\Query;
 use Doctrine\ORM\Query\AST\Functions\IdentityFunction;
 use Doctrine\ORM\Query\AST\Node;
@@ -51,7 +51,7 @@ public function walkSelectStatement(SelectStatement $selectStatement): void
 
         $query->setHint(
             self::IDENTIFIER_TYPE,
-            TypeRegistryLocator::fromConnection($query->getEntityManager()->getConnection())->get($rootClass->fieldMappings[$identifier]->type),
+            TypeProviderLocator::fromConnection($query->getEntityManager()->getConnection())->get($rootClass->fieldMappings[$identifier]->type),
         );
 
         $query->setHint(self::FORCE_DBAL_TYPE_CONVERSION, true);
diff --git a/src/Tools/SchemaValidator.php b/src/Tools/SchemaValidator.php
diff --git a/src/Utility/PersisterHelper.php b/src/Utility/PersisterHelper.php
diff --git a/tests/Tests/OrmTestCase.php b/tests/Tests/OrmTestCase.php
