-
Notifications
You must be signed in to change notification settings - Fork 0
/
Client.php
325 lines (289 loc) · 9.23 KB
/
Client.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<?php
namespace ArturDoruch\Http;
use ArturDoruch\Http\Cookie\CookieFile;
use ArturDoruch\Http\Curl\MessageHandlerFactory;
use ArturDoruch\Http\Curl\Options;
use ArturDoruch\Http\Message\Response;
/**
* @author Artur Doruch <arturdoruch@interia.pl>
*/
class Client extends AbstractClient
{
/**
* @var Options
*/
private $options;
/**
* @var CookieFile
*/
private $cookieFile;
/**
* @var Request
*/
private $lastRequest;
/**
* @var Response
*/
private $lastResponse;
/**
* @var array
*/
private $curlOptions = [];
/**
* @var MessageHandlerFactory
*/
private $messageHandlerFactory;
/**
* @param array $curlOptions cURL options, array with key-value pairs, where key is the cURL option
* and can be in three formats:
* - full constant name
* - constant integer value
* - constant name without "CURLOPT_" prefix.
* For example to set CURLOPT_TIMEOUT to 15 seconds,
* pass [CURLOPT_TIMEOUT => 15], [13 => 15] or ['timeout' => 15].
* @param bool $throwException It true RequestException will be thrown when response status code is 4xx, 5xx or 0.
* @param CookieFile $cookieFile Set if you want to store website session cookies into text file.
*/
public function __construct(array $curlOptions = [], $throwException = true, CookieFile $cookieFile = null)
{
$this->cookieFile = $cookieFile;
$this->options = new Options($cookieFile, $curlOptions);
$this->messageHandlerFactory = new MessageHandlerFactory($this->options);
parent::__construct($throwException);
}
/**
* @deprecated
* @param string $filename Path to file where session cookies will be stored.
*/
public function setCookieFilename($filename)
{
if ($this->cookieFile) {
$this->cookieFile->setFile($filename);
}
}
/**
* Gets path to currently used cookie file.
*
* @return string
*/
public function getCookieFilename()
{
return $this->cookieFile ? $this->cookieFile->getFilename() : null;
}
/**
* @todo Rename method to getCurlOptions()
*
* Gets default cURL options.
*
* @param bool $keysAsConstants
*
* @return array
*/
public function getDefaultCurlOptions($keysAsConstants = false)
{
return $this->options->getDefault($keysAsConstants);
}
/**
* Sets default cURL options, which will be used in every request.
*
* @param array $options
*/
public function setDefaultCurlOptions(array $options)
{
$this->options->setDefault($options);
}
/**
* Gets cURL options used to send the last request.
*
* @param bool $keysAsConstants
*
* @return array
*/
public function getCurlOptions($keysAsConstants = false)
{
return $this->options->getLast($keysAsConstants);
}
/**
* Sets cURL options for use with the next request.
*
* @param array $curlOptions
*/
public function setCurlOptions(array $curlOptions)
{
$this->curlOptions = $curlOptions;
}
/**
* Gets the last sending request.
*
* @return Request|null
*/
public function getLastRequest()
{
return $this->lastRequest;
}
/**
* @return Response|null
*/
public function getLastResponse()
{
return $this->lastResponse;
}
/**
* Adds listener to one of HTTP request event:
* BEFORE - event called just before send HTTP request,
* COMPLETE - event called when HTTP request is done.
*
* @param string $eventName One of: request.before, request.complete. See ArturDoruch\Http\Event\RequestEvents class.
* @param callable $listener The listener function, which receives event object as argument.
* For BEFORE event will be ArturDoruch\Http\Event\BeforeEvent,
* for COMPLETE event will be ArturDoruch\Http\Event\CompleteEvent object.
* @param int $priority The higher this value, the earlier an event listener will be triggered in the chain.
*/
public function addListener($eventName, callable $listener, $priority = 0)
{
$this->eventDispatcher->addListener($eventName, $listener, $priority);
}
/**
* Makes GET request.
*
* @param string $url
* @param array $parameters Url query parameters
* @param array $options
* @param array $curlOptions
*
* @return Response
*/
public function get($url, array $parameters = [], array $options = [], array $curlOptions = [])
{
return $this->request($this->createRequest($url, 'GET', $parameters, $options), $curlOptions);
}
/**
* Makes POST request.
*
* @param string $url
* @param array $parameters
* @param array $options
* @param array $curlOptions
*
* @return Response
*/
public function post($url, array $parameters = [], array $options = [], array $curlOptions = [])
{
return $this->request($this->createRequest($url, 'POST', $parameters, $options), $curlOptions);
}
/**
* Makes PATCH request.
*
* @param string $url
* @param array $parameters
* @param array $options
* @param array $curlOptions
*
* @return Response
*/
public function patch($url, array $parameters = [], array $options = [], array $curlOptions = [])
{
return $this->request($this->createRequest($url, 'PATCH', $parameters, $options), $curlOptions);
}
/**
* Makes PUT request.
*
* @param string $url
* @param array $parameters Form parameters
* @param array $options
* @param array $curlOptions
*
* @return Response
*/
public function put($url, array $parameters = [], array $options = [], array $curlOptions = [])
{
return $this->request($this->createRequest($url, 'PUT', $parameters, $options), $curlOptions);
}
/**
* Makes DELETE request.
*
* @param string $url
* @param array $parameters Form parameters
* @param array $options
* @param array $curlOptions
*
* @return Response
*/
public function delete($url, array $parameters = [], array $options = [], array $curlOptions = [])
{
return $this->request($this->createRequest($url, 'DELETE', $parameters, $options), $curlOptions);
}
/**
* @param Request $request
* @param array $curlOptions
*
* @return Response
*/
public function request(Request $request, array $curlOptions = [])
{
$this->lastRequest = $request;
$messageHandler = $this->messageHandlerFactory->create($request, $this->curlOptions + $curlOptions);
$this->curlOptions = [];
return $this->lastResponse = $this->sendRequest($messageHandler);
}
/**
* Sends multi parallel requests.
*
* @param Request[]|array $requests The list of Requests or urls.
* @param Request $request @deprecated This parameter is not used any more.
* @param array $curlOptions
* @param int $connections Number of parallel connections
* @param callable $rejectUrl The listener allowing to reject added request url. Received
* one argument $url and must return true if url should be rejected.
*
* @return Response[]
*/
public function multiRequest(array $requests, Request $request = null, array $curlOptions = [], $connections = null, callable $rejectUrl = null)
{
if ($connections) {
$this->setConnections($connections);
}
$messageHandlers = [];
foreach ($requests as $request) {
if (!$request instanceof Request) {
$request = $this->createRequest($request);
}
$messageHandlers[] = $this->messageHandlerFactory->create($request, $curlOptions);
}
return $this->sendMultiRequest($messageHandlers, $rejectUrl);
}
/**
* Creates an Request object.
*
* @param string $url
* @param string $method
* @param array $parameters Form parameters
* @param array $options
* - cookie
* - headers
* - body
* - json
* - files
*
* @return Request
*/
public function createRequest($url, $method = 'GET', array $parameters = [], array $options = [])
{
$request = new Request($method, $url);
$request->setParameters($parameters);
if ($options) {
if (isset($options['cookie'])) {
$request->addCookie((string) $options['cookie']);
}
if (isset($options['headers'])) {
$request->setHeaders($options['headers']);
}
if (isset($options['body'])) {
$request->setBody($options['body']);
} elseif (isset($options['json']) || isset($options['multipart'])) {
$request->setBody($options);
}
}
return $request;
}
}