jameron/regulator

Auth and role/permissions manager

2.4.8 2018-01-31 00:50 UTC

MIT

• Cameron Macfarlane

• roles
• permissions
• lms

README

This package has been built to work with Laravel 5.4.33 and later. (Some older versions of Laravel may not be compatible.)

This package contains methods and traits that can be used with your project, and optionally you can use the views for your UX. If you are using the admin views, make sure you also require the admin package found here: Admin package

Your composer file would look like so:

        "jameron/admin": "*",
        "jameron/regulator": "*",

Let's see if we can't get you up and running in 10 steps. If you are starting fresh, create your laravel application first thing:

composer create-project --prefer-dist laravel/laravel blog

1. Add the package to your compose.json file:

    "jameron/regulator": "*",

composer update

**NOTE Laravel 5.5+ users there is auto-discovery so you can ignore steps 2 and 3

1. Update your providers:

        Jameron\Regulator\RegulatorServiceProvider::class,

1. Update your Facades:

        'Regulator' => Jameron\Regulator\Facades\RegulatorFacade::class,

1. Publish the sass, js, and config:

php artisan vendor:publish

**NOTE: Select the number that coorelates to the jameron/regulator package

1. Run your migrations:

**NOTE: the Regulator package depends on Laravel Auth so if you haven't set it up yet run:

php artisan make:auth

**NOTE: DELETE the Auth::routes() from routes/web.php, the Regulator package includes these routes for you.

Alright now go ahead and migrate:

php artisan migrate

If you get this error

[Illuminate\Database\QueryException]
SQLSTATE[42000]: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes (SQL: alter table `users` add unique `users_email_unique`(`email`))``` 

You need to add this to your AppServiceProvider

use Illuminate\Support\Facades\Schema;

function boot()
{
    Schema::defaultStringLength(191);
}

1. Seed up the database with two roles and a few permissions

You can call it directly via command line or add it to your applications seeder file:

Added to application seeder

database/seeds/DatabaseSeeder.php

$this->call(\Jameron\Regulator\database\seeds\RegulatorSeeder::class);

Called via command line:

php artisan db:seed --class=\\Jameron\\Regulator\\database\\seeds\\RegulatorSeeder

1. Update your App\User.php

use Jameron\Regulator\Models\Traits\HasRoles;
class User extends Authenticatable
{
	use HasRoles;

You will also want these methods on your User model

    public function getRoleAttribute()
    {
        $roles = [];
        foreach($this->roles()->get() as $role) {
            $roles[] = $role->slug;
        }
        return implode(',', $roles);
    } 

    public function getEnabledAttribute()
    {
        return ($this->disabled) ? 'no' : 'yes';
    }

1. If you setup you project to use the database driver for sessions you can see when users are logged in or not. To set up the database session driver:

php artisan session:table

php artisan migrate

1. Subscribe to the login and logout events to update the users last_login and last_logout timestamp on the user model. Add this to app/Providers/EventServiceProvider.

protected $subscribe = [
\Jameron\Regulator\Listeners\UserEventSubscriber::class,
];

1. Update your webpack.mix.js file

   .js('resources/assets/regulator/js/RegulatorDependencies.js', 'public/js/Regulator.js')
   .sass('resources/assets/regulator/sass/regulator.scss', 'public/css')

1. Make sure you have vuex installed, it is used with the role permissions component.

npm install vuex --save

1. Compile it up:

npm run dev