EDM SDK

RestClient
in

Table of Contents

create()  : array<string|int, mixed>|null
fetch()  : array<string|int, mixed>|null
fetchCollection()  : Collection
fetchSingle()  : array<string|int, mixed>|null
getAccessToken()  : AccessToken
getUser()  : mixed
login()  : AccessToken
query()  : string|null
queryJson()  : array<string|int, mixed>|null
setAccessToken()  : RestClient

Methods

create()

public create(string $endpoint[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$endpoint : string
$data : array<string|int, mixed> = []
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null —

fetch()

public fetch(string $endpoint[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|null
Parameters
$endpoint : string
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null —

fetchCollection()

public fetchCollection(string $endpoint, array<string|int, mixed> $params) : Collection
Parameters
$endpoint : string
$params : array<string|int, mixed>
Return values
Collection —

fetchSingle()

public fetchSingle(string $endpoint, mixed $id, array<string|int, mixed> $params) : array<string|int, mixed>|null
Parameters
$endpoint : string
$id : mixed
$params : array<string|int, mixed>
Return values
array<string|int, mixed>|null —

getAccessToken()

public getAccessToken() : AccessToken
Return values
AccessToken —

getUser()

public getUser() : mixed
Return values
mixed —

login()

public login(string $userName, string $password) : AccessToken
Parameters
$userName : string
$password : string
Return values
AccessToken —

query()

public query(string $method, string $endpoint[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $body = null ]) : string|null
Parameters
$method : string
$endpoint : string
$params : array<string|int, mixed> = []
$body : array<string|int, mixed> = null
Return values
string|null —

queryJson()

public queryJson(string $method, string $endpoint[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $body = null ]) : array<string|int, mixed>|null
Parameters
$method : string
$endpoint : string
$params : array<string|int, mixed> = []
$body : array<string|int, mixed> = null
Return values
array<string|int, mixed>|null —

Search results