Add support for enum arguments to setValue()

The ORM is relying on that feature.
doctrine · Feb 27, 2024 · a102634 · a102634
1 parent 5ce8785
commit a102634
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -10,6 +10,16 @@ parameters:
 			count: 1
 			path: src/Persistence/Reflection/EnumReflectionProperty.php
 
+		-
+			message: "#^Method Doctrine\\\\Persistence\\\\Reflection\\\\EnumReflectionProperty\\:\\:toEnum\\(\\) should return array\\<BackedEnum\\>\\|BackedEnum but returns array\\<BackedEnum\\|int\\|string\\>\\.$#"
+			count: 1
+			path: src/Persistence/Reflection/EnumReflectionProperty.php
+
+		-
+			message: "#^Parameter \\#1 \\$callback of function array_map expects \\(callable\\(BackedEnum\\|int\\|string\\)\\: mixed\\)\\|null, array\\{class\\-string\\<BackedEnum\\>, 'from'\\} given\\.$#"
+			count: 1
+			path: src/Persistence/Reflection/EnumReflectionProperty.php
+
 		-
 			message: "#^Variable property access on \\$this\\(Doctrine\\\\Persistence\\\\Reflection\\\\TypedNoDefaultRuntimePublicReflectionProperty\\)\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -8,4 +8,12 @@
       <code>$parentClass === false</code>
     </TypeDoesNotContainType>
   </file>
+  <file src="src/Persistence/Reflection/EnumReflectionProperty.php">
+    <InvalidReturnStatement occurrences="1">
+      <code>$value</code>
+    </InvalidReturnStatement>
+    <PossiblyInvalidArgument occurrences="1">
+      <code>$value</code>
+    </PossiblyInvalidArgument>
+  </file>
 </files>
diff --git a/src/Persistence/Reflection/EnumReflectionProperty.php b/src/Persistence/Reflection/EnumReflectionProperty.php
@@ -86,13 +86,25 @@ private function fromEnum($enum)
     }
 
     /**
-     * @param int|string|int[]|string[] $value
+     * @param int|string|int[]|string[]|BackedEnum|BackedEnum[] $value
      *
      * @return ($value is int|string ? BackedEnum : BackedEnum[])
      */
     private function toEnum($value)
     {
+        if ($value instanceof BackedEnum) {
+            return $value;
+        }
+
         if (is_array($value)) {
+            foreach ($value as $v) {
+                if ($v instanceof BackedEnum) {
+                    return $value;
+                }
+
+                break;
+            }
+
             return array_map([$this->enumType, 'from'], $value);
         }
 

diff --git a/tests_php81/Persistence/Reflection/EnumReflectionPropertyTest.php b/tests_php81/Persistence/Reflection/EnumReflectionPropertyTest.php
@@ -64,6 +64,24 @@ public function testSetValidArrayValue(): void
         self::assertSame(['H', 'D'], $reflProperty->getValue($object));
         self::assertSame([Suit::Hearts, Suit::Diamonds], $object->suits);
     }
+
+    public function testSetEnum(): void
+    {
+        $object       = new TypedEnumClass();
+        $reflProperty = new EnumReflectionProperty(new ReflectionProperty(TypedEnumClass::class, 'suit'), Suit::class);
+        $reflProperty->setValue($object, Suit::Hearts);
+
+        self::assertSame(Suit::Hearts, $object->suit);
+    }
+
+    public function testSetEnumArray(): void
+    {
+        $object       = new TypedEnumClass();
+        $reflProperty = new EnumReflectionProperty(new ReflectionProperty(TypedEnumClass::class, 'suits'), Suit::class);
+        $reflProperty->setValue($object, [Suit::Hearts, Suit::Diamonds]);
+
+        self::assertSame([Suit::Hearts, Suit::Diamonds], $object->suits);
+    }
 }
 
 class TypedEnumClass