welcome hydrateAndInsert

Author: cosmastech

src/Illuminate/Database/Eloquent/Builder.php

@@ -60,13 +60,6 @@ class Builder implements BuilderContract
      */
     public $pendingAttributes = [];
 
-    /**
-     * Indicates if attributes, timestamps, and unique IDs should be merged before insert.
-     *
-     * @var bool
-     */
-    public $mergeAttributesBeforeInsert = false;
-
     /**
      * The relationships that should be eager loaded.
      *
@@ -596,56 +589,51 @@ public function findOr($id, $columns = ['*'], ?Closure $callback = null)
     }
 
     /**
-     * Insert new records into the database.
+     * Merge in Model's default attributes, set timestamps,
+     * cast any values, and then insert into the database.
      *
+     * @param  array<int, array<string, mixed>>  $values
      * @return bool
      */
-    public function insert(array $values)
+    public function hydrateAndInsert(array $values)
     {
-        if ($this->mergeAttributesBeforeInsert) {
-            $values = $this->castBeforeInsert($values);
-        }
-
-        return $this->forwardCallTo($this->query, 'insert', [$values]);
+        return $this->insert($this->hydrateForInsert($values));
     }
 
     /**
-     * Insert a new record and get the value of the primary key.
+     * Merge in Model's default attributes, set timestamps,
+     * cast any values, and then insert into the database,
+     * ignoring errors.
      *
-     * @param  string|null  $sequence
+     * @param  array<int, array<string, mixed>>  $values
      * @return int
      */
-    public function insertGetId(array $values, $sequence = null)
+    public function hydrateAndInsertOrIgnore(array $values)
     {
-        if ($this->mergeAttributesBeforeInsert) {
-            $values = $this->castBeforeInsert([$values])[0];
-        }
-
-        return $this->forwardCallTo($this->query, 'insertGetId', [$values, $sequence]);
+        return $this->insertOrIgnore($this->hydrateForInsert($values));
     }
 
     /**
-     * Insert new records into the database while ignoring errors.
+     * Merge in Model's default attributes, set timestamps,
+     * cast any values, and then insert into the database,
+     * returning the ID of the new record.
      *
+     * @param  array<string, mixed>  $values
      * @return int
      */
-    public function insertOrIgnore(array $values)
+    public function hydrateAndInsertGetId(array $values)
     {
-        if ($this->mergeAttributesBeforeInsert) {
-            $values = $this->castBeforeInsert($values);
-        }
-
-        return $this->forwardCallTo($this->query, 'insertOrIgnore', [$values]);
+        return $this->insertGetId($this->hydrateForInsert([$values])[0]);
     }
 
     /**
-     * Insert a number of records, merging in default attributes,
+     * Enrich values by merging in the Model's default attributes,
      * adding timestamps, and converting casts to raw values.
      *
      * @param  array<int, array<string, mixed>>  $values
      * @return array<int, array<string, mixed>>
      */
