ultraware/roles

Powerful package for handling roles and permissions in Laravel 5.

Thursday, March 22, 2018
by Ricky-rick
Repository
9 Watchers
93 Stars
58,050 Installations

PHP
3 Dependents
0 Suggesters
305 Forks
0 Open issues
45 Versions
14 % Grown

The README.md

, _(*1)

Abandoned

The Roles and permissions for laraval 5 package is abandoned and will no longer be maintained by Ultraware. Feel free to fork the project and submit it to packagist. We can share the url to your package on this page if you send us a message., _(*2)

Roles And Permissions For Laravel 5

Powerful package for handling roles and permissions in Laravel 5., _(*3)

Installation
Usage
Config File
More Information
License

Installation

This package is very easy to set up. There are only couple of steps., _(*4)

Composer

Pull this package in through Composer, _(*5)

composer require ultraware/roles

If you are still using Laravel 5.0, you must pull in version 1.7.*., _(*6)

Service Provider

Add the package to your application service providers in config/app.php file., _(*7)

'providers' => [

    ...

    /**
     * Third Party Service Providers...
     */
    Ultraware\Roles\RolesServiceProvider::class,

],

Config File And Migrations

Publish the package config file and migrations to your application. Run these commands inside your terminal., _(*8)

php artisan vendor:publish --provider="Ultraware\Roles\RolesServiceProvider" --tag=config
php artisan vendor:publish --provider="Ultraware\Roles\RolesServiceProvider" --tag=migrations

And also run migrations., _(*9)

php artisan migrate

This uses the default users table which is in Laravel. You should already have the migration file for the users table available and migrated., _(*10)

HasRoleAndPermission Trait And Contract

Include HasRoleAndPermission trait and also implement HasRoleAndPermission contract inside your User model., _(*11)

Migrate from bican roles

If you migrate from bican/roles to ultraware/roles yoe need to update a few things. - Change all calls to can, canOne and canAll to hasPermission, hasOnePermission, hasAllPermissions. - Change all calls to is, isOne and isAll to hasRole, hasOneRole, hasAllRoles., _(*12)

Usage

Creating Roles

use Ultraware\Roles\Models\Role;

$adminRole = Role::create([
    'name' => 'Admin',
    'slug' => 'admin',
    'description' => '', // optional
    'level' => 1, // optional, set to 1 by default
]);

$moderatorRole = Role::create([
    'name' => 'Forum Moderator',
    'slug' => 'forum.moderator',
]);

Because of Slugable trait, if you make a mistake and for example leave a space in slug parameter, it'll be replaced with a dot automatically, because of str_slug function., _(*13)

Attaching, Detaching and Syncing Roles

It's really simple. You fetch a user from database and call attachRole method. There is BelongsToMany relationship between User and Role model., _(*14)

use App\User;

$user = User::find($id);

$user->attachRole($adminRole); // you can pass whole object, or just an id
$user->detachRole($adminRole); // in case you want to detach role
$user->detachAllRoles(); // in case you want to detach all roles
$user->syncRoles($roles); // you can pass Eloquent collection, or just an array of ids

Checking For Roles

You can now check if the user has required role., _(*15)

if ($user->hasRole('admin')) { // you can pass an id or slug
    //
}

You can also do this:, _(*16)

if ($user->isAdmin()) {
    //
}

And of course, there is a way to check for multiple roles:, _(*17)

if ($user->hasRole(['admin', 'moderator'])) { 
    /*
    | Or alternatively:
    | $user->hasRole('admin, moderator'), $user->hasRole('admin|moderator'),
    | $user->hasOneRole('admin, moderator'), $user->hasOneRole(['admin', 'moderator']), $user->hasOneRole('admin|moderator')
    */

    // The user has at least one of the roles
}

if ($user->hasRole(['admin', 'moderator'], true)) {
    /*
    | Or alternatively:
    | $user->hasRole('admin, moderator', true), $user->hasRole('admin|moderator', true),
    | $user->hasAllRoles('admin, moderator'), $user->hasAllRoles(['admin', 'moderator']), $user->hasAllRoles('admin|moderator')
    */

    // The user has all roles
}

Levels

When you are creating roles, there is optional parameter level. It is set to 1 by default, but you can overwrite it and then you can do something like this:, _(*18)

if ($user->level() > 4) {
    //
}

If user has multiple roles, method level returns the highest one., _(*19)

Level has also big effect on inheriting permissions. About it later., _(*20)

Creating Permissions

It's very simple thanks to Permission model., _(*21)

use Ultraware\Roles\Models\Permission;

$createUsersPermission = Permission::create([
    'name' => 'Create users',
    'slug' => 'create.users',
    'description' => '', // optional
]);

$deleteUsersPermission = Permission::create([
    'name' => 'Delete users',
    'slug' => 'delete.users',
]);

Attaching, Detaching and Syncing Permissions

You can attach permissions to a role or directly to a specific user (and of course detach them as well)., _(*22)

use App\User;
use Ultraware\Roles\Models\Role;

$role = Role::find($roleId);
$role->attachPermission($createUsersPermission); // permission attached to a role

$user = User::find($userId);
$user->attachPermission($deleteUsersPermission); // permission attached to a user

$role->detachPermission($createUsersPermission); // in case you want to detach permission
$role->detachAllPermissions(); // in case you want to detach all permissions
$role->syncPermissions($permissions); // you can pass Eloquent collection, or just an array of ids

$user->detachPermission($deleteUsersPermission);
$user->detachAllPermissions();
$user->syncPermissions($permissions); // you can pass Eloquent collection, or just an array of ids

Checking For Permissions

