Download the PHP package jlg/php-adp-client without Composer
On this page you can find all versions of the php package jlg/php-adp-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download jlg/php-adp-client
More information about jlg/php-adp-client
Files in jlg/php-adp-client
Download jlg/php-adp-client
More information about jlg/php-adp-client
Files in jlg/php-adp-client
Vendor jlg
Package php-adp-client
Short Description Simple PHP ADP connection client.
License MIT
Homepage https://github.com/joshuaGlass808/php-adp-client
Package php-adp-client
Short Description Simple PHP ADP connection client.
License MIT
Homepage https://github.com/joshuaGlass808/php-adp-client
Please rate this library. Is it a good library?
Informations about the package php-adp-client
Simple PHP ADP Client
Getting started
Basic usage
Methods
-
getWorkersMeta(): HttpResponse
- sends a GET request to retrieve workers api meta data.
-
getWorker(string $aoid, array $select = []): HttpResponse
- gets a single worker based on workers AOID
- an optional select array can be passed as a secondary argument.
-
getWorkers(array $filters = [], int $skip = 0, int $top = 100, bool $count = false, array $select = []): HttpResponse
- gets all workers, but only returns
$top
records. -
You can use the
$skip
as a way of moving through all your users. - or you may need to get more than
$top
- gets all workers, but only returns
-
getWorkAssignmentMeta(): HttpResponse
- sends a GET request to retrieve Work-Assignment api meta data.
-
modifyWorkAssignment(array $params = []): HttpResponse
- sends a POST request to modify a workers work assignment.
-
get(string $url, array $requestPayload = []): HttpResponse
- sends a GET request to which ever ADP API endpoint you would like to use.
-
post(string $url, array $requestPayload = []): HttpResponse
- sends a POST request to which ever ADP API endpoint you would like to use.
-
apiCall(string $requestType, string $url, array $requestPayload = []): HttpResponse
- sends an HTTP request to which ADP API endpoint specified in the
$url
parameter. $requestType
needs to be either'get'
or'put'
- sends an HTTP request to which ADP API endpoint specified in the
-
static getContents(HttpResponse $response): HttpResponse
- gets the contents from a guzzle Http Response.
Additional Information
- Please refer to ADP API Documentation Explorer for additional details on request parameters and what to expect from the response.
- This is using Guzzle for the Http abstraction. You will need to call
->getBody()->getContents()
on the response from one of the methods listed above if you would like to get the contents of the ADP Api response. - If you are missing something in your config or any other type of validation, you will be met with an exception like this:
PHP Fatal error: Uncaught Jlg\ADP\Exceptions\ADPClientValidationException: [0]: Missing keys from config: server_url
All versions of php-adp-client with dependencies
PHP Build Version
Package Version
Requires
guzzlehttp/guzzle Version
^7.0.1
The package jlg/php-adp-client contains the following files
Loading the files please wait ....