Download the PHP package aaronrichards/laravel-roles without Composer

Composer

From your projects root folder in terminal run:

Laravel 5.8 and up use:

Publish All Assets

HasRoleAndPermission Trait And Contract

1. Include HasRoleAndPermission trait and also implement HasRoleAndPermission contract inside your User model. See example below.

2. Include use aaronrichards\LaravelRoles\Traits\HasRoleAndPermission; in the top of your User model below the namespace and implement the HasRoleAndPermission trait. See example below.

Example User model Trait And Contract:

Migrations and seeds

This uses the default users table which is in Laravel. You should already have the migration file for the users table available and migrated.

1. Setup the needed tables:

   php artisan migrate

2. Update database\seeds\DatabaseSeeder.php to include the seeds. See example below.

3. Seed an initial set of Permissions, Roles, and Users with roles.

Usage

Creating Roles

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.

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.

Assign a user role to new registered users

You can assign the user a role upon the users registration by updating the file app\Http\Controllers\Auth\RegisterController.php. You can assign a role to a user upon registration by including the needed models and modifying the create() method to attach a user role. See example below:

• Updated create() method of app\Http\Controllers\Auth\RegisterController.php:

Checking For Roles

You can now check if the user has required role.

You can also do this:

And of course, there is a way to check for multiple 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:

If user has multiple roles, method level returns the highest one.

Level has also big effect on inheriting permissions. About it later.

Creating Permissions

It's very simple thanks to Permission model called from config('roles.models.permission').

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).

Checking For Permissions

You can check for multiple permissions the same way as roles. You can make use of additional methods like hasOnePermission or hasAllPermissions.

Permissions Inheriting

Role with higher level is inheriting permission from roles with lower level.

There is an example of this magic:

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.

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

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).

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.

Blade Extensions

There are four Blade extensions. Basically, it is replacement for classic if statements.

Middleware

This package comes with VerifyRole, VerifyPermission and VerifyLevel middleware. The middleware aliases are already registered in \aaronrichards\LaravelRoles\RolesServiceProvider as of 1.7. You can optionally add them inside your app/Http/Kernel.php file with your own aliases like outlined below:

Now you can easily protect your routes.

It throws \aaronrichards\LaravelRoles\App\Exceptions\RoleDeniedException, \aaronrichards\LaravelRoles\App\Exceptions\PermissionDeniedException or \aaronrichards\LaravelRoles\App\Exceptions\LevelDeniedException exceptions if it goes wrong.

You can catch these exceptions inside app/Exceptions/Handler.php file and do whatever you want.

Configuration

• You can change connection for models, slug separator, models path and there is also a handy pretend feature.
• There are many configurable options which have been extended to be able to configured via .env file variables.
• Editing the configuration file directly may not needed becuase of this.
• See config file: roles.php.

Environment File

More Information

For more information, please have a look at HasRoleAndPermission contract.

Optional GUI Routes

Credit Note:

The romanbican/roles. I liked the method he made so I used them.

License

This package is free software distributed under the terms of the MIT license. Enjoy!