PHPLIB-1363 Add enum for list

Author: GromNaN

src/Builder/BuilderEncoder.php

@@ -4,6 +4,7 @@
 
 namespace MongoDB\Builder;
 
+use BackedEnum;
 use LogicException;
 use MongoDB\Builder\Expression\Variable;
 use MongoDB\Builder\Stage\GroupStage;
@@ -101,6 +102,10 @@ public function encode($value): stdClass|array|string
             throw new LogicException(sprintf('Class "%s" does not implement OperatorInterface.', $value::class));
         }
 
+        if ($value instanceof BackedEnum) {
+            return $this->encodeAsEnum($value);
+        }
+
         // The generic but incomplete encoding code
         switch ($value::ENCODE) {
             case Encode::Single:
@@ -124,6 +129,16 @@ public function encode($value): stdClass|array|string
         throw new LogicException(sprintf('Class "%s" does not have a valid ENCODE constant.', $value::class));
     }
 
+    private function encodeAsEnum(OperatorInterface&BackedEnum $value): stdClass
+    {
+        $val = $value->value;
+        if ($value::ENCODE === Encode::Array) {
+            $val = [$val];
+        }
+
+        return $this->wrap($value, $val);
+    }
+
     /**
      * Encode the value as an array of properties, in the order they are defined in the class.
      */

src/Builder/QueryType.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MongoDB\Builder;
+
+use MongoDB\Builder\Query\TypeOperator;
+use MongoDB\Builder\Type\Encode;
+use MongoDB\Builder\Type\FieldQueryInterface;
+use MongoDB\Builder\Type\OperatorInterface;
+
+/**
+ * Shortcut for $type field query operator
+ *
+ * @see https://www.mongodb.com/docs/manual/reference/operator/query/type/#available-types
+ * @see TypeOperator
+ */
+enum QueryType: string implements OperatorInterface, FieldQueryInterface
+{
+    public const ENCODE = Encode::Array;
+
+    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 Regex = 'regex';
+    case JavaScript = 'javascript';
+    case Int = 'int';
+    case Timestamp = 'timestamp';
+    case Long = 'long';
+    case Decimal128 = 'decimal';
+    case MinKey = 'minKey';
+    case MaxKey = 'maxKey';
+    /**
+     * Alias for Double, Int, Long, Decimal
+     */
+    case Number = 'number';
+
+    public function getOperator(): string
+    {
+        return '$type';
+    }
+}

src/Builder/Stage.php

@@ -21,7 +21,7 @@ final class Stage
      *
      * @see https://www.mongodb.com/docs/manual/reference/operator/aggregation/match/
      *
-     * @param QueryInterface|FieldQueryInterface|Type|stdClass|array<array-key,mixed>|bool|float|int|string|null ...$queries The query predicates to match
+     * @param QueryInterface|FieldQueryInterface|QueryType|stdClass|array<array-key,mixed>|bool|float|int|string|null ...$queries The query predicates to match
      */
     public static function match(QueryInterface|FieldQueryInterface|Type|stdClass|array|bool|float|int|string|null ...$queries): MatchStage
     {

tests/Builder/Query/TypeOperatorTest.php

@@ -6,6 +6,7 @@
 
 use MongoDB\Builder\Pipeline;
 use MongoDB\Builder\Query;
+use MongoDB\Builder\QueryType;
 use MongoDB\Builder\Stage;
 use MongoDB\Tests\Builder\PipelineTestCase;
 
@@ -32,7 +33,7 @@ public function testQueryingByDataType(): void
                 zipCode: Query::type(2),
             ),
             Stage::match(
-                zipCode: Query::type('string'),
+                zipCode: QueryType::String,
             ),
             Stage::match(
                 zipCode: Query::type(1),
@@ -41,7 +42,7 @@ public function testQueryingByDataType(): void
                 zipCode: Query::type('double'),
             ),
             Stage::match(
-                zipCode: Query::type('number'),
+                zipCode: QueryType::Number,
             ),
         );