mindscms/entrust

此包提供了一种灵活的方式来向Laravel添加基于角色的权限，由Sami Mansour定制。

维护者

详细信息

github.com/mindscms/entrust

源代码

问题

安装数: 8,982

依赖: 0

建议者: 0

安全: 0

星星: 24

关注者: 3

分支: 13

开放问题: 1

v2.6.0 2023-05-12 19:03 UTC

Requires

MIT 02efb13f281ee4e7345b2bb82283c8f507f561c4

  • Sami Mansour <mindscms.woop@gmail.com>

authacllaravelpermissionrolesilluminate

This package is auto-updated.

Last update: 2024-09-12 22:26:15 UTC

README

Entrust 是一种简洁灵活的方式来为 Laravel 10 及以下版本添加基于角色的权限。

内容

安装

  1. 为了安装 Laravel 8 Entrust，只需在您的 composer.json 中添加以下内容。然后运行 composer update
composer require mindscms/entrust
  1. 打开您的 config/app.php 并将以下内容添加到 providers 数组中
Mindscms\Entrust\EntrustServiceProvider::class,
  1. 在相同的 config/app.php 中，将以下内容添加到 aliases 数组中
'Entrust'   => Mindscms\Entrust\EntrustFacade::class,
  1. 运行以下命令以发布包配置文件 config/entrust.php
php artisan vendor:publish
  1. 打开您的 config/auth.php 并将其添加到其中
'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => Namespace\Of\Your\User\Model\User::class,
        'table' => 'users',
    ],
],
  1. 如果您想使用 中间件（需要 Laravel 5.1 或更高版本），您还需要将以下内容添加到 app/Http/Kernel.php 中的 routeMiddleware 数组中。
    'role' => \Mindscms\Entrust\Middleware\EntrustRole::class,
    'permission' => \Mindscms\Entrust\Middleware\EntrustPermission::class,
    'ability' => \Mindscms\Entrust\Middleware\EntrustAbility::class,

在 config/auth.php 中设置属性值。这些值将由 entrust 用于引用正确的用户表和模型。

配置

为了进一步自定义表名和模型命名空间，请编辑 config/entrust.php。

现在生成 Entrust 迁移

用户与角色的关联

它将生成 <timestamp>_entrust_setup_tables.php 迁移。您现在可以使用 artisan migrate 命令运行它

php artisan entrust:migration

迁移完成后，将出现四个新表

php artisan migrate

roles — 存储角色记录

  • permissions — 存储权限记录
  • role_user — 存储角色与用户之间的多对多关系
  • permission_role — 存储角色与权限之间的多对多关系
  • user_permission — 存储用户与权限之间的多对多关系
  • user_permission — 存储用户与权限之间的多对多关系

模型

角色

在 app/Role.php 中创建一个 Role 模型，使用以下示例

<?php namespace App;

use Mindscms\Entrust\EntrustRole;

class Role extends EntrustRole
{
    protected $guarded = [];
}

Role 模型有三个主要属性

  • name — 角色的唯一名称，用于在应用层查找角色信息。例如：“admin”、“owner”、“employee”。
  • display_name — 角色的人类可读名称。不一定唯一且为可选。例如：“用户管理员”、“项目所有者”、“Widget Co. 员工”。
  • description — 角色功能的更详细说明。也是可选的。

display_name 和 description 都是可选的；其字段在数据库中可为空。

权限

在 app/Permission.php 中创建一个 Permission 模型，使用以下示例

<?php namespace App;

use Mindscms\Entrust\EntrustPermission;

class Permission extends EntrustPermission
{
    protected $guarded = [];
    
    public function parent()
    {
        return $this->hasOne(Permission::class, 'id', 'parent');
    }

    public function children()
    {
        return $this->hasMany(Permission::class, 'parent', 'id');
    }

    public static function tree( $level = 1 )
    {
        return static::with(implode('.', array_fill(0, $level, 'children')))
            ->whereParent(0)
            ->whereAppear(1)
            ->whereSidebarLink(1)
            ->orderBy('ordering', 'asc')
            ->get();
    }
    
}

