README

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

这是专为 SCS UofT 定制的版本。

内容

安装
配置
- 用户与角色之间的关系
- 模型
  - 角色
  - 权限
  - 用户
  - 软删除
用法
故障排除
许可证
贡献指南
附加信息

安装

要安装 Laravel 5 Entrust，请运行

composer require scsuoft/entrust

打开您的 config/app.php 并将以下内容添加到 providers 数组中

Zizaco\Entrust\EntrustServiceProvider::class,

在相同的 config/app.php 中，将以下内容添加到 aliases 数组中

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

运行以下命令以发布包配置文件 config/entrust.php

php artisan vendor:publish

打开您的 config/auth.php 并向其中添加以下内容

'providers' => [
    'user' => [
        'driver' => 'shibboleth',
        'model' => 'App\YourModel',
        'table' => 'YourModelTable',
        'primaryKey' => 'm_staff_id',
    ],
],

如果您想使用中间件（需要 Laravel 5.1 或更高版本），您还需要将以下内容添加到 routeMiddleware 数组中

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

到 app/Http/Kernel.php 中的。

配置

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

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

用户与角色之间的关系

对于您本地的计算机设置，您应该在本地安装 MIMR2，如果您没有，您可能需要以下模拟表。现在生成 Entrust 迁移

php artisan entrust:migration

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

php artisan migrate

迁移后，将出现四个新表

m_access_group — 存储角色记录
m_permission — 存储权限记录
m_staff_access — 存储角色和用户之间的多对多关系
m_access_group_permission — 存储角色和权限之间的多对多关系

模型

角色

在 app/models/AccessGroup.php 中创建一个 Role 模型，如下所示

<?php namespace App;

use Zizaco\Entrust\EntrustRole;

class AccessGroup extends EntrustRole
{
}

权限

在 app/models/Permission.php 中创建一个 Permission 模型，如下所示

<?php namespace App;

use Zizaco\Entrust\EntrustPermission;

class Permission extends EntrustPermission
{
}

用户

接下来，在您的现有 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

用法

概念

让我们首先创建以下AccessGroup(role)和Permission。

$owner = new AccessGroup();
$owner->name         = 'owner';
$owner->save();

$admin = new AccessGroup();
$admin->name         = 'admin';
$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';
// Allow a user to...
$createPost->save();

$editUser = new Permission();
$editUser->name         = 'edit-user';
// Allow a user to...
$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' => ['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
);

路由过滤器

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

许可

Entrust 是在 MIT 许可证条款下分发的免费软件。

贡献指南

支持遵循 PSR-1 和 PSR-4 PHP 编码标准和语义化版本。

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

scsuoft / entrust

维护者

详细信息