Methods summary
public
|
#
__construct( array $config = [] )
Clients accept an array of constructor parameters.
Clients accept an array of constructor parameters.
Here's an example of creating a client using a base_uri and an array of
default request options to apply to each request:
$client = new Client([ 'base_uri' => 'http://www.foo.com/1.0/', 'timeout' => 0, 'allow_redirects' => false, 'proxy' => '192.168.16.1:10' ]);
Client configuration settings include the following options:
- handler: (callable) Function that transfers HTTP requests over the wire. The function is called with a Psr7\Http\Message\RequestInterface and array of transfer options, and must return a GuzzleHttp\Promise\PromiseInterface that is fulfilled with a Psr7\Http\Message\ResponseInterface on success. "handler" is a constructor only option that cannot be overridden in per/request options. If no handler is provided, a default handler will be created that enables all of the request options below by attaching all of the default middleware to the handler.
- base_uri: (string|UriInterface) Base URI of the client that is merged into relative URIs. Can be a string or instance of UriInterface.
- **: any request option
Parameters
- $config
- Client configuration settings.
See
\GuzzleHttp\RequestOptions for a list of available request options.
|
public
|
|
public
PromiseInterface
|
#
sendAsync( Psr\Http\Message\RequestInterface $request, array $options = [] )
Asynchronously send an HTTP request.
Asynchronously send an HTTP request.
Parameters
- $request
- Request to send
- $options
Request options to apply to the given
request and to the transfer.
Returns
PromiseInterface
Implementation of
|
public
Psr\Http\Message\ResponseInterface
|
#
send( Psr\Http\Message\RequestInterface $request, array $options = [] )
Send an HTTP request.
Parameters
- $request
- Request to send
- $options
Request options to apply to the given
request and to the transfer.
Returns
Throws
GuzzleException
Implementation of
|
public
PromiseInterface
|
#
requestAsync( string $method, string|Psr\Http\Message\UriInterface $uri = '', array $options = [] )
Create and send an asynchronous HTTP request.
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
- $method
- HTTP method
- $uri
- URI object or string.
- $options
- Request options to apply.
Returns
PromiseInterface
Implementation of
|
public
Psr\Http\Message\ResponseInterface
|
#
request( string $method, string|Psr\Http\Message\UriInterface $uri = '', array $options = [] )
Create and send an HTTP request.
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
- $method
- HTTP method.
- $uri
- URI object or string.
- $options
- Request options to apply.
Returns
Throws
GuzzleException
Implementation of
|
public
mixed
|
#
getConfig( string|null $option = null )
Get a client configuration option.
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
- $option
- The config option to retrieve.
Returns
mixed
Implementation of
|