yaoshanliang/entrust

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

维护者

详细信息

github.com/yaoshanliang/entrust

源代码

安装: 60

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

Forks: 1,289

1.7.0 2016-03-09 17:05 UTC

Requires

Requires (Dev)

MIT 1fa77fadfbc8840ee1e9a6ce483b39ba985f81d2

authacllaravelpermissionrolesilluminate

This package is not auto-updated.

Last update: 2024-09-14 17:48:26 UTC

README

Build Status Version License Total Downloads

SensioLabsInsight

Entrust 是一种简洁且灵活的方式，用于为 Laravel 5 添加基于角色的权限。

如果您正在寻找 Laravel 4 版本，请查看 分支 1.0。它包含 Laravel 4 的最新 entrust 版本。

内容

安装

为了安装 Laravel 5 Entrust，只需将以下内容添加到您的 composer.json 中。

"zizaco/entrust": "5.2.x-dev"

然后运行 composer install 或 composer update。

或者您也可以从终端运行 composer require 命令

composer require zizaco/entrust:5.2.x-dev

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

    Zizaco\Entrust\EntrustServiceProvider::class,

到 providers 数组中，并将

    'Entrust'   => Zizaco\Entrust\EntrustFacade::class,

添加到 aliases 数组中。

如果您打算使用 中间件（需要 Laravel 5.1 或更高版本），您还需要将

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

添加到 app/Http/Kernel.php 中的 routeMiddleware 数组中。

配置

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

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

用户与角色之间的关系

现在生成 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 内创建一个角色模型，使用以下示例

<?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 内创建一个权限模型，使用以下示例

<?php namespace App;

use Zizaco\Entrust\EntrustPermission;

class Permission extends EntrustPermission
{
}

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

  • name — 权限的唯一名称，用于在应用层中查找权限信息。例如：“create-post”，“edit-user”，“post-payment”，“mailing-list-subscribe”。
  • 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');

这将检查用户是否具有提供的任何角色和权限。在这种情况下，它将返回 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' => ['permission:owner', 'permission: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 的角色/权限，只需在 Facade 中使用 can 和 hasRole 方法即可。

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 编码标准，以及语义版本。

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