Laravel-permission（一個許可權管理的擴充套件包） 的使用

surest發表於2018-08-03
Laravel套件

前情: 學習laravel以來的第一篇文章，歡迎吐槽.....

什麼是多使用者角色

舉個例子，例如我們平常使用的論壇

  • 站長 ------ 擁有最高許可權，最主要的是能夠對使用者進行管理的許可權

  • 管理員 ----- 對一些文章的管理，不會造成對網站有較大的影響

  • vip ----- 對一些資源有下載許可權

  • 普通使用者 ---- 只能夠進行簡單的對自己文章的增刪改、評論等

  • 遊客 ---- 只能進行基本的瀏覽

建表

關係圖

  • roles ------- 角色資訊：站長等

  • permissions ------- 許可權資訊：管理內容等

  • model_has_roles ------- 模型對應角色 = 使用者對應的角色

  • role_has_permissions ------- 角色對應許可權 = 角色有什麼許可權

  • model_has_permissions ------- 模型對應許可權 = 使用者有許可權

我們來梳理一下關聯關係

許可權（permissions）與 角色（roles） ，一個 許可權 可能被多個 角色 擁有，一個 角色 可能有多個 許可權，關聯關係：多對多（role_has_permissions）

使用者 與 許可權 一對多（model_has_permissions）

使用者 與 角色 一對多（model_has_roles）

由次來說，關係明確了，當使用者有什麼角色 或者 有什麼許可權，即執行相應的操作

laravel-permission

laravel-permission 基於上面 的表情況，將使用者與許可權和角色相關聯

1. 安裝擴充套件包

通過 Composer 安裝：

$ composer require "spatie/laravel-permission:~2.7"

生成資料庫遷移檔案：

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

在migration目錄下可看到相關表資訊，執行資料庫遷移

php artisan migrate

生成配置資訊：

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

在User 模型下載入 

.....
use Spatie\Permission\Traits\HasRoles;  // use

class User extends Authenticatable
{

    use HasRoles;  // 載入角色相關資訊
    .....

建立角色 和使用者

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

.....
$role = Role::create(['name' => 'writer']);  // 建立角色
$permission = Permission::create(['name' => 'edit articles']);// 建立許可權

使用

為使用者新增許可權

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

為使用者新增角色

$user->assignRole('writer');

$user->assignRole(['writer', 'admin']);

給使用者刪除許可權

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

給角色新增許可權

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

為角色新增許可權

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

撤銷一個許可權 並且 新增一個新許可權

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

獲得當前使用者的角色集合

$user->getRoleNames();

將多個角色同步到許可權

$role->syncPermissions($permissions); //  @param array $permissions

$permission->syncRoles($roles);

從角色中刪除許可權

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

獲取當前的使用者的許可權列表

$permissions = $user->permissions;

獲取使用者的所有許可權，或者直接許可權 （odel_has_permissions），或者從角色獲取，或者從兩者獲取

$permissions = $user->getDirectPermissions();
$permissions = $user->getPermissionsViaRoles();
$permissions = $user->getAllPermissions();

獲取使用者的角色集合 collection

$roles = $user->getRoleNames(); // Returns a collection

返回指定角色的使用者 | Returns only users with the role 'writer'

$users = User::role('writer')->get(); //

返回指定許可權的使用者

$users = User::permission('edit articles')->get();

使用者有什麼角色

$user->hasRole('writer');

驗證類

檢查是否有某個許可權

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

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

檢查是否有某個角色|或者列

$user->hasRole('writer');

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

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

傳遞id值進行判斷是否有某個許可權

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

是否擁有一組許可權

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

檢查一個角色是否有某些許可權 | 刪除某些許可權

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

$role->revokePermissionTo('edit articles'); // 刪除

模板使用

@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

------------------------

@can('edit articles') // 擁有某個許可權 可執行操作
//
@endcan

資料填充

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());
    }
}

提示：如果在資料庫許可權相關資訊表的修改，必須掉用清除 快取的方法

// 命令刪除
php artisan cache:forget spatie.permission.cache  

app()['cache']->forget('spatie.permission.cache');

部分來自於教程第二部分 , Laravel-permission github地址：https://github.com/spatie/laravel-permissi...

本作品採用《CC 協議》，轉載必須註明作者和本文連結

每天3小時...加油

相關文章