README

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

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

安装后，您可以执行类似以下操作

// 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 spatie/laravel-permission

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

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

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

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

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

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',
    ],

    /*
     * 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,
];

Lumen

您可以通过 Composer 安装此包

composer require spatie/laravel-permission

将 vendor/spatie/laravel-permission/config/permission.php 复制到 config/permission.php。同样，将 vendor/spatie/laravel-permission/database/migrations/create_permission_tables.php.stub 复制到 database/migrations/create_permission_tables.php（请确保从文件名末尾删除 ".stub"）。

在 bootstrap/app.php 中，在其他服务提供者下方添加以下代码

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

然后，运行您的迁移

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;

    // ...
}

• 注意，如果您需要将 HasRoles 特性用于其他模型，例如 Page，则还需要将该模型中的 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

   // ...
}

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

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

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

如果您使用多个守卫，则还需要设置 guard_name 属性。请参阅 README 中的使用多个守卫部分。

HasRoles 特性为你的模型添加 Eloquent 关联，可以直接访问或用作基本查询的基类。

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

// get all permissions inherited by the user via roles
$permissions = $user->getAllPermissions();

// get a collection of all defined 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');

...或测试用户是否具有多个权限。

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

保存的权限将注册到默认保护者的 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 和角色

测试特定角色

@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

Blade 和权限

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

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

或

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

使用多个守卫

当使用默认的 Laravel 身份验证配置时，上述所有方法都会直接生效，无需额外配置。

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

使用多个守卫的权限和角色

默认情况下，默认守卫（config('auth.defaults.guard')）将被用作新权限和角色的守卫。当为特定守卫创建权限和角色时，您必须在模型上指定其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与用户的守卫相匹配，否则将抛出GuardDoesNotMatch异常。

使用多个守卫的blade指令

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

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

使用中间件

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

protected $routeMiddleware = [
    // ...
    'role' => \Spatie\Permission\Middlewares\RoleMiddleware::class,
    'permission' => \Spatie\Permission\Middlewares\PermissionMiddleware::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:super-admin|writer']], function () {
    //
});

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

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

public function __construct()
{
    $this->middleware(['role:super-admin','permission:publish articles|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

单元测试

在您的应用程序测试中，如果您不是在测试的setUp()部分中播种角色和权限，那么您可能会遇到鸡生蛋的问题，因为角色和权限没有被注册到 gate（因为您的测试在 gate 注册之后创建它们）。解决这个问题很简单：在您的测试中，只需添加一个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 existing permissions
           $role = Role::create(['name' => 'writer']);
           $role->givePermissionTo('edit articles');
           $role->givePermissionTo('delete articles');
   
           $role = Role::create(['name' => 'admin']);
           $role->givePermissionTo('publish articles');
           $role->givePermissionTo('unpublish articles');
       }
   }

扩展

如果您需要扩展或替换现有的Role或Permission模型，您只需注意以下事项

• 您的Role模型需要实现Spatie\Permission\Contracts\Role合约
• 您的Permission模型需要实现Spatie\Permission\Contracts\Permission合约
• 您可以使用此命令发布配置

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

并更新models.role和models.permission的值

缓存

角色和权限数据被缓存以提高性能。

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

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

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

手动缓存重置

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

php artisan cache:forget spatie.permission.cache

缓存标识符

提示：如果您正在使用缓存服务，如redis或memcached，并且服务器上还有其他网站运行，可能会遇到缓存冲突。建议您在/config/cache.php中为每个应用程序设置唯一的缓存prefix，这样可以防止其他应用程序意外使用/更改您的缓存数据。

需要用户界面吗？

此包不包括任何默认界面，您需要自行构建。要开始，请查看这篇全面的教程，作者是Caleb Oki。

测试

composer test

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全

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

明信片软件

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

我们的地址是：Spatie，Samberstraat 69D，2060 安特卫普，比利时。

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

致谢

• Freek Van der Herten
• 所有贡献者

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

特别感谢Alex Vanderbist，他为v2版本提供了巨大帮助，并感谢Chris Brown长期以来对我们维护此包的支持。

资源

• 如何为管理权限和角色创建用户界面

替代方案

Povilas Korop在Laravel News的文章中列出了一些替代方案。在同一篇文章中，他比较了laravel-permission和Joseph Silber的Bouncer，我们认为这也是一个非常出色的包。

支持我们

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

您的业务依赖于我们的贡献吗？在Patreon上与我们联系并支持我们。所有承诺都将专门用于分配人力以维护和新奇的项目。

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。