[11.x] Accept non-backed enum in database queries (#50674)

* Cast non-backed enum in database bindings * Update enum queries integration tests
laravel · Mar 21, 2024 · 08772cf · 08772cf
1 parent 075bda5
commit 08772cf
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 1 deletion.
diff --git a/src/Illuminate/Database/Query/Builder.php b/src/Illuminate/Database/Query/Builder.php
@@ -27,6 +27,7 @@
 use InvalidArgumentException;
 use LogicException;
 use RuntimeException;
+use UnitEnum;
 
 class Builder implements BuilderContract
 {
@@ -3953,7 +3954,11 @@ public function addBinding($value, $type = 'where')
      */
     public function castBinding($value)
     {
-        return $value instanceof BackedEnum ? $value->value : $value;
+        if ($value instanceof UnitEnum) {
+            return $value instanceof BackedEnum ? $value->value : $value->name;
+        }
+
+        return $value;
     }
 
     /**

diff --git a/tests/Database/DatabaseQueryBuilderTest.php b/tests/Database/DatabaseQueryBuilderTest.php
@@ -30,6 +30,8 @@
 use RuntimeException;
 use stdClass;
 
+include_once 'Enums.php';
+
 class DatabaseQueryBuilderTest extends TestCase
 {
     protected $called;
@@ -4474,6 +4476,14 @@ public function testAddBindingWithArrayMergesBindingsInCorrectOrder()
         $this->assertEquals(['foo', 'bar', 'baz'], $builder->getBindings());
     }
 
+    public function testAddBindingWithEnum()
+    {
+        $builder = $this->getBuilder();
+        $builder->addBinding(IntegerStatus::done);
+        $builder->addBinding([NonBackedStatus::done]);
+        $this->assertEquals([2, 'done'], $builder->getBindings());
+    }
+
     public function testMergeBuilders()
     {
         $builder = $this->getBuilder();

diff --git a/tests/Database/Enums.php b/tests/Database/Enums.php
@@ -18,6 +18,13 @@ enum IntegerStatus: int
     case done = 2;
 }
 
+enum NonBackedStatus
+{
+    case draft;
+    case pending;
+    case done;
+}
+
 enum ArrayableStatus: string implements Arrayable
 {
     case pending = 'pending';

diff --git a/tests/Integration/Database/Enums.php b/tests/Integration/Database/Enums.php
@@ -18,6 +18,13 @@ enum IntegerStatus: int
     case done = 2;
 }
 
+enum NonBackedStatus
+{
+    case draft;
+    case pending;
+    case done;
+}
+
 enum ArrayableStatus: string implements Arrayable
 {
     case pending = 'pending';

diff --git a/tests/Integration/Database/QueryingWithEnumsTest.php b/tests/Integration/Database/QueryingWithEnumsTest.php
@@ -16,6 +16,7 @@ protected function afterRefreshingDatabase()
             $table->increments('id');
             $table->string('string_status', 100)->nullable();
             $table->integer('integer_status')->nullable();
+            $table->string('non_backed_status', 100)->nullable();
         });
     }
 
@@ -24,30 +25,36 @@ public function testCanQueryWithEnums()
         DB::table('enum_casts')->insert([
             'string_status' => 'pending',
             'integer_status' => 1,
+            'non_backed_status' => 'pending',
         ]);
 
         $record = DB::table('enum_casts')->where('string_status', StringStatus::pending)->first();
         $record2 = DB::table('enum_casts')->where('integer_status', IntegerStatus::pending)->first();
         $record3 = DB::table('enum_casts')->whereIn('integer_status', [IntegerStatus::pending])->first();
+        $record4 = DB::table('enum_casts')->where('non_backed_status', NonBackedStatus::pending)->first();
 
         $this->assertNotNull($record);
         $this->assertNotNull($record2);
         $this->assertNotNull($record3);
+        $this->assertNotNull($record4);
         $this->assertSame('pending', $record->string_status);
         $this->assertEquals(1, $record2->integer_status);
+        $this->assertSame('pending', $record4->non_backed_status);
     }
 
     public function testCanInsertWithEnums()
     {
         DB::table('enum_casts')->insert([
             'string_status' => StringStatus::pending,
             'integer_status' => IntegerStatus::pending,
+            'non_backed_status' => NonBackedStatus::pending,
         ]);
 
         $record = DB::table('enum_casts')->where('string_status', StringStatus::pending)->first();
 
         $this->assertNotNull($record);
         $this->assertSame('pending', $record->string_status);
         $this->assertEquals(1, $record->integer_status);
+        $this->assertSame('pending', $record->non_backed_status);
     }
 }