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

Public Member Functions

 __call ($method, $args)
 
 __construct (array $config=[])
 
 getConfig ($option=null)
 
 request ($method, $uri='', array $options=[])
 
 requestAsync ($method, $uri='', array $options=[])
 
 send (RequestInterface $request, array $options=[])
 
 sendAsync (RequestInterface $request, array $options=[])
 

Additional Inherited Members

- Data Fields inherited from GuzzleHttp\ClientInterface
const VERSION = '6.5.4'
 

Detailed Description

@method ResponseInterface get(string|UriInterface $uri, array $options = []) @method ResponseInterface head(string|UriInterface $uri, array $options = []) @method ResponseInterface put(string|UriInterface $uri, array $options = []) @method ResponseInterface post(string|UriInterface $uri, array $options = []) @method ResponseInterface patch(string|UriInterface $uri, array $options = []) @method ResponseInterface delete(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface getAsync(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface headAsync(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface putAsync(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface postAsync(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface patchAsync(string|UriInterface $uri, array $options = []) @method Promise\PromiseInterface deleteAsync(string|UriInterface $uri, array $options = [])

Definition at line 26 of file vendor/guzzlehttp/guzzle/src/Client.php.

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Client::__construct ( array  $config = [])

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. 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
array$configClient configuration settings.
See also
\GuzzleHttp\RequestOptions for a list of available request options.

Definition at line 65 of file vendor/guzzlehttp/guzzle/src/Client.php.

Member Function Documentation

◆ __call()

GuzzleHttp\Client::__call (   $method,
  $args 
)
Parameters
string$method
array$args
Returns
Promise\PromiseInterface

Definition at line 87 of file vendor/guzzlehttp/guzzle/src/Client.php.

◆ getConfig()

GuzzleHttp\Client::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

Implements GuzzleHttp\ClientInterface.

Definition at line 199 of file vendor/guzzlehttp/guzzle/src/Client.php.

◆ request()

GuzzleHttp\Client::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. See \GuzzleHttp\RequestOptions.
Returns
ResponseInterface
Exceptions
GuzzleException

Implements GuzzleHttp\ClientInterface.

Definition at line 182 of file vendor/guzzlehttp/guzzle/src/Client.php.

◆ requestAsync()

GuzzleHttp\Client::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. See \GuzzleHttp\RequestOptions.
Returns
Promise\PromiseInterface

Implements GuzzleHttp\ClientInterface.

Definition at line 149 of file vendor/guzzlehttp/guzzle/src/Client.php.

◆ send()

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

Send an HTTP request.

Parameters
array$optionsRequest options to apply to the given request and to the transfer. See \GuzzleHttp\RequestOptions.
Returns
ResponseInterface
Exceptions
GuzzleException

Implements GuzzleHttp\ClientInterface.

Definition at line 129 of file vendor/guzzlehttp/guzzle/src/Client.php.

◆ sendAsync()

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

Asynchronously send an HTTP request.

Parameters
array$optionsRequest options to apply to the given request and to the transfer. See \GuzzleHttp\RequestOptions.
Returns
Promise\PromiseInterface

Implements GuzzleHttp\ClientInterface.

Definition at line 109 of file vendor/guzzlehttp/guzzle/src/Client.php.

References Psr\Http\Message\RequestInterface\getUri(), Psr\Http\Message\MessageInterface\hasHeader(), and Psr\Http\Message\RequestInterface\withUri().


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