PHPackages                             bluehorndigital/entrust - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. bluehorndigital/entrust

ActiveLibrary[Authentication & Authorization](/categories/authentication)

bluehorndigital/entrust
=======================

This package provides a flexible way to add Role-based Permissions to Laravel

6.0.0(5y ago)011.3kMITPHPPHP >=7.1

Since Feb 7Pushed 6mo agoCompare

[ Source](https://github.com/bluehorndigital/entrust)[ Packagist](https://packagist.org/packages/bluehorndigital/entrust)[ RSS](/packages/bluehorndigital-entrust/feed)WikiDiscussions main Synced 6d ago

READMEChangelog (2)Dependencies (6)Versions (29)Used By (0)

ENTRUST
=======

[](#entrust)

[![Version](https://camo.githubusercontent.com/262ad0729e992e53560f8a5e2e86b2119b2c059779a12d869075acdf0e503005/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f626c7565686f726e6469676974616c2f656e74727573742e737667)](https://packagist.org/packages/bluehorndigital/entrust)[![License](https://camo.githubusercontent.com/cb9da3d9cc1163b902eabb6085345b0b01367d67709efbeca56aa87fa3f06d51/68747470733a2f2f706f7365722e707567782e6f72672f626c7565686f726e6469676974616c2f656e74727573742f6c6963656e73652e737667)](https://packagist.org/packages/bluehorndigital/entrust)[![Total Downloads](https://camo.githubusercontent.com/fb27e7ab3df042d0ebb408e7e0c7af54e16185c4c9f7a25d3a98407f0463df13/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f626c7565686f726e6469676974616c2f656e74727573742e737667)](https://packagist.org/packages/bluehorndigital/entrust)

Entrust is a succinct and flexible way to add Role-based Permissions to **Laravel**.

This is a fork maintained by [Bluehorn Digital](https://bluehorn.digital) to support **Laravel 6** and above.

Contents
--------

[](#contents)

- [Installation](#installation)
- [Configuration](#configuration)
    - [User relation to roles](#user-relation-to-roles)
    - [Models](#models)
        - [Role](#role)
        - [Permission](#permission)
        - [User](#user)
        - [Soft Deleting](#soft-deleting)
- [Usage](#usage)
    - [Concepts](#concepts)
        - [Checking for Roles & Permissions](#checking-for-roles--permissions)
        - [User ability](#user-ability)
    - [Blade templates](#blade-templates)
    - [Middleware](#middleware)
    - [Short syntax route filter](#short-syntax-route-filter)
    - [Route filter](#route-filter)
- [Troubleshooting](#troubleshooting)
- [License](#license)
- [Contribution guidelines](#contribution-guidelines)
- [Additional information](#additional-information)

Installation
------------

[](#installation)

1. In order to install Laravel 5 Entrust, just add the following to your composer.json. Then run `composer update`:

```
"bluehorndigital/entrust": "5.2.x-dev"
```

2. Open your `config/app.php` and add the following to the `providers` array:

```
Zizaco\Entrust\EntrustServiceProvider::class,
```

3. In the same `config/app.php` and add the following to the `aliases ` array:

```
'Entrust'   => Zizaco\Entrust\EntrustFacade::class,
```

4. Run the command below to publish the package config file `config/entrust.php`:

```
php artisan vendor:publish
```

5. Open your `config/auth.php` and add the following to it:

```
'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => Namespace\Of\Your\User\Model\User::class,
        'table' => 'users',
    ],
],
```

6. If you want to use [Middleware](#middleware) (requires Laravel 5.1 or later) you also need to add the following:

```
    'role' => \Zizaco\Entrust\Middleware\EntrustRole::class,
    'permission' => \Zizaco\Entrust\Middleware\EntrustPermission::class,
    'ability' => \Zizaco\Entrust\Middleware\EntrustAbility::class,
```

to `routeMiddleware` array in `app/Http/Kernel.php`.

Configuration
-------------

[](#configuration)

Set the property values in the `config/auth.php`. These values will be used by entrust to refer to the correct user table and model.

To further customize table names and model namespaces, edit the `config/entrust.php`.

### User relation to roles

[](#user-relation-to-roles)

Now generate the Entrust migration:

```
php artisan entrust:migration
```

It will generate the `_entrust_setup_tables.php` migration. You may now run it with the artisan migrate command:

```
php artisan migrate
```

After the migration, four new tables will be present:

- `roles` — stores role records
- `permissions` — stores permission records
- `role_user` — stores [many-to-many](http://laravel.com/docs/4.2/eloquent#many-to-many) relations between roles and users
- `permission_role` — stores [many-to-many](http://laravel.com/docs/4.2/eloquent#many-to-many) relations between roles and permissions

### Models

[](#models)

#### Role

[](#role)

Create a Role model inside `app/models/Role.php` using the following example:

```