README

用于spatie/laravel-permission的spatie/laravel-permission管理界面。它允许管理员轻松添加/编辑/删除用户、角色和权限，使用Laravel Backpack。

与其他一些包不同

用户可以有多个角色；
用户可以有额外的权限，除了他们在角色中拥有的权限之外；

此包只是spatie/laravel-permission的用户界面。它将安装它，并允许您在代码中使用其API。请参阅他们的README以获取有关如何在代码中使用的更多信息。

安全更新和重大更改

请订阅Backpack通讯，以便了解有关任何安全更新、重大更改或主要功能的最新信息。我们每月发送1-2封电子邮件。

安装

此包假设您已安装Backpack for Laravel。如果您还没有安装，请先安装Backpack。
在您的终端中

composer require backpack/permissionmanager

完成spatie/laravel-permission的安装步骤，该步骤作为依赖项被拉入。运行其迁移。发布其配置文件。很可能如下：

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="migrations"
php artisan migrate
php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"
// then, add the Spatie\Permission\Traits\HasRoles trait to your User model(s)

发布backpack\permissionmanager配置文件和迁移

php artisan vendor:publish --provider="Backpack\PermissionManager\PermissionManagerServiceProvider" --tag="config" --tag="migrations"

注意：我们建议您只发布配置文件和迁移，但您也可以发布lang和routes。

运行迁移

php artisan migrate

该包假设可以使用默认的Backpack用户模型（很可能是App\Models\User来管理用户。如果您想使用不同的模型，请通过更改config/backpack/permissionmanager.php文件中的用户模型来实现。确保您使用的任何模型都使用CrudTrait和HasRoles特质。

<?php namespace App\Models;

use Backpack\CRUD\app\Models\Traits\CrudTrait; // <------------------------------- this one
use Spatie\Permission\Traits\HasRoles;// <---------------------- and this one
use Illuminate\Foundation\Auth\User as Authenticatable; 

class User extends Authenticatable
{
    use CrudTrait; // <----- this
    use HasRoles; // <------ and this

    /**
     * Your User Model content
     */

[可选] 在resources/views/vendor/backpack/base/inc/sidebar_content.blade.php或menu.blade.php中为其添加菜单项

<!-- Users, Roles, Permissions -->
<li class="nav-item nav-dropdown">
    <a class="nav-link nav-dropdown-toggle" href="#"><i class="nav-icon la la-users"></i> Authentication</a>
    <ul class="nav-dropdown-items">
        <li class="nav-item"><a class="nav-link" href="{{ backpack_url('user') }}"><i class="nav-icon la la-user"></i> <span>Users</span></a></li>
        <li class="nav-item"><a class="nav-link" href="{{ backpack_url('role') }}"><i class="nav-icon la la-id-badge"></i> <span>Roles</span></a></li>
        <li class="nav-item"><a class="nav-link" href="{{ backpack_url('permission') }}"><i class="nav-icon la la-key"></i> <span>Permissions</span></a></li>
    </ul>
</li>

[可选] 如果您想在Backpack路由中使用@can处理器，您可以

(7.A.) 将Backpack更改为使用默认的web保护者而不是它自己的保护者。在config/backpack/base.php中更改

    // The guard that protects the Backpack admin panel.
    // If null, the config.auth.defaults.guard value will be used.
-   'guard' => 'backpack',
+   'guard' => null,

注意

当您添加新角色和权限时，将保存在数据库中的保护者将是“web”；

(7.B.) 通过向您的config/backpack/base.php文件添加以下内容来为所有Backpack路由添加中间件

