Create a TypeRegistry and enable injection of Type instances

UPGRADE-2.17.md

@@ -0,0 +1,20 @@
+# UPGRADE FROM 2.16 to 2.17
+
+## `TypeRegistry` replaces `Type` static methods
+
+A new `Doctrine\ODM\MongoDB\Types\TypeRegistry` class has been introduced
+to manage custom types. The static methods of `Doctrine\ODM\MongoDB\Types\Type`
+are deprecated and will be removed in MongoDB ODM 3.0:
+- `Type::getType($name)` → `TypeRegistry::get($name)`
+- `Type::hasType($name)` → `TypeRegistry::has($name)`
+- `Type::addType($name, $class)` → `TypeRegistry::register($name, $class)`
+- `Type::getTypesMap()` → `TypeRegistry::getMap()`
+- `Type::registerType($name, $class)` → `TypeRegistry::register($name, $class)`
+- `Type::overrideType($name, $class)` → `TypeRegistry::register($name, $class)`
+- `Type::getTypeFromPHPVariable($value)` → `TypeRegistry::guessTypeFromValue($value)`
+- `Type::convertPHPToDatabaseValue($value)` → `TypeRegistry::convertToDatabaseValue($value)`
+
+You can set and get the `TypeRegistry` instance from the `Doctrine\ODM\MongoDB\Configuration`
+using `getTypeRegistry()` and `setTypeRegistry()`.
+
+To access the type of a mapped field, use the `ClassMetadata::getFieldType()` method.

docs/en/reference/basic-mapping.rst

@@ -24,6 +24,11 @@ document mapping metadata:
     stored in the metadata cache. Therefore all drivers perform equally well at
     runtime.
 
+    ``ClassMetadata`` instances must always be loaded through
+    ``ClassMetadataFactory``, which restores runtime dependencies (such as the
+    ``TypeRegistry``) after deserialization. Deserializing a ``ClassMetadata``
+    instance directly is not supported.
+
 Introduction to Attributes
 --------------------------
 

docs/en/reference/custom-mapping-types.rst

@@ -79,24 +79,29 @@ Restrictions to keep in mind:
    method that did not change in the request.
 
 When you have implemented the type you still need to let Doctrine
-know about it:
+know about it. You can create a ``TypeRegistry`` and inject it into the
+``DocumentManager``:
 
 .. code-block:: php
 
     <?php
 
     // in bootstrapping code
 
-    use Doctrine\ODM\MongoDB\Types\Type;
+    use Doctrine\ODM\MongoDB\DocumentManager;
+    use Doctrine\ODM\MongoDB\Types\TypeRegistry;
+
+    $typeRegistry = new TypeRegistry();
 
     // Adds a type. This results in an exception if type with given name is already registered
-    Type::addType('date_with_timezone', \My\Project\Types\DateTimeWithTimezoneType::class);
+    $typeRegistry->register('date_with_timezone', new \My\Project\Types\DateTimeWithTimezoneType());
 
-    // Overrides a type. This results in an exception if type with given name is not registered
-    Type::overrideType('date_immutable', \My\Project\Types\DateTimeWithTimezoneType::class);
+    // Overrides a type. This replaces any existing type with given name
+    $typeRegistry->register('date_immutable', new \My\Project\Types\DateTimeWithTimezoneType();
 
-    // Registers a type without checking whether it was already registered
-    Type::registerType('date_immutable', \My\Project\Types\DateTimeWithTimezoneType::class);
+    // Initialize DocumentManager with the TypeRegistry
+    $config = new Configuration();
+    $config->setTypeRegistry($typeRegistry);
 
 As can be seen above, when registering the custom types in the configuration you
 specify a unique name for the mapping type and map that to the corresponding
@@ -182,7 +187,8 @@ Register the type in your bootstrap code::
 
 .. code-block:: php
 
-    Type::addType(Money::class, App\MongoDB\Types\MoneyType::class);
+    $typeRegistry = new TypeRegistry();
+    $typeRegistry->register(Money::class, new App\MongoDB\Types\MoneyType());
 
 By using the |FQCN| of the value object class as the type name, the type is
 automatically used when encountering a property of that class. This means you

phpstan-baseline.neon

@@ -1265,3 +1265,15 @@ parameters:
 			identifier: staticMethod.impossibleType
 			count: 1
 			path: tests/Tests/Types/BinaryUuidTypeTest.php
+
+		-
+			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Doctrine\\\\ODM\\\\MongoDB\\\\Types\\\\FloatType'' and Doctrine\\ODM\\MongoDB\\Types\\StringType will always evaluate to false\.$#'
+			identifier: staticMethod.impossibleType
+			count: 1
+			path: tests/Tests/Types/TypeTest.php
+
+		-
+			message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertInstanceOf\(\) with ''Doctrine\\\\ODM\\\\MongoDB\\\\Types\\\\IntType'' and \*NEVER\* will always evaluate to false\.$#'
+			identifier: staticMethod.impossibleType
+			count: 1
+			path: tests/Tests/Types/TypeTest.php

src/Aggregation/Expr.php

@@ -26,7 +26,6 @@
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
-use Doctrine\ODM\MongoDB\Types\Type;
 use LogicException;
 
 use function array_filter;
@@ -1122,7 +1121,7 @@ private function prepareArgument($expression)
         }
 
         // Convert PHP types to MongoDB types for everything else
