sehrgut/laravel-object-roles

Roles & Permissions for Laravel where roles can be held in regard to a database object

Laravel Object Roles

Roles & Permissions for Laravel where roles can be held in regard to a database object, _(*1)

Table of Contents

• Why?
• Disclaimer
• Getting Started
• Documentation
  • Create Roles & Permissions
  • Assign Permissions to Roles
  • Assign Roles to Users
  • Check Permissions
• License

Why?

There are plenty of packages that add ACL functionalities to a Laravel application. Yet, none of the existing solutions seems to allow us to assign roles to users with respect to an object. We often come across a use case where we do not only need to define global roles, such as TECH_ADMIN, but also roles in regard to a database object, such as an Organisation, which has eg. EDITOR users that are granted certain permissions only on that specific Organisation and not on others., _(*2)

Disclaimer

This package is in its very early days. It currently makes quite a few assumptions:, _(*3)

1. Users are stored in a users table
2. The users table already exists when installing the package and running the migrations
3. The users table has a primary key id which is an unsigned integer
4. Neither of the following tables exists before installing the package:
   • roles
   • permissions
   • permission_role
   • role_user

Getting Started

1. Install Package

composer require sehrgut/laravel-object-roles

2. Run database migrations

php artisan migrate

3. Use HasRolesAndPermissions trait on the `User model

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use SehrGut\LaravelObjectRoles\HasRolesAndPermissions;
use SehrGut\LaravelObjectRoles\Models\Permission;

class User extends Model
{
    use HasRolesAndPermissions;
}

Documentation

Create Roles & Permissions

$permission = SehrGut\LaravelObjectRoles\Models\Permission::create([
    'name' => 'posts.update',
    'description' => 'The ability to update existing Post objects',
]);
$role = SehrGut\LaravelObjectRoles\Models\Role::create([
    'name' => 'EDITOR',
    'description' => 'A User who can manage content',
]);

Assign Permissions to Roles

$role->attachPermission('posts.update');
// or:
$role->attachPermission($permission);

Assign Roles to Users

$user->assignGlobalRole('EDITOR');
$user->assignObjectRole('EDITOR', $organisation);

Check Permissions

$user->hasGlobalPermission('posts.update')
$user->hasPermissionThrough('show_statistics', $organisation)

License

This project is released under the MIT License., _(*4)