[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch

title

Body

[close]

/vendor/guzzlehttp/guzzle/src/ -> Client.php (summary)

(no description)

File Size: 501 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Client:: (13 methods):
  __construct()
  __call()
  sendAsync()
  send()
  requestAsync()
  request()
  getConfig()
  buildUri()
  configureDefaults()
  prepareDefaults()
  transfer()
  applyOptions()
  invalidBody()


Class: Client  - X-Ref


__construct(array $config = [])   X-Ref
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

param: array $config Client configuration settings.

__call($method, $args)   X-Ref

param: string $method
param: array  $args
return: Promise\PromiseInterface

sendAsync(RequestInterface $request, array $options = [])   X-Ref
Asynchronously send an HTTP request.

param: array $options Request options to apply to the given
return: Promise\PromiseInterface

send(RequestInterface $request, array $options = [])   X-Ref
Send an HTTP request.

param: array $options Request options to apply to the given
return: ResponseInterface

requestAsync($method, $uri = '', array $options = [])   X-Ref
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.

param: string              $method  HTTP method
param: string|UriInterface $uri     URI object or string.
param: array               $options Request options to apply. See \GuzzleHttp\RequestOptions.
return: Promise\PromiseInterface

request($method, $uri = '', array $options = [])   X-Ref
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.

param: string              $method  HTTP method.
param: string|UriInterface $uri     URI object or string.
param: array               $options Request options to apply. See \GuzzleHttp\RequestOptions.
return: ResponseInterface

getConfig($option = null)   X-Ref
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.

param: string|null $option The config option to retrieve.
return: mixed

buildUri($uri, array $config)   X-Ref

param: string|null $uri
return: UriInterface

configureDefaults(array $config)   X-Ref
Configures the default options for a client.

param: array $config
return: void

prepareDefaults(array $options)   X-Ref
Merges default options into the array.

param: array $options Options to modify by reference
return: array

transfer(RequestInterface $request, array $options)   X-Ref
Transfers the given request and applies request options.

The URI of the request is not modified and the request options are used
as-is without merging in default options.

param: array $options See \GuzzleHttp\RequestOptions.
return: Promise\PromiseInterface

applyOptions(RequestInterface $request, array &$options)   X-Ref
Applies the array of request options to a request.

param: RequestInterface $request
param: array            $options
return: RequestInterface

invalidBody()   X-Ref
Throw Exception with pre-set message.

return: void



Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1