Move TypeRegistry to the Configuration class

Author: GromNaN

src/Aggregation/Expr.php

@@ -1121,7 +1121,7 @@ private function prepareArgument($expression)
         }
 
         // Convert PHP types to MongoDB types for everything else
-        return $this->dm->getTypes()->convertToDatabaseValue($expression);
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue($expression);
     }
 
     private function getDocumentPersister(): DocumentPersister

src/Aggregation/Stage/AbstractBucket.php

@@ -85,7 +85,7 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister()->prepareFieldName(substr($expression, 1));
         }
 
-        return $this->dm->getTypes()->convertToDatabaseValue($expression);
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue($expression);
     }
 
     private function getDocumentPersister(): DocumentPersister

src/Aggregation/Stage/AbstractReplace.php

@@ -49,6 +49,6 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister()->prepareFieldName(substr($expression, 1));
         }
 
-        return $this->dm->getTypes()->convertToDatabaseValue(Expr::convertExpression($expression));
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue(Expr::convertExpression($expression));
     }
 }

src/Aggregation/Stage/GraphLookup.php

@@ -263,7 +263,7 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister($this->class)->prepareFieldName(substr($expression, 1));
         }
 
-        return $this->dm->getTypes()->convertToDatabaseValue($expression);
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue(Expr::convertExpression($expression));
     }
 
     private function convertTargetFieldName(string $fieldName): string

src/Configuration.php

@@ -21,6 +21,7 @@
 use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
 use Doctrine\ODM\MongoDB\Repository\GridFSRepository;
 use Doctrine\ODM\MongoDB\Repository\RepositoryFactory;
+use Doctrine\ODM\MongoDB\Types\TypeRegistry;
 use Doctrine\Persistence\Mapping\Driver\MappingDriver;
 use Doctrine\Persistence\ObjectRepository;
 use InvalidArgumentException;
@@ -154,6 +155,22 @@ class Configuration
 
     private static string $version;
 
+    private ?TypeRegistry $typeRegistry = null;
+
+    public function setTypeRegistry(TypeRegistry $typeRegistry): void
+    {
+        if ($this->typeRegistry !== null) {
+            throw new LogicException('TypeRegistry is already set and cannot be changed.');
+        }
+
+        $this->typeRegistry = $typeRegistry;
+    }
+
+    public function getTypeRegistry(): TypeRegistry
+    {
+        return $this->typeRegistry ?? TypeRegistry::getSharedInstance();
+    }
+
     /**
      * Provides the driver options to be used when creating the MongoDB client.
      *

src/DocumentManager.php

@@ -22,7 +22,6 @@
 use Doctrine\ODM\MongoDB\Repository\GridFSRepository;
 use Doctrine\ODM\MongoDB\Repository\RepositoryFactory;
 use Doctrine\ODM\MongoDB\Repository\ViewRepository;
-use Doctrine\ODM\MongoDB\Types\TypeRegistry;
 use Doctrine\Persistence\Mapping\ProxyClassNameResolver;
 use Doctrine\Persistence\ObjectManager;
 use Doctrine\Persistence\ObjectRepository;
@@ -145,7 +144,7 @@ class DocumentManager implements ObjectManager
      * Creates a new Document that operates on the given Mongo connection
      * and uses the given Configuration.
      */
-    protected function __construct(?Client $client = null, ?Configuration $config = null, ?EventManager $eventManager = null, private ?TypeRegistry $typeRegistry = null)
+    protected function __construct(?Client $client = null, ?Configuration $config = null, ?EventManager $eventManager = null)
     {
         $this->config       = $config ?: new Configuration();
         $this->eventManager = $eventManager ?: new EventManager();
@@ -204,7 +203,6 @@ public function resolveClassName(string $className): string
             default => new StaticProxyFactory($this),
         };
         $this->repositoryFactory = $this->config->getRepositoryFactory();
