README

强大的Laravel角色和权限管理包。

• 安装
  • Composer
  • 服务提供者
  • 配置文件和迁移文件
  • HasRoleAndPermission 特性和契约
  • 从 Bican roles 迁移
• 使用方法
  • 创建角色
  • 附加、移除和同步角色
  • 检查角色
  • 级别
  • 创建权限
  • 附加、移除和同步权限
  • 检查权限
  • 权限继承
  • 实体检查
  • Blade 扩展
  • 中间件
• 配置文件
• 更多信息
• 许可证

安装

此包设置非常简单，只需几个步骤。

Composer

通过Composer引入此包

composer require 7Lab/laravel-roles

如果您仍在使用Laravel 5.0，必须引入版本1.7.*。

服务提供者

将包添加到config/app.php文件中的应用服务提供者中。

'providers' => [

    ...

    /**
     * Third Party Service Providers...
     */
    Ultraware\Roles\RolesServiceProvider::class,

],

配置文件和迁移文件

将包的配置文件和迁移文件发布到您的应用程序中。在终端中运行以下命令。

php artisan vendor:publish --provider="Ultraware\Roles\RolesServiceProvider" --tag=config
php artisan vendor:publish --provider="Ultraware\Roles\RolesServiceProvider" --tag=migrations

并运行迁移。

php artisan migrate

这使用Laravel中的默认用户表。您应该已经有用户表的迁移文件并已迁移。

HasRoleAndPermission 特性和契约

在您的User模型中包含HasRoleAndPermission特性和实现HasRoleAndPermission契约。

从bican roles迁移

如果您从bican/roles迁移到ultraware/roles，需要更新一些内容。

• 将所有对can、canOne和canAll的调用更改为hasPermission、hasOnePermission和hasAllPermissions。
• 将所有对is、isOne和isAll的调用更改为hasRole、hasOneRole和hasAllRoles。

使用方法

创建角色

use Ultraware\Roles\Models\Role;

$adminRole = Role::create([
    'name' => 'Admin',
    'slug' => 'admin',
    'description' => '', // optional
    'level' => 1, // optional, set to 1 by default
]);

$moderatorRole = Role::create([
    'name' => 'Forum Moderator',
    'slug' => 'forum.moderator',
]);

由于Slugable特性，如果您在slug参数中留下空格等错误，它将被自动替换为点，这是由于str_slug函数的缘故。

附加、移除和同步角色

这非常简单。您从数据库中检索一个用户并调用attachRole方法。在User和Role模型之间存在BelongsToMany关系。

use App\User;

$user = User::find($id);

$user->attachRole($adminRole); // you can pass whole object, or just an id
$user->detachRole($adminRole); // in case you want to detach role
$user->detachAllRoles(); // in case you want to detach all roles
$user->syncRoles($roles); // you can pass Eloquent collection, or just an array of ids

检查角色

现在您可以检查用户是否具有所需的角色。

if ($user->hasRole('admin')) { // you can pass an id or slug
    //
}

您也可以这样做

if ($user->isAdmin()) {
    //
}

当然，还有一种检查多个角色的方法

if ($user->hasRole(['admin', 'moderator'])) {
    /*
    | Or alternatively:
    | $user->hasRole('admin, moderator'), $user->hasRole('admin|moderator'),
    | $user->hasOneRole('admin, moderator'), $user->hasOneRole(['admin', 'moderator']), $user->hasOneRole('admin|moderator')
    */

    // The user has at least one of the roles
}

if ($user->hasRole(['admin', 'moderator'], true)) {
    /*
    | Or alternatively:
    | $user->hasRole('admin, moderator', true), $user->hasRole('admin|moderator', true),
    | $user->hasAllRoles('admin, moderator'), $user->hasAllRoles(['admin', 'moderator']), $user->hasAllRoles('admin|moderator')
    */

    // The user has all roles
}

级别

当您创建角色时，有一个可选参数 level。默认设置为 1，但您可以覆盖它，然后您可以这样做

if ($user->level() > 4) {
    //
}

如果用户具有多个角色，方法 level 返回最高级别。

Level 对权限继承也有很大影响。稍后介绍。

创建权限

多亏了 Permission 模型，这非常简单。

use Ultraware\Roles\Models\Permission;

$createUsersPermission = Permission::create([
    'name' => 'Create users',
    'slug' => 'create.users',
    'description' => '', // optional
]);

$deleteUsersPermission = Permission::create([
    'name' => 'Delete users',
    'slug' => 'delete.users',
]);

附加、分离和同步权限

您可以将权限附加到角色或直接附加到特定用户（当然也可以分离它们）。

use App\User;
use Ultraware\Roles\Models\Role;

$role = Role::find($roleId);
$role->attachPermission($createUsersPermission); // permission attached to a role

