Bristol SU Support Package
Public Member Functions | Private Attributes | List of all members
BristolSU\Support\Connection\Client\GuzzleClient Class Reference
Inheritance diagram for BristolSU\Support\Connection\Client\GuzzleClient:
Inheritance graph
[legend]
Collaboration diagram for BristolSU\Support\Connection\Client\GuzzleClient:
Collaboration graph
[legend]

Public Member Functions

 __construct (BaseGuzzleInterface $client)
 
 request ($method, $uri, array $options=[])
 

Private Attributes

 $client
 

Detailed Description

Guzzle implementation of the API client

Definition at line 15 of file GuzzleClient.php.

Constructor & Destructor Documentation

◆ __construct()

BristolSU\Support\Connection\Client\GuzzleClient::__construct ( BaseGuzzleInterface  $client)
Parameters
BaseGuzzleInterface$clientClient to send the request to

Definition at line 27 of file GuzzleClient.php.

References BristolSU\Support\Connection\Client\GuzzleClient\$client.

Member Function Documentation

◆ request()

BristolSU\Support\Connection\Client\GuzzleClient::request (   $method,
  $uri,
array  $options = [] 
)

Send a request and return the response

Parameters
string$methodMethod to use for the request
string$uriURL of the request
array$optionsOptions for the request. See Guzzle options for more information
Returns
Response from the request
Exceptions
GuzzleExceptionif the request failed

Implements BristolSU\Support\Connection\Contracts\Client\Client.

Definition at line 42 of file GuzzleClient.php.

Member Data Documentation

◆ $client

BristolSU\Support\Connection\Client\GuzzleClient::$client
private

The documentation for this class was generated from the following file: