Use an enum for query type

Author: GromNaN

docs/en/reference/attributes-reference.rst

@@ -339,14 +339,14 @@ multiple document classes, and even other embedded documents!
 #[Encrypt]
 ----------
 
-The `#[Encrypt]` attribute is used to define an encrypted field mapping for a document property. It allows you to configure fields for encryption and queryable encryption in MongoDB.
+The ``#[Encrypt]`` attribute is used to define an encrypted field mapping for a document property. It allows you to configure fields for encryption and queryable encryption in MongoDB.
 
 Optional arguments:
 
 - ``queryType`` - Specifies the query type for the field. Possible values:
   - ``null`` (default) - Field is not queryable.
-  - ``QUERY_TYPE_EQUALITY`` - Enables equality queries.
-  - ``QUERY_TYPE_RANGE`` - Enables range queries.
+  - ``EncryptQuery::Equality`` - Enables equality queries.
+  - ``EncryptQuery::Range`` - Enables range queries.
 - ``min``, ``max`` - Specify minimum and maximum (inclusive) queryable values fora field when possible, as smaller bounds improve query efficiency. If querying values outside of these bounds, MongoDB returns an error.
 - ``sparsity``, ``prevision``, ``trimFactor``, ``contention`` - For advanced users only. The default values for these options are suitable for the majority of use cases, and should only be modified if your use case requires it.
 
@@ -357,14 +357,15 @@ Example:
     <?php
 
     use Doctrine\ODM\MongoDB\Mapping\Annotations\Encrypt;
+    use Doctrine\ODM\MongoDB\Mapping\Annotations\EncryptQuery;
 
     #[Document]
     class Client
     {
         // ...
 
         #[Field]
-        #[Encrypt(queryType: Encrypt::QUERY_TYPE_EQUALITY)]
+        #[Encrypt(queryType: EncryptQuery::Equality)]
         public string $name;
     }
 

lib/Doctrine/ODM/MongoDB/Mapping/Annotations/Encrypt.php

@@ -6,11 +6,7 @@
 
 use Attribute;
 use Doctrine\Common\Annotations\Annotation\NamedArgumentConstructor;
-use InvalidArgumentException;
 use MongoDB\BSON\Type;
-use MongoDB\Driver\ClientEncryption;
-
-use function in_array;
 
 /**
  * Defines an encrypted field mapping.
@@ -23,27 +19,21 @@
 #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
 final class Encrypt implements Annotation
 {
-    public const QUERY_TYPE_EQUALITY = ClientEncryption::QUERY_TYPE_EQUALITY;
-    public const QUERY_TYPE_RANGE    = ClientEncryption::QUERY_TYPE_RANGE;
-
     /**
-     * @param self::QUERY_TYPE_*|null $queryType  Set the query type for the field, null if not queryable.
-     * @param int<1, 4>|null          $sparsity
-     * @param positive-int|null       $prevision
-     * @param positive-int|null       $trimFactor
-     * @param positive-int|null       $contention
+     * @param EncryptQuery|null $queryType  Set the query type for the field, null if not queryable.
+     * @param int<1, 4>|null    $sparsity
+     * @param positive-int|null $prevision
+     * @param positive-int|null $trimFactor
+     * @param positive-int|null $contention
      */
     public function __construct(
-        public ?string $queryType = null,
+        public ?EncryptQuery $queryType = null,
         public string|int|Type|null $min = null,
         public string|int|Type|null $max = null,
         public ?int $sparsity = null,
         public ?int $prevision = null,
         public ?int $trimFactor = null,
         public ?int $contention = null,
     ) {
-        if ($this->queryType && ! in_array($this->queryType, [self::QUERY_TYPE_EQUALITY, self::QUERY_TYPE_RANGE], true)) {
-            throw new InvalidArgumentException('Invalid query type');
-        }
     }
 }

lib/Doctrine/ODM/MongoDB/Mapping/Annotations/EncryptQuery.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ODM\MongoDB\Mapping\Annotations;
+
+use MongoDB\Driver\ClientEncryption;
+
+enum EncryptQuery: string
+{
+    case Equality = ClientEncryption::QUERY_TYPE_EQUALITY;
+    case Range    = ClientEncryption::QUERY_TYPE_RANGE;
+}

lib/Doctrine/ODM/MongoDB/Utility/EncryptionFieldMap.php

@@ -4,12 +4,14 @@
 
 namespace Doctrine\ODM\MongoDB\Utility;
 
+use Doctrine\ODM\MongoDB\Mapping\Annotations\EncryptQuery;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactoryInterface;
 use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use Generator;
 
 use function array_filter;
+use function assert;
 use function iterator_to_array;
 
 final class EncryptionFieldMap
@@ -72,6 +74,8 @@ private function createEncryptionFieldMap(ClassMetadata $classMetadata, string $
             // When queryType is null, the field is not queryable
             if (isset($mapping['encrypt']['queryType'])) {
                 $field['queries'] = array_filter($mapping['encrypt'], static fn ($v) => $v !== null);
+                assert($field['queries']['queryType'] instanceof EncryptQuery);
+                $field['queries']['queryType'] = $field['queries']['queryType']->value;
             }
 
             yield $field;

tests/Documents/Encryption/PatientRecord.php

@@ -14,13 +14,13 @@ class PatientRecord
 
     public function __construct(
         #[ODM\Field]
-        #[ODM\Encrypt(queryType: ODM\Encrypt::QUERY_TYPE_EQUALITY)]
+        #[ODM\Encrypt(queryType: ODM\EncryptQuery::Equality)]
         public string $ssn,
         #[ODM\EmbedOne(targetDocument: PatientBilling::class)]
         #[ODM\Encrypt]
         public PatientBilling $billing,
         #[ODM\Field]
-        #[ODM\Encrypt(queryType: ODM\Encrypt::QUERY_TYPE_RANGE, sparsity: 1, trimFactor: 4, min: 100, max: 2000)]
+        #[ODM\Encrypt(queryType: ODM\EncryptQuery::Range, sparsity: 1, trimFactor: 4, min: 100, max: 2000)]
         public int $billingAmount,
     ) {
     }