Permission 模型与 Role 模型具有相同的三个属性

  • name — 权限的唯一名称，用于在应用层查找权限信息。例如：“create-post”、“edit-user”、“post-payment”、“mailing-list-subscribe”。
  • display_name —— 权限的易读名称。不一定唯一，为可选项。例如：“创建帖子”、“编辑用户”、“帖子支付”、“订阅邮件列表”。
  • description —— 对权限的更详细解释。

一般来说，可以将最后两个属性以句子的形式来理解：“权限 display_name 允许用户 description。”

用户

接下来，在现有的 User 模型中使用 EntrustUserWithPermissionsTrait 特性。例如

<?php

use Mindscms\Entrust\Traits\EntrustUserWithPermissionsTrait;

class User extends Authenticatable
{
    use EntrustUserWithPermissionsTrait; // add this trait to your user model

    ...
}

这将为 User 模型启用与 Role 的关系，并添加以下方法 roles()、hasRole($name)、withRole($name)、can($permission) 和 ability($roles, $permissions, $options)。

用户权限

在 app/UserPermissions.php 中创建一个 UserPermissions 模型，以下是一个示例

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class UserPermissions extends Model
{
    protected $guarded = [];

    public function permission()
    {
        return $this->belongsToMany(Permission::class, 'id', 'permission_id');
    }

    public function user()
    {
        return $this->belongsToMany(User::class, 'id', 'user_id');
    }
}

别忘了运行 composer autoload

composer dumpautoload

现在你就可以开始了。

软删除

默认迁移利用了枢轴表中的 onDelete('cascade') 子句，在删除父记录时删除关系。如果由于某些原因你无法在数据库中使用级联删除，则 EntrustRole 和 EntrustPermission 类以及 HasRole 特性包含事件监听器以手动删除相关枢轴表中的记录。出于避免意外删除数据的目的，事件监听器将在模型使用软删除的情况下 不会 删除枢轴数据。然而，由于 Laravel 事件监听器的限制，无法区分对 delete() 的调用与对 forceDelete() 的调用。因此，在强制删除模型之前，你必须手动删除任何关系数据（除非你的枢轴表使用级联删除）。例如

$role = Role::findOrFail(1); // Pull back a given role

// Regular Delete
$role->delete(); // This will work no matter what

// Force Delete
$role->users()->sync([]); // Delete relationship data
$role->perms()->sync([]); // Delete relationship data

$role->forceDelete(); // Now force delete will work regardless of whether the pivot table has cascading delete

使用方法

概念

让我们先创建以下 Role 和 Permission

$owner = new Role();
$owner->name         = 'owner';
$owner->display_name = 'Project Owner'; // optional
$owner->description  = 'User is the owner of a given project'; // optional
$owner->save();

$admin = new Role();
$admin->name         = 'admin';
$admin->display_name = 'User Administrator'; // optional
$admin->description  = 'User is allowed to manage and edit other users'; // optional
$admin->save();

现在，创建好这两个角色后，我们可以将它们分配给用户。多亏了 HasRole 特性，这个过程非常简单

$user = User::where('username', '=', 'michele')->first();

// role attach alias
$user->attachRole($admin); // parameter can be an Role object, array, or id

// or eloquent's original technique
$user->roles()->attach($admin->id); // id only

现在我们只需要将这些权限添加到这些角色中

$createPost = new Permission();
$createPost->name         = 'create-post';
$createPost->display_name = 'Create Posts'; // optional
// Allow a user to...
$createPost->description  = 'create new blog posts'; // optional
$createPost->save();

$editUser = new Permission();
$editUser->name         = 'edit-user';
$editUser->display_name = 'Edit Users'; // optional
// Allow a user to...
$editUser->description  = 'edit existing users'; // optional
$editUser->save();

$admin->attachPermission($createPost);
// equivalent to $admin->perms()->sync(array($createPost->id));

$owner->attachPermissions(array($createPost, $editUser));
// equivalent to $owner->perms()->sync(array($createPost->id, $editUser->id));

检查角色和权限

现在我们可以通过简单的操作来检查角色和权限

$user->hasRole('owner');   // false
$user->hasRole('admin');   // true
$user->can('edit-user');   // false
$user->can('create-post'); // true

