README

删除 VENDOR/GITHUB2580

laravel-permission

spatie laravel permission

将用户与权限和角色关联

赞助商

• 安装
• 用法
  • 使用 "直接" 权限
  • 通过角色使用权限
  • 使用 Blade 指令
  • 使用多个守卫
  • 使用中间件
  • 使用 artisan 命令
• 单元测试
• 数据库播种
• 扩展
• 缓存

此包允许您在数据库中管理用户权限和角色。

一旦安装，您就可以执行如下操作

// Adding permissions to a user
$user->givePermissionTo('edit articles');

// Adding permissions via a role
$user->assignRole('writer');

$role->givePermissionTo('edit articles');

如果您使用多个守卫，我们也有相应的支持。每个守卫都将有自己的权限和角色集合，可以分配给守卫的用户。有关详细信息，请参阅README中的使用多个守卫部分。

因为所有权限都将注册在Laravel的gate上，您可以使用Laravel的默认can函数测试用户是否有权限

$user->can('edit articles');

Spatie是比利时安特卫普的一家网页设计公司。您可以在我们的网站上找到所有开源项目的概述在这里。

安装

• Laravel
• Lumen

Laravel

此包可用于Laravel 5.4或更高版本。如果您使用的是较旧版本的Laravel，请参阅此包的v1分支。

您可以通过composer安装此包

composer require github2018/permission
//composer require spatie/laravel-permission

在Laravel 5.5中，服务提供程序将自动注册。在框架的较旧版本中，只需将服务提供程序添加到config/app.php文件中即可

'providers' => [
    // ...
    Spatie\Permission\PermissionServiceProvider::class,
];

您可以使用以下命令发布迁移

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="migrations"

如果您使用UUID或GUID作为您的User模型，您可以更新create_permission_tables.php迁移，将$table->unsignedBigInteger($columnNames['model_morph_key'])替换为$table->uuid($columnNames['model_morph_key'])。为了保持一致性，您还可以更新包配置文件，使用model_uuid列名而不是默认的model_id列名。

迁移发布后，您可以运行迁移来创建角色和权限表

php artisan migrate

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"

发布后，配置文件config/permission.php包含

return [

    'models' => [

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * Eloquent model should be used to retrieve your permissions. Of course, it
         * is often just the "Permission" model but you may use whatever you like.
         *
         * The model you want to use as a Permission model needs to implement the
         * `Spatie\Permission\Contracts\Permission` contract.
         */

        'permission' => Spatie\Permission\Models\Permission::class,

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * Eloquent model should be used to retrieve your roles. Of course, it
         * is often just the "Role" model but you may use whatever you like.
         *
         * The model you want to use as a Role model needs to implement the
         * `Spatie\Permission\Contracts\Role` contract.
         */

        'role' => Spatie\Permission\Models\Role::class,

    ],

    'table_names' => [

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * table should be used to retrieve your roles. We have chosen a basic
         * default value but you may easily change it to any table you like.
         */

        'roles' => 'roles',

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * table should be used to retrieve your permissions. We have chosen a basic
         * default value but you may easily change it to any table you like.
         */

        'permissions' => 'permissions',

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * table should be used to retrieve your models permissions. We have chosen a
         * basic default value but you may easily change it to any table you like.
         */

        'model_has_permissions' => 'model_has_permissions',

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * table should be used to retrieve your models roles. We have chosen a
         * basic default value but you may easily change it to any table you like.
         */

        'model_has_roles' => 'model_has_roles',

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * table should be used to retrieve your roles permissions. We have chosen a
         * basic default value but you may easily change it to any table you like.
         */

        'role_has_permissions' => 'role_has_permissions',
    ],

    'column_names' => [

        /*
         * Change this if you want to name the related model primary key other than 
         * `model_id`.
         *
         * For example, this would be nice if your primary keys are all UUIDs. In 
         * that case, name this `model_uuid`.
         */
        'model_morph_key' => 'model_id',
    ],

    /*
     * By default all permissions will be cached for 24 hours unless a permission or
     * role is updated. Then the cache will be flushed immediately.
     */

    'cache_expiration_time' => 60 * 24,
    
    /*
     * When set to true, the required permission/role names are added to the exception
     * message. This could be considered an information leak in some contexts, so
     * the default setting is false here for optimum safety.
     */

    'display_permission_in_exception' => false,
];

