[8.x] syncWithPivotDefaults method

src/Illuminate/Database/Eloquent/Relations/Concerns/InteractsWithPivotTable.php

@@ -123,6 +123,23 @@ public function sync($ids, $detaching = true)
         return $changes;
     }
 
+    /**
+     * Sync the intermediate tables with a list of IDs or collection of models with default values.
+     *
+     * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array  $ids
+     * @param  bool  $detaching
+     * @param  array $defaults
+     * @return array
+     */
+    public function syncWithPivotDefaults($ids, array $defaults, bool $detaching = true)
+    {
+        $idsWithDefaults = collect($this->parseIds($ids))->mapWithKeys(function ($id) use ($defaults) {
+            return [$id => $defaults];
+        });
+
+        return $this->sync($idsWithDefaults, $detaching);
+    }
+
     /**
      * Format the sync / toggle record list so that it is keyed by ID.
      *

tests/Database/DatabaseEloquentBelongsToManySyncReturnValueTypeTest.php

@@ -47,6 +47,7 @@ public function createSchema()
             $table->foreign('article_id')->references('id')->on('articles');
             $table->integer('user_id')->unsigned();
             $table->foreign('user_id')->references('id')->on('users');
+            $table->boolean('visible')->default(false);
         });
     }
 
@@ -87,6 +88,28 @@ public function testSyncReturnValueType()
         collect($changes['attached'])->map(function ($id) {
             $this->assertSame(gettype($id), (new BelongsToManySyncTestTestArticle)->getKeyType());
         });
+
+        $user->articles->each(function (BelongsToManySyncTestTestArticle $article) {
+            $this->assertSame('0', $article->pivot->visible);
+        });
+    }
+
+    public function testSyncWithPivotDefaultsReturnValueType()
+    {
+        $this->seedData();
+
+        $user = BelongsToManySyncTestTestUser::query()->first();
+        $articleIDs = BelongsToManySyncTestTestArticle::all()->pluck('id')->toArray();
+
+        $changes = $user->articles()->syncWithPivotDefaults($articleIDs, ['visible' => true]);
+
+        collect($changes['attached'])->each(function ($id) {
+            $this->assertSame(gettype($id), (new BelongsToManySyncTestTestArticle)->getKeyType());
+        });
+
+        $user->articles->each(function (BelongsToManySyncTestTestArticle $article) {
+            $this->assertSame('1', $article->pivot->visible);
+        });
     }
 
     /**
@@ -118,7 +141,7 @@ class BelongsToManySyncTestTestUser extends Eloquent
 
     public function articles()
     {
-        return $this->belongsToMany(BelongsToManySyncTestTestArticle::class, 'article_user', 'user_id', 'article_id');
+        return $this->belongsToMany(BelongsToManySyncTestTestArticle::class, 'article_user', 'user_id', 'article_id')->withPivot('visible');
     }
 }