-        $this->typeRegistry    ??= TypeRegistry::getSharedInstance();
     }
 
     /**
@@ -219,9 +217,9 @@ public function getProxyFactory(): ProxyFactory
      * Creates a new Document that operates on the given Mongo connection
      * and uses the given Configuration.
      */
-    public static function create(?Client $client = null, ?Configuration $config = null, ?EventManager $eventManager = null, ?TypeRegistry $registry = null): DocumentManager
+    public static function create(?Client $client = null, ?Configuration $config = null, ?EventManager $eventManager = null): DocumentManager
     {
-        return new static($client, $config, $eventManager, $registry);
+        return new static($client, $config, $eventManager);
     }
 
     /**
@@ -957,9 +955,4 @@ public function getClassNameForAssociation(array $mapping, $data): string
 
         return $mapping['targetDocument'];
     }
-
-    public function getTypes(): TypeRegistry
-    {
-        return $this->typeRegistry;
-    }
 }

src/Hydrator/HydratorFactory.php

@@ -27,9 +27,12 @@
 use function rename;
 use function rtrim;
 use function sprintf;
+use function str_contains;
 use function str_replace;
 use function substr;
+use function trigger_deprecation;
 use function uniqid;
+use function var_export;
 
 use const DIRECTORY_SEPARATOR;
 use const PHP_VERSION_ID;
@@ -195,7 +198,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                     ,
                     $mapping['name'],
                     $mapping['fieldName'],
-                    $this->dm->getTypes()->get($mapping['type'])->closureToPHP(),
+                    $this->closureToPHP($class, $mapping['fieldName']),
                 );
             } elseif (! isset($mapping['association'])) {
                 $code .= sprintf(
@@ -218,7 +221,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                     ,
                     $mapping['name'],
                     $mapping['fieldName'],
-                    $this->dm->getTypes()->get($mapping['type'])->closureToPHP(),
+                    $this->closureToPHP($class, $mapping['fieldName']),
                 );
             } elseif ($mapping['association'] === ClassMetadata::REFERENCE_ONE && $mapping['isOwningSide']) {
                 $code .= sprintf(
@@ -475,4 +478,19 @@ public function hydrate(object $document, array $data, array $hints = []): array
 
         return $data;
     }
+
+    private function closureToPHP(ClassMetadata $class, string $fieldName): string
+    {
+        $code = $class->getFieldType($fieldName)->closureToPHP();
+
+        if (str_contains($code, '$typeIdentifier')) {
+            trigger_deprecation('doctrine/mongodb-odm', '2.16', 'Using $typeIdentifier in Type::closureToPHP() is deprecated and will be removed in Doctrine ODM 3.0');
+        }
+
+        return str_replace(
+            '$fieldName',
+            var_export($fieldName, true),
+            $code,
+        );
+    }
 }

src/Mapping/ClassMetadata.php

@@ -20,6 +20,7 @@
 use Doctrine\ODM\MongoDB\Mapping\PropertyAccessors\PropertyAccessorFactory;
 use Doctrine\ODM\MongoDB\Proxy\InternalProxy;
 use Doctrine\ODM\MongoDB\Types\Incrementable;
+use Doctrine\ODM\MongoDB\Types\InvalidTypeException;
 use Doctrine\ODM\MongoDB\Types\Type;
 use Doctrine\ODM\MongoDB\Types\TypeRegistry;
 use Doctrine\ODM\MongoDB\Types\Versionable;
@@ -869,7 +870,7 @@
     /** @var class-string|null */
     private ?string $rootClass;
 
