From db49a70ec2f518ff07c176a9663e9e87133fb03c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Tamarelle?= <jerome@tamarelle.net>
Date: Thu, 26 Jun 2025 12:13:09 +0200
Subject: [PATCH] Add Type::getBSONType()

---
 .../ODM/MongoDB/Types/BinDataType.php         |  5 ++++
 .../ODM/MongoDB/Types/BooleanType.php         |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/BsonType.php   | 26 +++++++++++++++++++
 .../ODM/MongoDB/Types/CollectionType.php      |  5 ++++
 .../ODM/MongoDB/Types/CustomIdType.php        |  9 +++++++
 lib/Doctrine/ODM/MongoDB/Types/DateType.php   |  5 ++++
 .../ODM/MongoDB/Types/Decimal128Type.php      |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/FloatType.php  |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/HashType.php   |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/IdType.php     |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/IntType.php    |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/KeyType.php    |  8 ++++++
 .../ODM/MongoDB/Types/ObjectIdType.php        |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/RawType.php    |  9 +++++++
 lib/Doctrine/ODM/MongoDB/Types/StringType.php |  5 ++++
 .../ODM/MongoDB/Types/TimestampType.php       |  5 ++++
 lib/Doctrine/ODM/MongoDB/Types/Type.php       | 12 +++++++++
 17 files changed, 124 insertions(+)
 create mode 100644 lib/Doctrine/ODM/MongoDB/Types/BsonType.php

diff --git a/lib/Doctrine/ODM/MongoDB/Types/BinDataType.php b/lib/Doctrine/ODM/MongoDB/Types/BinDataType.php
index 662ac63d2f..012bf1ac9e 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/BinDataType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/BinDataType.php
@@ -22,6 +22,11 @@ class BinDataType extends Type
      */
     protected $binDataType = Binary::TYPE_GENERIC;
 
+    public function getBSONType(): BsonType
+    {
+        return BsonType::BinaryData;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value === null) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/BooleanType.php b/lib/Doctrine/ODM/MongoDB/Types/BooleanType.php
index eb52fd3dc5..5488030070 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/BooleanType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/BooleanType.php
@@ -9,6 +9,11 @@
  */
 class BooleanType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Boolean;
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value !== null ? (bool) $value : null;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/BsonType.php b/lib/Doctrine/ODM/MongoDB/Types/BsonType.php
new file mode 100644
index 0000000000..0f1ba01105
--- /dev/null
+++ b/lib/Doctrine/ODM/MongoDB/Types/BsonType.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ODM\MongoDB\Types;
+
+enum BsonType: string
+{
+    case Double            = 'double';
+    case String            = 'string';
+    case Object            = 'object';
+    case Array             = 'array';
+    case BinaryData        = 'binData';
+    case ObjectId          = 'objectId';
+    case Boolean           = 'bool';
+    case Date              = 'date';
+    case Null              = 'null';
+    case RegularExpression = 'regex';
+    case JavaScript        = 'javascript';
+    case Int32             = 'int';
+    case Timestamp         = 'timestamp';
+    case Int64             = 'long';
+    case Decimal128        = 'decimal';
+    case MinKey            = 'minKey';
+    case MaxKey            = 'maxKey';
+}
diff --git a/lib/Doctrine/ODM/MongoDB/Types/CollectionType.php b/lib/Doctrine/ODM/MongoDB/Types/CollectionType.php
index c5b749b7f0..bcbac74320 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/CollectionType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/CollectionType.php
@@ -14,6 +14,11 @@
  */
 class CollectionType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Array;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value !== null && ! is_array($value)) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/CustomIdType.php b/lib/Doctrine/ODM/MongoDB/Types/CustomIdType.php
index 191a37ea46..0a84b5d9b7 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/CustomIdType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/CustomIdType.php
@@ -4,11 +4,20 @@
 
 namespace Doctrine\ODM\MongoDB\Types;
 
