README

用于处理 Laravel 5.3 中角色和权限的强大包

基于Bican/Roles 包。

那么有什么不同呢？

区别在于如何处理继承。在 Bican/Roles 中，权限是基于您的最高 角色级别 继承的。

而本包使用 parent_id 列表来允许角色相互继承。

这使得我们只能拉取继承自用户角色的权限，或者直接分配给用户的权限。

安装
使用方法
- 角色
- 权限
- 继承
- 实体检查
- Blade 扩展
- 中间件
配置文件
更多信息
许可证

安装

此包非常易于设置。只需几个步骤。

Composer

通过 Composer（文件 composer.json）将此包拉入。

{
    "require": {
        "php": ">=5.5.9",
        "laravel/framework": "5.1.*",
        "dcn/rbac": "~1.1.0"
    }
}

在您的终端中运行以下命令。

composer update

服务提供者

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

'providers' => [
    
    /*
     * Laravel Framework Service Providers...
     */
    Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
    Illuminate\Auth\AuthServiceProvider::class,
    ...
    
    /**
     * Third Party Service Providers...
     */
    DCN\RBAC\RBACServiceProvider::class,

],

配置文件和迁移

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

php artisan vendor:publish --provider="DCN\RBAC\RBACServiceProvider" --tag=config
php artisan vendor:publish --provider="DCN\RBAC\RBACServiceProvider" --tag=migrations

并运行迁移。

php artisan migrate

必须为 Laravel 自带的用户表创建迁移文件。

HasRoleAndPermission 特性和合约

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

use DCN\RBAC\Traits\HasRoleAndPermission;
use DCN\RBAC\Contracts\HasRoleAndPermission as HasRoleAndPermissionContract;

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

就这么多！

使用方法

创建角色

use DCN\RBAC\Models\Role;

$adminRole = Role::create([
    'name' => 'Admin',
    'slug' => 'admin',
    'description' => '', // optional
    'parent_id' => NULL, // optional, set to NULL 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

拒绝角色

要拒绝用户一个角色及其所有子角色，请参阅以下示例。

如果您计划使用此功能，我们建议您相应地规划您的角色。因为您很容易无意中锁定用户。

use App\User;

$role = Role::find($roleId);

$user = User::find($userId);
$user->attachRole($role, FALSE); // Deny this role, and all of its decedents to the user regardless of what has been assigned.

检查角色

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

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

您也可以这样做

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

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

if ($user->roleIs('admin|moderator')) { // or $user->roleIs('admin, moderator') and also $user->roleIs(['admin', 'moderator'])
    // if user has at least one role
}

if ($user->roleIs('admin|moderator', true)) { // or $user->roleIs('admin, moderator', true) and also $user->roleIs(['admin', 'moderator'], true)
    // if user has all roles
}

以及通配符

if ($user->roleIs('admin|moderator.*')) { // or $user->roleIs('admin, moderator.*') and also $user->roleIs(['admin', 'moderator.*'])
    //User has admin role, or a moderator role
}

创建权限

这要归功于 Permission 模型，非常简单。

use DCN\RBAC\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 DCN\RBAC\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();

拒绝权限

您可以拒绝用户一个权限，或者您也可以拒绝整个角色一个权限。

要这样做，在附加权限时只需传递第二个参数为 false。这将拒绝用户该权限，无论他们分配了什么。拒绝的权限优先于继承和授予的权限。

use App\User;
use DCN\RBAC\Models\Role;

$role = Role::find($roleId);
$role->attachPermission($createUsersPermission, FALSE); // Deny this permission to all users who have or inherit this role.

$user = User::find($userId);
$user->attachPermission($deleteUsersPermission, FALSE); // Deny this permission to this user regardless of what roles they are in.

检查权限

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

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

您可以用与角色相同的方式检查多个权限。

继承

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

分配给其他角色的父_id 的角色在用户分配或继承父角色时将自动继承。

以下是一个示例

您有5个管理组。管理员、店铺管理员、店铺库存管理员、博客管理员和博客作者。

管理员角色是店铺管理员角色以及博客管理员角色的父级。

而店铺管理员角色是店铺库存管理员角色的父级。

并且博客管理员角色是博客作者的父级。

这使得管理员角色可以继承店铺库存管理员角色和博客作者角色。

但店铺管理员角色只继承店铺库存管理员角色，

而博客管理员角色只继承博客作者角色。

另一个示例

在这里，admin继承了admin.user、admin.blog和blog.writer。

而admin.user不继承任何内容，admin.blog继承blog.writer。

没有内容继承development，而development也不继承任何内容。

实体检查

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

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

@permission('edit.articles') // @if(Auth::check() && Auth::user()->may('edit.articles'))
    // user can edit articles
@endpermission

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

@role('admin|moderator', 'all') // @if(Auth::check() && Auth::user()->roleIs('admin|moderator', 'all'))
    // user is admin and also moderator
@else
    // something else
@endrole

中间件

此包附带VerifyRole和VerifyPermission中间件。您必须将它们添加到您的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' => \DCN\RBAC\Middleware\VerifyRole::class,
    'permission' => \DCN\RBAC\Middleware\VerifyPermission::class,
];

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

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

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

如果出错，它将抛出\DCN\RBAC\Exception\RoleDeniedException或\DCN\RBAC\Exception\PermissionDeniedException异常。

您可以在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 \DCN\RBAC\Exceptions\RoleDeniedException) {
        // you can for example flash message, redirect...
        return redirect()->back();
    }

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

配置文件

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

许可证

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

我不在乎您如何使用它。

贡献

我老实说不知道我在做什么。如果您看到可以修复的东西，请在develop分支上提交一个pull request！。

adexaja / rbac

维护者

详情