rmccue /
Requests
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Requests 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 Requests, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 21 | class Requests { |
||
| 22 | /** |
||
| 23 | * POST method |
||
| 24 | * |
||
| 25 | * @var string |
||
| 26 | */ |
||
| 27 | const POST = 'POST'; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * PUT method |
||
| 31 | * |
||
| 32 | * @var string |
||
| 33 | */ |
||
| 34 | const PUT = 'PUT'; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * GET method |
||
| 38 | * |
||
| 39 | * @var string |
||
| 40 | */ |
||
| 41 | const GET = 'GET'; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * HEAD method |
||
| 45 | * |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | const HEAD = 'HEAD'; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * DELETE method |
||
| 52 | * |
||
| 53 | * @var string |
||
| 54 | */ |
||
| 55 | const DELETE = 'DELETE'; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * OPTIONS method |
||
| 59 | * |
||
| 60 | * @var string |
||
| 61 | */ |
||
| 62 | const OPTIONS = 'OPTIONS'; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * TRACE method |
||
| 66 | * |
||
| 67 | * @var string |
||
| 68 | */ |
||
| 69 | const TRACE = 'TRACE'; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * PATCH method |
||
| 73 | * |
||
| 74 | * @link https://tools.ietf.org/html/rfc5789 |
||
| 75 | * @var string |
||
| 76 | */ |
||
| 77 | const PATCH = 'PATCH'; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Default size of buffer size to read streams |
||
| 81 | * |
||
| 82 | * @var integer |
||
| 83 | */ |
||
| 84 | const BUFFER_SIZE = 1160; |
||
| 85 | |||
| 86 | /** |
||
| 87 | * Current version of Requests |
||
| 88 | * |
||
| 89 | * @var string |
||
| 90 | */ |
||
| 91 | const VERSION = '1.7'; |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Registered transport classes |
||
| 95 | * |
||
| 96 | * @var array |
||
| 97 | */ |
||
| 98 | protected static $transports = array(); |
||
| 99 | |||
| 100 | /** |
||
| 101 | * Selected transport name |
||
| 102 | * |
||
| 103 | * Use {@see get_transport()} instead |
||
| 104 | * |
||
| 105 | * @var array |
||
| 106 | */ |
||
| 107 | public static $transport = array(); |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Default certificate path. |
||
| 111 | * |
||
| 112 | * @see Requests::get_certificate_path() |
||
| 113 | * @see Requests::set_certificate_path() |
||
| 114 | * |
||
| 115 | * @var string |
||
| 116 | */ |
||
| 117 | protected static $certificate_path; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * This is a static class, do not instantiate it |
||
| 121 | * |
||
| 122 | * @codeCoverageIgnore |
||
| 123 | */ |
||
| 124 | private function __construct() {} |
||
| 125 | |||
| 126 | /** |
||
| 127 | * Autoloader for Requests |
||
| 128 | * |
||
| 129 | * Register this with {@see register_autoloader()} if you'd like to avoid |
||
| 130 | * having to create your own. |
||
| 131 | * |
||
| 132 | * (You can also use `spl_autoload_register` directly if you'd prefer.) |
||
| 133 | * |
||
| 134 | * @codeCoverageIgnore |
||
| 135 | * |
||
| 136 | * @param string $class Class name to load |
||
| 137 | */ |
||
| 138 | public static function autoloader($class) { |
||
| 149 | |||
| 150 | /** |
||
| 151 | * Register the built-in autoloader |
||
| 152 | * |
||
| 153 | * @codeCoverageIgnore |
||
| 154 | */ |
||
| 155 | public static function register_autoloader() { |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Register a transport |
||
| 161 | * |
||
| 162 | * @param string $transport Transport class to add, must support the Requests_Transport interface |
||
| 163 | */ |
||
| 164 | public static function add_transport($transport) { |
||
| 174 | |||
| 175 | /** |
||
| 176 | * Get a working transport |
||
| 177 | * |
||
| 178 | * @throws Requests_Exception If no valid transport is found (`notransport`) |
||
| 179 | * @return Requests_Transport |
||
| 180 | */ |
||
| 181 | protected static function get_transport($capabilities = array()) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Checks to see if we have a transport for the capabilities requested. |
||
| 222 | * |
||
| 223 | * @return bool |
||
| 224 | */ |
||
| 225 | public static function has_capability($capabilities = array()) { |
||
| 234 | |||
| 235 | /**#@+ |
||
| 236 | * @see request() |
||
| 237 | * @param string $url |
||
| 238 | * @param array $headers |
||
| 239 | * @param array $options |
||
| 240 | * @return Requests_Response |
||
| 241 | */ |
||
| 242 | /** |
||
| 243 | * Send a GET request |
||
| 244 | */ |
||
| 245 | public static function get($url, $headers = array(), $options = array()) { |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Send a HEAD request |
||
| 251 | */ |
||
| 252 | public static function head($url, $headers = array(), $options = array()) { |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Send a DELETE request |
||
| 258 | */ |
||
| 259 | public static function delete($url, $headers = array(), $options = array()) { |
||
| 262 | |||
| 263 | /** |
||
| 264 | * Send a TRACE request |
||
| 265 | */ |
||
| 266 | public static function trace($url, $headers = array(), $options = array()) { |
||
| 269 | /**#@-*/ |
||
| 270 | |||
| 271 | /**#@+ |
||
| 272 | * @see request() |
||
| 273 | * @param string $url |
||
| 274 | * @param array $headers |
||
| 275 | * @param array $data |
||
| 276 | * @param array $options |
||
| 277 | * @return Requests_Response |
||
| 278 | */ |
||
| 279 | /** |
||
| 280 | * Send a POST request |
||
| 281 | */ |
||
| 282 | public static function post($url, $headers = array(), $data = array(), $options = array()) { |
||
| 285 | /** |
||
| 286 | * Send a PUT request |
||
| 287 | */ |
||
| 288 | public static function put($url, $headers = array(), $data = array(), $options = array()) { |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Send an OPTIONS request |
||
| 294 | */ |
||
| 295 | public static function options($url, $headers = array(), $data = array(), $options = array()) { |
||
| 298 | |||
| 299 | /** |
||
| 300 | * Send a PATCH request |
||
| 301 | * |
||
| 302 | * Note: Unlike {@see post} and {@see put}, `$headers` is required, as the |
||
| 303 | * specification recommends that should send an ETag |
||
| 304 | * |
||
| 305 | * @link https://tools.ietf.org/html/rfc5789 |
||
| 306 | */ |
||
| 307 | public static function patch($url, $headers, $data = array(), $options = array()) { |
||
| 310 | /**#@-*/ |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Main interface for HTTP requests |
||
| 314 | * |
||
| 315 | * This method initiates a request and sends it via a transport before |
||
| 316 | * parsing. |
||
| 317 | * |
||
| 318 | * The `$options` parameter takes an associative array with the following |
||
| 319 | * options: |
||
| 320 | * |
||
| 321 | * - `timeout`: How long should we wait for a response? |
||
| 322 | * Note: for cURL, a minimum of 1 second applies, as DNS resolution |
||
| 323 | * operates at second-resolution only. |
||
| 324 | * (float, seconds with a millisecond precision, default: 10, example: 0.01) |
||
| 325 | * - `connect_timeout`: How long should we wait while trying to connect? |
||
| 326 | * (float, seconds with a millisecond precision, default: 10, example: 0.01) |
||
| 327 | * - `useragent`: Useragent to send to the server |
||
| 328 | * (string, default: php-requests/$version) |
||
| 329 | * - `follow_redirects`: Should we follow 3xx redirects? |
||
| 330 | * (boolean, default: true) |
||
| 331 | * - `redirects`: How many times should we redirect before erroring? |
||
| 332 | * (integer, default: 10) |
||
| 333 | * - `blocking`: Should we block processing on this request? |
||
| 334 | * (boolean, default: true) |
||
| 335 | * - `filename`: File to stream the body to instead. |
||
| 336 | * (string|boolean, default: false) |
||
| 337 | * - `auth`: Authentication handler or array of user/password details to use |
||
| 338 | * for Basic authentication |
||
| 339 | * (Requests_Auth|array|boolean, default: false) |
||
| 340 | * - `proxy`: Proxy details to use for proxy by-passing and authentication |
||
| 341 | * (Requests_Proxy|array|string|boolean, default: false) |
||
| 342 | * - `max_bytes`: Limit for the response body size. |
||
| 343 | * (integer|boolean, default: false) |
||
| 344 | * - `idn`: Enable IDN parsing |
||
| 345 | * (boolean, default: true) |
||
| 346 | * - `transport`: Custom transport. Either a class name, or a |
||
| 347 | * transport object. Defaults to the first working transport from |
||
| 348 | * {@see getTransport()} |
||
| 349 | * (string|Requests_Transport, default: {@see getTransport()}) |
||
| 350 | * - `hooks`: Hooks handler. |
||
| 351 | * (Requests_Hooker, default: new Requests_Hooks()) |
||
| 352 | * - `verify`: Should we verify SSL certificates? Allows passing in a custom |
||
| 353 | * certificate file as a string. (Using true uses the system-wide root |
||
| 354 | * certificate store instead, but this may have different behaviour |
||
| 355 | * across transports.) |
||
| 356 | * (string|boolean, default: library/Requests/Transport/cacert.pem) |
||
| 357 | * - `verifyname`: Should we verify the common name in the SSL certificate? |
||
| 358 | * (boolean: default, true) |
||
| 359 | * - `data_format`: How should we send the `$data` parameter? |
||
| 360 | * (string, one of 'query' or 'body', default: 'query' for |
||
| 361 | * HEAD/GET/DELETE, 'body' for POST/PUT/OPTIONS/PATCH) |
||
| 362 | * |
||
| 363 | * @throws Requests_Exception On invalid URLs (`nonhttp`) |
||
| 364 | * |
||
| 365 | * @param string $url URL to request |
||
| 366 | * @param array $headers Extra headers to send with the request |
||
| 367 | * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests |
||
| 368 | * @param string $type HTTP request type (use Requests constants) |
||
| 369 | * @param array $options Options for the request (see description for more information) |
||
| 370 | * @return Requests_Response |
||
| 371 | */ |
||
| 372 | public static function request($url, $headers = array(), $data = array(), $type = self::GET, $options = array()) { |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Send multiple HTTP requests simultaneously |
||
| 403 | * |
||
| 404 | * The `$requests` parameter takes an associative or indexed array of |
||
| 405 | * request fields. The key of each request can be used to match up the |
||
| 406 | * request with the returned data, or with the request passed into your |
||
| 407 | * `multiple.request.complete` callback. |
||
| 408 | * |
||
| 409 | * The request fields value is an associative array with the following keys: |
||
| 410 | * |
||
| 411 | * - `url`: Request URL Same as the `$url` parameter to |
||
| 412 | * {@see Requests::request} |
||
| 413 | * (string, required) |
||
| 414 | * - `headers`: Associative array of header fields. Same as the `$headers` |
||
| 415 | * parameter to {@see Requests::request} |
||
| 416 | * (array, default: `array()`) |
||
| 417 | * - `data`: Associative array of data fields or a string. Same as the |
||
| 418 | * `$data` parameter to {@see Requests::request} |
||
| 419 | * (array|string, default: `array()`) |
||
| 420 | * - `type`: HTTP request type (use Requests constants). Same as the `$type` |
||
| 421 | * parameter to {@see Requests::request} |
||
| 422 | * (string, default: `Requests::GET`) |
||
| 423 | * - `cookies`: Associative array of cookie name to value, or cookie jar. |
||
| 424 | * (array|Requests_Cookie_Jar) |
||
| 425 | * |
||
| 426 | * If the `$options` parameter is specified, individual requests will |
||
| 427 | * inherit options from it. This can be used to use a single hooking system, |
||
| 428 | * or set all the types to `Requests::POST`, for example. |
||
| 429 | * |
||
| 430 | * In addition, the `$options` parameter takes the following global options: |
||
| 431 | * |
||
| 432 | * - `complete`: A callback for when a request is complete. Takes two |
||
| 433 | * parameters, a Requests_Response/Requests_Exception reference, and the |
||
| 434 | * ID from the request array (Note: this can also be overridden on a |
||
| 435 | * per-request basis, although that's a little silly) |
||
| 436 | * (callback) |
||
| 437 | * |
||
| 438 | * @param array $requests Requests data (see description for more information) |
||
| 439 | * @param array $options Global and default options (see {@see Requests::request}) |
||
| 440 | * @return array Responses (either Requests_Response or a Requests_Exception object) |
||
| 441 | */ |
||
| 442 | public static function request_multiple($requests, $options = array()) { |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Get the default options |
||
| 512 | * |
||
| 513 | * @see Requests::request() for values returned by this method |
||
| 514 | * @param boolean $multirequest Is this a multirequest? |
||
| 515 | * @return array Default option values |
||
| 516 | */ |
||
| 517 | protected static function get_default_options($multirequest = false) { |
||
| 544 | |||
| 545 | /** |
||
| 546 | * Get default certificate path. |
||
| 547 | * |
||
| 548 | * @return string Default certificate path. |
||
| 549 | */ |
||
| 550 | public static function get_certificate_path() { |
||
| 557 | |||
| 558 | /** |
||
| 559 | * Set default certificate path. |
||
| 560 | * |
||
| 561 | * @param string $path Certificate path, pointing to a PEM file. |
||
| 562 | */ |
||
| 563 | public static function set_certificate_path( $path ) { |
||
| 566 | |||
| 567 | /** |
||
| 568 | * Set the default values |
||
| 569 | * |
||
| 570 | * @param string $url URL to request |
||
| 571 | * @param array $headers Extra headers to send with the request |
||
| 572 | * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests |
||
| 573 | * @param string $type HTTP request type |
||
| 574 | * @param array $options Options for the request |
||
| 575 | * @return array $options |
||
| 576 | */ |
||
| 577 | protected static function set_defaults(&$url, &$headers, &$data, &$type, &$options) { |
||
| 628 | |||
| 629 | /** |
||
| 630 | * HTTP response parser |
||
| 631 | * |
||
| 632 | * @throws Requests_Exception On missing head/body separator (`requests.no_crlf_separator`) |
||
| 633 | * @throws Requests_Exception On missing head/body separator (`noversion`) |
||
| 634 | * @throws Requests_Exception On missing head/body separator (`toomanyredirects`) |
||
| 635 | * |
||
| 636 | * @param string $headers Full response text including headers and body |
||
| 637 | * @param string $url Original request URL |
||
| 638 | * @param array $req_headers Original $headers array passed to {@link request()}, in case we need to follow redirects |
||
| 639 | * @param array $req_data Original $data array passed to {@link request()}, in case we need to follow redirects |
||
| 640 | * @param array $options Original $options array passed to {@link request()}, in case we need to follow redirects |
||
| 641 | * @return Requests_Response |
||
| 642 | */ |
||
| 643 | protected static function parse_response($headers, $url, $req_headers, $req_data, $options) { |
||
| 735 | |||
| 736 | /** |
||
| 737 | * Callback for `transport.internal.parse_response` |
||
| 738 | * |
||
| 739 | * Internal use only. Converts a raw HTTP response to a Requests_Response |
||
| 740 | * while still executing a multiple request. |
||
| 741 | * |
||
| 742 | * @param string $response Full response text including headers and body (will be overwritten with Response instance) |
||
| 743 | * @param array $request Request data as passed into {@see Requests::request_multiple()} |
||
| 744 | * @return null `$response` is either set to a Requests_Response instance, or a Requests_Exception object |
||
| 745 | */ |
||
| 746 | public static function parse_multiple(&$response, $request) { |
||
| 758 | |||
| 759 | /** |
||
| 760 | * Decoded a chunked body as per RFC 2616 |
||
| 761 | * |
||
| 762 | * @see https://tools.ietf.org/html/rfc2616#section-3.6.1 |
||
| 763 | * @param string $data Chunked body |
||
| 764 | * @return string Decoded body |
||
| 765 | */ |
||
| 766 | protected static function decode_chunked($data) { |
||
| 801 | // @codeCoverageIgnoreEnd |
||
| 802 | |||
| 803 | /** |
||
| 804 | * Convert a key => value array to a 'key: value' array for headers |
||
| 805 | * |
||
| 806 | * @param array $array Dictionary of header values |
||
| 807 | * @return array List of headers |
||
| 808 | */ |
||
| 809 | public static function flatten($array) { |
||
| 816 | |||
| 817 | /** |
||
| 818 | * Convert a key => value array to a 'key: value' array for headers |
||
| 819 | * |
||
| 820 | * @codeCoverageIgnore |
||
| 821 | * @deprecated Misspelling of {@see Requests::flatten} |
||
| 822 | * @param array $array Dictionary of header values |
||
| 823 | * @return array List of headers |
||
| 824 | */ |
||
| 825 | public static function flattern($array) { |
||
| 828 | |||
| 829 | /** |
||
| 830 | * Decompress an encoded body |
||
| 831 | * |
||
| 832 | * Implements gzip, compress and deflate. Guesses which it is by attempting |
||
| 833 | * to decode. |
||
| 834 | * |
||
| 835 | * @param string $data Compressed data in one of the above formats |
||
| 836 | * @return string Decompressed string |
||
| 837 | */ |
||
| 838 | public static function decompress($data) { |
||
| 859 | |||
| 860 | /** |
||
| 861 | * Decompression of deflated string while staying compatible with the majority of servers. |
||
| 862 | * |
||
| 863 | * Certain Servers will return deflated data with headers which PHP's gzinflate() |
||
| 864 | * function cannot handle out of the box. The following function has been created from |
||
| 865 | * various snippets on the gzinflate() PHP documentation. |
||
| 866 | * |
||
| 867 | * Warning: Magic numbers within. Due to the potential different formats that the compressed |
||
| 868 | * data may be returned in, some "magic offsets" are needed to ensure proper decompression |
||
| 869 | * takes place. For a simple progmatic way to determine the magic offset in use, see: |
||
| 870 | * https://core.trac.wordpress.org/ticket/18273 |
||
| 871 | * |
||
| 872 | * @since 2.8.1 |
||
| 873 | * @link https://core.trac.wordpress.org/ticket/18273 |
||
| 874 | * @link https://secure.php.net/manual/en/function.gzinflate.php#70875 |
||
| 875 | * @link https://secure.php.net/manual/en/function.gzinflate.php#77336 |
||
| 876 | * |
||
| 877 | * @param string $gzData String to decompress. |
||
| 878 | * @return string|bool False on failure. |
||
| 879 | */ |
||
| 880 | public static function compatible_gzinflate($gzData) { |
||
| 974 | |||
| 975 | public static function match_domain($host, $reference) { |
||
| 995 | } |
||
| 996 |
Loading history...
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVarassignment in line 1 and the$higherassignment in line 2 are dead. The first because$myVaris never used and the second because$higheris always overwritten for every possible time line.