Lumen

您可以通过Composer安装此包

composer require spatie/laravel-permission

复制所需的文件

cp vendor/spatie/laravel-permission/config/permission.php config/permission.php
cp vendor/spatie/laravel-permission/database/migrations/create_permission_tables.php.stub database/migrations/2018_01_01_000000_create_permission_tables.php

您还需要在config/auth.php中创建另一个配置文件。从Laravel仓库获取它或运行以下命令

curl -Ls https://raw.githubusercontent.com/laravel/lumen-framework/5.5/config/auth.php -o config/auth.php

然后，在bootstrap/app.php中注册中间件

$app->routeMiddleware([
    'auth'       => App\Http\Middleware\Authenticate::class,
    'permission' => Spatie\Permission\Middlewares\PermissionMiddleware::class,
    'role'       => Spatie\Permission\Middlewares\RoleMiddleware::class,
]);

以及配置和服务提供程序

$app->configure('permission');
$app->register(Spatie\Permission\PermissionServiceProvider::class);

现在，运行您的迁移

php artisan migrate

用法

首先，将Spatie\Permission\Traits\HasRoles特性添加到您的User模型中

use Illuminate\Foundation\Auth\User as Authenticatable;
use Spatie\Permission\Traits\HasRoles;

class User extends Authenticatable
{
    use HasRoles;

    // ...
}

• 请注意，如果您需要在其他模型（如Page）中使用HasRoles特性，您也需要将protected $guard_name = 'web';添加到该模型，否则您会得到错误

use Illuminate\Database\Eloquent\Model;
use Spatie\Permission\Traits\HasRoles;

class Page extends Model
{
   use HasRoles;

   protected $guard_name = 'web'; // or whatever guard you want to use

   // ...
}

此包允许用户与权限和角色关联。每个角色都与多个权限相关联。《角色》和《权限》都是常规的Eloquent模型。它们需要一个name，可以像这样创建

use Spatie\Permission\Models\Role;
use Spatie\Permission\Models\Permission;

$role = Role::create(['name' => 'writer']);
$permission = Permission::create(['name' => 'edit articles']);

可以使用以下方法之一将权限分配给角色

$role->givePermissionTo($permission);
$permission->assignRole($role);

可以使用以下方法之一将多个权限同步到角色

$role->syncPermissions($permissions);
$permission->syncRoles($roles);

可以使用以下方法之一从角色中删除权限

$role->revokePermissionTo($permission);
$permission->removeRole($role);

如果使用多个守卫，还需要设置 guard_name 属性。请参阅关于使用多个守卫 的readme部分。

HasRoles 特性为您的模型添加了Eloquent关系，可以直接访问或用作基础查询

// get a list of all permissions directly assigned to the user
$permissions = $user->permissions;

// get all permissions for the user, either directly, or from roles, or from both
$permissions = $user->getDirectPermissions();
$permissions = $user->getPermissionsViaRoles();
$permissions = $user->getAllPermissions();

// get the names of the user's roles
$roles = $user->getRoleNames(); // Returns a collection

HasRoles 特性还为您模型的查询添加了 role 范围，以将查询范围到特定的角色或权限

$users = User::role('writer')->get(); // Returns only users with the role 'writer'

role 范围可以接受字符串、一个 \Spatie\Permission\Models\Role 对象或一个 \Illuminate\Support\Collection 对象。

同一特性还添加了一个范围，仅获取具有特定权限的用户。

