ClientInterface
in
Interface ClientInterface
Table of Contents
| request() | Takes parameters passed in, makes a request to the API, and processes the response. | mixed|StreamInterface |
|---|---|---|
| makeRequest() | ResponseInterface | |
| processResponse() | Processes the returned response from the API. | mixed|StreamInterface |
| getQuery() | Get query from Client. | array |
| clearQuery() | Clear query. | mixed |
| addQuery() | Add a query parameter to filter results. | mixed |
| getOptions() | Get options from Client. | array |
| clearOptions() | Clear options. | mixed |
| addOption() | Add an option to the Guzzle request object. | mixed |
Methods
request()
Takes parameters passed in, makes a request to the API, and processes the response.
public
request(
$verb :
string
, $path :
string
[, $options :
array
= [] ]
)
: mixed|StreamInterface
Parameters
- $verb : string
- $path : string
- $options : array = []
Return values
mixed|StreamInterfacemakeRequest()
public
makeRequest(
$verb :
string
, $path :
string
[, $options :
array
= [] ]
)
: ResponseInterface
Parameters
- $verb : string
- $path : string
- $options : array = []
Return values
ResponseInterfaceprocessResponse()
Processes the returned response from the API.
public
processResponse(
$response :
ResponseInterface
)
: mixed|StreamInterface
Parameters
- $response : ResponseInterface
Tags
Return values
mixed|StreamInterfacegetQuery()
Get query from Client.
public
getQuery(
)
: array
Return values
arrayclearQuery()
Clear query.
public
clearQuery(
)
: mixed
Return values
mixedaddQuery()
Add a query parameter to filter results.
public
addQuery(
$name :
string
, $value :
string|int
)
: mixed
Parameters
- $name : string
- $value : string|int
Return values
mixedgetOptions()
Get options from Client.
public
getOptions(
)
: array
Return values
arrayclearOptions()
Clear options.
public
clearOptions(
)
: mixed
Return values
mixedaddOption()
Add an option to the Guzzle request object.
public
addOption(
$name :
string
, $value :
mixed
)
: mixed
Parameters
- $name : string
- $value : mixed