Improve detection of the type from a PHP variable #2814

GromNaN · 2025-09-01T16:24:25Z

Q	A
Type	feature
BC Break	no
Fixed issues	Related to #2789

Summary

The method getTypeFromPHPVariable is used only by convertPHPToDatabaseValue. Which is used to process expressions in the aggregation builder.

With this new feature, we try to find the type for object class name; assuming custom types are registered using the FQCN of the objects they store.

GromNaN · 2025-09-01T16:25:45Z

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

+
+.. code-block:: php
+
+    #[Field(type: Uuid::class)]


Setting the custom type here should not be necessary. As soon as you register a type with the value object type name, it should be registered automatically

mongodb-odm/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

Lines 2771 to 2793 in afb565e

switch ($type->getName()) {

case DateTime::class:

$mapping['type'] = Type::DATE;

break;

case DateTimeImmutable::class:

$mapping['type'] = Type::DATE_IMMUTABLE;

break;

case 'array':

$mapping['type'] = Type::HASH;

break;

case 'bool':

$mapping['type'] = Type::BOOL;

break;

case 'float':

$mapping['type'] = Type::FLOAT;

break;

case 'int':

$mapping['type'] = Type::INT;

break;

case 'string':

$mapping['type'] = Type::STRING;

break;

}

Is it clear from this example that you're referencing Ramsey\Uuid\Uuid? There's no use statement and this is a separate code block from the custom type class above.

Updated to use the FQCN.

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

paulinevos · 2025-09-02T14:54:00Z

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

+    Type::addType(Ramsey\Uuid\Uuid::class, My\Project\Types\UuidType::class);
+
+.. note::
+   The type name should match the support class name (e.g., ``uuid`` for ``UuidType``) to enable automatic association with the field type.


For the automatic association, how does that work? Does it take everything before the Type suffix? How does it handle casing, e.g. in FooBarType?

I'm not certain, but I think this might utilize doctrine/inflector internally.

I think it would be helpful to add here what format would constitute a match.

In fact, there is no such magic. The name should be the class name of the value object.

jmikola · 2025-09-02T18:00:26Z

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

+
+You can create a custom mapping type for your own value objects or classes. For
+example, to map a UUID value object using the `ramsey/uuid library`_, you can
+implement a type that converts between your class and the MongoDB binary format.


Should this say "BSON binary format", or do you think that'd just be more confusing for users? OK to leave as-is.

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

jmikola · 2025-09-02T18:02:36Z

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

