proshore/entrust-lumen

此包提供了一种灵活的方式来为Lumen添加基于角色的权限

维护者

详细信息

github.com/proshore/entrust-lumen

源代码

安装次数: 22,287

依赖: 0

建议者: 0

安全: 0

星级: 12

关注者: 6

分支: 1,288

1.0.3 2018-03-19 05:05 UTC

Requires

Requires (Dev)

MIT 3451aa1830fd9de1782d5553bed1c4221a5ddd12

  • Proshore <babishshrestha.woop@gmail.com>
  • Saroj <saroj.woop@proshore.eu>

authaclpermissionrolesilluminatelumen

This package is auto-updated.

Last update: 2024-09-06 05:57:40 UTC

README

ENTRUST (Lumen 5 包)

Build Status Version License Total Downloads

Entrust-Lumen是一个修改后可以在Lumen下运行的项目。它是一种简洁且灵活的方式来为Lumen 5添加基于角色的权限。

内容

安装

  1. 为了安装Lumen 5 Entrust，只需将以下内容添加到您的composer.json中。然后运行composer update
"proshore/entrust-lumen":"1.0.2"

到您的composer.json中。然后运行composer install或composer update。

然后在您的bootstrap/app.php中添加

    // Register Service providers for Entrust
    $app->register(Zizaco\Entrust\EntrustServiceProvider::class);

在相同文件中找到带有

$app->withFacades();

的行，并添加以下门面

    $app->withFacades(true,
         [
             Zizaco\Entrust\EntrustFacade::class => 'Entrust',
         ]);

.

如果您打算使用中间件（需要Lumen 5.1或更高版本），您还需要在bootstrap/app.php中的$app->routeMiddleware方法数组中添加

    'role' => \Zizaco\Entrust\Middleware\EntrustRole::class,
    'permission' => \Zizaco\Entrust\Middleware\EntrustPermission::class,
    'ability' => \Zizaco\Entrust\Middleware\EntrustAbility::class,

到 $app->routeMiddleware 方法数组中。

配置

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

您还可以发布此包的配置以进一步自定义表名和模型命名空间。
只需使用php artisan vendor:publish，您的app/config目录中就会创建一个entrust.php文件。

注意：您可能需要安装lumen-vendor-publish来发布entrust.php文件。

为了将您的自定义配置集成到您的应用程序中，在bootstrap/app.php中插入以下行

    $app->configure('permission');

用户与角色之间的关系

现在生成Entrust迁移

php artisan entrust:migration

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

php artisan migrate

迁移后，将出现四个新表

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

模型

角色

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

<?php namespace App;

use Zizaco\Entrust\EntrustRole;

class Role extends EntrustRole
{
}

Role模型有三个主要属性

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

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

权限

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

<?php namespace App;

use Zizaco\Entrust\EntrustPermission;

class Permission extends EntrustPermission
{
}

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

  • name — 权限的唯一名称，用于在应用层中查找权限信息。例如："创建帖子"、"编辑用户"、"发布付款"、"订阅邮件列表"。
  • display_name — 权限的人类可读名称。不一定唯一且为可选。例如："创建帖子"、"编辑用户"、"发布付款"、"订阅邮件列表"。
  • description — 对权限的更详细说明。

一般来说，可以将其视为一个句子："权限 display_name 允许用户 description"。

用户

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

<?php

use Zizaco\Entrust\Traits\EntrustUserTrait;

class User extends Eloquent
{
    use EntrustUserTrait; // add this trait to your user model

    ...
}

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

别忘了导出 composer 自动加载

composer dump-autoload

你现在可以开始了。

软删除

默认迁移利用了枢轴表中的 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

用户能力

可以使用惊人的 ability 函数进行更复杂的检查。它接受三个参数（角色、权限、选项）

  • roles 是要检查的角色的集合。
  • permissions 是要检查的权限的集合。

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

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

// or

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

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

第三个参数是选项数组

$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');

中间件

可以使用中间件通过权限或角色来过滤路由和路由组

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' => ['permission:owner', 'permission:writer']

对于更复杂的情况，请使用接受3个参数的ability中间件：roles、permissions、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
);

路由过滤器

可以使用从Facade中的can和hasRole方法来在过滤器中使用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资产，或者发布过程中出现了问题。首先，检查你是否有app/config目录中的entrust.php文件。如果没有，那么尝试执行php artisan vendor:publish，如果它没有出现，则手动将/vendor/zizaco/entrust/src/config/config.php文件复制到你的配置目录中，并将其重命名为entrust.php。

许可

Entrust是遵循MIT许可条款免费分发的软件。

贡献指南

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

请在问题页面报告你发现的所有问题。
欢迎提交拉取请求。