Using Spatie's Laravel 11 Permissions package

Using Spatie's Laravel Permissions package, you can manage user roles and permissions efficiently in a Laravel 11 application. Here's a step-by-step guide to integrate and use Spatie's Permissions package.

Step 1: Install Laravel

First, make sure you have Laravel installed. If not, you can create a new Laravel project:

composer create-project --prefer-dist laravel/laravel laravel11-app
cd laravel11-app

Step 2: Install Spatie Laravel Permissions

Next, install the Spatie Permissions package via Composer:

composer require spatie/laravel-permission

Step 3: Publish the Configuration File

Publish the configuration file to customize the package settings:

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider"

This command will create a configuration file config/permission.php.

Step 4: Run the Migration

Run the migration to create the necessary tables in your database:

php artisan migrate

Step 5: Add the Trait to Your User Model

Add the HasRoles trait to your User model so you can assign roles and permissions:

// app/Models/User.php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable
{
    use HasRoles;

    // Your other model methods and properties...
}

Step 6: Create Roles and Permissions

You can create roles and permissions using Artisan commands, seeder files, or directly in your application code.

Using Artisan Commands

php artisan tinker

Inside Tinker:

use Spatie\Permission\Models\Role;
use Spatie\Permission\Models\Permission;

$role = Role::create(['name' => 'admin']);
$permission = Permission::create(['name' => 'edit articles']);

$role->givePermissionTo($permission);
$permission->assignRole($role);

Using Seeder Files

Create a seeder file:

php artisan make:seeder RolesAndPermissionsSeeder

Edit the seeder file to include roles and permissions:

// database/seeders/RolesAndPermissionsSeeder.php

namespace Database\Seeders;

use Illuminate\Database\Seeder;
use Spatie\Permission\Models\Role;
use Spatie\Permission\Models\Permission;

class RolesAndPermissionsSeeder extends Seeder
{
    public function run()
    {
        // Reset cached roles and permissions
        app()[\Spatie\Permission\PermissionRegistrar::class]->forgetCachedPermissions();

        // Create permissions
        Permission::create(['name' => 'edit articles']);
        Permission::create(['name' => 'delete articles']);
        Permission::create(['name' => 'publish articles']);
        Permission::create(['name' => 'unpublish articles']);

        // Create roles and assign existing permissions
        $role = Role::create(['name' => 'writer']);
        $role->givePermissionTo('edit articles');

        $role = Role::create(['name' => 'admin']);
        $role->givePermissionTo(['edit articles', 'delete articles', 'publish articles', 'unpublish articles']);
    }
}

Run the seeder:

php artisan db:seed --class=RolesAndPermissionsSeeder

Step 7: Assign Roles and Permissions to Users

You can assign roles and permissions to users in your application code:

use App\Models\User;
use Spatie\Permission\Models\Role;
use Spatie\Permission\Models\Permission;

// Assign a role to a user
$user = User::find(1);
$user->assignRole('admin');

// Remove a role from a user
$user->removeRole('admin');

// Check if a user has a role
$user->hasRole('admin'); // returns true or false

// Assign a permission to a user
$user->givePermissionTo('edit articles');

// Remove a permission from a user
$user->revokePermissionTo('edit articles');

// Check if a user has a permission
$user->can('edit articles'); // returns true or false

Step 8: Middleware for Role and Permission

You can use middleware to restrict access to routes based on roles or permissions.

Define Middleware in Routes

// routes/web.php

use Illuminate\Support\Facades\Route;

Route::group(['middleware' => ['role:admin']], function () {
    Route::get('/admin', function () {
        return 'Welcome, Admin!';
    });
});

Route::group(['middleware' => ['permission:edit articles']], function () {
    Route::get('/edit-articles', function () {
        return 'You can edit articles!';
    });
});

Step 9: Blade Directives

Spatie's package provides Blade directives to check for roles and permissions in your views.

Check Roles

blade
@role('admin')
    <p>This is visible to users with the admin role.</p>
@endrole

Check Permissions

@can('edit articles')
    <p>This is visible to users with the permission to edit articles.</p>
@endcan

Conclusion

By following these steps, you can integrate and manage user roles and permissions in your Laravel 11 application using Spatie's Laravel Permissions package. This setup will help you build a robust and scalable authorization system tailored to your application's needs. For more details and advanced usage, refer to the official Spatie documentation.