PHPackages                             zizaco/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. zizaco/entrust

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

zizaco/entrust
==============

This package provides a flexible way to add Role-based Permissions to Laravel. Supports laravel 5|6|7|8

1.9.1(8y ago)6.0k5.3M—9.1%1.3k[269 issues](https://github.com/Zizaco/entrust/issues)[52 PRs](https://github.com/Zizaco/entrust/pulls)20MITPHPPHP >=5.5.0CI passing

Since Feb 7Pushed 1y ago251 watchersCompare

[ Source](https://github.com/Zizaco/entrust)[ Packagist](https://packagist.org/packages/zizaco/entrust)[ RSS](/packages/zizaco-entrust/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (7)Versions (33)Used By (20)

ENTRUST (Laravel 9|10 Package)
==============================

[](#entrust-laravel-910-package)

Forked from [zizaco/entrust](https://github.com/Zizaco/entrust)

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

If you are using an older version of laravel, use version ~3.0

Contents
--------

[](#contents)

- [ENTRUST (Laravel 9|10 Package)](#entrust-laravel-910-package)
    - [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)

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

[](#installation)

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

```
"zizaco/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:

```