Client
in package
implements
ClientInterface
uses
ClientTrait
Basic client
Tags
Table of Contents
Interfaces
- ClientInterface
- Interface for basic clients.
Properties
- $credentials : Credentials
- $defaultArgs : array<string|int, mixed>
Methods
- __construct() : mixed
- Creates a new client.
- getArguments() : array<string|int, mixed>
- Get the available arguments for client initialization
- getCredentials() : array<string|int, mixed>
- Get the current client credentials
Properties
$credentials
protected
Credentials
$credentials
$defaultArgs
private
static array<string|int, mixed>
$defaultArgs
= ['token' => ['type' => 'value', 'valid' => ['string'], 'doc' => 'Token for dataCycle API', 'required' => true], 'baseUrl' => ['type' => 'value', 'valid' => ['string'], 'doc' => 'Base url for dataCycle API. (Must end with /api)', 'required' => true]]
Methods
__construct()
Creates a new client.
public
__construct(array<string|int, mixed> $args) : mixed
APIYes
Parameters
- $args : array<string|int, mixed>
getArguments()
Get the available arguments for client initialization
public
static getArguments() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getCredentials()
Get the current client credentials
public
getCredentials() : array<string|int, mixed>
APIYes