-    public function castBeforeInsert(array $values)
+    public function hydrateForInsert(array $values)
     {
         if (empty($values)) {
             return [];
@@ -1915,20 +1903,6 @@ public function withAttributes(Expression|array|string $attributes, $value = nul
         return $this;
     }
 
-    /**
-     * Indicate if insert methods should merge in default attributes,
-     * add timestamps, and converting casts to raw values.
-     *
-     * @param  bool  $mergeBeforeInsert
-     * @return $this
-     */
-    public function mergeAttributesBeforeInsert($mergeBeforeInsert = true)
-    {
-        $this->mergeAttributesBeforeInsert = $mergeBeforeInsert;
-
-        return $this;
-    }
-
     /**
      * Apply query-time casts to the model instance.
      *

tests/Database/DatabaseEloquentIntegrationTest.php

@@ -2474,12 +2474,12 @@ public function testTouchingBiDirectionalChaperonedModelUpdatesAllRelatedTimesta
         }
     }
 
-    public function testCanInsertWithCasts()
+    public function testCanEnrichAndInsert()
     {
         DB::enableQueryLog();
         Carbon::setTestNow('2025-03-15T07:32:00Z');
 
-        $this->assertTrue(EloquentTestUser::mergeAttributesBeforeInsert()->insert([
+        $this->assertTrue(EloquentTestUser::hydrateAndInsert([
             ['email' => '[email protected]', 'birthday' => null],
             ['email' => '[email protected]', 'birthday' => new Carbon('1980-01-01')],
             ['email' => '[email protected]', 'birthday' => '1987-11-01', 'created_at' => '2025-01-02T02:00:55', 'updated_at' => Carbon::parse('2025-02-19T11:41:13')],
@@ -2505,7 +2505,7 @@ public function testCanInsertWithCasts()
 
         DB::flushQueryLog();
 
-        $this->assertTrue(EloquentTestWithJSON::mergeAttributesBeforeInsert()->insert([
+        $this->assertTrue(EloquentTestWithJSON::hydrateAndInsert([
             ['id' => 1, 'json' => ['album' => 'Keep It Like a Secret', 'release_date' => '1999-02-02']],
             ['id' => 2, 'json' => (object) ['album' => 'You In Reverse', 'release_date' => '2006-04-11']],
         ]));
@@ -2520,15 +2520,15 @@ public function testCanInsertWithCasts()
         });
     }
 
-    public function testCanInsertWithCastsWithUniqueStringIds()
+    public function testCanHydrateAndInsertWithUniqueStringIds()
     {
         Str::createUuidsUsingSequence([
             '00000000-0000-7000-0000-000000000000',
             '11111111-0000-7000-0000-000000000000',
             '22222222-0000-7000-0000-000000000000',
         ]);
 
-        $this->assertTrue(ModelWithUniqueStringIds::mergeAttributesBeforeInsert()->insert([
+        $this->assertTrue(ModelWithUniqueStringIds::hydrateAndInsert([
             [
                 'name' => 'Taylor', 'role' => IntBackedRole::Admin, 'role_string' => StringBackedRole::Admin,
             ],
@@ -2567,6 +2567,37 @@ public function testCanInsertWithCastsWithUniqueStringIds()
         $this->assertSame('22222222-0000-7000-0000-000000000000', $chris->uuid);
     }
 
+    public function testHydrateAndInsertOrIgnore()
+    {
+        Str::createUuidsUsingSequence([
+            '00000000-0000-7000-0000-000000000000',
+            '11111111-0000-7000-0000-000000000000',
+            '22222222-0000-7000-0000-000000000000',
+        ]);
+
+        $this->assertEquals(1, ModelWithUniqueStringIds::hydrateAndInsertOrIgnore([
+            [
+                'id' => 1, 'name' => 'Taylor', 'role' => IntBackedRole::Admin, 'role_string' => StringBackedRole::Admin,
+            ],
+        ]));
+
+        $this->assertSame(1, ModelWithUniqueStringIds::hydrateAndInsertOrIgnore([
+            [
+                'id' => 1, 'name' => 'Taylor', 'role' => IntBackedRole::Admin, 'role_string' => StringBackedRole::Admin,
+            ],
+            [
+                'id' => 2, 'name' => 'Nuno',
+            ],
+        ]));
+
+        $models = ModelWithUniqueStringIds::get();
+        $this->assertSame('00000000-0000-7000-0000-000000000000', $models->firstWhere('name', 'Taylor')->uuid);
+        $this->assertSame(
+            ['uuid' => '22222222-0000-7000-0000-000000000000', 'role' => IntBackedRole::User],
+            $models->firstWhere('name', 'Nuno')->only('uuid', 'role')
+        );
+    }
+
     public function testMergeBeforeInsertGetId()
     {
         Str::createUuidsUsingSequence([
@@ -2575,7 +2606,7 @@ public function testMergeBeforeInsertGetId()
 
         DB::enableQueryLog();
 
-        $this->assertIsInt($newId = ModelWithUniqueStringIds::mergeAttributesBeforeInsert()->insertGetId([
+        $this->assertIsInt($newId = ModelWithUniqueStringIds::hydrateAndinsertGetId([
             'name' => 'Taylor',
             'role' => IntBackedRole::Admin,
             'role_string' => StringBackedRole::Admin,