+use LogicException;
+
+use function sprintf;
+
 /**
  * The Id type.
  */
 class CustomIdType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class));
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/DateType.php b/lib/Doctrine/ODM/MongoDB/Types/DateType.php
index 542e8febd4..e9943e8b1d 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/DateType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/DateType.php
@@ -28,6 +28,11 @@
  */
 class DateType extends Type implements Versionable
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Date;
+    }
+
     /**
      * Converts a value to a DateTime.
      * Supports microseconds
diff --git a/lib/Doctrine/ODM/MongoDB/Types/Decimal128Type.php b/lib/Doctrine/ODM/MongoDB/Types/Decimal128Type.php
index 1ae53f73bd..86fd2816cf 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/Decimal128Type.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/Decimal128Type.php
@@ -13,6 +13,11 @@ class Decimal128Type extends Type implements Incrementable, Versionable
 {
     use ClosureToPHP;
 
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Decimal128;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value === null) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/FloatType.php b/lib/Doctrine/ODM/MongoDB/Types/FloatType.php
index 79ed5a999c..c8bba71c19 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/FloatType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/FloatType.php
@@ -9,6 +9,11 @@
  */
 class FloatType extends Type implements Incrementable
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Double;
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value !== null ? (float) $value : null;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/HashType.php b/lib/Doctrine/ODM/MongoDB/Types/HashType.php
index 27ed20a90b..6c7f0362d6 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/HashType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/HashType.php
@@ -13,6 +13,11 @@
  */
 class HashType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Object;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value !== null && ! is_array($value)) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/IdType.php b/lib/Doctrine/ODM/MongoDB/Types/IdType.php
index b3583a3cab..9ae64d5e7b 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/IdType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/IdType.php
@@ -12,6 +12,11 @@
  */
 class IdType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::ObjectId;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value === null) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/IntType.php b/lib/Doctrine/ODM/MongoDB/Types/IntType.php
index 6999f3a90d..0a2e7e1bed 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/IntType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/IntType.php
@@ -11,6 +11,11 @@
  */
 class IntType extends Type implements Incrementable, Versionable
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Int32;
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value !== null ? (int) $value : null;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/KeyType.php b/lib/Doctrine/ODM/MongoDB/Types/KeyType.php
index b98b3c880d..0ac3f95500 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/KeyType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/KeyType.php
@@ -4,14 +4,22 @@
 
 namespace Doctrine\ODM\MongoDB\Types;
 
+use LogicException;
 use MongoDB\BSON\MaxKey;
 use MongoDB\BSON\MinKey;
 
+use function sprintf;
+
 /**
  * The Key type.
  */
 class KeyType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class));
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value === null) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/ObjectIdType.php b/lib/Doctrine/ODM/MongoDB/Types/ObjectIdType.php
index 13f7f87ffc..f92ce126a5 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/ObjectIdType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/ObjectIdType.php
@@ -11,6 +11,11 @@
  */
 class ObjectIdType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::ObjectId;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value === null) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/RawType.php b/lib/Doctrine/ODM/MongoDB/Types/RawType.php
index a5ec7d041e..ccc86a580e 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/RawType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/RawType.php
@@ -4,11 +4,20 @@
 
 namespace Doctrine\ODM\MongoDB\Types;
 
+use LogicException;
+
+use function sprintf;
+
 /**
  * Raw data type.
  */
 class RawType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        throw new LogicException(sprintf('Cannot determine BSON type for "%s".', self::class));
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/StringType.php b/lib/Doctrine/ODM/MongoDB/Types/StringType.php
index 75a13a69ec..31a5cc01f8 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/StringType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/StringType.php
@@ -11,6 +11,11 @@
  */
 class StringType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::String;
+    }
+
     public function convertToDatabaseValue($value)
     {
         return $value === null || $value instanceof Regex ? $value : (string) $value;
diff --git a/lib/Doctrine/ODM/MongoDB/Types/TimestampType.php b/lib/Doctrine/ODM/MongoDB/Types/TimestampType.php
index 7ded83b5b0..cec9468acc 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/TimestampType.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/TimestampType.php
@@ -14,6 +14,11 @@
  */
 class TimestampType extends Type
 {
+    public function getBSONType(): BsonType
+    {
+        return BsonType::Timestamp;
+    }
+
     public function convertToDatabaseValue($value)
     {
         if ($value instanceof Timestamp) {
diff --git a/lib/Doctrine/ODM/MongoDB/Types/Type.php b/lib/Doctrine/ODM/MongoDB/Types/Type.php
index b8b308c11e..e80cd1d8c8 100644
--- a/lib/Doctrine/ODM/MongoDB/Types/Type.php
+++ b/lib/Doctrine/ODM/MongoDB/Types/Type.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\Types;
 
+use BadMethodCallException;
 use DateTimeInterface;
 use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use Doctrine\ODM\MongoDB\Types;
@@ -91,6 +92,17 @@ final private function __construct()
     {
     }
 
+    /**
+     * 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));
+    }
+
     /**
      * Converts a value from its PHP representation to its database representation
      * of this type.