yadahan/nova-bouncer

A Laravel Nova tool for managing Bouncer roles and abilities.

v0.7.0 2020-12-08 23:50 UTC

This package is auto-updated.

Last update: 2021-10-09 01:27:35 UTC


README

StyleCI Total Downloads GitHub license

Use the power of Bouncer within your Nova application.

nova bouncer screenshot

Installation

Nova Bouncer requires silber/bouncer.

You may use Composer to install Nova Bouncer into your Laravel project:

composer require yadahan/nova-bouncer

Configuration

After installing the Nova Bouncer, you need to register the tool with Nova in app/Providers/NovaServiceProvder.php file:

public function tools()
{
    return [
        // ...
        new \Yadahan\BouncerTool\BouncerTool(),
    ];
}

Next, add the Roles and Abilities MorphToMany fields to your User resource in app/Nova/User.php file:

use Laravel\Nova\Fields\Text;
use Laravel\Nova\Fields\MorphToMany;

public function fields(Request $request)
{
    return [
        // ...
        MorphToMany::make('Roles', 'roles', 'Yadahan\BouncerTool\Nova\Role')->fields(function () {
            return [
                Text::make('Scope')
                    ->sortable()
                    ->rules('nullable', 'integer'),
            ];
        }),

        MorphToMany::make('Abilities', 'abilities', 'Yadahan\BouncerTool\Nova\Ability')
            ->fields(new \Yadahan\BouncerTool\Nova\PermissionsFields),
    ];
}

Finally, publish the Nova Bouncer config using the vendor:publish Artisan command:

php artisan vendor:publish --provider="Yadahan\BouncerTool\BouncerToolServiceProvider"

After publishing the config, you may define the models and abilities that you want to manage, in config/bouncer-tool.php file:

'entities' => [
    '*' => 'Everything',
    'App\User' => 'User',
],

'actions' => [
    '*' => 'All abilities',
    'viewAny' => 'View any',
    'view' => 'View',
    'create' => 'Create',
    'update' => 'Update',
    'delete' => 'Delete',
    'restore' => 'Restore',
    'forceDelete' => 'Force delete',
],

Basic Usage

A new item group (Bouncer) will appear in your Nova navigation menu.

Only users who are authorized to manage the Bouncer models can see this navigation items.

You may give ability to manage the Bouncer models for a user\role:

$user = User::find(1);

Bouncer::allow($user)->toManage(\Silber\Bouncer\Database\Role::class);
Bouncer::allow($user)->toManage(\Silber\Bouncer\Database\Ability::class);

// or

Bouncer::role()->create([
    'name' => 'manage-bouncer',
    'title' => 'Manage bouncer',
]);

Bouncer::allow('manage-bouncer')->toManage(\Silber\Bouncer\Database\Role::class);
Bouncer::allow('manage-bouncer')->toManage(\Silber\Bouncer\Database\Ability::class);

$user->assign('manage-bouncer');

Laravel Authorization

https://laravel.com/docs/authorization#creating-policies

Generating Policies

You may generate a policy using the make:policy artisan command:

php artisan make:policy UserPolicy --model=User

Registering Policies

Once the policy exists, it needs to be registered in app/Providers/AuthServiceProvider.php file:

protected $policies = [
    // ...
    'App\User' => 'App\Policies\UserPolicy',
];

Contributing

Thank you for considering contributing to the Nova Bouncer.

License

Nova Bouncer is open-sourced software licensed under the MIT license.