Documentation

RequestOptions

in package

• Application

This class contains a list of built-in Guzzle request options.

Tags

see

https://github.com/guzzle/guzzle/blob/7.15/docs/request-options.md

Table of Contents

Constants

ALLOW_REDIRECTS  : mixed = 'allow_redirects'

allow_redirects: (bool|array) Controls redirect behavior. Pass false to disable redirects, pass true to enable redirects, pass an associative to provide custom redirect settings. Defaults to "false".

AUTH  : mixed = 'auth'

auth: (array{0: string, 1: string, 2?: string|null}|string|false|null) Pass an array of HTTP authentication parameters to use with the request.

BODY  : mixed = 'body'

body: (resource|string|null|int|float|bool|\Psr\Http\Message\StreamInterface|(callable&object)|\Iterator|\Stringable) Body to send in the request. Callable arrays are arrays, and arrays are not valid body values in Guzzle.

CERT  : mixed = 'cert'

cert: (string|array{0: string, 1?: string|null}) Set to a string to specify the path to a client certificate file. PEM is the default certificate format. If a password is required, set cert to an array containing the certificate path in the first array element followed by the certificate password in the second array element. A null password is treated the same as omitting it. Use cert_type to specify another supported certificate format.

CERT_TYPE  : mixed = 'cert_type'

cert_type: (string) Specify the SSL client certificate file type.

CONNECT_TIMEOUT  : mixed = 'connect_timeout'

connect_timeout: (int|float, default=0) Number of seconds to wait while trying to connect to a server. Use 0 to wait 300 seconds (the default behavior).

COOKIES  : mixed = 'cookies'

cookies: (false|GuzzleHttp\Cookie\CookieJarInterface, default=false) Specifies whether or not cookies are used in a request or what cookie jar to use or what cookies to send. This option only works if your handler has the `cookie` middleware. Valid values are `false` and an instance of {@see Cookie\CookieJarInterface}.

CRYPTO_METHOD  : mixed = 'crypto_method'

crypto_method: (int) A value describing the minimum TLS protocol version to use.

CRYPTO_METHOD_MAX  : mixed = 'crypto_method_max'

crypto_method_max: (int) A value describing the maximum TLS protocol version to use.

CURL  : mixed = 'curl'

curl: (array) Raw cURL options to apply when using a built-in cURL handler.

DEBUG  : mixed = 'debug'

debug: (bool|resource) Set to true or set to a PHP stream returned by fopen() enable debug output with the HTTP handler used to send a request.

DECODE_CONTENT  : mixed = 'decode_content'

decode_content: (bool|string, default=true) Specify whether or not Content-Encoding responses (gzip, deflate, etc.) are automatically decoded.

DELAY  : mixed = 'delay'

delay: (int|float) The amount of time to delay before sending in milliseconds.

EXPECT  : mixed = 'expect'

expect: (bool|integer) Controls the behavior of the "Expect: 100-Continue" header.

FORCE_IP_RESOLVE  : mixed = 'force_ip_resolve'

force_ip_resolve: (string) Set to "v4" to force IPv4 resolution or "v6" for IPv6 resolution when supported by the handler.

FORM_PARAMS  : mixed = 'form_params'

form_params: (array<array-key, string|int|float|bool|null|array>) Associative array of form field names to scalar, null, or nested array values. Sets the Content-Type header to application/x-www-form-urlencoded when no Content-Type header is already present.

HEADERS  : mixed = 'headers'

headers: (array<array-key, string|non-empty-array<array-key, string>>|null) Associative array of HTTP headers. Each value MUST be a string or non-empty array of strings.

HTTP_ERRORS  : mixed = 'http_errors'

http_errors: (bool, default=true) Set to false to disable exceptions when a non- successful HTTP response is received. By default, exceptions will be thrown for 4xx and 5xx responses. This option only works if your handler has the `httpErrors` middleware.

IDN_CONVERSION  : mixed = 'idn_conversion'

idn_conversion: (bool|int|null, default=false) A combination of IDNA_* constants for PHP's idn_to_ascii() function. Set to false or null to disable IDN support, or to true to use the default configuration (IDNA_DEFAULT constant).

JSON  : mixed = 'json'

json: (mixed) Adds JSON data to a request. The provided value is JSON encoded and a Content-Type header of application/json will be added to the request if no Content-Type header is already present.

MULTIPART  : mixed = 'multipart'

multipart: (array) Array of part arrays, each containing a required "name" key mapping to the string or integer form field name, a required "contents" key mapping to any non-array value accepted by PSR-7 Utils::streamFor() or a nested array of field values, an optional "headers" array of string custom header values, and an optional "filename" key mapping to a string to send as the filename in the part.

MULTIPLEX  : mixed = 'multiplex'

