Laravel Permission Manager – Manage permissions easily

Laravel Permission Manager is a package that simplifies role and permission management in your Laravel application. It allows you to define roles and permissions, assign permissions to roles, and manage user access throughout your application seamlessly.

Installation

To install the package, you can use Composer:

composer require spatie/laravel-permission

1	composer require spatie/laravel-permission

Configuration

After installation, publish the configuration file and migration files:

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

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

This will create a config/permission.php configuration file, and migration files for creating the necessary tables (roles, permissions, and the pivot table).

Running Migrations

Next, run the migrations to create the required tables:

php artisan migrate

1	php artisan migrate

Usage

Setting Up Models: You need to add the HasRoles trait to your User model to enable role and permission management.

namespace App\Models;

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

class User extends Authenticatable
{
    use HasRoles;

    // Your model properties and methods...
}

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable

{

use HasRoles;

// Your model properties and methods...

}

Creating Roles and Permissions: You can create roles and permissions using the following methods:

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

// Create a new role
Role::create(['name' => 'admin']);

// Create a new permission
Permission::create(['name' => 'edit articles']);

use Spatie\Permission\Models\Role;

use Spatie\Permission\Models\Permission;

// Create a new role

Role::create(['name' => 'admin']);

// Create a new permission

Permission::create(['name' => 'edit articles']);

Assigning Permissions to Roles:

$role = Role::findByName('admin'); $permission = Permission::findByName('edit articles'); $role->givePermissionTo($permission);

1
2
3
4

$role = Role::findByName('admin');
$permission = Permission::findByName('edit articles');

$role->givePermissionTo($permission);
Assigning Roles to Users:

$user = User::find(1); $user->assignRole('admin');

1
2

$user = User::find(1);
$user->assignRole('admin');
Checking Permissions: You can check if a user has a specific role or permission:

if ($user->hasRole('admin')) { // The user is an admin } if ($user->can('edit articles')) { // The user has permission to edit articles }

1
2
3
4
5
6
7

if ($user->hasRole('admin')) {
// The user is an admin
}

if ($user->can('edit articles')) {
// The user has permission to edit articles
}

Example Output

Here’s how you can visualize roles and permissions:

Creating Roles and Permissions:

Role::create(['name' => 'editor']); Permission::create(['name' => 'publish articles']);

1
2

Role::create(['name' => 'editor']);
Permission::create(['name' => 'publish articles']);
Assigning Permissions to a Role:

$editorRole = Role::findByName('editor'); $editorRole->givePermissionTo('publish articles');

1
2

$editorRole = Role::findByName('editor');
$editorRole->givePermissionTo('publish articles');
Assigning Role to a User:

php

$user = User::find(2); $user->assignRole('editor');

1
2

$user = User::find(2);
$user->assignRole('editor');

Checking User Permissions:

php

if ($user->hasRole('editor')) {
    // User has the 'editor' role
}

if ($user->can('publish articles')) {
    // User has permission to publish articles
}

if ($user->hasRole('editor')) {

// User has the 'editor' role

}

if ($user->can('publish articles')) {

// User has permission to publish articles

}

Customizing Models

If you want to customize the names of the roles and permissions tables or change the model used for roles and permissions, you can do this in the config/permission.php file.

Conclusion

The Laravel Permission Manager package by Spatie is a powerful tool for managing user roles and permissions in Laravel applications. It provides a simple and elegant API to assign roles, permissions, and check user access, making it easy to implement role-based access control in your application.