-    private TypeRegistry $types;
+    private TypeRegistry $typeRegistry;
 
     /**
      * Initializes a new ClassMetadata instance that will hold the object-document mapping
@@ -935,18 +936,17 @@ public static function getReferenceFieldName(string $storeAs, string $pathPrefix
      */
     public function setTypeRegistry(TypeRegistry $types): void
     {
-        $this->types = $types;
+        $this->typeRegistry = $types;
     }
 
     private function getTypeRegistry(): TypeRegistry
     {
-        if (! isset($this->types)) {
-            /* @see Type::getRegistry() */
-            $this->types = TypeRegistry::getSharedInstance();
-            trigger_deprecation('doctrine/mongodb-odm', '2.16', 'Using ClassMetadata without a TypeRegistry is deprecated. Inject the TypeRegistry instance from the DocumentManager via ClassMetadata::setTypeRegistry($dm->getTypes()).');
+        if (! isset($this->typeRegistry)) {
+            $this->typeRegistry = TypeRegistry::getSharedInstance();
+            trigger_deprecation('doctrine/mongodb-odm', '2.16', 'Using ClassMetadata without a TypeRegistry is deprecated. Inject the TypeRegistry instance from the DocumentManager via $classMetadata->setTypeRegistry($configuration->getTypeRegistry()).');
         }
 
-        return $this->types;
+        return $this->typeRegistry;
     }
 
     public function getReflectionClass(): ReflectionClass
@@ -1943,9 +1943,7 @@ public function setIdGenerator(IdGenerator $generator): void
      */
     public function getPHPIdentifierValue($id)
     {
-        $idType = $this->fieldMappings[$this->identifier]['type'];
-
-        return $this->getTypeRegistry()->get($idType)->convertToPHPValue($id);
+        return $this->getFieldType($this->identifier)->convertToPHPValue($id);
     }
 
     /**
@@ -1957,9 +1955,7 @@ public function getPHPIdentifierValue($id)
      */
     public function getDatabaseIdentifierValue($id)
     {
-        $idType = $this->fieldMappings[$this->identifier]['type'];
-
-        return $this->getTypeRegistry()->get($idType)->convertToDatabaseValue($id);
+        return $this->getFieldType($this->identifier)->convertToDatabaseValue($id);
     }
 
     /**
@@ -2061,6 +2057,19 @@ public function getFieldMapping(string $fieldName): array
         return $this->fieldMappings[$fieldName];
     }
 
+    public function getFieldType(string $fieldName): Type
+    {
+        if (! isset($this->fieldMappings[$fieldName]['type'])) {
+            return $this->getTypeRegistry()->get(Type::RAW);
+        }
+
+        try {
+            return $this->getTypeRegistry()->get($this->fieldMappings[$fieldName]['type']);
+        } catch (InvalidTypeException) {
+            throw MappingException::invalidTypeForField($this->name, $fieldName, $this->fieldMappings[$fieldName]['type']);
+        }
+    }
+
     /**
      * Gets mappings of fields holding embedded document(s).
      *

src/Mapping/ClassMetadataFactory.php

@@ -119,7 +119,7 @@ protected function getDriver(): MappingDriver
 
     protected function wakeupReflection(ClassMetadataInterface $class, ReflectionService $reflService): void
     {
-        $class->setTypeRegistry($this->dm->getTypes());
+        $class->setTypeRegistry($this->config->getTypeRegistry());
 
         if (PHP_VERSION_ID < 80400) {
             return;
@@ -136,7 +136,7 @@ protected function wakeupReflection(ClassMetadataInterface $class, ReflectionSer
 
     protected function initializeReflection(ClassMetadataInterface $class, ReflectionService $reflService): void
     {
-        $class->setTypeRegistry($this->dm->getTypes());
+        $class->setTypeRegistry($this->config->getTypeRegistry());
     }
 
     protected function isEntity(ClassMetadataInterface $class): bool

src/Mapping/MappingException.php

@@ -27,6 +27,11 @@ public static function typeNotFound(string $name): self
         return new self(sprintf('Type to be overwritten %s does not exist.', $name));
     }
 
+    public static function invalidTypeForField(string $className, string $fieldName, string $type): self
+    {
+        return new self(sprintf("Type '%s' is not valid for field '%s' in class '%s'.", $type, $fieldName, $className));
+    }
+
     public static function typeRequirementsNotFulfilled(string $className, string $fieldName, string $type, string $reason): self
     {
         return new self(sprintf("Can not use '%s' type for field '%s' in class '%s' as its requirements are not met: %s.", $fieldName, $className, $type, $reason));