lucasvllima/laravel-nova-permission

Laravel Nova工具,用于Spatie的权限库。

dev-master 2024-01-19 15:07 UTC

This package is not auto-updated.

Last update: 2024-09-28 17:12:45 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)。有关更多信息,请参阅许可证文件