wordpress-seo / vendor_prefixed / guzzlehttp / guzzle / src / RequestOptions.php

RequestOptions.php in Yoast SEO – Advanced SEO with real-time guidance and built-in AI 18.2, at vendor_prefixed/guzzlehttp/guzzle/src/RequestOptions.php

236 lines 10.1 KB

Raw Download Zip

1	<?php
2
3	namespace YoastSEO_Vendor\GuzzleHttp;
4
5	/**
6	* This class contains a list of built-in Guzzle request options.
7	*
8	* More documentation for each option can be found at http://guzzlephp.org/.
9	*
10	* @link http://docs.guzzlephp.org/en/v6/request-options.html
11	*/
12	final class RequestOptions
13	{
14	/**
15	* allow_redirects: (bool\|array) Controls redirect behavior. Pass false
16	* to disable redirects, pass true to enable redirects, pass an
17	* associative to provide custom redirect settings. Defaults to "false".
18	* This option only works if your handler has the RedirectMiddleware. When
19	* passing an associative array, you can provide the following key value
20	* pairs:
21	*
22	* - max: (int, default=5) maximum number of allowed redirects.
23	* - strict: (bool, default=false) Set to true to use strict redirects
24	* meaning redirect POST requests with POST requests vs. doing what most
25	* browsers do which is redirect POST requests with GET requests
26	* - referer: (bool, default=false) Set to true to enable the Referer
27	* header.
28	* - protocols: (array, default=['http', 'https']) Allowed redirect
29	* protocols.
30	* - on_redirect: (callable) PHP callable that is invoked when a redirect
31	* is encountered. The callable is invoked with the request, the redirect
32	* response that was received, and the effective URI. Any return value
33	* from the on_redirect function is ignored.
34	*/
35	const ALLOW_REDIRECTS = 'allow_redirects';
36	/**
37	* auth: (array) Pass an array of HTTP authentication parameters to use
38	* with the request. The array must contain the username in index [0],
39	* the password in index [1], and you can optionally provide a built-in
40	* authentication type in index [2]. Pass null to disable authentication
41	* for a request.
42	*/
43	const AUTH = 'auth';
44	/**
45	* body: (resource\|string\|null\|int\|float\|StreamInterface\|callable\|\Iterator)
46	* Body to send in the request.
47	*/
48	const BODY = 'body';
49	/**
50	* cert: (string\|array) Set to a string to specify the path to a file
51	* containing a PEM formatted SSL client side certificate. If a password
52	* is required, then set cert to an array containing the path to the PEM
53	* file in the first array element followed by the certificate password
54	* in the second array element.
55	*/
56	const CERT = 'cert';
57	/**
58	* cookies: (bool\|GuzzleHttp\Cookie\CookieJarInterface, default=false)
59	* Specifies whether or not cookies are used in a request or what cookie
60	* jar to use or what cookies to send. This option only works if your
61	* handler has the `cookie` middleware. Valid values are `false` and
62	* an instance of {@see GuzzleHttp\Cookie\CookieJarInterface}.
63	*/
64	const COOKIES = 'cookies';
65	/**
66	* connect_timeout: (float, default=0) Float describing the number of
67	* seconds to wait while trying to connect to a server. Use 0 to wait
68	* indefinitely (the default behavior).
69	*/
70	const CONNECT_TIMEOUT = 'connect_timeout';
71	/**
72	* debug: (bool\|resource) Set to true or set to a PHP stream returned by
73	* fopen() enable debug output with the HTTP handler used to send a
74	* request.
75	*/
76	const DEBUG = 'debug';
77	/**
78	* decode_content: (bool, default=true) Specify whether or not
79	* Content-Encoding responses (gzip, deflate, etc.) are automatically
80	* decoded.
81	*/
82	const DECODE_CONTENT = 'decode_content';
83	/**
84	* delay: (int) The amount of time to delay before sending in milliseconds.
85	*/
86	const DELAY = 'delay';
87	/**
88	* expect: (bool\|integer) Controls the behavior of the
89	* "Expect: 100-Continue" header.
90	*
91	* Set to `true` to enable the "Expect: 100-Continue" header for all
92	* requests that sends a body. Set to `false` to disable the
93	* "Expect: 100-Continue" header for all requests. Set to a number so that
94	* the size of the payload must be greater than the number in order to send
95	* the Expect header. Setting to a number will send the Expect header for
96	* all requests in which the size of the payload cannot be determined or
97	* where the body is not rewindable.
98	*
99	* By default, Guzzle will add the "Expect: 100-Continue" header when the
100	* size of the body of a request is greater than 1 MB and a request is
101	* using HTTP/1.1.
102	*/
103	const EXPECT = 'expect';
104	/**
105	* form_params: (array) Associative array of form field names to values
106	* where each value is a string or array of strings. Sets the Content-Type
107	* header to application/x-www-form-urlencoded when no Content-Type header
108	* is already present.
109	*/
110	const FORM_PARAMS = 'form_params';
111	/**
112	* headers: (array) Associative array of HTTP headers. Each value MUST be
113	* a string or array of strings.
114	*/
115	const HEADERS = 'headers';
116	/**
117	* http_errors: (bool, default=true) Set to false to disable exceptions
118	* when a non- successful HTTP response is received. By default,
119	* exceptions will be thrown for 4xx and 5xx responses. This option only
120	* works if your handler has the `httpErrors` middleware.
121	*/
122	const HTTP_ERRORS = 'http_errors';
123	/**
124	* idn: (bool\|int, default=true) A combination of IDNA_* constants for
125	* idn_to_ascii() PHP's function (see "options" parameter). Set to false to
126	* disable IDN support completely, or to true to use the default
127	* configuration (IDNA_DEFAULT constant).
128	*/
129	const IDN_CONVERSION = 'idn_conversion';
130	/**
131	* json: (mixed) Adds JSON data to a request. The provided value is JSON
132	* encoded and a Content-Type header of application/json will be added to
133	* the request if no Content-Type header is already present.
134	*/
135	const JSON = 'json';
136	/**
137	* multipart: (array) Array of associative arrays, each containing a
138	* required "name" key mapping to the form field, name, a required
139	* "contents" key mapping to a StreamInterface\|resource\|string, an
140	* optional "headers" associative array of custom headers, and an
141	* optional "filename" key mapping to a string to send as the filename in
142	* the part. If no "filename" key is present, then no "filename" attribute
143	* will be added to the part.
144	*/
145	const MULTIPART = 'multipart';
146	/**
147	* on_headers: (callable) A callable that is invoked when the HTTP headers
148	* of the response have been received but the body has not yet begun to
149	* download.
150	*/
151	const ON_HEADERS = 'on_headers';
152	/**
153	* on_stats: (callable) allows you to get access to transfer statistics of
154	* a request and access the lower level transfer details of the handler
155	* associated with your client. ``on_stats`` is a callable that is invoked
156	* when a handler has finished sending a request. The callback is invoked
157	* with transfer statistics about the request, the response received, or
158	* the error encountered. Included in the data is the total amount of time
159	* taken to send the request.
160	*/
161	const ON_STATS = 'on_stats';
162	/**
163	* progress: (callable) Defines a function to invoke when transfer
164	* progress is made. The function accepts the following positional
165	* arguments: the total number of bytes expected to be downloaded, the
166	* number of bytes downloaded so far, the number of bytes expected to be
167	* uploaded, the number of bytes uploaded so far.
168	*/
169	const PROGRESS = 'progress';
170	/**
171	* proxy: (string\|array) Pass a string to specify an HTTP proxy, or an
172	* array to specify different proxies for different protocols (where the
173	* key is the protocol and the value is a proxy string).
174	*/
175	const PROXY = 'proxy';
176	/**
177	* query: (array\|string) Associative array of query string values to add
178	* to the request. This option uses PHP's http_build_query() to create
179	* the string representation. Pass a string value if you need more
180	* control than what this method provides
181	*/
182	const QUERY = 'query';
183	/**
184	* sink: (resource\|string\|StreamInterface) Where the data of the
185	* response is written to. Defaults to a PHP temp stream. Providing a
186	* string will write data to a file by the given name.
187	*/
188	const SINK = 'sink';
189	/**
190	* synchronous: (bool) Set to true to inform HTTP handlers that you intend
191	* on waiting on the response. This can be useful for optimizations. Note
192	* that a promise is still returned if you are using one of the async
193	* client methods.
194	*/
195	const SYNCHRONOUS = 'synchronous';
196	/**
197	* ssl_key: (array\|string) Specify the path to a file containing a private
198	* SSL key in PEM format. If a password is required, then set to an array
199	* containing the path to the SSL key in the first array element followed
200	* by the password required for the certificate in the second element.
201	*/
202	const SSL_KEY = 'ssl_key';
203	/**
204	* stream: Set to true to attempt to stream a response rather than
205	* download it all up-front.
206	*/
207	const STREAM = 'stream';
208	/**
209	* verify: (bool\|string, default=true) Describes the SSL certificate
210	* verification behavior of a request. Set to true to enable SSL
211	* certificate verification using the system CA bundle when available
212	* (the default). Set to false to disable certificate verification (this
213	* is insecure!). Set to a string to provide the path to a CA bundle on
214	* disk to enable verification using a custom certificate.
215	*/
216	const VERIFY = 'verify';
217	/**
218	* timeout: (float, default=0) Float describing the timeout of the
219	* request in seconds. Use 0 to wait indefinitely (the default behavior).
220	*/
221	const TIMEOUT = 'timeout';
222	/**
223	* read_timeout: (float, default=default_socket_timeout ini setting) Float describing
224	* the body read timeout, for stream requests.
225	*/
226	const READ_TIMEOUT = 'read_timeout';
227	/**
228	* version: (float) Specifies the HTTP protocol version to attempt to use.
229	*/
230	const VERSION = 'version';
231	/**
232	* force_ip_resolve: (bool) Force client to use only ipv4 or ipv6 protocol
233	*/
234	const FORCE_IP_RESOLVE = 'force_ip_resolve';
235	}
236