Open Journal Systems  3.3.0
GuzzleHttp\ClientInterface Interface Reference
Inheritance diagram for GuzzleHttp\ClientInterface:
GuzzleHttp\Client

Public Member Functions

 getConfig ($option=null)
 
 request ($method, $uri, array $options=[])
 
 requestAsync ($method, $uri, array $options=[])
 
 send (RequestInterface $request, array $options=[])
 
 sendAsync (RequestInterface $request, array $options=[])
 

Data Fields

const VERSION = '6.5.4'
 

Detailed Description

Client interface for sending HTTP requests.

Definition at line 13 of file vendor/guzzlehttp/guzzle/src/ClientInterface.php.

Member Function Documentation

◆ getConfig()

GuzzleHttp\ClientInterface::getConfig (   $option = null)

Get a client configuration option.

These options include default request options of the client, a "handler" (if utilized by the concrete client), and a "base_uri" if utilized by the concrete client.

Parameters
string | null$optionThe config option to retrieve.
Returns
mixed

Implemented in GuzzleHttp\Client.

◆ request()

GuzzleHttp\ClientInterface::request (   $method,
  $uri,
array  $options = [] 
)

Create and send an HTTP request.

Use an absolute path to override the base path of the client, or a relative path to append to the base path of the client. The URL can contain the query string as well.

Parameters
string$methodHTTP method.
string | UriInterface$uriURI object or string.
array$optionsRequest options to apply.
Returns
ResponseInterface
Exceptions
GuzzleException

Implemented in GuzzleHttp\Client.

◆ requestAsync()

GuzzleHttp\ClientInterface::requestAsync (   $method,
  $uri,
array  $options = [] 
)

Create and send an asynchronous HTTP request.

Use an absolute path to override the base path of the client, or a relative path to append to the base path of the client. The URL can contain the query string as well. Use an array to provide a URL template and additional variables to use in the URL template expansion.

Parameters
string$methodHTTP method
string | UriInterface$uriURI object or string.
array$optionsRequest options to apply.
Returns
PromiseInterface

Implemented in GuzzleHttp\Client.

◆ send()

GuzzleHttp\ClientInterface::send ( RequestInterface  $request,
array  $options = [] 
)

Send an HTTP request.

Parameters
RequestInterface$requestRequest to send
array$optionsRequest options to apply to the given request and to the transfer.
Returns
ResponseInterface
Exceptions
GuzzleException

Implemented in GuzzleHttp\Client.

◆ sendAsync()

GuzzleHttp\ClientInterface::sendAsync ( RequestInterface  $request,
array  $options = [] 
)

Asynchronously send an HTTP request.

Parameters
RequestInterface$requestRequest to send
array$optionsRequest options to apply to the given request and to the transfer.
Returns
PromiseInterface

Implemented in GuzzleHttp\Client.

Field Documentation

◆ VERSION

const GuzzleHttp\ClientInterface::VERSION = '6.5.4'
Deprecated:
Will be removed in Guzzle 7.0.0

Definition at line 18 of file vendor/guzzlehttp/guzzle/src/ClientInterface.php.

Referenced by GuzzleHttp\default_user_agent().


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