ffogarasi/laravel-roles

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

维护者

详情

github.com/ffogarasi/laravel-roles

源代码

安装: 11

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 195

v1.0.2 2017-07-01 17:19 UTC

Requires

MIT 3d3e5cfcecab44ef8b89ea6fdd2898db537c169b

  • Fogarasi Ferenc <ffogarssi.woop@gmail.com>

aclrolespermissionslevels

This package is not auto-updated.

Last update: 2024-09-20 20:46:46 UTC

README

Total Downloads Latest Stable Version License

Laravel 5.4 中处理角色和权限的强大包。

安装

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

Composer

通过 Composer 拉取此包

composer require jeremykenedy/laravel-roles

服务提供者

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

'providers' => [

    ...

    /**
     * Third Party Service Providers...
     */
    jeremykenedy\LaravelRoles\RolesServiceProvider::class,

],

配置文件

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

php artisan vendor:publish --provider="jeremykenedy\LaravelRoles\RolesServiceProvider" --tag=config
php artisan vendor:publish --provider="jeremykenedy\LaravelRoles\RolesServiceProvider" --tag=migrations
php artisan vendor:publish --provider="jeremykenedy\LaravelRoles\RolesServiceProvider" --tag=seeds

HasRoleAndPermission 特性和契约

  1. 在您的 User 模型中包含 HasRoleAndPermission 特性和实现 HasRoleAndPermission 契约。以下是一个示例。

  2. 在 User 模型顶部包含 use jeremykenedy\LaravelRoles\Traits\HasRoleAndPermission;，并在命名空间下方实现 HasRoleAndPermission 特性。以下是一个示例。

示例 User 模型特性和契约

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Notifications\Notifiable;
use jeremykenedy\LaravelRoles\Traits\HasRoleAndPermission;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable;
    use HasRoleAndPermission;

    // rest of your model ...
}

迁移和种子

此包使用 Laravel 中的默认用户表。您应该已经拥有用户表的迁移文件，并且已迁移。

  1. 设置所需表

    php artisan migrate

  2. 更新 database\seeds\DatabaseSeeder.php 以包含种子。以下是一个示例。

<?php

use Illuminate\Database\Seeder;
use Illuminate\Database\Eloquent\Model;

class DatabaseSeeder extends Seeder
{
    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run()
    {
        Model::unguard();

            $this->call('PermissionsTableSeeder');
            $this->call('RolesTableSeeder');
            $this->call('ConnectRelationshipsSeeder');
            //$this->call('UsersTableSeeder');

        Model::reguard();
    }
}
  1. 使用角色对一组初始权限、角色和用户进行种子。
composer dump-autoload
php artisan db:seed

已种入角色

已种入权限

就这样！

从 Bican 角色迁移

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

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

用法

创建角色

use jeremykenedy\LaravelRoles\Models\Role;

$adminRole = Role::create([
    'name' => 'Admin',
    'slug' => 'admin',
    'description' => '',
    'level' => 5,
]);

$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

为新注册用户分配用户角色

您可以通过更新文件 app\Http\Controllers\Auth\RegisterController.php 来在用户注册时为用户分配角色。您可以通过包含所需的模型并修改 create() 方法来附加用户角色，从而在注册时为用户分配角色。以下是一个示例

  • 更新 app\Http\Controllers\Auth\RegisterController.php 的顶部
<?php

namespace App\Http\Controllers\Auth;

use App\User;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Validator;
use jeremykenedy\LaravelRoles\Models\Role;
use jeremykenedy\LaravelRoles\Models\Permission;
use Illuminate\Foundation\Auth\RegistersUsers;
  • 更新 app\Http\Controllers\Auth\RegisterController.php 的 create() 方法
    protected function create(array $data)
    {
        $user = User::create([
            'name' => $data['name'],
            'email' => $data['email'],
            'password' => bcrypt($data['password']),
        ]);

        $role = Role::where('name', '=', 'User')->first();  //choose the default role upon user creation.
        $user->attachRole($role);

        return $user;

    }

检查角色

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

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 对权限继承也有很大的影响。稍后关于这一点。

创建权限

由于采用了权限模型，这非常简单。

use jeremykenedy\LaravelRoles\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 jeremykenedy\LaravelRoles\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 jeremykenedy\LaravelRoles\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' => \jeremykenedy\LaravelRoles\Middleware\VerifyRole::class,
    'permission' => \jeremykenedy\LaravelRoles\Middleware\VerifyPermission::class,
    'level' => \jeremykenedy\LaravelRoles\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',
]);

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

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

    /**
     * Render an exception into an HTTP response.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Exception  $exception
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $exception)
    {

        $userLevelCheck = $exception instanceof \jeremykenedy\LaravelRoles\Exceptions\RoleDeniedException ||
            $exception instanceof \jeremykenedy\LaravelRoles\Exceptions\RoleDeniedException ||
            $exception instanceof \jeremykenedy\LaravelRoles\Exceptions\PermissionDeniedException ||
            $exception instanceof \jeremykenedy\LaravelRoles\Exceptions\LevelDeniedException;

        if ($userLevelCheck) {

            if ($request->expectsJson()) {
                return Response::json(array(
                    'error'    =>  403,
                    'message'   =>  'Unauthorized.'
                ), 403);
            }

            abort(403);
        }

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

配置文件

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

更多信息

有关更多信息，请查看HasRoleAndPermission合约。

信用通知

此包是romanbican/roles和ultraware/roles的改编。

许可证

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