Replace OperatorInterface::getOperator() with OperatorInterface::NAME constant (#1541)

Author: GromNaN

generator/config/expression/case.yaml

@@ -3,7 +3,8 @@ name: $case
 link: 'https://www.mongodb.com/docs/manual/reference/operator/aggregation/switch/'
 type:
     - switchBranch
-encode: flat_object
+encode: object
+wrapObject: false
 description: |
     Represents a single case in a $switch expression
 arguments:

generator/config/schema.json

@@ -60,14 +60,18 @@
                     "enum": [
                         "array",
                         "object",
-                        "flat_object",
                         "single"
                     ]
                 },
                 "description": {
                     "$comment": "The description of the argument from MongoDB's documentation.",
                     "type": "string"
                 },
+                "wrapObject": {
+                    "$comment": "Wrap the properties in an object with the operator name",
+                    "type": "boolean",
+                    "default": true
+                },
                 "arguments": {
                     "$comment": "An optional list of arguments for the operator.",
                     "type": "array",

generator/src/Definition/OperatorDefinition.php

@@ -32,17 +32,21 @@ public function __construct(
         /** @var list<string> */
         public array $type,
         public string|null $description = null,
+        public bool $wrapObject = true,
         array $arguments = [],
         array $tests = [],
     ) {
         $this->encode = match ($encode) {
             'single' => Encode::Single,
             'array' => Encode::Array,
             'object' => Encode::Object,
-            'flat_object' => Encode::FlatObject,
             default => throw new UnexpectedValueException(sprintf('Unexpected "encode" value for operator "%s". Got "%s"', $name, $encode)),
         };
 
+        if (! $wrapObject && $this->encode !== Encode::Object) {
+            throw new UnexpectedValueException(sprintf('Operator "%s" cannot have wrapObject set to false when encode is not "object"', $name));
+        }
+
         // Convert arguments to ArgumentDefinition objects
         // Optional arguments must be after required arguments
         $requiredArgs = $optionalArgs = [];

generator/src/OperatorClassGenerator.php

@@ -22,7 +22,6 @@
 use function interface_exists;
 use function rtrim;
 use function sprintf;
-use function var_export;
 
 /**
  * Generates a value object class for stages and operators.
@@ -62,6 +61,7 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
         $class->addComment('@internal');
         $namespace->addUse(Encode::class);
         $class->addConstant('ENCODE', new Literal('Encode::' . $operator->encode->name));
+        $class->addConstant('NAME', $operator->wrapObject ? $operator->name : null);
 
         $encodeNames = [];
         $constructor = $class->addMethod('__construct');
@@ -179,10 +179,6 @@ public function createClass(GeneratorDefinition $definition, OperatorDefinition
             $class->addConstant('PROPERTIES', $encodeNames);
         }
 
-        $class->addMethod('getOperator')
-            ->setReturnType('string')
-            ->setBody('return ' . var_export($operator->name, true) . ';');
-
         return $namespace;
     }
 

psalm-baseline.xml

@@ -172,7 +172,26 @@
       <code><![CDATA[stdClass]]></code>
     </TooManyTemplateParams>
   </file>
+  <file src="src/Builder/Type/CombinedFieldQuery.php">
+    <MixedArgument>
+      <code><![CDATA[$operator]]></code>
+      <code><![CDATA[$operator]]></code>
+    </MixedArgument>
+    <MixedArrayOffset>
+      <code><![CDATA[$seenOperators[$operator]]]></code>
+    </MixedArrayOffset>
+    <MixedAssignment>
+      <code><![CDATA[$operator]]></code>
+    </MixedAssignment>
+  </file>
   <file src="src/Builder/Type/QueryObject.php">
+    <MixedArgument>
+      <code><![CDATA[$query::NAME]]></code>
+    </MixedArgument>
+    <MixedArrayOffset>
+      <code><![CDATA[$seenQueryOperators[$query::NAME]]]></code>
+      <code><![CDATA[$seenQueryOperators[$query::NAME]]]></code>
+    </MixedArrayOffset>
     <MixedAssignment>
       <code><![CDATA[$queries[$fieldPath]]]></code>
       <code><![CDATA[$query]]></code>
@@ -183,6 +202,11 @@
             is_array($queriesOrArrayOfQueries[0]) &&
             count($queriesOrArrayOfQueries[0]) > 0]]></code>
     </RedundantConditionGivenDocblockType>
+    <UndefinedConstant>
+      <code><![CDATA[$query::NAME]]></code>
+      <code><![CDATA[$query::NAME]]></code>
+      <code><![CDATA[$query::NAME]]></code>
+    </UndefinedConstant>
   </file>
   <file src="src/ChangeStream.php">
     <DeprecatedConstant>