Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vyuldashev/nova-permission
A Laravel Nova tool for Spatie's laravel-permission library
https://github.com/vyuldashev/nova-permission
acl laravel nova permission php secure spatie
Last synced: 1 day ago
JSON representation
A Laravel Nova tool for Spatie's laravel-permission library
- Host: GitHub
- URL: https://github.com/vyuldashev/nova-permission
- Owner: vyuldashev
- Created: 2018-08-23T15:52:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T08:57:54.000Z (5 months ago)
- Last Synced: 2024-12-18T17:03:27.891Z (8 days ago)
- Topics: acl, laravel, nova, permission, php, secure, spatie
- Language: PHP
- Homepage: https://novapackages.com/packages/vyuldashev/nova-permission
- Size: 1.13 MB
- Stars: 419
- Watchers: 15
- Forks: 219
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A Laravel Nova tool for Spatie's laravel-permission library
[](https://packagist.org/packages/vyuldashev/nova-permission)
[](https://packagist.org/packages/vyuldashev/nova-permission)
## Installation
You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:
```bash
composer require vyuldashev/nova-permission
```
Go through the [Installation](https://github.com/spatie/laravel-permission#installation) section in order to setup [laravel-permission](https://packagist.org/packages/spatie/laravel-permission).
Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::make(),
];
}
```
Next, add middleware to `config/nova.php`
```php
// in config/nova.php
'middleware' => [
// ...
\Vyuldashev\NovaPermission\ForgetCachedPermissions::class,
],
```
Finally, add `MorphToMany` fields to you `app/Nova/User` resource:
```php
// ...
use Laravel\Nova\Fields\MorphToMany;
public function fields(Request $request)
{
return [
// ...
MorphToMany::make('Roles', 'roles', \Vyuldashev\NovaPermission\Role::class),
MorphToMany::make('Permissions', 'permissions', \Vyuldashev\NovaPermission\Permission::class),
];
}
```
Or if you want to attach multiple permissions at once, use `RoleBooleanGroup` and `PermissionBooleanGroup` fields (requires at least Nova 2.6.0):
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleBooleanGroup;
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.
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleSelect;
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:
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::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:
```php
// ...
use Vyuldashev\NovaPermission\PermissionBooleanGroup;
use Vyuldashev\NovaPermission\RoleSelect;
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
```php
// in app/Providers/NovaServiceProvider.php
// ...
public function tools()
{
return [
// ...
\Vyuldashev\NovaPermission\NovaPermissionTool::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.