PHPackages                             whitesunrise/guardian - 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. whitesunrise/guardian

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

whitesunrise/guardian
=====================

Multi- for Laravel 5.3+

07PHP

Since Jun 21Pushed 9y ago2 watchersCompare

[ Source](https://github.com/whitesunrise/guardian)[ Packagist](https://packagist.org/packages/whitesunrise/guardian)[ RSS](/packages/whitesunrise-guardian/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Guardian - Multi-Auth with roles and permissions built right in
===============================================================

[](#guardian---multi-auth-with-roles-and-permissions-built-right-in)

> This is a private composer repository for [White Sunrise, LLC](http://www.whitesunrise.com/) software and web development.

> **This package is sti under open development and should not be used in production**

This package allows a quick and tested way to setup a multi-auth user validation and authentication system, with custom middleware, guards, migrations, and seeders for testing. This package has only been tested in Laravel 5.3 and 5.4. See below for installation instructions and other information.

#### About White Sunrise LLC

[](#about-white-sunrise-llc)

White Sunrise has been creating great websites and cloud-based software since 2008. We are known for innovative and leading-edge development to create custom solutions for our clients

Find out more about us [here](http://www.whitesunrise.com/why-us/about-us/).

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

[](#installation)

This package can be easily installed as a private composer package. See below for details and docs.

### Laravel 5.4

[](#laravel-54)

1. Create a folder named `packages` in your Laravel project directory, and clone the repository into that folder:

```
cd
mkdir packages && cd packages
git clone git@github.com:whitesunrise/guardian.git
```

2. Add the cloned repository to your project's composer.json file in the `autoload` section like so:

```
"autoload": {
    "classmap": [
        "database"
    ],
    "psr-4": {
        "App\\": "app/",
        "WhiteSunrise\\Guardian\\": "packages/whitesunri/whitesunri/src/"
    }
},
```

3. Clear composer and artisan autoload from your project root:

```
composer dumpautoload && php artisan clear-compiled
```

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

```
WhiteSunrise\Guardian\GuardianServiceProvider::class,
```

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

```
'Guardian' =>  WhiteSunrise\Guardian\Facades\GuardianFacade::class,
```

6. Publish the package configuration file to **config/guardian.php**:

```
php artisan vendor:publish --provider="WhiteSunrise\Guardian\GuardianServiceProvider" --tag=config
```

7. Open your `config/auth.php` and make the following 3 changes for the Admin User class:

    1. In the `providers` array:

        ```
        'providers' => [
            'users' => [
                'driver' => 'eloquent',
                'model' => App\Models\User::class,
            ],
            'admins' => [
                'driver' => 'eloquent',
                'model' => App\Models\AdminUser::class,
            ],
        ],
        ```
    2. In the `guards` array:

        ```
        'guards' => [
            'web' => [
                'driver' => 'session',
                'provider' => 'users',
            ],
            'web_admin' => [
                'driver' => 'session',
                'provider' => 'admins',
            ],

            'api' => [
                'driver' => 'token',
                'provider' => 'users',
            ],
        ],
        ```
    3. In the `passwords` array:

        ```
        'passwords' => [
            'users' => [
                'provider' => 'users',
                'table' => 'password_resets',
                'expire' => 60,
            ],
            'admins' => [
                'provider' => 'admins',
                'table' => 'admin_password_resets',
                'expire' => 60,
            ],
        ],
        ```
8. If you want to use Middleware (requires Laravel 5.1 or later. you also need to add the following to the `routeMiddleware` array in `app/Http/Kernel.php`:

```
'role' => \WhiteSunrise\Guardian\Middleware\GuardianRole::class,
'permission' => \WhiteSunrise\Guardian\Middleware\GuardianPermission::class,
'ability' => \WhiteSunrise\Guardian\Middleware\GuardianAbility::class,
```

### Configuration

[](#configuration)

Set the proper values in the `config/auth.php`.

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

#### Users

[](#users)

Guardian uses the `app/Models` directory for storing models. **If you used \[Laravel's Authentication Quickstart\](.** to generate your User model and controllers, make sure you update the values in your config file.

1. Generate the Guardian migrations:

```
php artisan whitesunrise:guardian:make:migration all
```

This will generate the `_guardian_create_roles_tables.php` and `_guardian_create_permissions_tables.php` migrations. Now you can run the migration(s.:

```
php artisan migrate
```

After the migration, five new tables will be present:

1. `roles` - stores role records
2. `permissions` - stores permission records
3. `role_users` - stores \[many-to-many\](. relations between roles and users
4. `role_admin_users` - stores \[many-to-many\](. relations between roles and admin users
5. `permission_roles` - stores \[many-to-many\](. relations between roles and permissions

### Models

[](#models)

#### Role

[](#role)

Generate the new Role model inside `app/models/Role.php` by running:

```
artisan whitesunrise:guardian:make:model role
```

The `Role` model is used for both the `User` and `AdminUser` models. Both have pivot tables to keep user data separate. `Role` model has four main attributes:

- `name` - Unique human readable name for the Role. For example: "User Administrator", "Project Owner", "Widget Co. Employee".
- `slug` - Unique name for the Role, used for looking up role information in the application layer. For example: "admin", "owner", "employee".
- `description` - A more detailed explanation of what the Role does. This field is optional.
- `parent_id` - Optional field to inherit permissions from another role.

Both `parent_id` and `description` are optional; their fields are nullable in the database.

> Alternatively, you may use an existing Role model instead by extending the GuardianRole class, shown below.

```
namespace App\Models;

use WhiteSunrise\Guardian\Models\GuardianRole;

class Role extends GuardianRole
{
}
```

#### Permission

[](#permission)

Generate the new Permission model inside `app/models/Permission.php` by running:

```
artisan whitesunrise:guardian:make:model permission
```

The `Permission` model has three main attributes:

- `name` - Unique human readable name for the permission. For example "Create Posts", "Edit Users", "Post Payments", "Subscribe to mailing list".
- `slug` - Unique name for the permission, used for looking up permission information in the application layer. For example: "create-post", "edit-user", "post-payment", "mailing-list-subscribe".
- `description` - A more detailed explanation of the Permission.

In general, it may be helpful to think of the last two attributes in the form of a sentence: "The permission `name` allows a user to `description`."

> Alternatively, you may use an existing Permission model instead by extending the GuardianPermission class, shown below.

```