$users = User::permission('edit articles')->get(); // Returns only users with the permission 'edit articles' (inherited or directly)

该范围可以接受字符串、一个 \Spatie\Permission\Models\Permission 对象或一个 \Illuminate\Support\Collection 对象。

使用“直接”权限（见下文以同时使用角色和权限）

可以将权限分配给任何用户

$user->givePermissionTo('edit articles');

// You can also give multiple permission at once
$user->givePermissionTo('edit articles', 'delete articles');

// You may also pass an array
$user->givePermissionTo(['edit articles', 'delete articles']);

可以从用户中撤销权限

$user->revokePermissionTo('edit articles');

或一次性撤销和添加新权限

$user->syncPermissions(['edit articles', 'delete articles']);

您可以测试用户是否具有权限

$user->hasPermissionTo('edit articles');

或传递表示权限ID的整数

$user->hasPermissionTo('1');
$user->hasPermissionTo(Permission::find(1)->id);
$user->hasPermissionTo($somePermission->id);

您可以测试用户是否具有数组中任何权限

$user->hasAnyPermission(['edit articles', 'publish articles', 'unpublish articles']);

...或用户是否具有数组中所有权限

$user->hasAllPermissions(['edit articles', 'publish articles', 'unpublish articles']);

您也可以传递整数以通过权限ID查找

$user->hasAnyPermission(['edit articles', 1, 5]);

保存的权限将与默认守卫的 Illuminate\Auth\Access\Gate 类注册。因此，您可以使用Laravel的默认 can 函数测试用户是否具有权限

$user->can('edit articles');

通过角色使用权限

可以将角色分配给任何用户

$user->assignRole('writer');

// You can also assign multiple roles at once
$user->assignRole('writer', 'admin');
// or as an array
$user->assignRole(['writer', 'admin']);

可以从用户中移除角色

$user->removeRole('writer');

角色也可以同步

// All current roles will be removed from the user and replaced by the array given
$user->syncRoles(['writer', 'admin']);

您可以确定用户是否具有特定角色

$user->hasRole('writer');

您还可以确定用户是否具有给定列表中的任何角色

$user->hasAnyRole(Role::all());

您还可以确定用户是否具有给定列表中的所有角色

$user->hasAllRoles(Role::all());

assignRole、hasRole、hasAnyRole、hasAllRoles 和 removeRole 函数可以接受字符串、一个 \Spatie\Permission\Models\Role 对象或一个 \Illuminate\Support\Collection 对象。

可以将权限分配给角色

$role->givePermissionTo('edit articles');

您可以确定角色是否具有特定权限

$role->hasPermissionTo('edit articles');

可以从角色中撤销权限

$role->revokePermissionTo('edit articles');

givePermissionTo 和 revokePermissionTo 函数可以接受字符串或一个 Spatie\Permission\Models\Permission 对象。

权限会从角色自动继承。此外，还可以为用户分配单个权限。例如

$role = Role::findByName('writer');
$role->givePermissionTo('edit articles');

$user->assignRole('writer');

$user->givePermissionTo('delete articles');

在上面的示例中，一个角色被赋予了编辑文章的权限，并将此角色分配给了一个用户。现在该用户可以编辑文章，并且还可以删除文章。'删除文章'的权限是用户的直接权限，因为它直接分配给了他们。当我们调用 $user->hasDirectPermission('delete articles') 时，它返回 true，但对于 $user->hasDirectPermission('edit articles') 返回 false。

此方法在构建用于设置应用程序中角色和用户权限的表单时很有用，如果想要限制或更改用户的角色继承权限，即只允许更改用户的直接权限。

您可以列出所有这些权限

// Direct permissions
$user->getDirectPermissions() // Or $user->permissions;

// Permissions inherited from the user's roles
$user->getPermissionsViaRoles();

// All permissions which apply on the user (inherited and direct)
$user->getAllPermissions();

所有这些响应都是 Spatie\Permission\Models\Permission 对象的集合。