hasRole() 和 can() 都可以接收一个角色 & 权限数组来检查

$user->hasRole(['owner', 'admin']);       // true
$user->can(['edit-user', 'create-post']); // true

默认情况下，如果用户的角色或权限中存在任何项，则方法将返回 true。将 true 作为第二个参数传递将指示该方法检查所有项目

$user->hasRole(['owner', 'admin']);             // true
$user->hasRole(['owner', 'admin'], true);       // false, user does not have admin role
$user->can(['edit-user', 'create-post']);       // true
$user->can(['edit-user', 'create-post'], true); // false, user does not have edit-user permission

可以为每个 User 拥有任意多的 Role，反之亦然。

Entrust 类为当前登录用户提供了对 can() 和 hasRole() 的快捷方式

Entrust::hasRole('role-name');
Entrust::can('permission-name');

// is identical to

Auth::user()->hasRole('role-name');
Auth::user()->can('permission-name');

您还可以使用占位符（通配符）通过执行来检查任何匹配的权限

// match any admin permission
$user->can("admin.*"); // true

// match any permission about users
$user->can("*_users"); // true

要按特定角色筛选用户，可以使用 withRole() 范围，例如检索所有管理员

$admins = User::withRole('admin')->get();
// or maybe with a relationsship
$company->users()->withRole('admin')->get();

用户能力

可以使用强大的 ability 函数进行更高级的检查。它接受三个参数（角色、权限、选项）

  • roles 是要检查的一组角色。
  • permissions 是要检查的一组权限。

角色或权限变量可以是逗号分隔的字符串或数组

$user->ability(array('admin', 'owner'), array('create-post', 'edit-user'));

// or

$user->ability('admin,owner', 'create-post,edit-user');

这将检查用户是否具有提供的任何角色和权限。在这种情况下，它将返回 true，因为用户是 admin 并且有 create-post 权限。

第三个参数是选项数组

$options = array(
    'validate_all' => true | false (Default: false),
    'return_type'  => boolean | array | both (Default: boolean)
);
  • validate_all 是一个布尔标志，用于设置是否检查所有值都为 true，或者如果至少匹配一个角色或权限就返回 true。
  • return_type 指定是否返回布尔值、检查值的数组，或同时返回两者。

以下是一个示例输出

$options = array(
    'validate_all' => true,
    'return_type' => 'both'
);

list($validate, $allValidations) = $user->ability(
    array('admin', 'owner'),
    array('create-post', 'edit-user'),
    $options
);

var_dump($validate);
// bool(false)

var_dump($allValidations);
// array(4) {
//     ['role'] => bool(true)
//     ['role_2'] => bool(false)
//     ['create-post'] => bool(true)
//     ['edit-user'] => bool(false)
// }

Entrust 类为当前登录用户提供了对 ability() 的快捷方式

Entrust::ability('admin,owner', 'create-post,edit-user');

// is identical to

Auth::user()->ability('admin,owner', 'create-post,edit-user');

Blade 模板

在您的 Blade 模板中可用三个指令。您提供给指令参数的内容将被直接传递给相应的 Entrust 函数。

@role('admin')
    <p>This is visible to users with the admin role. Gets translated to 
    \Entrust::role('admin')</p>
@endrole

@permission('manage-admins')
    <p>This is visible to users with the given permissions. Gets translated to 
    \Entrust::can('manage-admins'). The @can directive is already taken by core 
    laravel authorization package, hence the @permission directive instead.</p>
@endpermission

@ability('admin,owner', 'create-post,edit-user')
    <p>This is visible to users with the given abilities. Gets translated to 
    \Entrust::ability('admin,owner', 'create-post,edit-user')</p>
@endability

中间件

您可以使用中间件根据权限或角色过滤路由和路由组

Route::group(['prefix' => 'admin', 'middleware' => ['role:admin']], function() {
    Route::get('/', 'AdminController@welcome');
    Route::get('/manage', ['middleware' => ['permission:manage-admins'], 'uses' => 'AdminController@manageAdmins']);
});

可以使用管道符号作为OR运算符

'middleware' => ['role:admin|root']

要模拟AND功能，只需使用多个中间件实例