multiplex: (string) Controls how a request sent through a built-in cURL handler relates to shared, multiplexed connections: how an HTTP/2 request pursues one, or, with Multiplexing::NONE, whether the transfer may share its connection at all. When the option is not set, multiplexing is left to libcurl: nothing waits, and established multiplex-capable connections are still shared. Use Multiplexing::EAGER to explicitly never wait for pending connections, Multiplexing::WAIT to wait on libcurl-eligible pending connections with CURLOPT_PIPEWAIT, normally to the same origin, Multiplexing::REQUIRE_EAGER to fail unless a multiplexed protocol is guaranteed while dialing eagerly, or Multiplexing::REQUIRE_WAIT for the same guarantee while also waiting on pending connections. The required modes require a handler that permits actual multiplexing, not merely a multiplexed protocol, and are rejected on a Multiplexing::NONE handler.

ON_HEADERS  : mixed = 'on_headers'

on_headers: (callable) A callable that is invoked when the HTTP headers of the response have been received but the body has not yet begun to download.

ON_STATS  : mixed = 'on_stats'

on_stats: (callable) allows you to get access to transfer statistics of a request and access the lower level transfer details of the handler associated with your client. ``on_stats`` is a callable that is invoked when a handler has finished sending a request. The callback is invoked with transfer statistics about the request, the response received, or the error encountered. Included in the data is the total amount of time taken to send the request.

ON_TRAILERS  : mixed = 'on_trailers'

on_trailers: (callable) A callable that is invoked by the built-in cURL handlers once per successful transfer, after the response body has been received, with an associative array of the parsed HTTP trailers followed by the response. Trailer field names are lowercased and grouped case-insensitively; values keep their wire order. Malformed trailer field lines are discarded before parsing. Trailer fields are reported separately from response headers and are never merged into the response.

PROGRESS  : mixed = 'progress'

progress: (callable) Defines a function to invoke when transfer progress is made. The function accepts the following positional arguments: the total number of bytes expected to be downloaded, the number of bytes downloaded so far, the number of bytes expected to be uploaded, the number of bytes uploaded so far.

PROTOCOLS  : mixed = 'protocols'

protocols: (non-empty-array<array-key, string>, default=['http', 'https']) Allowed URI schemes. Built-in handlers accept only the case-sensitive values "http" and "https".

PROXY  : mixed = 'proxy'

proxy: (string|array) Pass a string to specify an HTTP proxy, or an array to specify different proxies for different protocols (where the key is the protocol and the value is a proxy string or null). Provide a "no" key as a comma-delimited string, array of strings, or null to specify hosts or host-and-port pairs that should not be proxied.

QUERY  : mixed = 'query'

query: (array<array-key, mixed>|string) Associative array of query string values to add to the request. This option uses PHP's http_build_query() to create the string representation. Pass a string value if you need more control than what this method provides

READ_TIMEOUT  : mixed = 'read_timeout'

read_timeout: (int|float, default=default_socket_timeout ini setting) Number describing the body read timeout, for stream requests.

RETRIES  : mixed = 'retries'

retries: (int) Current retry count used by the retry middleware.

SINK  : mixed = 'sink'

sink: (resource|string|\Psr\Http\Message\StreamInterface) Where the data of the response is written to. Defaults to a PHP temp stream. Providing a string will write data to a file by the given name.

SSL_KEY  : mixed = 'ssl_key'

ssl_key: (array{0: string, 1?: string|null}|string) Specify the path to a private SSL key file. PEM is the default private key format. If a password is required, set ssl_key to an array containing the key path in the first array element followed by the key password in the second element. A null password is treated the same as omitting it. Use ssl_key_type to specify another supported key format.

SSL_KEY_TYPE  : mixed = 'ssl_key_type'

ssl_key_type: (string) Specify the SSL private key file type.

STREAM  : mixed = 'stream'

stream: (bool) Set to true to attempt to stream a response rather than download it all up-front.

STREAM_CONTEXT  : mixed = 'stream_context'

stream_context: (array) PHP stream context options to merge into the context used by the built-in stream handler.

SYNCHRONOUS  : mixed = 'synchronous'

synchronous: (bool) Set to true to inform HTTP handlers that you intend on waiting on the response. This can be useful for optimizations. Note that a promise is still returned if you are using one of the async client methods.

TIMEOUT  : mixed = 'timeout'

timeout: (int|float, default=0) Number describing the timeout of the request in seconds. Use 0 to wait indefinitely (the default behavior).

VERIFY  : mixed = 'verify'

verify: (bool|string, default=true) Describes the SSL certificate verification behavior of a request. Set to true to enable SSL certificate verification using the system CA bundle when available (the default). Set to false to disable certificate verification (this is insecure!). Set to a string to provide the path to a CA bundle on disk to enable verification using a custom certificate.

VERSION  : mixed = 'version'

version: (string|int|float) Specifies the HTTP protocol version to attempt to use.