Managing Many-to-Many Relationships with Eloquent `attach`, `detach`, `sync`

// Assume User and Role models have a many-to-many relationship
// defined with roles() and users() methods respectively.
// The pivot table is 'role_user'.
use App\Models\User;
use App\Models\Role;

// Get a user and some roles
$user = User::find(1);
$adminRole = Role::where('name', 'Admin')->first();
$editorRole = Role::where('name', 'Editor')->first();
$viewerRole = Role::where('name', 'Viewer')->first();

if ($user && $adminRole && $editorRole && $viewerRole) {
    // 1. Attaching a role: Add a new role to the user
    $user->roles()->attach($adminRole->id);
    echo "Attached Admin role to user 1.
";

    // You can attach multiple roles at once or with pivot data
    // $user->roles()->attach([$adminRole->id, $editorRole->id]);
    // $user->roles()->attach($adminRole->id, ['expires_at' => now()->addYear()]);

    // 2. Detaching a role: Remove an existing role from the user
    $user->roles()->detach($editorRole->id);
    echo "Detached Editor role from user 1.
";

    // 3. Syncing roles: Add roles if they don't exist, remove if they're not in the array
    // This ensures only Admin and Viewer roles are associated with the user.
    // Any other roles currently associated will be detached.
    $user->roles()->sync([$adminRole->id, $viewerRole->id]);
    echo "Synced user 1 roles to Admin and Viewer.
";

    // Get the current roles for the user (after sync)
    $user->load('roles'); // Reload the relationship
    echo "User 1 roles after sync: ";
    foreach ($user->roles as $role) {
        echo $role->name . " ";
    }
    echo "
";

    // Sync with pivot data
    $user->roles()->syncWithoutDetaching([
        $adminRole->id => ['level' => 1],
        $editorRole->id => ['level' => 2, 'active' => true]
    ]);
    echo "Synced roles with pivot data.
";
}
else {
    echo "User or roles not found. Please seed your database.
";
}

// For detaching all roles from a user:
// $user->roles()->detach();

// For syncing an empty array to remove all roles:
// $user->roles()->sync([]);