nova-permission
A Laravel Nova tool for Spatie’s laravel-permission library
Installation
You can install the package in to a Laravel app that uses Nova via composer:
composer require vyuldashev/nova-permission
Go through the Installation section in order to setup laravel-permission.
Next up, you must register the tool with Nova. This is typically done in the tools
method of the NovaServiceProvider
.
// in app/Providers/NovaServiceProvider.php // ... public function tools() { return [ // ... VyuldashevNovaPermissionNovaPermissionTool::make(), ]; }
Next, add middleware to config/nova.php
// in config/nova.php 'middleware' => [ // ... VyuldashevNovaPermissionForgetCachedPermissions::class, ],
Finally, add MorphToMany
fields to you app/Nova/User
resource:
// ... use LaravelNovaFieldsMorphToMany; public function fields(Request $request) { return [ // ... MorphToMany::make('Roles', 'roles', VyuldashevNovaPermissionRole::class), MorphToMany::make('Permissions', 'permissions', VyuldashevNovaPermissionPermission::class), ]; }
Or if you want to attach multiple permissions at once, use RoleBooleanGroup
and PermissionBooleanGroup
fields (requires at least Nova 2.6.0):
// ... use VyuldashevNovaPermissionPermissionBooleanGroup; use VyuldashevNovaPermissionRoleBooleanGroup; public function fields(Request $request) { return [ // ... RoleBooleanGroup::make('Roles'), PermissionBooleanGroup::make('Permissions'), ]; }
If your User
could have a single role at any given time, you can use RoleSelect
field. This field will render a standard select where you can pick a single role from.
// ... use VyuldashevNovaPermissionPermissionBooleanGroup; use VyuldashevNovaPermissionRoleSelect; public function fields(Request $request) { return [ // ... RoleSelect::make('Role', 'roles'), ]; }
Customization
If you want to use custom resource classes you can define them when you register a tool:
// in app/Providers/NovaServiceProvider.php // ... public function tools() { return [ // ... VyuldashevNovaPermissionNovaPermissionTool::make() ->roleResource(CustomRole::class) ->permissionResource(CustomPermission::class), ]; }
If you want to show your roles and policies with a custom label, you can set $labelAttribute
when instantiating your fields:
// ... use VyuldashevNovaPermissionPermissionBooleanGroup; use VyuldashevNovaPermissionRoleSelect; public function fields(Request $request) { return [ // ... RoleBooleanGroup::make('Roles', 'roles', null, 'description'), PermissionBooleanGroup::make('Permissions', 'permissions', null, 'description'), RoleSelect::make('Role', 'roles', null, 'description'), ]; }
Define Policies
// in app/Providers/NovaServiceProvider.php // ... public function tools() { return [ // ... VyuldashevNovaPermissionNovaPermissionTool::make() ->rolePolicy(RolePolicy::class) ->permissionPolicy(PermissionPolicy::class), ]; }
Usage
A new menu item called “Permissions & Roles” will appear in your Nova app after installing this package.