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 BaseRequest 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 BaseRequest, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | class BaseRequest |
||
| 13 | { |
||
| 14 | private $scheme; |
||
| 15 | private $user; |
||
| 16 | private $pass; |
||
| 17 | private $host; |
||
| 18 | private $port; |
||
| 19 | private $path; |
||
| 20 | private $query = array(); |
||
| 21 | |||
| 22 | /** @var [string => string] */ |
||
| 23 | private $headers = array(); |
||
| 24 | |||
| 25 | private $capath; |
||
| 26 | private $cafile; |
||
| 27 | |||
| 28 | protected static $defaultCurlOptions = array(); |
||
| 29 | |||
| 30 | private static $NSS_CIPHERS = array( |
||
| 31 | 'rsa_3des_sha', |
||
| 32 | 'rsa_des_sha', |
||
| 33 | 'rsa_null_md5', |
||
| 34 | 'rsa_null_sha', |
||
| 35 | 'rsa_rc2_40_md5', |
||
| 36 | 'rsa_rc4_128_md5', |
||
| 37 | 'rsa_rc4_128_sha', |
||
| 38 | 'rsa_rc4_40_md5', |
||
| 39 | 'fips_des_sha', |
||
| 40 | 'fips_3des_sha', |
||
| 41 | 'rsa_des_56_sha', |
||
| 42 | 'rsa_rc4_56_sha', |
||
| 43 | 'rsa_aes_128_sha', |
||
| 44 | 'rsa_aes_256_sha', |
||
| 45 | 'rsa_aes_128_gcm_sha_256', |
||
| 46 | 'dhe_rsa_aes_128_gcm_sha_256', |
||
| 47 | 'ecdh_ecdsa_null_sha', |
||
| 48 | 'ecdh_ecdsa_rc4_128_sha', |
||
| 49 | 'ecdh_ecdsa_3des_sha', |
||
| 50 | 'ecdh_ecdsa_aes_128_sha', |
||
| 51 | 'ecdh_ecdsa_aes_256_sha', |
||
| 52 | 'ecdhe_ecdsa_null_sha', |
||
| 53 | 'ecdhe_ecdsa_rc4_128_sha', |
||
| 54 | 'ecdhe_ecdsa_3des_sha', |
||
| 55 | 'ecdhe_ecdsa_aes_128_sha', |
||
| 56 | 'ecdhe_ecdsa_aes_256_sha', |
||
| 57 | 'ecdh_rsa_null_sha', |
||
| 58 | 'ecdh_rsa_128_sha', |
||
| 59 | 'ecdh_rsa_3des_sha', |
||
| 60 | 'ecdh_rsa_aes_128_sha', |
||
| 61 | 'ecdh_rsa_aes_256_sha', |
||
| 62 | 'ecdhe_rsa_rc4_128_sha', |
||
| 63 | 'ecdhe_rsa_3des_sha', |
||
| 64 | 'ecdhe_rsa_aes_128_sha', |
||
| 65 | 'ecdhe_rsa_aes_256_sha', |
||
| 66 | 'ecdhe_ecdsa_aes_128_gcm_sha_256', |
||
| 67 | 'ecdhe_rsa_aes_128_gcm_sha_256', |
||
| 68 | ); |
||
| 69 | |||
| 70 | /** |
||
| 71 | * enable ECC cipher suites in cURL/NSS |
||
| 72 | * @codeCoverageIgnore |
||
| 73 | */ |
||
| 74 | public static function nssCiphers() |
||
| 86 | |||
| 87 | 4 | protected function getProxy($url) |
|
| 113 | |||
| 114 | /** |
||
| 115 | * @param $io |
||
| 116 | * @param bool $useRedirector |
||
| 117 | * @param $githubDomains |
||
| 118 | * @param $gitlabDomains |
||
| 119 | */ |
||
| 120 | 6 | protected function setupAuthentication(IO\IOInterface $io, $useRedirector, array $githubDomains, array $gitlabDomains) |
|
| 167 | |||
| 168 | /** |
||
| 169 | * @return array |
||
| 170 | */ |
||
| 171 | 4 | public function getCurlOptions() |
|
| 236 | |||
| 237 | /** |
||
| 238 | * @return string |
||
| 239 | */ |
||
| 240 | 7 | public function getURL() |
|
| 254 | |||
| 255 | /** |
||
| 256 | * @return string user/pass/access_token masked url |
||
| 257 | */ |
||
| 258 | 1 | View Code Duplication | public function getMaskedURL() |
| 266 | |||
| 267 | /** |
||
| 268 | * @return string |
||
| 269 | */ |
||
| 270 | 2 | View Code Duplication | public function getOriginURL() |
| 277 | |||
| 278 | 9 | private static function ifOr($str, $pre = '', $post = '') |
|
| 285 | |||
| 286 | /** |
||
| 287 | * @param string $url |
||
| 288 | */ |
||
| 289 | 11 | public function setURL($url) |
|
| 300 | |||
| 301 | 1 | public function addParam($key, $val) |
|
| 305 | |||
| 306 | 1 | public function addHeader($key, $val) |
|
| 310 | |||
| 311 | 7 | public function setCA($path = null, $file = null) |
|
| 316 | |||
| 317 | 1 | public function isHTTP() |
|
| 321 | } |
||
| 322 |
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: