README

处理 Laravel 5 中角色和权限的强大包（5.1 及 5.0）。

• 安装
  • Composer
  • 服务提供者
  • 配置文件和迁移
  • HasRoleAndPermission 特性和契约
• 使用
  • 创建角色
  • 附加和分离角色
  • 检查角色
  • 级别
  • 创建权限
  • 附加和分离权限
  • 检查权限
  • 权限继承
  • 实体检查
  • Blade 扩展
  • 中间件
• 配置文件
• 更多信息
• 许可协议

安装

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

Composer

通过 Composer (文件 composer.json) 引入此包。

{
    "require": {
        "php": ">=5.5.9",
        "laravel/framework": "5.1.*",
        "bican/roles": "2.1.*"
    }
}

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

在终端中运行此命令。

composer update

服务提供者

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

'providers' => [
    
    /*
     * Laravel Framework Service Providers...
     */
    Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
    Illuminate\Auth\AuthServiceProvider::class,
    ...
    
    /**
     * Third Party Service Providers...
     */
    Bican\Roles\RolesServiceProvider::class,

],

配置文件和迁移

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

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

并运行迁移。

php artisan migrate

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

HasRoleAndPermission 特性和契约

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

use Bican\Roles\Traits\HasRoleAndPermission;
use Bican\Roles\Contracts\HasRoleAndPermission as HasRoleAndPermissionContract;

class User extends Model implements AuthenticatableContract, CanResetPasswordContract, HasRoleAndPermissionContract
{
    use Authenticatable, CanResetPassword, HasRoleAndPermission;

就这些了！

使用

创建角色

use Bican\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

检查角色

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

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

您也可以这样做

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

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

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

    // if user has at least one role
}

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

    // if user has all roles
}

级别

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

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

如果用户具有多个角色，则方法 level 返回最高的一个。

等级对权限继承也有很大的影响。关于这一点稍后讨论。

创建权限

得益于Permission模型，创建权限非常简单。

use Bican\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 Bican\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

$user->detachPermission($deleteUsersPermission);
$user->detachAllPermissions();

检查权限

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

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

您可以像检查角色一样检查多个权限。您可以使用额外的方法，如canOne、canAll或hasPermission。

权限继承

等级较高的角色会从等级较低的角色继承权限。

这里有一个魔法的例子。

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

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

实体检查

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

use App\Article;
use Bican\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()->is('admin'))
    // user is admin
@endrole

@permission('edit.articles') // @if(Auth::check() && Auth::user()->can('edit.articles'))
    // user can edit articles
@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', 'all') // @if(Auth::check() && Auth::user()->is('admin|moderator', 'all'))
    // user is admin and also moderator
@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' => \Bican\Roles\Middleware\VerifyRole::class,
    'permission' => \Bican\Roles\Middleware\VerifyPermission::class,
    'level' => \Bican\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',
]);

如果出错，它会抛出\Bican\Roles\Exceptions\RoleDeniedException、\Bican\Roles\Exceptions\PermissionDeniedException或\Bican\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 \Bican\Roles\Exceptions\RoleDeniedException) {
        // you can for example flash message, redirect...
        return redirect()->back();
    }

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

配置文件

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

更多信息

有关更多信息，请参阅HasRoleAndPermission协议。

许可证

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