Skip to content

Commit

Permalink
update middleware to be out the box and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremykenedy committed Apr 19, 2019
1 parent be050a5 commit 0850e69
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 7 deletions.
31 changes: 24 additions & 7 deletions readme.md
Expand Up @@ -50,12 +50,22 @@ Supports Laravel 5.3, 5.4, 5.5, 5.6, 5.7 and 5.8.
This package is very easy to set up. There are only couple of steps.

### Composer
From your projects root folder in terminal run:

Laravel 5.8 and up use:

Pull this package in through Composer
```
composer require jeremykenedy/laravel-roles
composer require jeremykenedy/laravel-roles
```

Laravel 5.7 and below use:

```
composer require jeremykenedy/laravel-roles:1.4.0
```

* Note: The major difference is that Laravel's users table migration out the box changed from `$table->increments('id');` to `$table->bigIncrements('id');` in Laravel 5.8.

### Service Provider
* Laravel 5.5 and up
Uses package auto discovery feature, no need to edit the `config/app.php` file.
Expand Down Expand Up @@ -461,8 +471,9 @@ There are four Blade extensions. Basically, it is replacement for classic if sta
```

### Middleware

This package comes with `VerifyRole`, `VerifyPermission` and `VerifyLevel` middleware. You must add them inside your `app/Http/Kernel.php` file.
This package comes with `VerifyRole`, `VerifyPermission` and `VerifyLevel` middleware.
The middleware aliases are already registered in `\jeremykenedy\LaravelRoles\RolesServiceProvider` as of 1.7.
You can optionally add them inside your `app/Http/Kernel.php` file with your own aliases like outlined below:

```php
/**
Expand All @@ -473,10 +484,16 @@ This package comes with `VerifyRole`, `VerifyPermission` and `VerifyLevel` middl
protected $routeMiddleware = [
'auth' => \App\Http\Middleware\Authenticate::class,
'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
'can' => \Illuminate\Auth\Middleware\Authorize::class,
'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
'role' => \jeremykenedy\LaravelRoles\Middleware\VerifyRole::class,
'permission' => \jeremykenedy\LaravelRoles\Middleware\VerifyPermission::class,
'level' => \jeremykenedy\LaravelRoles\Middleware\VerifyLevel::class,
'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
'role' => \jeremykenedy\LaravelRoles\Middleware\VerifyRole::class,
'permission' => \jeremykenedy\LaravelRoles\Middleware\VerifyPermission::class,
'level' => \jeremykenedy\LaravelRoles\Middleware\VerifyLevel::class,
];
```

Expand Down
9 changes: 9 additions & 0 deletions src/RolesServiceProvider.php
Expand Up @@ -7,6 +7,9 @@
use jeremykenedy\LaravelRoles\Database\Seeds\DefaultPermissionsTableSeeder;
use jeremykenedy\LaravelRoles\Database\Seeds\DefaultRolesTableSeeder;
use jeremykenedy\LaravelRoles\Database\Seeds\DefaultUsersTableSeeder;
use jeremykenedy\LaravelRoles\Middleware\VerifyRole;
use jeremykenedy\LaravelRoles\Middleware\VerifyPermission;
use jeremykenedy\LaravelRoles\Middleware\VerifyLevel;

class RolesServiceProvider extends ServiceProvider
{
Expand All @@ -22,10 +25,16 @@ class RolesServiceProvider extends ServiceProvider
/**
* Bootstrap any application services.
*
* @param \Illuminate\Routing\Router $router The router
*
* @return void
*/

public function boot()
{
$this->app['router']->aliasMiddleware('role', VerifyRole::class);
$this->app['router']->aliasMiddleware('permission', VerifyPermission::class);
$this->app['router']->aliasMiddleware('level', VerifyLevel::class);
$this->registerBladeExtensions();
}

Expand Down

0 comments on commit 0850e69

Please sign in to comment.