-        return Type::convertPHPToDatabaseValue($expression);
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue($expression);
     }
 
     private function getDocumentPersister(): DocumentPersister

src/Aggregation/Stage/AbstractBucket.php

@@ -10,7 +10,6 @@
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
-use Doctrine\ODM\MongoDB\Types\Type;
 
 use function array_map;
 use function is_array;
@@ -86,7 +85,7 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister()->prepareFieldName(substr($expression, 1));
         }
 
-        return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue($expression);
     }
 
     private function getDocumentPersister(): DocumentPersister

src/Aggregation/Stage/AbstractReplace.php

@@ -9,7 +9,6 @@
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
-use Doctrine\ODM\MongoDB\Types\Type;
 
 use function array_map;
 use function is_array;
@@ -50,6 +49,6 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister()->prepareFieldName(substr($expression, 1));
         }
 
-        return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue(Expr::convertExpression($expression));
     }
 }

src/Aggregation/Stage/GraphLookup.php

@@ -11,7 +11,6 @@
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
-use Doctrine\ODM\MongoDB\Types\Type;
 use Doctrine\Persistence\Mapping\MappingException as BaseMappingException;
 use LogicException;
 
@@ -264,7 +263,7 @@ private function convertExpression($expression)
             return '$' . $this->getDocumentPersister($this->class)->prepareFieldName(substr($expression, 1));
         }
 
-        return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
+        return $this->dm->getConfiguration()->getTypeRegistry()->convertToDatabaseValue(Expr::convertExpression($expression));
     }
 
     private function convertTargetFieldName(string $fieldName): string

src/Aggregation/Stage/VectorSearch.php

@@ -8,7 +8,6 @@
 use Doctrine\ODM\MongoDB\Aggregation\Stage;
 use Doctrine\ODM\MongoDB\Persisters\DocumentPersister;
 use Doctrine\ODM\MongoDB\Query\Expr;
-use Doctrine\ODM\MongoDB\Types\Type;
 use InvalidArgumentException;
 use MongoDB\BSON\Binary;
 use MongoDB\BSON\Decimal128;
@@ -82,7 +81,7 @@ public function getExpression(): array
         }
 
         if ($this->queryVector !== null) {
-            $params['queryVector'] = Type::getType($this->persister->getClassMetadata()->fieldMappings[$this->path ?? '']['type'] ?? Type::RAW)->convertToDatabaseValue($this->queryVector);
+            $params['queryVector'] = $this->persister->convertToDatabaseValue($this->path ?? '', $this->queryVector, $this->persister->getClassMetadata());
         }
 
         return [$this->getStageName() => $params];

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/Hydrator/HydratorFactory.php

@@ -12,7 +12,6 @@
 use Doctrine\ODM\MongoDB\Events;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Proxy\InternalProxy;
-use Doctrine\ODM\MongoDB\Types\Type;
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use ProxyManager\Proxy\GhostObjectInterface;
 
@@ -28,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;
@@ -196,7 +198,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                     ,
                     $mapping['name'],
                     $mapping['fieldName'],
