Complex classes like HttpClient often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use HttpClient, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
13 | class HttpClient |
||
14 | { |
||
15 | /** |
||
16 | * The default request options. |
||
17 | * |
||
18 | * @var array |
||
19 | */ |
||
20 | protected static $defaultOptions = [ |
||
21 | 'connect_timeout' => 5, |
||
22 | 'timeout' => 30, |
||
23 | ]; |
||
24 | |||
25 | /** |
||
26 | * The Guzzle client. |
||
27 | * |
||
28 | * @var \GuzzleHttp\Client |
||
29 | */ |
||
30 | protected $client; |
||
31 | |||
32 | /** |
||
33 | * The request options. |
||
34 | * |
||
35 | * @var array |
||
36 | */ |
||
37 | protected $options = []; |
||
38 | |||
39 | /** |
||
40 | * The Guzzle response. |
||
41 | * |
||
42 | * @var \GuzzleHttp\Psr7\Response |
||
43 | */ |
||
44 | protected $response; |
||
45 | |||
46 | /** |
||
47 | * Indicate whether to catch Guzzle exceptions. |
||
48 | * |
||
49 | * @var bool |
||
50 | */ |
||
51 | protected $catchExceptions = true; |
||
52 | |||
53 | /** |
||
54 | * Get the default request options. |
||
55 | * |
||
56 | * @return array |
||
57 | */ |
||
58 | 24 | public static function defaultOptions() |
|
62 | |||
63 | /** |
||
64 | * Set the default request options. |
||
65 | * |
||
66 | * @param array $options |
||
67 | * @return void |
||
68 | */ |
||
69 | 1 | public static function setDefaultOptions(array $options) |
|
73 | |||
74 | /** |
||
75 | * Create a http client instance. |
||
76 | * |
||
77 | * @param array|string|\Psr\Http\Message\UriInterface $options base URI or any request options |
||
78 | * |
||
79 | * @throws \InvalidArgumentException |
||
80 | */ |
||
81 | 23 | public function __construct($options = []) |
|
82 | { |
||
83 | 23 | if (is_string($options) || $options instanceof UriInterface) { |
|
84 | 1 | $options = ['base_uri' => $options]; |
|
85 | 23 | } elseif (! is_array($options)) { |
|
86 | throw new InvalidArgumentException('Options must be a string, UriInterface, or an array'); |
||
87 | } |
||
88 | |||
89 | 23 | $this->client = new Client( |
|
90 | 23 | array_replace_recursive(static::defaultOptions(), $options) |
|
91 | 23 | ); |
|
92 | |||
93 | 23 | $this->options = $this->client->getConfig(); |
|
|
|||
94 | 23 | } |
|
95 | |||
96 | /** |
||
97 | * Get the Guzzle client instance. |
||
98 | * |
||
99 | * @return \GuzzleHttp\Client |
||
100 | */ |
||
101 | 2 | public function getClient() |
|
102 | { |
||
103 | 2 | return $this->client; |
|
104 | } |
||
105 | |||
106 | /** |
||
107 | * Get whether to catch Guzzle exceptions or not. |
||
108 | * |
||
109 | * @return bool |
||
110 | */ |
||
111 | public function areExceptionsCaught() |
||
112 | { |
||
113 | return $this->catchExceptions; |
||
114 | } |
||
115 | |||
116 | /** |
||
117 | * Set whether to catch Guzzle exceptions or not. |
||
118 | * |
||
119 | * @param bool $catch |
||
120 | * @return $this |
||
121 | */ |
||
122 | public function catchExceptions($catch) |
||
123 | { |
||
124 | $this->catchExceptions = (bool) $catch; |
||
125 | |||
126 | return $this; |
||
127 | } |
||
128 | |||
129 | /** |
||
130 | * Get the request options using "dot" notation. |
||
131 | * |
||
132 | * @param string|null $key |
||
133 | * @return mixed |
||
134 | 3 | */ |
|
135 | public function getOption($key = null) |
||
136 | 3 | { |
|
137 | return Arr::get($this->options, $key); |
||
138 | } |
||
139 | |||
140 | /** |
||
141 | * Set the request options using "dot" notation. |
||
142 | * |
||
143 | * @param string|array $key |
||
144 | * @param mixed $value |
||
145 | * @return $this |
||
146 | */ |
||
147 | public function option($key, $value = null) |
||
148 | { |
||
149 | $keys = is_array($key) ? $key : [$key => $value]; |
||
150 | |||
151 | foreach ($keys as $key => $value) { |
||
152 | Arr::set($this->options, $key, $value); |
||
153 | } |
||
154 | |||
155 | return $this; |
||
156 | } |
||
157 | |||
158 | /** |
||
159 | * Merge the given options to the request options. |
||
160 | * |
||
161 | * @param array $options,... |
||
162 | * @return $this |
||
163 | */ |
||
164 | public function mergeOption(array ...$options) |
||
165 | { |
||
166 | $this->options = array_replace_recursive($this->options, ...$options); |
||
167 | |||
168 | return $this; |
||
169 | } |
||
170 | |||
171 | 1 | /** |
|
172 | * Remove one or many request options using "dot" notation. |
||
173 | 1 | * |
|
174 | * @param array|string $keys |
||
175 | * @return $this |
||
176 | */ |
||
177 | public function removeOption($keys) |
||
178 | { |
||
179 | Arr::forget($this->options, is_array($keys) ? $keys : func_get_args()); |
||
180 | |||
181 | return $this; |
||
182 | } |
||
183 | 1 | ||
184 | /** |
||
185 | 1 | * Set a request header. |
|
186 | * |
||
187 | 1 | * @param string $name |
|
188 | 1 | * @param mixed $value |
|
189 | 1 | * @return $this |
|
190 | */ |
||
191 | 1 | public function header($name, $value) |
|
192 | { |
||
193 | return $this->option('headers.'.$name, $value); |
||
194 | } |
||
195 | |||
196 | /** |
||
197 | * Set the request content type. |
||
198 | * |
||
199 | * @param string $type |
||
200 | * @return $this |
||
201 | */ |
||
202 | public function contentType($type) |
||
203 | { |
||
204 | return $this->header('Content-Type', $type); |
||
205 | } |
||
206 | |||
207 | /** |
||
208 | * Set the request accept type. |
||
209 | * |
||
210 | * @param string $type |
||
211 | * @return $this |
||
212 | */ |
||
213 | public function accept($type) |
||
214 | { |
||
215 | return $this->header('Accept', $type); |
||
216 | } |
||
217 | |||
218 | /** |
||
219 | * Set the request accept type to "application/json". |
||
220 | * |
||
221 | * @return $this |
||
222 | */ |
||
223 | public function acceptJson() |
||
224 | { |
||
225 | return $this->accept('application/json'); |
||
226 | } |
||
227 | |||
228 | /** |
||
229 | * Specify where the body of the response will be saved. |
||
230 | * Set the "sink" option. |
||
231 | * |
||
232 | * @param mixed $dest |
||
233 | * @return $this |
||
234 | */ |
||
235 | public function saveTo($dest) |
||
236 | { |
||
237 | return $this->removeOption('save_to')->option('sink', $dest); |
||
238 | } |
||
239 | |||
240 | /** |
||
241 | * Get the Guzzle response instance. |
||
242 | * |
||
243 | * @return \GuzzleHttp\Psr7\Response|null |
||
244 | */ |
||
245 | public function getResponse() |
||
246 | { |
||
247 | return $this->response; |
||
248 | } |
||
249 | |||
250 | /** |
||
251 | * Get data from the response. |
||
252 | * |
||
253 | * @param string|\Closure $callback |
||
254 | * @param array $parameters |
||
255 | * @param mixed $default |
||
256 | * @return mixed |
||
257 | */ |
||
258 | protected function getResponseData($callback, array $parameters = [], $default = null) |
||
259 | { |
||
260 | if ($this->response) { |
||
261 | return $callback instanceof Closure |
||
262 | ? $callback($this->response, ...$parameters) |
||
263 | : $this->response->$callback(...$parameters); |
||
264 | } |
||
265 | |||
266 | return $default; |
||
267 | } |
||
268 | |||
269 | /** |
||
270 | * Get the response content. |
||
271 | * |
||
272 | * @return string |
||
273 | */ |
||
274 | public function getContent() |
||
275 | { |
||
276 | return (string) $this->getBody(); |
||
277 | } |
||
278 | |||
279 | /** |
||
280 | * Get the JSON-decoded response content. |
||
281 | * |
||
282 | * @param bool $assoc |
||
283 | * @return mixed |
||
284 | */ |
||
285 | public function getJsonContent($assoc = true) |
||
286 | { |
||
287 | return json_decode($this->getContent(), $assoc); |
||
288 | } |
||
289 | |||
290 | /** |
||
291 | * Make request to a URI. |
||
292 | * |
||
293 | * @param string $uri |
||
294 | * @param string $method |
||
295 | * @param array $options |
||
296 | * @return $this |
||
297 | */ |
||
298 | public function request($uri = '', $method = 'GET', array $options = []) |
||
299 | { |
||
300 | $this->response = null; |
||
301 | |||
302 | $method = strtoupper($method); |
||
303 | $options = array_replace_recursive($this->options, $options); |
||
304 | |||
305 | try { |
||
306 | $this->response = $this->client->request($method, $uri, $options); |
||
307 | } catch (Exception $e) { |
||
308 | 2 | if (! $this->catchExceptions) { |
|
309 | throw $e; |
||
310 | 2 | } |
|
311 | } |
||
312 | 2 | ||
313 | return $this; |
||
314 | } |
||
315 | 2 | ||
316 | 2 | /** |
|
317 | 2 | * Make request to a URI, expecting JSON content. |
|
318 | * |
||
319 | * @param string $uri |
||
320 | * @param string $method |
||
321 | * @param array $options |
||
322 | 2 | * @return $this |
|
323 | */ |
||
324 | public function requestJson($uri = '', $method = 'GET', array $options = []) |
||
325 | { |
||
326 | $options = $this->addAcceptableJsonType( |
||
327 | array_replace_recursive($this->options, $options) |
||
328 | ); |
||
329 | |||
330 | return $this->request($uri, $method, $options); |
||
331 | } |
||
332 | |||
333 | /** |
||
334 | * Add JSON type to the "Accept" header for the request options. |
||
335 | * |
||
336 | * @param array $options |
||
337 | * @return array |
||
338 | */ |
||
339 | protected function addAcceptableJsonType(array $options) |
||
340 | { |
||
341 | $accept = Arr::get($options, 'headers.Accept', ''); |
||
342 | |||
343 | if (! Str::contains($accept, ['/json', '+json'])) { |
||
344 | $accept = rtrim('application/json,'.$accept, ','); |
||
345 | Arr::set($options, 'headers.Accept', $accept); |
||
346 | } |
||
347 | |||
348 | return $options; |
||
349 | } |
||
350 | |||
351 | /** |
||
352 | * Request the URI and return the response content. |
||
353 | * |
||
354 | * @param string $uri |
||
355 | * @param string $method |
||
356 | * @param array $options |
||
357 | * @return string |
||
358 | */ |
||
359 | public function fetchContent($uri = '', $method = 'GET', array $options = []) |
||
360 | { |
||
361 | return $this->request($uri, $method, $options)->getContent(); |
||
362 | } |
||
363 | |||
364 | /** |
||
365 | * Request the URI and return the JSON-decoded response content. |
||
366 | * |
||
367 | * @param string $uri |
||
368 | * @param string $method |
||
369 | * @param array $options |
||
370 | * @return mixed |
||
371 | */ |
||
372 | public function fetchJson($uri = '', $method = 'GET', array $options = []) |
||
373 | { |
||
374 | return $this->requestJson($uri, $method, $options)->getJsonContent(); |
||
375 | } |
||
376 | |||
377 | /** |
||
378 | * Get the dynamic request methods. |
||
379 | * |
||
380 | * @return array |
||
381 | */ |
||
382 | protected function getDynamicRequestMethods() |
||
383 | { |
||
384 | return [ |
||
385 | 'get', 'head', 'put', 'post', 'patch', 'delete', 'options', |
||
386 | ]; |
||
387 | } |
||
388 | |||
389 | /** |
||
390 | * Get the dynamic requestJson methods. |
||
391 | 2 | * |
|
392 | * @return array |
||
393 | */ |
||
394 | 2 | protected function getDynamicRequestJsonMethods() |
|
395 | 2 | { |
|
396 | return [ |
||
397 | 'get', 'put', 'post', 'patch', 'delete', |
||
398 | ]; |
||
399 | } |
||
400 | |||
401 | /** |
||
402 | * Get the dynamic response methods. |
||
403 | 1 | * |
|
404 | * @return array |
||
405 | */ |
||
406 | 1 | protected function getDynamicResponseMethods() |
|
413 | |||
414 | /** |
||
415 | 1 | * Insert HTTP method to the parameters. |
|
416 | * |
||
417 | * @param array $parameters |
||
418 | 1 | * @return array |
|
419 | 1 | */ |
|
420 | 1 | protected function insertHttpMethodToParameters($method, array $parameters) |
|
421 | { |
||
422 | if (empty($parameters)) { |
||
423 | $parameters = ['', $method]; |
||
424 | } else { |
||
425 | array_splice($parameters, 1, 0, $method); |
||
426 | } |
||
427 | |||
428 | return $parameters; |
||
429 | 1 | } |
|
430 | |||
431 | 1 | /** |
|
432 | * Dynamically send request, get response data, or set request option. |
||
433 | 1 | * |
|
434 | * @param string $method |
||
435 | * @param array $parameters |
||
436 | 1 | * @return mixed |
|
437 | */ |
||
438 | public function __call($method, $parameters) |
||
458 | } |
||
459 |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..