README

Laravel Role Lite

A lightweight role management package for Laravel applications.

Laravel Role Lite is a lightweight package for managing user roles in Laravel applications. It provides a simple and intuitive API for defining roles, assigning them to users throughout your application with minimal configuration.

Prerequisites

Laravel v10, v11 and v12
PHP 8.3 or higher

Installation

composer require oltrematica/laravel-role-lite

After installing the package, publish migrations:

php artisan vendor:publish --tag=oltrematica-role-lite-migrations

Run the migrations to create the necessary database tables:

php artisan migrate

Configuration

The package comes with a default configuration file that you can modify according to your needs. The configuration file is located at config/oltrematica-role-lite.php. Maybe you can be satisfied with the default configuration, but if you want to change it, you can publish the configuration file using the following command:

php artisan vendor:publish --tag=oltrematica-role-lite-config

Table Names

You can customize the table names used by the package:

'table_names' => [
    // Table for storing roles
    'roles' => 'roles',
    
    // Your users table (usually 'users')
    'users' => 'users',
    
    // Pivot table for role-user relationship
    'role_user' => 'role_user',
],

Model Names

You can specify a custom User model:

'model_names' => [
    // If you want to use a custom user model, specify it here
    // Otherwise, it will use the model defined in auth.providers.users.model
    'user' => null,
],

Usage

I suggest you to use Enum for roles, but you can use string too.

enum Roles: string
{
    case ADMIN = 'admin';
    case EDITOR = 'editor';
    case MODERATOR = 'moderator';
}

Assigning Roles

// Assign a role to a user
$user->assignRole('admin');

// or you can use Enum 
$user->assignRole(\App\Enums\Roles::ADMIN);

Assign multiple roles

$user->assignRoles(['editor', 'moderator']);

Checking Roles

Check if a user has a specific role:

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

// or

if ($user->hasRole(\App\Enums\Roles::ADMIN)) {
    // User has admin role
}

Check if a user has any of the given roles

if ($user->hasAnyRole(['admin', 'editor'])) {
    // User has either admin or editor role
}

// or

if ($user->hasAnyRole([Roles::ADMIN, Roles::EDITOR])) {
    // User has either admin or editor role
}

Check if a user has all the given roles

if ($user->hasAllRoles(['admin', 'editor'])) {
    // User has both admin and editor roles
}

// or

if ($user->hasAllRoles([Roles::ADMIN, Roles::EDITOR])) {
    // User has both admin and editor roles
}

Events

The package fires events when roles are assigned or removed from users. You can listen to these events in your application to perform additional actions.

UserRoleCreated: Fired when a role is assigned to a user.
UserRoleDeleted: Fired when a role is removed from a user.
UserRoleUpdated: Fired when a role is updated for a user.

Code Quality

The project includes automated tests and tools for code quality control.

Rector

Rector is a tool for automating code refactoring and migrations. It can be run using the following command:

composer refactor

PhpStan

PhpStan is a tool for static analysis of PHP code. It can be run using the following command:

composer analyse

Pint

Pint is a tool for formatting PHP code. It can be run using the following command:

composer format

Automated Tests