EdmClient
in package
implements
RestClient
Interfaces, Classes and Traits
Table of Contents
- __construct() : mixed
- cascadeQueryParams() : string
- create() : array<string|int, mixed>|null
- decodeResponse() : array<string|int, mixed>
- fetch() : array<string|int, mixed>|null
- fetchCollection() : Collection
- fetchSingle() : array<string|int, mixed>|null
- getAccessToken() : AccessToken
- getBaseUri() : string
- getDefaultRestClientoptions() : mixed
- getHttpClient() : Client
- getOAuthProvider() : AbstractProvider
- getUser() : User
- handleClientException() : mixed
- logIn() : AccessToken
- prepareQueryParams() : array<string|int, mixed>|string
- Transforms parameters containing arrays to a string due to https://github.com/guzzle/guzzle/issues/1308#issuecomment-156816900
- query() : string|null
- queryJson() : array<string|int, mixed>|null
- setAccessToken() : RestClient
- setHttpClient() : RestClient
- setOAuthProvider() : RestClient
Methods
__construct()
public
__construct(string $baseUrl, AbstractProvider $oauthProvider[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $baseUrl : string
- $oauthProvider : AbstractProvider
- $options : array<string|int, mixed> = []
Return values
mixed —cascadeQueryParams()
public
static cascadeQueryParams(array<string|int, mixed> $params[, string $commonName = null ]) : string
Parameters
- $params : array<string|int, mixed>
- $commonName : string = null
Return values
string —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 —decodeResponse()
public
static decodeResponse(string $response) : array<string|int, mixed>
Parameters
- $response : string
Return values
array<string|int, mixed> —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 $idOrSlug, array<string|int, mixed> $params) : array<string|int, mixed>|null
Parameters
- $endpoint : string
- $idOrSlug : mixed
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>|null —getAccessToken()
public
getAccessToken() : AccessToken
Return values
AccessToken —getBaseUri()
public
static getBaseUri(string $edmUrl) : string
Parameters
- $edmUrl : string
Return values
string —getDefaultRestClientoptions()
public
static getDefaultRestClientoptions() : mixed
Return values
mixed —getHttpClient()
public
getHttpClient() : Client
Return values
Client —getOAuthProvider()
public
getOAuthProvider() : AbstractProvider
Return values
AbstractProvider —getUser()
public
getUser() : User
Return values
User —handleClientException()
public
static handleClientException(ClientException $e) : mixed
Parameters
- $e : ClientException
Return values
mixed —logIn()
public
logIn(string $userName, string $password) : AccessToken
Parameters
- $userName : string
- $password : string
Return values
AccessToken —prepareQueryParams()
Transforms parameters containing arrays to a string due to https://github.com/guzzle/guzzle/issues/1308#issuecomment-156816900
public
static prepareQueryParams(array<string|int, mixed> $params) : array<string|int, mixed>|string
Parameters
- $params : array<string|int, mixed>
-
The query parameters
Return values
array<string|int, mixed>|string —The prepared array or a query string
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 —setAccessToken()
public
setAccessToken(AccessToken $accessToken) : RestClient
Parameters
- $accessToken : AccessToken
Return values
RestClient —setHttpClient()
public
setHttpClient(Client $httpClient) : RestClient
Parameters
- $httpClient : Client
Return values
RestClient —setOAuthProvider()
public
setOAuthProvider(AbstractProvider $oauthProvider) : RestClient
Parameters
- $oauthProvider : AbstractProvider