Add Type::getBSONType()
#2786
Open
Add Type::getBSONType()
#2786
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GromNaN
commented
Jun 26, 2025
Comment on lines
+95
to
+105
| /** | ||
| * Returns the alias name of the BSON type. | ||
| * | ||
| * @link https://www.mongodb.com/docs/manual/reference/bson-types/ | ||
| */ | ||
| public function getBSONType(): BsonType | ||
| { | ||
| // This method will be abstract in the next major version. | ||
| throw new BadMethodCallException(sprintf('The method "%s::getBSONType" is not implemented. You must implement this method in the concrete type class.', static::class)); | ||
| } | ||
|
|
There was a problem hiding this comment.
We cannot make this method abstract in a minor version, that would be a breaking change for custom type classes that extend this class.
| /** | ||
| * Raw data type. | ||
| */ | ||
| class RawType extends Type | ||
| { | ||
| public function getBSONType(): BsonType | ||
| { | ||
| throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class)); |
There was a problem hiding this comment.
The field type can be anything.
| /** | ||
| * The Key type. | ||
| */ | ||
| class KeyType extends Type | ||
| { | ||
| public function getBSONType(): BsonType | ||
| { | ||
| throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class)); |
There was a problem hiding this comment.
The field type can be maxKey or minKey.
| @@ -11,6 +11,11 @@ | |||
| */ | |||
| class IntType extends Type implements Incrementable, Versionable | |||
| { | |||
| public function getBSONType(): BsonType | |||
| { | |||
| return BsonType::Int32; | |||
There was a problem hiding this comment.
Depending on the system and the value, I think the type can be an int 32 bits or 64 bits.
| /** | ||
| * The Id type. | ||
| */ | ||
| class CustomIdType extends Type | ||
| { | ||
| public function getBSONType(): BsonType | ||
| { | ||
| throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class)); |
There was a problem hiding this comment.
The field type can be anything.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
While working on
encryptedFieldsMap(#2785 (comment)), we found that it would be useful if every ODM Type could indicate its BSON type.It's possible to assign 1 BSON type for most of the ODM types, but there are some exception with some ODM types that can return multiple BSON types (see comments).