README

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

与某些其他包相比

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

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

安全更新和重大更改

请 订阅 Backpack Newsletter 以了解任何安全更新、重大更改或主要功能。我们每 1-2 个月发送一次电子邮件。

安装

1. 此包假设您已经安装了 Backpack for Laravel。如果您还没有安装，请先 安装 Backpack。

2. 在您的终端

composer require backpack/permissionmanager

1. 完成 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)

1. 发布 backpack\permissionmanager 配置文件及迁移

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

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

1. 运行迁移

php artisan migrate

1. 此包假设可以使用默认的 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
     */

1. [可选] 在 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>

1. [可选] 如果您想在 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"；

OR

(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'))，它做的是完全相同的事情，但始终有效；
• 当您添加新的角色和权限时，将保存在数据库中的守卫将是 "backpack"；

1. [可选] 在您定义角色或权限后，请使用位于 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函数来测试用户是否有权限。

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文件；包将看到它，并加载您的路由文件，而不是包中的路由文件；
• 创建扩展包中控制器/模型的控制器/模型，并在您的新路由文件中使用它们；
• 修改您想要的任何新控制器/模型；

当创建自己的控制器、seeder时，请确保您使用的是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 Newsletter 以了解任何安全更新、重大更改或主要功能。我们每 1-2 个月发送一次电子邮件。

鸣谢

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

许可证

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

聘请我们

我们投入了超过50,000个小时来创建、完善和维护Laravel的行政面板。我们开发了电子商务、电子学习、ERP、社交网络、支付网关等等。我们对行政面板的工作量如此之大，以至于我们创造了其领域中最受欢迎的软件之一——仅通过将我们在项目中重复的部分公开化。

如果您正在寻找一个开发者/团队来帮助您在Laravel上构建行政面板，那就无需再找了。您很难找到比这更有经验、更有热情的人。这就是我们的事业所在。请联系我们。让我们看看是否可以合作。