+                sprintf(
+                    'Could not convert database value "%s" from "%s" to %s',
+                    $value,
+                    get_debug_type($value),


Are use function lines necessary? I'm OK to omit them, but just want to ensure you've considered the question.

jmikola · 2025-09-02T18:04:07Z

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

+
+.. code-block:: php
+
+    #[Field(type: Uuid::class)]


Is it clear from this example that you're referencing Ramsey\Uuid\Uuid? There's no use statement and this is a separate code block from the custom type class above.

jmikola · 2025-09-02T18:05:00Z

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

+    Type::addType(Ramsey\Uuid\Uuid::class, My\Project\Types\UuidType::class);
+
+.. note::
+   The type name should match the support class name (e.g., ``uuid`` for ``UuidType``) to enable automatic association with the field type.


I'm not certain, but I think this might utilize doctrine/inflector internally.

jmikola · 2025-09-02T18:05:38Z

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

+
+This pattern can be adapted for any custom class—just implement the conversion logic for your value object.
+
+.. |FQCN| raw:: html <abbr title="Fully-Qualified Class Name">FQCN</abbr>


@GromNaN: this looks like it may be a false positive, since this is some very niche RST syntax

jmikola · 2025-09-02T18:06:03Z

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

+.. note::
+   The type name should match the support class name (e.g., ``uuid`` for ``UuidType``) to enable automatic association with the field type.
+
+This pattern can be adapted for any custom class—just implement the conversion logic for your value object.


Same feedback here as @paulinevos' thread above re: "class-just"

This sentence was duplicate if the previous one. I removed it.

jmikola · 2025-09-02T18:07:18Z

lib/Doctrine/ODM/MongoDB/Types/InvalidTypeException.php

+{
+    public static function invalidTypeName(string $name): self
+    {
+        return new self(sprintf('Invalid type specified "%s".', $name));


Should this use a colon?

Suggested change

return new self(sprintf('Invalid type specified "%s".', $name));

return new self(sprintf('Invalid type specified: "%s".', $name));

lib/Doctrine/ODM/MongoDB/Types/Type.php

jmikola · 2025-09-02T18:10:14Z

lib/Doctrine/ODM/MongoDB/Types/Type.php

+            'integer' => self::getType('int'),
+            'boolean' => self::getType('bool'),
+            'double' => self::getType('float'),
+            'string' => self::getType('string'),


Any reason you're not referencing the constants here, as you did above?

No reason. Updated.

relying on an exception is inefficient

… is the FQCN of the value object

GromNaN

Thanks for the review. I added the type detection for DTO class name in property type.

GromNaN · 2025-09-03T12:55:15Z

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

+    Type::addType(Ramsey\Uuid\Uuid::class, My\Project\Types\UuidType::class);
+
+.. note::
+   The type name should match the support class name (e.g., ``uuid`` for ``UuidType``) to enable automatic association with the field type.


In fact, there is no such magic. The name should be the class name of the value object.

GromNaN · 2025-09-03T12:56:13Z

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

+.. note::
+   The type name should match the support class name (e.g., ``uuid`` for ``UuidType``) to enable automatic association with the field type.
+
+This pattern can be adapted for any custom class—just implement the conversion logic for your value object.


This sentence was duplicate if the previous one. I removed it.

GromNaN · 2025-09-03T12:57:19Z

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

+
+This pattern can be adapted for any custom class—just implement the conversion logic for your value object.
+
+.. |FQCN| raw:: html <abbr title="Fully-Qualified Class Name">FQCN</abbr>


I revert changes on this line. I'm not sure how this will be formatted.

GromNaN · 2025-09-03T12:57:51Z

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

+
+.. code-block:: php
+
+    #[Field(type: Uuid::class)]


Updated to use the FQCN.

GromNaN · 2025-09-03T13:15:37Z

lib/Doctrine/ODM/MongoDB/Types/Type.php

+            'integer' => self::getType('int'),
+            'boolean' => self::getType('bool'),
+            'double' => self::getType('float'),
+            'string' => self::getType('string'),


No reason. Updated.

GromNaN · 2025-09-03T16:02:46Z

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

+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
+can omit the ``type`` option when defining the field mapping::
+
+.. code-block:: php
+
+    #[Field]
+    public Ramsey\Uuid\Uuid $id;


This is a new feature that can compete with embedded documents: adding custom logic to convert a value object into BSON.

GromNaN · 2025-09-03T16:27:30Z

lib/Doctrine/ODM/MongoDB/Types/InvalidTypeException.php

We don't have a global namespace for exception like it is generally done in libraries. Existing exception names are:

Doctrine\ODM\MongoDB\MongoDBException

Doctrine\ODM\MongoDB\ConfigurationException

Doctrine\ODM\MongoDB\DocumentNotFoundException

Doctrine\ODM\MongoDB\Mapping\MappingException

Doctrine\ODM\MongoDB\Hydrator\HydratorException

Doctrine\ODM\MongoDB\LockException

Copilot

Pull Request Overview

This PR improves type detection for PHP variables in the MongoDB ODM by enhancing the getTypeFromPHPVariable method to automatically detect custom types based on object class names. The change allows custom types registered using their FQCN to be automatically selected when processing aggregation expressions.

Key changes:

Enhanced type detection to check if an object's class name corresponds to a registered custom type
Improved exception handling by introducing a dedicated InvalidTypeException
Added automatic type inference for object properties when custom types are registered with class FQCNs

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
`lib/Doctrine/ODM/MongoDB/Types/Type.php`	Enhanced `getTypeFromPHPVariable` method to detect custom types by class name and improved type detection logic
`lib/Doctrine/ODM/MongoDB/Types/InvalidTypeException.php`	New dedicated exception class for invalid type scenarios
`lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php`	Added automatic type detection for properties with registered custom types
`tests/Doctrine/ODM/MongoDB/Tests/Types/TypeTest.php`	Added comprehensive test coverage for the new type detection functionality
`tests/Doctrine/ODM/MongoDB/Tests/Functional/CustomTypeTest.php`	Added tests demonstrating custom type detection and proper test setup/teardown
`tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/GH2789Test.php`	Improved test isolation by properly managing type registry state
`docs/en/reference/custom-mapping-types.rst`	Updated documentation with UUID custom type example and FQCN usage patterns

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/Doctrine/ODM/MongoDB/Tests/Types/TypeTest.php

tests/Doctrine/ODM/MongoDB/Tests/Functional/CustomTypeTest.php

lib/Doctrine/ODM/MongoDB/Types/Type.php

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

GromNaN added the Feature label Sep 1, 2025

GromNaN commented Sep 1, 2025

View reviewed changes

GromNaN requested a review from Copilot September 1, 2025 16:26

This comment was marked as outdated.

Sign in to view

GromNaN mentioned this pull request Sep 1, 2025

Unable to use #[Version] with custom type #2789

Closed

GromNaN requested review from jmikola and paulinevos September 2, 2025 14:13

paulinevos reviewed Sep 2, 2025

View reviewed changes

jmikola reviewed Sep 2, 2025

View reviewed changes

GromNaN added 5 commits September 3, 2025 15:23

Improve detection of the type from a PHP variable

f31949e

Add documentation for custom type covering value object

93e30af

Update docs

e676197

Optimize getting type from value class name

6a6e234

relying on an exception is inefficient

Enable automatic type detection from the property type when type name…

d106a5a

… is the FQCN of the value object

GromNaN force-pushed the type-from-php-variable branch from d446495 to d106a5a Compare September 3, 2025 15:59

GromNaN commented Sep 3, 2025

View reviewed changes

Fix backedEnum type

13e2439

GromNaN commented Sep 3, 2025

View reviewed changes

GromNaN requested review from jmikola, Copilot and paulinevos September 3, 2025 16:51

Copilot AI reviewed Sep 3, 2025

View reviewed changes

GromNaN commented Sep 10, 2025

View reviewed changes

docs/en/reference/custom-mapping-types.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

7fc2352

	switch ($type->getName()) {
	case DateTime::class:
	$mapping['type'] = Type::DATE;
	break;
	case DateTimeImmutable::class:
	$mapping['type'] = Type::DATE_IMMUTABLE;
	break;
	case 'array':
	$mapping['type'] = Type::HASH;
	break;
	case 'bool':
	$mapping['type'] = Type::BOOL;
	break;
	case 'float':
	$mapping['type'] = Type::FLOAT;
	break;
	case 'int':
	$mapping['type'] = Type::INT;
	break;
	case 'string':
	$mapping['type'] = Type::STRING;
	break;
	}


		This pattern can be adapted for any custom class—just implement the conversion logic for your value object.

		.. \|FQCN\| raw:: html <abbr title="Fully-Qualified Class Name">FQCN</abbr>

	return new self(sprintf('Invalid type specified "%s".', $name));
	return new self(sprintf('Invalid type specified: "%s".', $name));

Uh oh!

Improve detection of the type from a PHP variable #2814

Are you sure you want to change the base?

Improve detection of the type from a PHP variable #2814

Uh oh!

Conversation

GromNaN commented Sep 1, 2025

Summary

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!

This comment was marked as outdated.

Uh oh!

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!

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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GromNaN left a comment

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!