doc88 / flux
Laravel 应用集成 Flux / Doc88 的库。
v1.2.0
2020-07-07 15:57 UTC
Requires
- php: >=7.2.0
- doc88/flux-entity-permission: ^1.1
- mashape/unirest-php: ^3.0
README
Laravel 应用集成 Flux / Doc88 的库。
安装
- 执行命令 composer require doc88/flux
- 将 Doc88\Flux\FluxServiceProvider 添加到 config/app.php 中的 providers
- 执行命令 php artisan vendor:publish
使用方法
类 Doc88\Flux\Authorization
用于在 Flux 中执行 Auth 功能的类。集成方法包括
- 登录 - 通过 Flux 实现登录的功能。
Authorization::login( $email, $senha, $conta, $produto );
- 参数
- email : Flux 中用户的邮箱
- senha : Flux 中用户的密码
- conta : Flux 中账户/公司的标识符(slug)。例如:comerc
- produto : Flux 中产品/应用程序的标识符(slug)。例如:zordon
- 返回:在成功的情况下,返回将是一个 JSON 对象,如下例所示。
{ "data": { "id": "b1041a3e-d196-4dca-9b35-37278b6511cf", "type": "Bearer", "token": "ZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKSVV6STFOaUo5LmV5SnBjM01pT2lKR2JIVjRJaXdpYVdGMElqb2lNakF5TUMwd05TMHhPRlF4T1Rvek16bzBOU3N3TURvd01DSXNJbVZoZENJNklqSXdNakF0TURVdE1UaFVNVGs2TXpNNk5EVXJNREE2TURBaUxDSjFjMlZ5WDJsa0lqb2lOREE1T0dJMU5HVXRZekZpWXkwME5UTTVMV0ZqTURndE9EVXdaVFEzWWpGaVlqSTNJaXdpWVdOamIzVnVkRjlwWkNJNklqWXpabVUxTjJRM0xXUTRZMll0TkRJek1DMWlOamxrTFRBeU5tVXpORGxpWW1FNE55SXNJbkJ5YjJSMVkzUmZhV1FpT2lKaVkyVm1ZakE0WkMwd09EZGxMVFJqTkRVdE9UQmxOQzAyWkdWa01tRmlaRFkzTlRVaWZRLlZjU0x2NlpENWljZjIxWXp4bjVqS0plWHNwQXNBNkNYZUw0aHNzNl9NaEE=", "expires_at": "2020-06-17T19:33:45.000000Z", "created_at": "2020-05-18T19:33:45.000000Z", "account": { "id": "63fe57d7-d8cf-4230-b69d-026e349bba87", "name": "Comerc", "slug": "comerc", "active": true, "created_at": "2020-04-14T19:59:43.000000Z", "updated_at": "2020-04-14T19:59:43.000000Z", "addresses": [] }, "product": { "id": "bcefb08d-087e-4c45-90e4-6ded2abd6755", "name": "Zordon", "slug": "zordon", "active": true, "created_at": "2020-04-14T17:45:35.000000Z", "updated_at": "2020-04-14T17:45:35.000000Z", "modules": [] }, "user": { "id": "4098b54e-c1bc-4539-ac08-850e47b1bb27", "name": "Moacir Durazzo Junior", "email": "moacir.junior@doc89.com.br", "created_at": "2020-04-09T20:02:17.000000Z", "updated_at": "2020-04-09T20:02:17.000000Z" } } }
- 参数
- 模块 - 检查用户是否具有访问应用/产品中某个模块的权限。
Authorization::module( $token, $module, $account = null, $product = null )
- 参数
- token : 通过 登录 函数获得的用户登录令牌
- module : Flux 中模块的标识符(slug)。例如:monitoria
- conta : Flux 中账户/公司的标识符(slug)。例如:comerc
- produto : Flux 中产品/应用程序的标识符(slug)。例如:zordon
- 返回:在成功的情况下,返回将是一个 JSON 对象,如下例所示。
{ "permission": true }
- 参数
- 权限 - 检查用户是否具有访问应用/产品中特定操作的权限。
Authorization::permission( $token, $action, $account = null, $product = null )
- 参数
- token : 通过 登录 函数获得的用户登录令牌
- action : Flux 中操作的标识符(slug)。例如:cadastro-de-alarme
- conta : Flux 中账户/公司的标识符(slug)。例如:comerc
- produto : Flux 中产品/应用程序的标识符(slug)。例如:zordon
- 返回:在成功的情况下,返回将是一个 JSON 对象,如下例所示。
{ "permission": true }
- 参数
- 实体 - 根据 Flux Entity Permission 检查实体权限。
Authorization::entity( $method, $params )
- 参数
- method : 要调用的 EntityPermission 类的方法
- params : 传递给所选 method 的参数数组,根据 Flux Entity Permission
- 返回:根据 Flux Entity Permission 文档中的说明返回
- 参数