hassni/laravel-nova-permission

Laravel Nova 的一款用于 Spatie's Permission 库的工具。

2.0 2021-06-20 06:50 UTC

This package is auto-updated.

Last update: 2024-09-20 16:24:46 UTC


README

License Latest Stable Version Scrutinizer Code Quality Total Downloads

Nova 工具让您

  • 在 Nova 控制台中管理角色和权限
  • 为 Nova 资源使用基于权限的授权

屏幕截图

screenshot of the backup tool

需求与依赖

除了 Laravel Nova 包和 Spatie Permission 包外,没有其他 PHP 依赖。

安装

您可以通过 composer 将此工具安装到使用 Nova 的 Laravel 应用程序中

composer require insenseanalytics/laravel-nova-permission

接下来,如果您未启用包发现,您需要将提供者在 config/app.php 文件中注册。

'providers' => [
    ...,
    Insenseanalytics\LaravelNovaPermission\NovaPermissionServiceProvider::class,
]

接下来,您必须将工具与 Nova 注册。通常在 NovaServiceProvidertools 方法中完成此操作。

// in app/Providers/NovaServiceProvider.php

public function tools()
{
    return [
        // ...
        \Insenseanalytics\LaravelNovaPermission\LaravelNovaPermission::make(),
    ];
}

接下来,将 MorphToMany 字段添加到您的 app/Nova/User 资源中

use Laravel\Nova\Fields\MorphToMany;

public function fields(Request $request)
{
    return [
        // ...
        MorphToMany::make('Roles', 'roles', \Insenseanalytics\LaravelNovaPermission\Role::class),
        MorphToMany::make('Permissions', 'permissions', \Insenseanalytics\LaravelNovaPermission\Permission::class),
    ];
}

最后,将 ForgetCachedPermissions 类添加到您的 config/nova.php 中间件,如下所示

// in config/nova.php
'middleware' => [
	'web',
	Authenticate::class,
	DispatchServingNovaEvent::class,
	BootTools::class,
	Authorize::class,
	\Insenseanalytics\LaravelNovaPermission\ForgetCachedPermissions::class,
],

本地化

您可以使用 artisan 命令行工具发布本地化文件

php artisan vendor:publish --provider="Insenseanalytics\LaravelNovaPermission\NovaPermissionServiceProvider"

使用自定义角色/权限资源类

如果您想使用自定义资源类,您可以在注册工具时定义它们

// in app/Providers/NovaServiceProvider.php

public function tools()
{
    return [
        // ...
        \Insenseanalytics\LaravelNovaPermission\LaravelNovaPermission::make()
            ->roleResource(CustomRole::class)
            ->permissionResource(CustomPermission::class),
    ];
}

基于权限的 Nova 资源授权

默认情况下,Laravel Nova 使用基于策略的授权进行 Nova 资源授权。如果您使用 Spatie Permission 库,您很可能希望将其替换为基于权限的授权,而不需要定义授权策略。

要这样做,您可以使用 PermissionsBasedAuthTrait 并在您的 Nova 资源类中定义一个 permissionsForAbilities 静态数组属性,如下所示

// in app/Nova/YourNovaResource.php

class YourNovaResource extends Resource
{
    use \Insenseanalytics\LaravelNovaPermission\PermissionsBasedAuthTrait;

    public static $permissionsForAbilities = [
      'all' => 'manage products',
    ];
}

上面的例子意味着具有“管理产品”权限的用户可以执行此资源上的所有操作。您也可以像这样为每个操作定义单独的权限

    public static $permissionsForAbilities = [
      'viewAny' => 'view products',
      'view' => 'view products',
      'create' => 'create products',
      'update' => 'update products',
      'delete' => 'delete products',
      'restore' => 'restore products',
      'forceDelete' => 'forceDelete products',
      'addAttribute' => 'add product attributes',
      'attachAttribute' => 'attach product attributes',
      'detachAttribute' => 'detach product attributes',
    ];

关系

为了允许用户在模型上指定关系,您需要在模型上添加另一个权限。例如,如果您的 Product 属于 User,请在 app/Nova/User.php 上添加以下权限。

    public static $permissionsForAbilities = [
      'addProduct' => 'add user on products'
    ];

贡献

欢迎贡献,只要您使用 PSR-2,解释您想要解决/添加的问题/功能,并使用测试来支持您的代码,您的贡献将得到充分认可。祝您编码愉快!

许可证

MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件