README

此包允许您在数据库中管理用户权限和角色。它受到了laravel-permission的启发。相同的代码，相同的一切，但它与laravel-mongodb兼容

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

// 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');

安装

Laravel 兼容性

Laravel

您可以通过Composer安装此包

composer require aptcreativedesign/laravel-permission-mongodb

您可以使用以下方式发布迁移

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

php artisan migrate

您可以使用以下方式发布配置文件

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

发布后，config/permission.php配置文件包含以下内容

return [

    'models' => [

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * Moloquent 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
         * `AptCD\Permission\Contracts\Permission` contract.
         */

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

        /*
         * When using the "HasRoles" trait from this package, we need to know which
         * Moloquent 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
         * `AptCD\Permission\Contracts\Role` contract.
         */

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

    ],

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

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

    /*
     * By default we'll make an entry in the application log when the permissions
     * could not be loaded. Normally this only occurs while installing the packages.
     *
     * If for some reason you want to disable that logging, set this value to false.
     */

    'log_registration_exception' => true,
    
    /*
     * 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 aptcreativedesign/laravel-permission-mongodb

复制所需文件

cp vendor/aptcreativedesign/laravel-permission-mongodb/config/permission.php config/permission.php
cp vendor/aptcreativedesign/laravel-permission-mongodb/database/migrations/create_permission_collections.php.stub database/migrations/2018_01_01_000000_create_permission_collections.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' => AptCD\Permission\Middlewares\PermissionMiddleware::class,
    'role'       => AptCD\Permission\Middlewares\RoleMiddleware::class,
]);

以及配置和服务提供者

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

现在，运行您的迁移

php artisan migrate

用法

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

use Illuminate\Auth\Authenticatable;
use Jenssegers\Mongodb\Eloquent\Model as Model;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use AptCD\Permission\Traits\HasRoles;

class User extends Model implements AuthenticatableContract, AuthorizableContract
{
    use Authenticatable, Authorizable, HasRoles;

    // ...
}

注意：如果您需要在另一个模型中使用HasRoles特质，例如Page，则还需要将该模型的protected $guard_name = 'web';也添加到该模型中，否则您将收到错误

use Jenssegers\Mongodb\Eloquent\Model as Model;
use AptCD\Permission\Traits\HasRoles;

class Page extends Model
{
    use HasRoles;

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

    // ...
}

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

use AptCD\Permission\Models\Role;
use AptCD\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 特性为您的模型添加 Moloquent 关联，可以直接访问或用作基础查询。

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

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

// get all permissions names
$permissions = $user->getPermissionNames(); // Returns a collection

// get a collection of all defined roles
$roles = $user->roles->pluck('name'); // Returns a collection

// get all role names
$roles = $user->getRoleNames() // Returns a collection;

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

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

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

使用“直接”权限

可以将权限授予任何具有 HasRoles 特性的用户。

$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 函数可以接受字符串、\AptCD\Permission\Models\Role 对象或 \Illuminate\Support\Collection 对象。

可以将权限授予角色。

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

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

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

可以从角色中撤销权限。

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

givePermissionTo 和 revokePermissionTo 函数可以接受字符串或 AptCD\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();

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

如果我们遵循前面的示例，第一个响应将包含 delete article 权限的集合，第二个将包含 edit article 权限的集合，第三个将包含两者。

使用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(Role::all())
    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(Role::all())
    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 身份验证配置中使用时，上述所有方法都将自动生效，无需额外配置。

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

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

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

// Create a superadmin role for the admin users

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

注意：在确定给定模型上的角色/权限是否有效时，它将按以下顺序选择守卫：首先，模型的 $guard_name 属性；然后是配置中的守卫（通过提供者）；然后是 auth.guards 配置数组中首先定义的守卫；然后是 auth.defaults.guard 配置。

将权限和角色分配给守卫用户

您可以使用与上述在通过角色使用权限中描述的相同方法来分配权限和角色。只需确保权限或角色上的 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' => \AptCD\Permission\Middlewares\RoleMiddleware::class,
    'permission' => \AptCD\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 () {
    //
});

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

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

您可以在 Laravel 异常处理程序中添加一些内容。

public function render($request, Exception $exception)
{
    if ($exception instanceof \AptCD\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() 中作为一部分播种角色和权限，那么您可能会遇到一个鸡生蛋的问题，其中角色和权限没有注册到门（因为您的测试在门注册完成后创建它们）。解决这个问题很简单：在您的测试中，只需添加一个 setUp() 指令来重新注册权限，如下所示

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

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

数据库播种

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

在播种之前最好清除 aptcd.permission.cache，以避免缓存冲突错误。这可以通过 Artisan 命令（见后面的故障排除：缓存部分）或直接在播种类中完成（见下面的示例）。
下面是一个示例播种器，它清除缓存，创建权限，然后分配权限到角色

use Illuminate\Database\Seeder;
use AptCD\Permission\Models\Role;
use AptCD\Permission\Models\Permission;

class RolesAndPermissionsSeeder extends Seeder
{
    public function run()
    {
        // Reset cached roles and permissions
        app()['cache']->forget('aptcd.permission.cache');
        
        // create permissions
        Permission::firstOrCreate(['name' => 'edit articles']);
        Permission::firstOrCreate(['name' => 'delete articles']);
        Permission::firstOrCreate(['name' => 'publish articles']);
        Permission::firstOrCreate(['name' => 'unpublish articles']);
        
        // create roles and assign existing permissions
        $role = Role::firstOrCreate(['name' => 'writer']);
        $role->givePermissionTo('edit articles');
        $role->givePermissionTo('delete articles');
        
        $role = Role::firstOrCreate(['name' => 'admin']);
        $role->givePermissionTo(['publish articles', 'unpublish articles']);
    }
}

扩展

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

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

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

您的 Role 模型需要实现 AptCD\Permission\Contracts\Role 接口
您的 Permission 模型需要实现 AptCD\Permission\Contracts\Permission 接口

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

php artisan vendor:publish --provider="AptCD\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 aptcd.permission.cache

缓存标识符

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

需要UI吗？

我们基于 laravel-permission 构建。该软件包本身不带任何屏幕，您需要自己构建。要开始，请查看这篇详细教程，作者是 Caleb Oki。

变更日志

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

测试

composer test

贡献

有关详细信息，请参阅贡献指南和行为准则。

安全

如果您发现任何安全问题，请通过电子邮件 aptcreativedesign@gmail.com 反馈，而不是使用问题跟踪器。

致谢

许可

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

aptcreativedesign / laravel-permission-mongodb

维护者

详细信息