-                    Type::getType($mapping['type'])->closureToPHP(),
+                    $this->closureToPHP($class, $mapping['fieldName']),
                 );
             } elseif (! isset($mapping['association'])) {
                 $code .= sprintf(
@@ -219,7 +221,7 @@ private function generateHydratorClass(ClassMetadata $class, string $hydratorCla
                     ,
                     $mapping['name'],
                     $mapping['fieldName'],
-                    Type::getType($mapping['type'])->closureToPHP(),
+                    $this->closureToPHP($class, $mapping['fieldName']),
                 );
             } elseif ($mapping['association'] === ClassMetadata::REFERENCE_ONE && $mapping['isOwningSide']) {
                 $code .= sprintf(
@@ -476,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

@@ -19,7 +19,9 @@
 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;
 use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
 use Doctrine\Persistence\Mapping\ClassMetadata as BaseClassMetadata;
@@ -867,6 +869,8 @@
     /** @var class-string|null */
     private ?string $rootClass;
 
+    private TypeRegistry $typeRegistry;
+
     /**
      * Initializes a new ClassMetadata instance that will hold the object-document mapping
      * metadata of the class with the given name.
@@ -926,6 +930,24 @@ public static function getReferenceFieldName(string $storeAs, string $pathPrefix
         return ($pathPrefix ? $pathPrefix . '.' : '') . self::getReferencePrefix($storeAs) . 'id';
     }
 
+    /**
+     * Inject the TypeRegistry instance, used for field transformation and type detection.
+     */
+    public function setTypeRegistry(TypeRegistry $types): void
+    {
+        $this->typeRegistry = $types;
+    }
+
+    private function getTypeRegistry(): TypeRegistry
+    {
+        if (! isset($this->typeRegistry)) {
+            $this->typeRegistry = TypeRegistry::getSharedInstance();
+            trigger_deprecation('doctrine/mongodb-odm', '2.17', 'Using ClassMetadata without a TypeRegistry is deprecated. Inject the TypeRegistry instance from the DocumentManager via $classMetadata->setTypeRegistry($configuration->getTypeRegistry()).');
+        }
+
+        return $this->typeRegistry;
+    }
+
     public function getReflectionClass(): ReflectionClass
     {
         return $this->reflClass;
@@ -1711,7 +1733,7 @@ private function applyStorageStrategy(array &$mapping): void
             default:
                 $defaultStrategy   = self::STORAGE_STRATEGY_SET;
                 $allowedStrategies = [self::STORAGE_STRATEGY_SET];
-                $type              = Type::getType($mapping['type']);
+                $type              = $this->getTypeRegistry()->get($mapping['type']);
                 if ($type instanceof Incrementable) {
                     $allowedStrategies[] = self::STORAGE_STRATEGY_INCREMENT;
                 }
@@ -1920,9 +1942,7 @@ public function setIdGenerator(IdGenerator $generator): void
      */
     public function getPHPIdentifierValue($id)
     {
-        $idType = $this->fieldMappings[$this->identifier]['type'];
-
-        return Type::getType($idType)->convertToPHPValue($id);
+        return $this->getFieldType($this->identifier)->convertToPHPValue($id);
     }
 
     /**
@@ -1934,9 +1954,7 @@ public function getPHPIdentifierValue($id)
      */
     public function getDatabaseIdentifierValue($id)
     {
-        $idType = $this->fieldMappings[$this->identifier]['type'];
-
-        return Type::getType($idType)->convertToDatabaseValue($id);
+        return $this->getFieldType($this->identifier)->convertToDatabaseValue($id);
     }
 
     /**
@@ -2038,6 +2056,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).
      *
@@ -2203,7 +2234,7 @@ public function isIdGeneratorNone(): bool
      */
     public function setVersionMapping(array &$mapping): void
     {
-        if (! Type::getType($mapping['type']) instanceof Versionable) {
+        if (! $this->getTypeRegistry()->get($mapping['type']) instanceof Versionable) {
             throw LockException::invalidVersionFieldType($mapping['type']);
         }
 
@@ -2466,7 +2497,7 @@ public function mapField(array $mapping): array
 
         if (isset($mapping['encrypt']['queryType'])) {
             // The encrypted range query options min and max must be converted to the database type
-            $type = Type::getType($mapping['type']);
+            $type = $this->getTypeRegistry()->get($mapping['type']);
             foreach (['min', 'max'] as $option) {
                 if (isset($mapping['encrypt'][$option])) {
                     $mapping['encrypt'][$option] = $type->convertToDatabaseValue($mapping['encrypt'][$option]);
@@ -2880,7 +2911,7 @@ private function validateAndCompleteTypedFieldMapping(array $mapping): array
             return $mapping;
         }
 
-        if (! $type->isBuiltin() && Type::hasType($type->getName())) {
+        if (! $type->isBuiltin() && $this->getTypeRegistry()->has($type->getName())) {
             $mapping['type'] = $type->getName();
 
             return $mapping;