如果我们遵循之前的例子，第一个响应将是一个具有删除文章权限的集合，第二个将是一个具有编辑文章权限的集合，第三个将包含两者。

使用 Blade 指令

此包还添加了Blade指令，用于验证当前登录用户是否拥有给定的角色列表中的所有角色或任意一个角色。

可选地，您可以将检查将执行的guard作为第二个参数传递。

Blade和Roles

测试特定角色

@role('writer')
    I am a writer!
@else
    I am not a writer...
@endrole

等同于

@hasrole('writer')
    I am a writer!
@else
    I am not a writer...
@endhasrole

测试列表中的任意角色

@hasanyrole($collectionOfRoles)
    I have one or more of these roles!
@else
    I have none of these roles...
@endhasanyrole
// or
@hasanyrole('writer|admin')
    I am either a writer or an admin or both!
@else
    I have none of these roles...
@endhasanyrole

测试所有角色

@hasallroles($collectionOfRoles)
    I have all of these roles!
@else
    I do not have all of these roles...
@endhasallroles
// or
@hasallroles('writer|admin')
    I am both a writer and an admin!
@else
    I do not have all of these roles...
@endhasallroles

或者，使用@unlessrole可以对单个角色进行相反的检查，如下所示

@unlessrole('does not have this role')
    I do not have the role
@else
    I do have the role
@endunlessrole

Blade和Permissions

此包不添加任何特定权限的Blade指令。相反，使用Laravel的本地@can指令来检查用户是否具有特定的权限。

@can('edit articles')
  //
@endcan

或

@if(auth()->user()->can('edit articles') && $some_other_condition)
  //
@endif

使用多个守卫

当使用默认的Laravel认证配置时，上述所有方法将自动生效，无需额外配置。

然而，当使用多个保护者时，它们将像命名空间一样作用于您的权限和角色。这意味着每个保护者都有自己的权限和角色集合，可以分配给其用户模型。

使用多个保护者使用权限和角色

在创建新的权限和角色时，如果没有指定保护者，则将使用auth.guards配置数组中定义的第一个保护者。当为特定的保护者创建权限和角色时，您必须在模型上指定其guard_name。

// Create a superadmin role for the admin users
$role = Role::create(['guard_name' => 'admin', 'name' => 'superadmin']);

// Define a `publish articles` permission for the admin users belonging to the admin guard
$permission = Permission::create(['guard_name' => 'admin', 'name' => 'publish articles']);

// Define a *different* `publish articles` permission for the regular users belonging to the web guard
$permission = Permission::create(['guard_name' => 'web', 'name' => 'publish articles']);

检查用户是否具有特定保护者的权限

$user->hasPermissionTo('publish articles', 'admin');

注意：在确定给定模型上的角色/权限是否有效时，它将按照以下顺序选择保护者：$guard_name属性的模型；通过提供者配置的配置中的保护者；配置数组中定义的第一个保护者；auth.defaults.guard配置。

注意：当使用除默认的web保护者之外的保护者时，您需要通过在模型中设置$guard_name属性来声明每个模型希望使用的guard_name。每个模型一个是最简单的。

注意：如果您的应用程序只使用单个保护者，但不是web，则将您的config/app.php中列出的保护者的顺序更改为主保护者，并将其作为定义的保护者的列表中的第一个。

将权限和角色分配给保护者用户

您可以使用与上述使用角色通过权限中描述的相同方法将权限和角色分配给用户。只需确保权限或角色上的guard_name与用户的保护者匹配，否则将抛出GuardDoesNotMatch异常。

使用多个保护者使用blade指令

您可以通过将希望使用的保护者作为指令的第二个参数传递来使用使用blade指令中列出的所有blade指令。

@role('super-admin', 'admin')
    I am a super-admin!
@else
    I am not a super-admin...
@endrole

使用中间件

