Download the PHP package dcarbone/amber-hat without Composer
On this page you can find all versions of the php package dcarbone/amber-hat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dcarbone/amber-hat
More information about dcarbone/amber-hat
Files in dcarbone/amber-hat
Package amber-hat
Short Description Lib designed to help PHP apps consume from REDCap's API
License GPL-2.0
Homepage https://github.com/dcarbone/amber-hat
Informations about the package amber-hat
amber-hat
A REDCap Client library written in PHP
Installation
This lib requires the use of Composer.
Client Creation
To get started, you will need 3 things:
- Full URL to your REDCap installation's API endpoint (typically something like "https://redcap.mygreatinstitution.edu/api/")
- A REDCap API token
- A Temp directory on the server capable of handling potentially large files
Once you have those, you can immediately start exporting data for the project the token gives you access to:
Available Data Export methods:
- Arms
- Events
- Metadata
- Export Field Names
- Project Information
- Form Events
- Users
- Instruments (forms)
- Records
- Record Field File
- Version
Basic Export Data Object Structure
With the exception of Records, Project Information, and Record Field File, all export methods return a collection class which extends AbstractItemCollection. This collection class implements the following interfaces:
The objects present in the collection are all classes which implement the ItemInterface interface. The interface requires concrete classes to implement the following:
NOTE: For PHP 5.3 users, I have created a JsonSerializableCompatible interface, however you must execute json_encode on the result of the implemented method call, rather than on the object itself.
Ex:
Available Data Import methods:
At the moment, no import methods are available. However, this feature is being worked on and will hopefully come to fruition soon.
All versions of amber-hat with dependencies
ext-libxml Version *
lib-libxml Version *
ext-curl Version *
lib-curl Version *
ext-mbstring Version *
ext-pcre Version *
lib-pcre Version *
ext-date Version *
ext-spl Version *
dcarbone/curl-plus Version 2.0.*