ngockush / permissionmanager
使用Backpack CRUD为Laravel 5提供用户和权限管理界面。
Requires
- hacoidev/crud: ^1.0.0
- spatie/laravel-permission: ^5.0|^4.0|^3.0
Requires (Dev)
- phpunit/phpunit: ^9.0||^7.0
- scrutinizer/ocular: ~1.1
This package is not auto-updated.
Last update: 2024-09-25 16:39:52 UTC
README
为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"
注意:我们建议您只发布配置文件和迁移,但您也可以发布语言和路由。
- 运行迁移
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
确定权限。外观使用在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 类。因此,您可以使用 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 对象或一个 \Illuminate\Support\Collection 对象。
可以将权限授予角色
$role->givePermissionTo('edit articles');
您可以确定角色是否具有某个特定权限
$role->hasPermissionTo('edit articles');
可以从角色中撤销权限
$role->revokePermissionTo('edit articles');
givePermissionTo 和 revokePermissionTo 函数可以接受一个字符串或一个 Permission 对象。
保存的权限和角色也注册到 Illuminate\Auth\Access\Gate 类。
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 上构建管理面板,无需再寻找。您将很难找到比这更有经验且对此更有热情的人。这就是我们 所做的工作。 联系我们。让我们看看我们是否可以一起工作。