Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpexpertsinc/laravel-rbac
A modern Role Based Authorization Control (RBAC) for Laravel 5.7+. Forked from thelfensdrfer/laravel-rbac
https://github.com/phpexpertsinc/laravel-rbac
Last synced: about 5 hours ago
JSON representation
A modern Role Based Authorization Control (RBAC) for Laravel 5.7+. Forked from thelfensdrfer/laravel-rbac
- Host: GitHub
- URL: https://github.com/phpexpertsinc/laravel-rbac
- Owner: PHPExpertsInc
- License: mit
- Created: 2018-12-13T16:38:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-26T12:31:15.000Z (over 5 years ago)
- Last Synced: 2024-04-21T15:12:52.456Z (7 months ago)
- Language: PHP
- Size: 491 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Laravel RBAC
Super simple RBAC/ACL implementation for Laravel 5. Laravel >=5.4 compatible fork of https://github.com/thelfensdrfer/laravel-rbac.
## Installation
Require this package with composer ([Packagist](https://packagist.org/packages/phpexperts/laravel-rbac)) using the following command
```
composer require phpexperts/laravel-rbac
```
or modify your `composer.json`
```
"require": {
...
"phpexperts/laravel-rbac": "^1.0"
}
```
then run `composer update`.
After installation register the ServiceProvider to the `providers` array in `config/app.php`
```php
PHPExperts\LaravelRBAC\RbacServiceProvider::class,
```
Run the migrations
```
$ php artisan migrate
```
Add RBAC middleware to your `app/Http/Kernel.php`
```php
protected $routeMiddleware = [
...
'rbac' => '\PHPExperts\LaravelRBAC\Middleware\Rbac::class'
];
```
Add Rbac trait to your `User` model
```php
use PHPExperts\LaravelRBAC\Traits\Rbac;
class User extends Authenticatable
{
use HasRoles;
...
}
```
## Usage
### Roles
#### Create role
```php
$adminRole = new Role;
$adminRole->name = 'Administrator';
$adminRole->slug = 'administrator';
$adminRole->description = 'System Administrator';
$adminRole->save();
$editorRole = new Role;
$editorRole->name = 'Editor';
$editorRole->slug = 'editor';
$editorRole->description = 'Editor';
$editorRole->save();
```
#### Assign role to user
```php
$user = User::find(1);
$user->roles()->attach($adminRole->id);
```
you can also assign multiple roles at once
```php
$user->roles()->attach([$adminRole->id, $editorRole->id]);
```
#### Revoke role from user
```php
$user->roles()->detach($adminRole->id);
```
you can also revoke multiple roles at once
```php
$user->roles()->detach([$adminRole->id, $editorRole->id]);
```
#### Sync roles
```php
$user->roles()->sync([$editorRole->id]);
```
Any role already assigned to user will be revoked if you don't pass its id to sync method.
### Permissions
#### Create permission
```php
$createUser = new Permission;
$createUser->name = 'Create user';
$createUser->slug = 'user.create';
$createUser->description = 'Permission to create user';
$createUser->save();
$updateUser = new Permission;
$updateUser->name = 'Update user';
$updateUser->slug = 'user.update';
$updateUser->description = 'Permission to update user';
$updateUser->save();
```
#### Assign permission to role
```php
$adminRole = Role::find(1);
$adminRole->permissions()->attach($createUser->id);
```
you can also assign multiple permissions at once
```php
$adminRole->permissions()->attach([$createUser->id, $updateUser->id]);
```
#### Revoke permission from role
```php
$adminRole->permissions()->detach($createUser->id);
```
you can also revoke multiple permissions at once
```php
$adminRole->permissions()->detach([$createUser->id, $updateUser->id]);
```
#### Sync permissions
```php
$adminRole->permissions()->sync([$updateUser->id]);
```
Any permission already assigned to role will be revoked if you don't pass its id to sync method.
### Check user roles/permissions
Roles and permissions can be checked on `User` instance using `hasRole` and `canDo` methods.
```php
$isAdmin = Auth::user()->hasRole('administrator'); // pass role slug as parameter
$isAdminOrEditor = Auth::user()->hasRole('administrator|editor'); // using OR operator
$canUpdateUser = Auth::user()->canDo('update.user'); // pass permission slug as parameter
$canUpdateOrCreateUser = Auth::user()->canDo('update.user|create.user'); // using OR operator
```
### Protect routes
Laravel RBAC provides middleware to protect single route and route groups. Middleware expects 2 comma separated params:
- **is** or **can** as first param - what to check (role/permission)
- role/permission slug as second param
```php
Route::get('/backend', [
'uses' => 'BackendController@index',
'middleware' => ['auth', 'rbac:is,administrator']
]);
Route::get('/backend', [
'uses' => 'BackendController@index',
'middleware' => ['auth', 'rbac:is,administrator|editor']
]);
Route::get('/dashboard', [
'uses' => 'DashboardController@index',
'middleware' => ['auth', 'rbac:can,view.dashboard']
]);
Route::get('/dashboard', [
'uses' => 'DashboardController@index',
'middleware' => ['auth', 'rbac:can,view.dashboard|view.statistics']
]);
```
### Blade directive
Laravel RBAC provides two Blade directives to check if user has role/permission assigned.
Check for role
```
@ifUserIs('administrator')
// show admin content here
@else
// sorry
@endif
@ifUserIs('administrator|editor')
// show editor content here
@else
// sorry
@endif
```
Check for permission
```
@ifUserCan('delete.user')
// show delete button
@endif
@ifUserCan('delete.user|manage.user')
// show delete button
@endif
```
## License
Laravel RBAC is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)