if ($user->hasPermission('create.users')) { // you can pass an id or slug
    //
}

if ($user->canDeleteUsers()) {
    //
}

You can check for multiple permissions the same way as roles. You can make use of additional methods like hasOnePermission or hasAllPermissions., _(*23)

Permissions Inheriting

Role with higher level is inheriting permission from roles with lower level., _(*24)

There is an example of this magic:, _(*25)

You have three roles: user, moderator and admin. User has a permission to read articles, moderator can manage comments and admin can create articles. User has a level 1, moderator level 2 and admin level 3. It means, moderator and administrator has also permission to read articles, but administrator can manage comments as well., _(*26)

If you don't want permissions inheriting feature in you application, simply ignore level parameter when you're creating roles., _(*27)

Entity Check

Let's say you have an article and you want to edit it. This article belongs to a user (there is a column user_id in articles table)., _(*28)

use App\Article;
use Ultraware\Roles\Models\Permission;

$editArticlesPermission = Permission::create([
    'name' => 'Edit articles',
    'slug' => 'edit.articles',
    'model' => 'App\Article',
]);

$user->attachPermission($editArticlesPermission);

$article = Article::find(1);

if ($user->allowed('edit.articles', $article)) { // $user->allowedEditArticles($article)
    //
}

This condition checks if the current user is the owner of article. If not, it will be looking inside user permissions for a row we created before., _(*29)

if ($user->allowed('edit.articles', $article, false)) { // now owner check is disabled
    //
}

Blade Extensions

There are four Blade extensions. Basically, it is replacement for classic if statements., _(*30)

@role('admin') // @if(Auth::check() && Auth::user()->hasRole('admin'))
    // user has admin role
@endrole

@permission('edit.articles') // @if(Auth::check() && Auth::user()->hasPermission('edit.articles'))
    // user has edit articles permissison
@endpermission

@level(2) // @if(Auth::check() && Auth::user()->level() >= 2)
    // user has level 2 or higher
@endlevel

@allowed('edit', $article) // @if(Auth::check() && Auth::user()->allowed('edit', $article))
    // show edit button
@endallowed

@role('admin|moderator', true) // @if(Auth::check() && Auth::user()->hasRole('admin|moderator', true))
    // user has admin and moderator role
@else
    // something else
@endrole

Middleware

This package comes with VerifyRole, VerifyPermission and VerifyLevel middleware. You must add them inside your app/Http/Kernel.php file., _(*31)

/**
 * The application's route middleware.
 *
 * @var array
 */
protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'role' => \Ultraware\Roles\Middleware\VerifyRole::class,
    'permission' => \Ultraware\Roles\Middleware\VerifyPermission::class,
    'level' => \Ultraware\Roles\Middleware\VerifyLevel::class,
];

Now you can easily protect your routes., _(*32)

$router->get('/example', [
    'as' => 'example',
    'middleware' => 'role:admin',
    'uses' => 'ExampleController@index',
]);

$router->post('/example', [
    'as' => 'example',
    'middleware' => 'permission:edit.articles',
    'uses' => 'ExampleController@index',
]);

$router->get('/example', [
    'as' => 'example',
    'middleware' => 'level:2', // level >= 2
    'uses' => 'ExampleController@index',
]);

It throws \Ultraware\Roles\Exceptions\RoleDeniedException, \Ultraware\Roles\Exceptions\PermissionDeniedException or \Ultraware\Roles\Exceptions\LevelDeniedException exceptions if it goes wrong., _(*33)

You can catch these exceptions inside app/Exceptions/Handler.php file and do whatever you want., _(*34)

/**
 * Render an exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $e
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $e)
{
    if ($e instanceof \Ultraware\Roles\Exceptions\RoleDeniedException) {
        // you can for example flash message, redirect...
        return redirect()->back();
    }

    return parent::render($request, $e);
}

Config File

You can change connection for models, slug separator, models path and there is also a handy pretend feature. Have a look at config file for more information., _(*35)

More Information

For more information, please have a look at HasRoleAndPermission contract., _(*36)

License

This package is free software distributed under the terms of the MIT license., _(*37)

The Versions

22/03 2018

dev-master

9999999-dev

Powerful package for handling roles and permissions in Laravel 5.

library roles

Powerful package for handling roles and permissions in Laravel 5.

ultraware/roles

The README.md

Abandoned

Roles And Permissions For Laravel 5

Installation

Composer

Service Provider

Config File And Migrations

HasRoleAndPermission Trait And Contract

Migrate from bican roles

Usage

Creating Roles

Attaching, Detaching and Syncing Roles

Checking For Roles

Levels

Creating Permissions

Attaching, Detaching and Syncing Permissions

Checking For Permissions

Permissions Inheriting

Entity Check

Blade Extensions

Middleware

Config File

More Information

License

The Versions

dev-master

The Requires

The Development Requires

by Ultraware

5.6.x-dev

The Requires

The Development Requires

by Ultraware

5.6.1

The Requires

The Development Requires

by Ultraware

5.6.0

The Requires

The Development Requires

by Ultraware

5.5.x-dev

The Requires

The Development Requires

by Ultraware

5.5.0

The Requires

The Development Requires

by Ultraware

5.4.x-dev

The Requires

The Development Requires

by Ultraware

5.3.x-dev

The Requires

The Development Requires

by Ultraware

5.3.1

The Requires

The Development Requires

by Ultraware

5.4.0

The Requires

The Development Requires

by Ultraware

5.3.0

The Requires

The Development Requires

by Ultraware

5.2.x-dev

The Requires

The Development Requires

by Ultraware

5.2.0

The Requires

The Development Requires

by Ultraware