'middleware' => ['role:owner', 'role:writer']

对于更复杂的情况，请使用接受3个参数的ability中间件：角色、权限、validate_all

'middleware' => ['ability:admin|owner,create-post|edit-user,true']

简短语法路由过滤器

要在app/Http/routes.php中根据权限或角色过滤路由，可以调用以下内容

// only users with roles that have the 'manage_posts' permission will be able to access any route within admin/post
Entrust::routeNeedsPermission('admin/post*', 'create-post');

// only owners will have access to routes within admin/advanced
Entrust::routeNeedsRole('admin/advanced*', 'owner');

// optionally the second parameter can be an array of permissions or roles
// user would need to match all roles or permissions for that route
Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment'));
Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'));

这两种方法都接受第三个参数。如果第三个参数为null，则禁止访问的返回将是App::abort(403)，否则将返回第三个参数。因此，您可以像这样使用它

Entrust::routeNeedsRole('admin/advanced*', 'owner', Redirect::to('/home'));

此外，这两种方法还接受第四个参数。默认值为true，并检查所有提供的角色/权限。如果将其设置为false，则函数仅在所有角色/权限对该用户失败时才会失败。这对于需要允许多个组访问的行政应用程序很有用。

// if a user has 'create-post', 'edit-comment', or both they will have access
Entrust::routeNeedsPermission('admin/post*', array('create-post', 'edit-comment'), null, false);

// if a user is a member of 'owner', 'writer', or both they will have access
Entrust::routeNeedsRole('admin/advanced*', array('owner','writer'), null, false);

// if a user is a member of 'owner', 'writer', or both, or user has 'create-post', 'edit-comment' they will have access
// if the 4th parameter is true then the user must be a member of Role and must have Permission
Entrust::routeNeedsRoleOrPermission(
    'admin/advanced*',
    array('owner', 'writer'),
    array('create-post', 'edit-comment'),
    null,
    false
);

路由过滤器

可以使用Entrust的can和hasRole方法从Facade中直接在过滤器中使用Entrust角色/权限

Route::filter('manage_posts', function()
{
    // check the current user
    if (!Entrust::can('create-post')) {
        return Redirect::to('admin');
    }
});

// only users with roles that have the 'manage_posts' permission will be able to access any admin/post route
Route::when('admin/post*', 'manage_posts');

使用过滤器检查角色

Route::filter('owner_role', function()
{
    // check the current user
    if (!Entrust::hasRole('Owner')) {
        App::abort(403);
    }
});

// only owners will have access to routes within admin/advanced
Route::when('admin/advanced*', 'owner_role');

如您所见，Entrust::hasRole()和Entrust::can()检查用户是否已登录，然后检查用户是否具有该角色或权限。如果用户未登录，则返回值也将是false。

故障排除

如果在执行迁移时遇到类似以下错误的错误

SQLSTATE[HY000]: General error: 1005 Can't create table 'laravelbootstrapstarter.#sql-42c_f8' (errno: 150)
    (SQL: alter table `role_user` add constraint role_user_user_id_foreign foreign key (`user_id`)
    references `users` (`id`)) (Bindings: array ())

那么很可能是您的用户表中的id列与role_user中的user_id列不匹配。请确保两个都是INT(10)。

当尝试使用EntrustUserTrait方法时，遇到类似以下错误的错误

Class name must be a valid object or a string

那么可能您没有发布Entrust资产或发布时出了问题。首先，请检查您的config目录中是否有entrust.php文件。如果没有，则尝试运行php artisan vendor:publish，如果它没有出现，则手动将/vendor/Mindscms/entrust/src/config/config.php文件复制到您的配置目录中，并将其重命名为entrust.php。

如果您的应用程序使用自定义命名空间，则需要告诉Entrust您的permission和role模型的位置，您可以通过编辑config/entrust.php中的配置文件来完成此操作

'role' => 'Custom\Namespace\Role'

'permission' => 'Custom\Namespace\permission'

许可

Entrust是免费软件，根据MIT许可条款发布。

贡献指南

支持遵循PSR-1和PSR-4 PHP编码标准，以及语义版本控制。

请在问题页面报告您发现的任何问题。
欢迎提交拉取请求。