此包包含RoleMiddleware、PermissionMiddleware和RoleOrPermissionMiddleware中间件。您可以将它们添加到您的app/Http/Kernel.php文件中。

protected $routeMiddleware = [
    // ...
    'role' => \Spatie\Permission\Middlewares\RoleMiddleware::class,
    'permission' => \Spatie\Permission\Middlewares\PermissionMiddleware::class,
    'role_or_permission' => \Spatie\Permission\Middlewares\RoleOrPermissionMiddleware::class,
];

然后您可以使用中间件规则保护您的路由

Route::group(['middleware' => ['role:super-admin']], function () {
    //
});

Route::group(['middleware' => ['permission:publish articles']], function () {
    //
});

Route::group(['middleware' => ['role:super-admin','permission:publish articles']], function () {
    //
});

Route::group(['middleware' => ['role_or_permission:super-admin']], function () {
    //
});

Route::group(['middleware' => ['role_or_permission:publish articles']], function () {
    //
});

或者，您可以使用|（管道）字符分隔多个角色或权限

Route::group(['middleware' => ['role:super-admin|writer']], function () {
    //
});

Route::group(['middleware' => ['permission:publish articles|edit articles']], function () {
    //
});

Route::group(['middleware' => ['role_or_permission:super-admin|edit articles']], function () {
    //
});

您可以通过在构造函数中设置所需的中间件以类似的方式保护您的控制器

public function __construct()
{
    $this->middleware(['role:super-admin','permission:publish articles|edit articles']);
}

public function __construct()
{
    $this->middleware(['role_or_permission:super-admin|edit articles']);
}

捕获角色和权限失败

如果您想覆盖默认的403响应，您可以使用应用程序的异常处理器捕获UnauthorizedException。