    // The classes for the middleware to check if the visitor is an admin
    // Can be a single class or an array of clases
    'middleware_class' => [
        App\Http\Middleware\CheckIfAdmin::class,
        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
+       Backpack\Base\app\Http\Middleware\UseBackpackAuthGuardInsteadOfDefaultAuthGuard::class,
    ],

原因：spatie/laravel-permission使用Auth外观在@can中确定权限。外观Auth使用在config/auth.php中定义的默认保护者，而不是我们的Backpack保护者。

请注意

这将使auth()返回与Backpack路由中的backpack_auth()相同的内容；
您只需要这样做，如果您想使用@can；您也可以使用@if(backpack_user()->can('read'))，它做完全相同的事情，但100%有效；
当您添加新角色和权限时，将保存在数据库中的保护者将是“backpack”；

[可选] 在您定义它们之后，使用 config/backpack/permissionmanager.php 中的配置文件禁止创建/更新您的角色或权限。请注意，代码中使用名称引用权限和角色。如果您允许您的管理员编辑这些字符串，并且他们确实这样做，您的权限和角色检查将停止工作。

自定义 UserCrudController

如果您想添加更多字段到本包提供的默认用户控制器中，您可以绑定自己的控制器来覆盖本包中提供的一个

// in some ServiceProvider, AppServiceProvider for example

$this->app->bind(
    \Backpack\PermissionManager\app\Http\Controllers\UserCrudController::class, //this is package controller
    \App\Http\Controllers\Admin\UserCrudController::class //this should be your own controller
);

// this tells Laravel that when UserCrudController is requested, your own UserCrudController should be served.

API 使用

由于本包需要 spatie/laravel-permission，API 将相同。请参阅他们的 README 文件以获取完整的 API。尽管如此，这里是一个摘要

使用权限

可以将权限授予用户

backpack_user()->givePermissionTo('edit articles');

可以从用户中撤销权限

backpack_user()->revokePermissionTo('edit articles');

您可以使用测试用户是否有权限

backpack_user()->hasPermissionTo('edit articles');

保存的权限将注册到 Illuminate\Auth\Access\Gate-class 中。因此，您可以使用 Laravel 的默认 can-function 来测试用户是否有权限。

backpack_user()->can('edit articles');

使用角色和权限

可以将角色分配给用户

backpack_user()->assignRole('writer');

可以从用户中移除角色

backpack_user()->removeRole('writer');

您可以确定用户是否具有特定角色

backpack_user()->hasRole('writer');

您也可以确定用户是否具有给定列表中的任何角色

backpack_user()->hasAnyRole(Role::all());

您还可以确定用户是否具有给定列表中的所有角色

backpack_user()->hasAllRoles(Role::all());

assignRole、hasRole、hasAnyRole、hasAllRoles 和 removeRole 函数可以接受字符串、Role-object 或 \Illuminate\Support\Collection-object。

可以将权限授予角色

$role->givePermissionTo('edit articles');

您可以确定角色是否具有特定权限

$role->hasPermissionTo('edit articles');

可以从角色中撤销权限

$role->revokePermissionTo('edit articles');

givePermissionTo 和 revokePermissionTo 函数可以接受字符串或 Permission-object。

保存的权限和角色也注册到 Illuminate\Auth\Access\Gate-class。

backpack_user()->can('edit articles');

使用 blade 指令

此包还添加了 Blade 指令来验证当前登录用户是否具有给定列表的所有或任何角色。

@role('writer')
    I\'m a writer!
@else
    I\'m not a writer...
@endrole
@hasrole('writer')
    I\'m a writer!
@else
    I\'m not a writer...
@endhasrole
@hasanyrole(Role::all())
    I have one or more of these roles!
@else
    I have none of these roles...
@endhasanyrole
@hasallroles(Role::all())
    I have all of these roles!
@else
    I don\'t have all of these roles
@endhasallroles

您可以使用 Laravel 的原生 @can 指令来检查用户是否具有特定权限。

从 3.x 升级到 4.x

要从 PermissionManager 3.x 升级到 4.x

升级到 spatie/laravel-permission 2.28.2+ - 请注意，数据库已更改，并且它们不提供更改的跟踪；
在您的 composer.json 文件中要求 backpack/permissionmanager 版本 4.0.*；
删除您的旧 config/backpack/permissionmanager.php 文件；
按照上面的安装步骤操作；

如果您正在升级到 Laravel 8 安装，请注意，User Model 可能已从 App\User::class 移至 App\Models\User::class，请检查您的配置是否符合该更改 config/backpack/permissionmanager.php。

变更日志

有关最近更改的详细信息，请参阅 CHANGELOG。

覆盖功能

如果您需要修改在项目中如何使用此功能

创建一个 routes/backpack/permissionmanager.php 文件；包将看到它，并加载您的路由文件，而不是包中的文件；
创建扩展包中提供的控制器/模型的自定义控制器/模型，并在您的新路由文件中使用它们；
修改您想要在新的控制器/模型中修改的内容；

在创建自己的控制器、种子时，请确保您使用的是 BackpackUser 模型，而不是您应用中的 User 模型。最简单的方法是使用 config('backpack.base.user_model_fqn')，它拉入完全限定命名空间 User 模型，如定义在您的 config/backpack/base.php 中。您可能需要使用 $model = config('backpack.base.user_model_fqn'); $model = new $model; 来实例化它，以便执行像 $model->where(...) 这样的操作。

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全

如果您发现任何与安全相关的问题，请发送电子邮件至tabacitu@backpackforlaravel.com，而不是使用问题跟踪器。

请订阅Backpack通讯，以便了解有关任何安全更新、重大更改或主要功能的最新信息。我们每月发送1-2封电子邮件。

致谢

Marius Constantin - 首席开发者
Cristian Tabacitu - 维护者
所有贡献者

许可证

Backpack 免费供非商业用途，商业用途则为49欧元/项目。请参阅许可证文件和backpackforlaravel.com以获取更多信息。

雇佣我们

我们投入了超过50,000小时来创建、打磨和维护Laravel的行政面板。我们开发了电子商务、电子学习、ERP、社交网络、支付网关等等。我们对行政面板的工作已经如此之多，以至于我们创造了该领域最受欢迎的软件之一——仅仅是通过使我们在项目中重复的内容公开。

如果您正在寻找一位或一个团队来帮助您在Laravel上构建一个行政面板，那就不要继续寻找了。您将很难找到一个比我们有更多经验和热情的人。这就是我们所做的工作。联系我们。让我们看看是否可以合作。

tannhatcms / permissionmanager

维护者

详细信息