Manage Many-to-Many Relationships with Pivot Data in Eloquent

// In App\Models\Role.php (e.g., User has many Roles, Role has many Users)
class Role extends Model
{
    public function users()
    {
        return $this->belongsToMany(User::class)->withTimestamps()->withPivot('status', 'notes');
    }
}

// In App\Models\User.php
class User extends Model
{
    public function roles()
    {
        return $this->belongsToMany(Role::class)->withTimestamps()->withPivot('status', 'notes');
    }
}

// Attaching a role to a user with pivot data
$user = App\Models\User::find(1);
$roleId = 2;
$user->roles()->attach($roleId, ['status' => 'active', 'notes' => 'Initial assignment']);

// Detaching a role
$user->roles()->detach($roleId);

// Syncing roles (adds/removes to match provided array)
$user->roles()->sync([1, 3 => ['status' => 'pending']]); // Role 3 gets specific pivot data

// Syncing without detaching others
$user->roles()->syncWithoutDetaching([4]);

// Accessing pivot data
foreach ($user->roles as $role) {
    echo $role->name . ' - Status: ' . $role->pivot->status . '
';
}

// Using a custom pivot model
// In App\Models\UserRole.php (pivot model)
class UserRole extends Pivot
{
    protected $table = 'role_user'; // If not convention-based
}

// In App\Models\User.php
public function roles()
{
    return $this->belongsToMany(Role::class)->using(UserRole::class)->withPivot('status', 'notes');
}