public function render($request, Exception $exception)
{
    if ($exception instanceof \Spatie\Permission\Exceptions\UnauthorizedException) {
        // Code here ...
    }

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

使用 artisan 命令

您可以使用 artisan 命令从控制台创建角色或权限。

php artisan permission:create-role writer

php artisan permission:create-permission "edit articles"

当为特定守卫创建权限/角色时，您可以指定守卫名称作为第二个参数。

php artisan permission:create-role writer web

php artisan permission:create-permission "edit articles" web

在创建角色时，您还可以同时创建和链接权限。

php artisan permission:create-role writer web "create articles|edit articles"

单元测试

在您的应用程序测试中，如果您在测试 setUp() 中不作为种子数据创建角色和权限，那么您可能会遇到鸡生蛋的困境，因为角色和权限没有被注册到守卫中（因为您的测试是在守卫注册之后创建的）。解决这个问题很简单：在您的测试中，只需添加一个 setUp() 指令来重新注册权限，如下所示

    public function setUp()
    {
        // first include all the normal setUp operations
        parent::setUp();

        // now re-register all the roles and permissions
        $this->app->make(\Spatie\Permission\PermissionRegistrar::class)->registerPermissions();
    }

数据库播种

关于数据库种子的两个注意事项

1. 在播种之前最好刷新 spatie.permission.cache，以避免缓存冲突错误。这可以通过 artisan 命令（见后面的故障排除：缓存部分）或直接在播种类中完成（见下面示例）。

2. 这是一个示例播种器，它清除缓存，创建权限，然后分配权限到角色

   use Illuminate\Database\Seeder;
   use Spatie\Permission\Models\Role;
   use Spatie\Permission\Models\Permission;
   
   class RolesAndPermissionsSeeder extends Seeder
   {
       public function run()
       {
           // Reset cached roles and permissions
           app()['cache']->forget('spatie.permission.cache');
   
           // create permissions
           Permission::create(['name' => 'edit articles']);
           Permission::create(['name' => 'delete articles']);
           Permission::create(['name' => 'publish articles']);
           Permission::create(['name' => 'unpublish articles']);
   
           // create roles and assign created permissions
   
           $role = Role::create(['name' => 'writer']);
           $role->givePermissionTo('edit articles');
   
           $role = Role::create(['name' => 'moderator']);
           $role->givePermissionTo(['publish articles', 'unpublish articles']);
   
           $role = Role::create(['name' => 'super-admin']);
           $role->givePermissionTo(Permission::all());
       }
   }

扩展

如果您需要扩展现有的 Role 或 Permission 模型，请注意

• 您的 Role 模型需要扩展 Spatie\Permission\Models\Role 模型
• 您的 Permission 模型需要扩展 Spatie\Permission\Models\Permission 模型

如果您需要替换现有的 Role 或 Permission 模型，您需要牢记以下事项

• 您的 Role 模型需要实现 Spatie\Permission\Contracts\Role 协议
• 您的 Permission 模型需要实现 Spatie\Permission\Contracts\Permission 协议

在这两种情况下，无论是扩展还是替换，您都需要在配置中指定您的新模型。为此，您必须在发布配置后更新配置文件中的 models.role 和 models.permission 值

php artisan vendor:publish --provider="Spatie\Permission\PermissionServiceProvider" --tag="config"

缓存

角色和权限数据被缓存以加快性能。

当您使用提供的用于操作角色和权限的方法时，缓存会自动为您重置

$user->assignRole('writer');
$user->removeRole('writer');
$user->syncRoles(params);
$role->givePermissionTo('edit articles');
$role->revokePermissionTo('edit articles');
$role->syncPermissions(params);
$permission->assignRole('writer');
$permission->removeRole('writer');
$permission->syncRoles(params);

然而，如果您直接在数据库中操作权限/角色数据而不是调用提供的方法，那么除非您手动重置缓存，否则您将看不到应用程序中的更改。

手动缓存重置

要手动重置此包的缓存，请运行

php artisan cache:forget spatie.permission.cache

缓存标识符

提示：如果您正在使用像 redis 或 memcached 这样的缓存服务，并且您的服务器上运行着其他网站，您可能会遇到缓存冲突。在 /config/cache.php 中设置您自己的缓存 prefix 是明智的，使其对每个应用程序都是唯一的。这将防止其他应用程序意外地使用/更改您的缓存数据。

需要 UI 吗？

该包不附带任何屏幕，您应该自己构建。以下是一些帮助您开始的选项

• @vyuldashev 的 Laravel Nova 包，用于管理角色和权限

• Caleb Oki 提供的关于构建权限 UI 的全面教程

• 如何为管理权限和角色创建 UI

测试

composer test

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG

贡献

有关详细信息，请参阅 CONTRIBUTING

安全

如果您发现任何安全相关的问题，请通过电子邮件 freek@spatie.be 而不是使用问题跟踪器。

明信片软件

您可以使用此包，但如果它进入您的生产环境，我们非常感谢您从您的家乡给我们寄一张明信片，说明您正在使用我们的哪个包。

我们的地址是：Spatie，Samberstraat 69D，2060 Antwerp，比利时。

我们将在公司网站上发布所有收到的明信片。请访问此处。

致谢

• Freek Van der Herten
• 所有贡献者

本包主要基于Jeffrey Way的精彩Laracasts课程，关于权限和角色。他的原始代码可以在GitHub上的此存储库中找到。

特别感谢Alex Vanderbist，他在v2版本中提供了很大帮助，并感谢Chris Brown长期支持我们维护这个包。

替代方案

• Povilas Korop在Laravel News的文章中列出了优秀的替代方案。在相同文章中，他还比较了laravel-permission与Joseph Silber的Bouncer，我们认为这也是一个优秀的包。
• ultraware/roles在功能上采用了一种略有不同的方法。

支持我们

Spatie是一家位于比利时安特卫普的网页设计公司。您可以在我们的网站上找到我们所有开源项目的概述。

您的业务依赖于我们的贡献吗？请联系我们，在Patreon上支持我们。所有承诺都将用于分配人力维护和新奇事物。

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。