README

基于thinkphp5框架，将用户与权限、角色相关联的工具

Requires

php: >=7.0
topthink/think-migration: ^2.0
thinkphp: >=5.0

Installing

$ composer require haojohnny/permission -vvv

Prepare

$ mkdir -p ./database/migrations

$ cp ./vendor/haojohnny/permission/config/permission.php ./config/
$ cp ./vendor/haojohnny/permission/database/migrations/20190531110604_create_permission_tables.php ./database/migrations/

在permission.php的配置文件中设置表名

'permissions' => 'permissions', # 权限表
'model_has_permissions' => 'model_has_permissions', # 用户权限表
'roles' => 'roles', # 角色表
'model_has_roles' => 'model_has_roles', # 用户角色表
'role_has_permissions' => 'role_has_permissions'  # 角色权限表

执行数据库迁移

$ php think migrate:create CreatePermissionTables

Usage

Roles和Permissions继承自\think\Model，使用create方法创建对应角色和权限

<?php

use Haojohnny\Permission\Models\Roles;
use Haojohnny\Permission\Models\Permissions;

$role = Roles::create(['name' => 'editor']);
$permission = Permissions::create(['name' => 'edit articles']);

而model中的create方法使用的是REPLACE INTO，因此推荐使用findOrCreate

<?php

use Haojohnny\Permission\Models\Roles;
use Haojohnny\Permission\Models\Permissions;

$role = Roles::findOrCreate(['name' => 'editor']);
$permission = Permissions::findOrCreate(['name' => 'permission1']);

在model中使用use HasRoles引入权限管理

<?php

namespace app\index\model;

use think\Model;
use Haojohnny\Permission\Traits\HasRoles;

class User extends Model
{
    use HasRoles;

    // ...
}

给用户添加权限

<?php

$user = User::get(1);
// 添加一个权限
$user->givePermission('permission1');

// 添加多个权限
$user->givePermission('permission1', 'permission2');

// 支持数组
$user->givePermission(['permission1', 'permission2']);
$user->givePermission(['permission1', 'permission2'], ['pemission3', 'permission4']);

// 支持字符串和数组混合
$user->givePermission('permission1', ['permission2', 'permission3']);

撤销用户权限

<?php

$user = User::get(1);
// 撤销一个权限
$user->revokePermission('permission1');

// 也可以像权限管理那样支持字符串和数组及两种混合形式。
$user->revokePermission('permission1', ['permission2', 'permission2']);

为角色分配权限，撤销权限

HasRoles中使用了use HasPermissions，因此可以使用givePermission和revokePermission方法

<?php
use Haojohnny\Permission\Models\Roles;

$role = Roles::create(['name' => 'editor']);

// 为角色添加权限
$role->givePermission('permission1');
$role->givePermission('permission1', ['permission2', 'permission2']);

// 为角色撤销权限
$role->revokePermission('permission1', ['permission2', 'permission2']);

注意：角色权限和直接权限是相互独立的。

给用户为分配角色

<?php

$user = User::get(1);
// 分配一个角色
$user->assignRole('editor');

// 也支持字符串和数组及两种混合形式。
$user->assignRole('editor1'，['editor2', 'editor3']);

给用户撤销角色

<?php

$user = User::get(1);
// 撤销一个角色
$user->revokeRole('editor');

// 也支持字符串和数组及两种混合形式。
$user->revokeRole('editor1', ['editor2', 'editor3']);

权限判断

<?php

$user = User::get(1);
$user->hasPermission('permission1');

角色判断

<?php
$user = User::get(1);
$user->hasRole('editor1');

TODO

Contributing

You can contribute in one of three ways:

File bug reports using the issue tracker.
Answer questions or fix bugs on the issue tracker.
Contribute new features or update the wiki.

The code contribution process is not very formal. You just need to make sure that you follow the PSR-0, PSR-1, and PSR-2 coding guidelines. Any new code contributions must be accompanied by unit tests where applicable.

License

MIT

haojohnny / permission

Maintainers

Details