$user = User::find($userId);
$user->attachPermission($deleteUsersPermission); // permission attached to a user

$role->detachPermission($createUsersPermission); // in case you want to detach permission
$role->detachAllPermissions(); // in case you want to detach all permissions
$role->syncPermissions($permissions); // you can pass Eloquent collection, or just an array of ids

$user->detachPermission($deleteUsersPermission);
$user->detachAllPermissions();
$user->syncPermissions($permissions); // you can pass Eloquent collection, or just an array of ids

检查权限

if ($user->hasPermission('create.users')) { // you can pass an id or slug
    //
}

if ($user->canDeleteUsers()) {
    //
}

您可以使用与角色相同的方式检查多个权限。您可以使用额外的方法，如 hasOnePermission 或 hasAllPermissions。

权限继承

级别较高的角色从级别较低的角色的角色中继承权限。

这是一个 魔法 的示例

您有三个角色：user、moderator 和 admin。用户有阅读文章的权限，版主可以管理评论，管理员可以创建文章。用户级别为 1，版主级别为 2，管理员级别为 3。这意味着，版主和管理员也有阅读文章的权限，但管理员还可以管理评论。

如果您不希望在您的应用程序中启用权限继承功能，只需在创建角色时忽略 level 参数即可。

实体检查

假设您有一篇文章，并且您想编辑它。这篇文章属于一个用户（文章表中有一个 user_id 列）。

use App\Article;
use Ultraware\Roles\Models\Permission;

$editArticlesPermission = Permission::create([
    'name' => 'Edit articles',
    'slug' => 'edit.articles',
    'model' => 'App\Article',
]);

$user->attachPermission($editArticlesPermission);

$article = Article::find(1);

if ($user->allowed('edit.articles', $article)) { // $user->allowedEditArticles($article)
    //
}

此条件检查当前用户是否是文章的所有者。如果不是，它将查找我们之前创建的用户权限行。

if ($user->allowed('edit.articles', $article, false)) { // now owner check is disabled
    //
}

Blade 扩展

有四个 Blade 扩展。基本上，它是经典 if 语句的替代品。

@role('admin') // @if(Auth::check() && Auth::user()->hasRole('admin'))
    // user has admin role
@endrole

@permission('edit.articles') // @if(Auth::check() && Auth::user()->hasPermission('edit.articles'))
    // user has edit articles permissison
@endpermission

@level(2) // @if(Auth::check() && Auth::user()->level() >= 2)
    // user has level 2 or higher
@endlevel

@allowed('edit', $article) // @if(Auth::check() && Auth::user()->allowed('edit', $article))
    // show edit button
@endallowed

@role('admin|moderator', true) // @if(Auth::check() && Auth::user()->hasRole('admin|moderator', true))
    // user has admin and moderator role
@else
    // something else
@endrole

中间件

此包包含 VerifyRole、VerifyPermission 和 VerifyLevel 中间件。您必须在 app/Http/Kernel.php 文件中添加它们。

/**
 * The application's route middleware.
 *
 * @var array
 */
protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'role' => \Ultraware\Roles\Middleware\VerifyRole::class,
    'permission' => \Ultraware\Roles\Middleware\VerifyPermission::class,
    'level' => \Ultraware\Roles\Middleware\VerifyLevel::class,
];

现在您可以轻松保护您的路由。

$router->get('/example', [
    'as' => 'example',
    'middleware' => 'role:admin',
    'uses' => 'ExampleController@index',
]);

$router->post('/example', [
    'as' => 'example',
    'middleware' => 'permission:edit.articles',
    'uses' => 'ExampleController@index',
]);

$router->get('/example', [
    'as' => 'example',
    'middleware' => 'level:2', // level >= 2
    'uses' => 'ExampleController@index',
]);

如果出错，它将抛出 \Ultraware\Roles\Exceptions\RoleDeniedException、\Ultraware\Roles\Exceptions\PermissionDeniedException 或 \Ultraware\Roles\Exceptions\LevelDeniedException 异常。

您可以在 app/Exceptions/Handler.php 文件中捕获这些异常并执行任何您想做的事情。

/**
 * Render an exception into an HTTP response.
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Exception  $e
 * @return \Illuminate\Http\Response
 */
public function render($request, Exception $e)
{
    if ($e instanceof \Ultraware\Roles\Exceptions\RoleDeniedException) {
        // you can for example flash message, redirect...
        return redirect()->back();
    }

    return parent::render($request, $e);
}

配置文件

您可以更改模型的连接、slug 分隔符、模型路径，还有一个方便的假装功能。查看配置文件以获取更多信息。

更多信息

有关更多信息，请参阅HasRoleAndPermission 合同。

许可证

本软件包是免费软件，根据MIT许可证的条款分发。