2017 © Pedro Peláez
 

library rbac-laravel

A RBAC package for Laravel.

image

huang-yi/rbac-laravel

A RBAC package for Laravel.

  • Thursday, August 31, 2017
  • by coodeer
  • Repository
  • 2 Watchers
  • 24 Stars
  • 520 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 6 Forks
  • 1 Open issues
  • 6 Versions
  • 90 % Grown

The README.md

关于Rbac-Laravel

Rbac-Laravel是一个基于Laravel框架的RBAC拓展包,RBAC(Role-Based Access Control)是指基于角色的访问控制。该拓展包为Laravel框架提供了RBAC模型的实现,并且提供了诸多操作RBAC的便捷方法。, (*1)

版本信息

Rbac Laravel PHP
1.0.x 5.3.* >=5.6.4

安装方法

使用composer来快速安装拓展包:, (*2)

$ composer require huang-yi/rbac-laravel:1.0.*

或者编辑项目根目录的composer.json文件,在require属性里面添加一项:, (*3)

{
    "require": {
        "huang-yi/rbac-laravel": "1.0.*"
    }
}

然后执行composer update。, (*4)

配置信息

首先往Laravel应用中注册ServiceProvider,打开文件config/app.php,在providers中添加一项:, (*5)

[
    'providers' => [
        HuangYi\Rbac\RbacServiceProvider::class,
    ]
]

然后发布拓展包的配置文件,使用如下命令:, (*6)

$ php artisan vendor:publish

这时候config/目录下会出现rbac.php文件,该配置文件中有两个配置选项:, (*7)

第一个为connection属性,用于配置RBAC模块使用的数据库连接名。, (*8)

第二个为user属性,用于配置Laravel应用中使用的用户模型。默认为App\User。, (*9)

上述配置文件中所配置的user模型类必须use HuangYi\Rbac\RbacTrait:, (*10)

namespace App;

use HuangYi\Rbac\RbacTrait;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use RbacTrait;

}

数据迁移

执行以下命令创建拓展包必须依赖的数据库表:, (*11)

$ php artisan migrate

使用方法

Permission

1、权限有三个属性:nameslugdescription。, (*12)

2、创建一个权限:HuangYi\Rbac\Managers\PermissionManager::create(array $attributes), (*13)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$permission = $permissionManager->create([
    'name' => 'Create product',
    'slug' => 'product.create',
    'description' => 'Create a new product.',
]);

3、删除一个权限:HuangYi\Rbac\Managers\PermissionManager::delete($ID), (*14)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$deleted = $permissionManager->delete(1);

删除权限时会自动解绑已绑定的角色。, (*15)

4、更新一个权限:HuangYi\Rbac\Managers\PermissionManager::update($ID, array $attributes), (*16)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$updated = $permissionManager->update(1, [
    'description' => 'Blabla...',
]);

5、查询一个权限:HuangYi\Rbac\Managers\PermissionManager::find($ID), (*17)

$permissionManager = new \HuangYi\Rbac\Managers\PermissionManager();

$permission = $permissionManager->find(1);

Role

1、角色有三个属性:nameslugdescription。, (*18)

2、创建一个角色:HuangYi\Rbac\Managers\RoleManager::create(array $attributes), (*19)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$role = $roleManager->create([
    'name' => 'Administrator',
    'slug' => 'admin',
    'description' => 'Can do anything.',
]);

3、删除一个角色:HuangYi\Rbac\Managers\RoleManager::delete($ID), (*20)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$deleted = $roleManager->delete(1);

删除角色时会自动解绑已绑定的用户和权限。, (*21)

4、更新一个角色:HuangYi\Rbac\Managers\RoleManager::update($ID, array $attributes), (*22)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$updated = $roleManager->update(1, [
    'description' => 'Blabla...',
]);

5、查询一个角色:HuangYi\Rbac\Managers\RoleManager::find($ID), (*23)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

$role = $roleManager->find(1);

6、为角色绑定权限:HuangYi\Rbac\Managers\RoleManager::attachPermissions($permissionIDs), (*24)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

// 绑定一个权限
$roleManager->attachPermissions(1);

// 同时绑定多个权限
$roleManager->attachPermissions([1, 2, 3]);

7、为角色解绑权限:HuangYi\Rbac\Managers\RoleManager::detachPermissions($permissionIDs), (*25)

$roleManager = new \HuangYi\Rbac\Managers\RoleManager();

// 解绑一个权限
$roleManager->detachPermissions(1);

// 同时绑定多个权限
$roleManager->detachPermissions([1, 2, 3]);

User

1、为用户绑定角色:HuangYi\Rbac\RbacTrait::attachRoles($roleIDs), (*26)

$user = \App\User::find(1);

// 绑定一个角色
$user->attachRoles(1);

// 同时绑定多个角色
$user->attachRoles([1, 2, 3]);

2、为用户解绑角色:HuangYi\Rbac\RbacTrait::detachRoles($roleIDs), (*27)

$user = \App\User::find(1);

// 解绑一个角色
$user->detachRoles(1);

// 同时解绑多个角色
$user->detachRoles([1, 2, 3]);

3、判断用户是否为某些角色,若需要判断多个角色请使用|间隔:HuangYi\Rbac\RbacTrait::hasRole($roles), (*28)

$user = \App\User::find(1);

// 判断一个角色
$user->hasRole('admin');

// 判断多个角色
$user->hasRole('seller|operator');

4、判断用户是否拥有某些权限,若需要判断多个权限请使用|间隔:HuangYi\Rbac\RbacTrait::hasPermission($permissions), (*29)

$user = \App\User::find(1);

// 判断一个权限
$user->hasPermission('product.create');

// 判断多个权限
$user->hasPermission('product.create|product.update');

Middleware

Rbac-Laravel为开发人员提供了便利的Middleware,如果需要使用请将HuangYi\Rbac\RbacMiddleware注入到app/Http/Kernel.php中的路由中间件里:, (*30)

protected $routeMiddleware = [
    'rbac' => \HuangYi\Rbac\RbacMiddleware::class,
];

配置好后即可在路由中使用:, (*31)

Route::get('/do/something', [
    'uses' => 'SomeController@action',
    'middleware' => 'rbac:role,roleSlug1|roleSlug2',
]);

Route::get('/do/something', [
    'uses' => 'SomeController@action',
    'middleware' => 'rbac:permission,permissionSlug1|permissionSlug2',
]);

在视图中使用

@ifHasRole('roleSlug1|roleSlug2')


You can see this., (*32)

@endIfHasRole @ifHasPermission('permission1|permission2')

You can see this too., (*33)

@endIfHasPermission

支持

Bugs和问题可提交至Github,或者请联系作者黄毅(coodeer@163.com), (*34)

License

The Rbac-Laravel is open-sourced software licensed under the MIT license, (*35)

The Versions

31/08 2017

dev-develop

dev-develop

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac

31/08 2017

1.0.x-dev

1.0.9999999.9999999-dev

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac

31/08 2017

dev-master

9999999-dev

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac

31/08 2017

1.0.3

1.0.3.0

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac

15/01 2017

1.0.2

1.0.2.0

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac

07/01 2017

1.0.1

1.0.1.0

A RBAC package for Laravel.

  Sources   Download

MIT

The Requires

 

The Development Requires

by Huang Yi

laravel rbac