[12.x] Add *OrFail transaction methods to BelongsToMany

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

@@ -63,6 +63,20 @@ public function toggle($ids, $touch = true)
         return $changes;
     }
 
+    /**
+     * Toggles a model (or models) from the parent within a transaction.
+     *
+     * @param  mixed  $ids
+     * @param  bool  $touch
+     * @return array
+     *
+     * @throws \Throwable
+     */
+    public function toggleOrFail($ids, $touch = true)
+    {
+        return $this->parent->getConnection()->transaction(fn () => $this->toggle($ids, $touch));
+    }
+
     /**
      * Sync the intermediate tables with a list of IDs without detaching.
      *
@@ -131,6 +145,33 @@ public function sync($ids, $detaching = true)
         return $changes;
     }
 
+    /**
+     * Sync the intermediate tables with a list of IDs or collection of models within a transaction.
+     *
+     * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array  $ids
+     * @param  bool  $detaching
+     * @return array{attached: array, detached: array, updated: array}
+     *
+     * @throws \Throwable
+     */
+    public function syncOrFail($ids, $detaching = true)
+    {
+        return $this->parent->getConnection()->transaction(fn () => $this->sync($ids, $detaching));
+    }
+
+    /**
+     * Sync the intermediate tables with a list of IDs without detaching within a transaction.
+     *
+     * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array  $ids
+     * @return array{attached: array, detached: array, updated: array}
+     *
+     * @throws \Throwable
+     */
+    public function syncWithoutDetachingOrFail($ids)
+    {
+        return $this->syncOrFail($ids, false);
+    }
+
     /**
      * Sync the intermediate tables with a list of IDs or collection of models with the given pivot values.
      *
@@ -281,6 +322,21 @@ public function attach($ids, array $attributes = [], $touch = true)
         }
     }
 
+    /**
+     * Attach a model to the parent within a transaction.
+     *
+     * @param  mixed  $ids
+     * @param  array  $attributes
+     * @param  bool  $touch
+     * @return void
+     *
+     * @throws \Throwable
+     */
+    public function attachOrFail($ids, array $attributes = [], $touch = true)
+    {
+        $this->parent->getConnection()->transaction(fn () => $this->attach($ids, $attributes, $touch));
+    }
+
     /**
      * Attach a model to the parent using a custom class.
      *
@@ -464,6 +520,20 @@ public function detach($ids = null, $touch = true)
         return $results;
     }
 
+    /**
+     * Detach models from the relationship within a transaction.
+     *
+     * @param  mixed  $ids
+     * @param  bool  $touch
+     * @return int
+     *
+     * @throws \Throwable
+     */
+    public function detachOrFail($ids = null, $touch = true)
+    {
+        return $this->parent->getConnection()->transaction(fn () => $this->detach($ids, $touch));
+    }
+
     /**
      * Detach models from the relationship using a custom class.
      *

tests/Database/DatabaseEloquentBelongsToManyOrFailTest.php

@@ -0,0 +1,191 @@
+<?php
+
+namespace Illuminate\Tests\Database;
+
+use Illuminate\Database\Capsule\Manager as DB;
+use Illuminate\Database\Eloquent\Model as Eloquent;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use PHPUnit\Framework\TestCase;
+
+class DatabaseEloquentBelongsToManyOrFailTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        $db = new DB;
+
+        $db->addConnection([
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+        ]);
+
+        $db->bootEloquent();
+        $db->setAsGlobal();
+
+        $this->createSchema();
+    }
+
+    public function createSchema()
+    {
+        $this->schema()->create('users', function ($table) {
+            $table->increments('id');
+            $table->string('email');
+        });
+
+        $this->schema()->create('roles', function ($table) {
+            $table->increments('id');
+            $table->string('name');
+        });
+
+        $this->schema()->create('role_user', function ($table) {
+            $table->integer('user_id')->unsigned();
+            $table->integer('role_id')->unsigned();
+            $table->boolean('active')->default(false);
+        });
+    }
+
+    protected function tearDown(): void
+    {
+        $this->schema()->drop('users');
+        $this->schema()->drop('roles');
+        $this->schema()->drop('role_user');
+    }
+
+    protected function seedData()
+    {
+        OrFailUser::create(['id' => 1, 'email' => 'taylor@laravel.com']);
+        OrFailRole::insert([
+            ['id' => 1, 'name' => 'Admin'],
+            ['id' => 2, 'name' => 'Editor'],
+            ['id' => 3, 'name' => 'Viewer'],
+        ]);
+    }
+
+    public function testSyncOrFail()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+
+        $result = $user->roles()->syncOrFail([1, 2]);
+
+        $this->assertEquals([1, 2], $result['attached']);
+        $this->assertEmpty($result['detached']);
+        $this->assertEmpty($result['updated']);
+        $this->assertCount(2, $user->roles);
+    }
+
+    public function testSyncWithoutDetachingOrFail()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+        $user->roles()->attach([1]);
+
+        $result = $user->roles()->syncWithoutDetachingOrFail([2, 3]);
+
+        $this->assertEquals([2, 3], $result['attached']);
+        $this->assertEmpty($result['detached']);
+        $this->assertCount(3, $user->roles()->get());
+    }
+
+    public function testAttachOrFail()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+
+        $user->roles()->attachOrFail(1);
+
+        $this->assertCount(1, $user->roles);
+    }
+
+    public function testAttachOrFailWithAttributes()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+        $user->roles()->attachOrFail(1, ['active' => true]);
+
+        $pivot = DB::table('role_user')->where('user_id', 1)->where('role_id', 1)->first();
+        $this->assertEquals(1, $pivot->active);
+    }
+
+    public function testDetachOrFail()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+        $user->roles()->attach([1, 2, 3]);
+
+        $result = $user->roles()->detachOrFail([1, 2]);
+
+        $this->assertEquals(2, $result);
+        $this->assertCount(1, $user->roles()->get());
+    }
+
+    public function testDetachOrFailAll()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+        $user->roles()->attach([1, 2, 3]);
+
+        $result = $user->roles()->detachOrFail();
+
+        $this->assertEquals(3, $result);
+        $this->assertCount(0, $user->roles()->get());
+    }
+
+    public function testToggleOrFail()
+    {
+        $this->seedData();
+
+        $user = OrFailUser::find(1);
+        $user->roles()->attach([1]);
+
+        $result = $user->roles()->toggleOrFail([1, 2]);
+
+        $this->assertEquals([1], $result['detached']);
+        $this->assertEquals([2], $result['attached']);
+        $this->assertCount(1, $user->roles()->get());
+    }
+
+    /**
+     * Get a database connection instance.
+     *
+     * @return \Illuminate\Database\Connection
+     */
+    protected function connection()
+    {
+        return Eloquent::getConnectionResolver()->connection();
+    }
+
+    /**
+     * Get a schema builder instance.
+     *
+     * @return \Illuminate\Database\Schema\Builder
+     */
+    protected function schema()
+    {
+        return $this->connection()->getSchemaBuilder();
+    }
+}
+
+class OrFailUser extends Eloquent
+{
+    protected $table = 'users';
+    protected $guarded = [];
+    public $timestamps = false;
+
+    public function roles(): BelongsToMany
+    {
+        return $this->belongsToMany(OrFailRole::class, 'role_user', 'user_id', 'role_id');
+    }
+}
+
+class OrFailRole extends Eloquent
+{
+    protected $table = 'roles';
+    protected $guarded = [];
+    public $timestamps = false;
+}