blitheness / laravel-deputy
Laravel用于与Deputy API交互的包
Requires
- illuminate/support: ^5.6
- laravel/framework: ^5.6
This package is not auto-updated.
Last update: 2022-01-08 15:28:45 UTC
README
该项目已被归档,将不再提供支持。任何人都可以fork该项目以继续开发。
laravel-deputy
Laravel包,用于与Deputy API交互。Deputy是一个强大的业务管理系统,可在https://www.deputy.com获取。
此包按原样提供,不保证功能或支持。此包不一定适用于所有用例。更多信息请参阅此存储库的LICENSE文件。
以下提供了一些基本说明。
安装
composer require blitheness/laravel-deputy dev-master
php artisan vendor:publish
(然后输入Blitheness\Deputy\DeputyServiceProvider的数字)
配置
要么更新config/deputy.php
以更改'url'和'token'值,要么在.env文件中设置'DEPUTY_URL'和'DEPUTY_TOKEN'值。
URL是您的公司使用的Deputy子域,例如"mycompany.eu.deputy.com",不包括"http://"、"https://"或任何尾随斜杠。
令牌是您的Deputy API '永久令牌',可能由组织中的系统管理员创建。授权用户可以通过遵循Deputy API文档中的说明生成令牌:https://www.deputy.com/api-doc/API/Authentication
使用
资源
- 公司
- 员工
- 员工协议
- 员工合同
- 员工工作场所
- 运营单位
- 用户(只读)
门面
要使用Deputy '资源',请使用实时门面。
将以下内容添加到控制器的顶部 use Facades\Blitheness\Deputy\Models\RESOURCE_NAME;
其中 RESOURCE_NAME 是上述列表中的资源。
检索数据
已知ID
$result = Resource::find(ID)
其中 Resource 是上述列表中的资源,而 ID 是您要查找的Deputy中资源的ID。
搜索
要搜索,请使用该资源的实时门面上的'search'方法
$results = Resource::search('FieldName', 'eq', 'Value')->get();
每个查询可以多次使用条件,通过链接搜索调用来实现,例如
$results = Resource::search('FieldName', 'eq', 'Value')->search('Active', 'eq', '1')->get();
更新资源
模型属性
要更新资源,它不能是只读资源。
首先,检索您要修改的资源,例如
$resource = Employee::find(123);
其次,更改模型上的所需属性
$resource->FirstName = "新的首位名";
最后,在模型上调用保存方法
$resource->save()
后台任务(作业)
从地点中移除员工
要使员工与地点解除关联,您必须知道员工的ID和地点的ID。
然后,可以调度以下作业之一
Blitheness\Deputy\Jobs\DisassociateEmployee
首先,在类声明之前将此包含在控制器文件中
use Blitheness\Deputy\Jobs\DisassociateEmployee;
然后,在您想要调度作业的地方写入以下内容
DisassociateEmployee::dispatch($deputyId, $locationId);
其中,deputyId是员工ID,locationId是他们将被移除的地点的ID。