Managing Many-to-Many Relationships with Custom Pivot Models

// app/Models/RoleUser.php
namespace App\Models;

use Illuminate\Database\Eloquent\Relations\Pivot;

class RoleUser extends Pivot
{
    protected $table = 'role_user'; // Explicitly define pivot table name

    // Add custom methods or attributes for the pivot table
    public function isActive()
    {
        return (bool) $this->is_active;
    }
}

// app/Models/User.php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasFactory;

    public function roles()
    {
        return $this->belongsToMany(Role::class)
                    ->using(RoleUser::class) // Specify the custom pivot model
                    ->withPivot('is_active', 'assigned_date'); // Include additional pivot columns
    }
}

// app/Models/Role.php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;

class Role extends Model
{
    use HasFactory;

    public function users()
    {
        return $this->belongsToMany(User::class)
                    ->using(RoleUser::class)
                    ->withPivot('is_active', 'assigned_date');
    }
}

// Usage example in a controller or route
$user = App\Models\User::find(1);

// Attach a role with pivot data
$user->roles()->attach(2, ['is_active' => true, 'assigned_date' => now()]);

// Accessing pivot data with custom pivot model
foreach ($user->roles as $role) {
    if ($role->pivot->isActive()) { // Call method on custom pivot model
        echo "User has active role: " . $role->name . "
";
    }
}

// Direct access to the pivot model instance
$pivot = $user->roles()->where('role_id', 2)->first()->pivot;
echo $pivot->assigned_date;