dcarbone / amber-hat
用于帮助PHP应用程序从REDCap API中消费的库
0.4.2
2015-12-18 22:50 UTC
Requires
- php: >=5.3.3
- ext-curl: *
- ext-date: *
- ext-libxml: *
- ext-mbstring: *
- ext-pcre: *
- ext-spl: *
- lib-curl: *
- lib-libxml: *
- lib-pcre: *
- dcarbone/curl-plus: 2.0.*
Suggests
- ext-openssl: For that SSL goodness.
- lib-openssl
This package is auto-updated.
Last update: 2024-09-17 09:39:26 UTC
README
用PHP编写的REDCap客户端库
安装
此库需要使用 Composer。
"require": { "dcarbone/amber-hat": "0.4.*" }
客户端创建
要开始使用,你需要以下三个东西
- 您的REDCap安装API端点的完整URL(通常是类似 "https://redcap.mygreatinstitution.edu/api/" 的东西)
- REDCap API令牌
- 服务器上的临时目录,能够处理可能的大文件
一旦您有了这些,您就可以立即开始导出令牌可访问的项目数据
use DCarbone\AmberHat\AmberHatClient; $client = new AmberHatClient( 'https://redcap.mygreatinstitution.edu/api/', 'mygreattoken', 'my-cache-dir');
可用的数据导出方法
基本导出数据对象结构
除了记录、项目信息和记录字段文件之外,所有导出方法都返回一个扩展AbstractItemCollection的集合类。此集合类实现了以下接口
集合中存在的对象都是实现了ItemInterface接口的类。该接口要求具体类实现以下
注意:对于PHP 5.3用户,我已经创建了一个JsonSerializableCompatible接口,但是您必须对实现该方法的返回结果执行json_encode,而不是对对象本身执行。
例
$json_string = json_encode($itemObject->jsonSerialize());
可用的数据导入方法
目前没有可用的导入方法。然而,此功能正在开发中,并希望很快实现。