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

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

adesr/entrust
=============

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

0.0.5(8y ago)0184MITPHPPHP >=5.5.0

Since Aug 9Pushed 8y ago1 watchersCompare

[ Source](https://github.com/adesr/entrust)[ Packagist](https://packagist.org/packages/adesr/entrust)[ RSS](/packages/adesr-entrust/feed)WikiDiscussions master Synced yesterday

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

ENTRUST (Laravel 5 Package)
===========================

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

This repo is a fork for [zizaco/entrust](https://github.com/Zizaco/entrust). It supports dynamic navigation based on role and permissions registered.

Contents
--------

[](#contents)

- [Installation](#installation)
- [Configuration](#configuration)
    - [User relation to roles](#user-relation-to-roles)
    - [Models](#models)
        - [Role](#role)
        - [Permission](#permission)
        - [Menu](#menu)
        - [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)

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

[](#installation)

1. In order to install Laravel 5 Entrust, just run following command:

```
composer require adesr/entrust
```

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

```
Adesr\Entrust\EntrustServiceProvider::class,
```

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

```
'Entrust'   => Adesr\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' => \Adesr\Entrust\Middleware\EntrustRole::class,
    'permission' => \Adesr\Entrust\Middleware\EntrustPermission::class,
    'ability' => \Adesr\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/5.4/eloquent#many-to-many) relations between roles and users
- `permission_role` — stores [many-to-many](http://laravel.com/docs/5.4/eloquent#many-to-many) relations between roles and permissions
- `menus` — stores menu records
- `menu_role` — stores [many-to-many](http://laravel.com/docs/5.4/eloquent#many-to-many) relations between menus and roles
- `menu_permission` — stores [many-to-many](http://laravel.com/docs/5.4/eloquent#many-to-many) relations between menus and permissions

### Models

[](#models)

RUn following command:

```
php artisan entrust:models
```

It will generate 3 model files inside `app` directory:

- `Role`
- `Permission`
- `Menu`

or, you can create your own model:

#### Role

[](#role)

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

```