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:
| 1 | <?php |
||
| 15 | class Client extends \GuzzleHttp\Client |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * @const string Version number |
||
| 19 | */ |
||
| 20 | const VERSION = '0.0.1'; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Defaults to expecting that Apache Tomcat runs on port 8080 on localhost |
||
| 24 | * (127.0.0.1). |
||
| 25 | * |
||
| 26 | * @var array[] |
||
| 27 | */ |
||
| 28 | protected $options = [ |
||
| 29 | 'scheme' => 'https', |
||
| 30 | 'hostname' => 'localhost', |
||
| 31 | 'port' => '8080', |
||
| 32 | 'token' => null, |
||
| 33 | 'username' => null, |
||
| 34 | 'password' => null, |
||
| 35 | ]; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @param $options array |
||
| 39 | */ |
||
| 40 | 20 | public function __construct($options = []) |
|
| 63 | |||
| 64 | /** |
||
| 65 | * Set the bearer token. |
||
| 66 | * |
||
| 67 | * @param string $token Bearer Token from Auth request |
||
| 68 | */ |
||
| 69 | 11 | public function setBearerToken($token) |
|
| 73 | |||
| 74 | /** |
||
| 75 | * Authenticate and get Bearer token from SmartCall. |
||
| 76 | * |
||
| 77 | * @param string $username |
||
| 78 | * @param string $password |
||
| 79 | * |
||
| 80 | * @throws Exception |
||
| 81 | * |
||
| 82 | * @return array |
||
| 83 | */ |
||
| 84 | 3 | public function auth($username, $password) |
|
| 85 | { |
||
| 86 | try { |
||
| 87 | 3 | $response = $this->post( |
|
| 88 | 3 | '/webservice/auth', |
|
| 89 | [ |
||
| 90 | 'headers' => [ |
||
| 91 | 3 | 'Authorization' => sprintf( |
|
| 92 | 3 | 'Basic %s', |
|
| 93 | 3 | base64_encode( |
|
| 94 | 3 | sprintf( |
|
| 95 | 3 | '%s:%s', |
|
| 96 | 3 | $username, |
|
| 97 | 3 | $password |
|
| 98 | ) |
||
| 99 | ) |
||
| 100 | ), |
||
| 101 | ], |
||
| 102 | ] |
||
| 103 | ); |
||
| 104 | |||
| 105 | return [ |
||
| 106 | 1 | 'status' => 'ok', |
|
| 107 | 1 | 'http_code' => $response->getStatusCode(), |
|
| 108 | 1 | 'body' => (string) $response->getBody(), |
|
| 109 | ]; |
||
| 110 | 2 | } catch (\GuzzleHttp\Exception\ClientException $e) { |
|
| 111 | 2 | return $this->clientError($e); |
|
| 112 | } catch (\GuzzleHttp\Exception\ServerException $e) { |
||
| 113 | return $this->parseError($e); |
||
| 114 | } |
||
| 115 | } |
||
| 116 | |||
| 117 | /** |
||
| 118 | * Authenticate and invalidates all the user allocated tokens. |
||
| 119 | * |
||
| 120 | * @throws Exception |
||
| 121 | * |
||
| 122 | * @return array |
||
| 123 | */ |
||
| 124 | 2 | View Code Duplication | public function authDelete() |
| 150 | |||
| 151 | /** |
||
| 152 | * Authenticate and invalidates all the user allocated tokens. |
||
| 153 | * |
||
| 154 | * @param string $username |
||
| 155 | * @param string $password |
||
| 156 | * |
||
| 157 | * @throws Exception |
||
| 158 | * |
||
| 159 | * @return array |
||
| 160 | */ |
||
| 161 | 3 | View Code Duplication | public function authFlush($username = null, $password = null) |
| 184 | |||
| 185 | /** |
||
| 186 | * Authenticate and gets the number of available session tokens. |
||
| 187 | * |
||
| 188 | * @param string $username |
||
| 189 | * @param string $password |
||
| 190 | * |
||
| 191 | * @throws Exception |
||
| 192 | * |
||
| 193 | * @return array |
||
| 194 | */ |
||
| 195 | 3 | View Code Duplication | public function authToken($username = null, $password = null) |
| 218 | |||
| 219 | /** |
||
| 220 | * Authenticate and request period based cashup reports. |
||
| 221 | * |
||
| 222 | * @param string $dealerMsisdn |
||
| 223 | * @param string $start |
||
| 224 | * @param string $end |
||
| 225 | * |
||
| 226 | * @throws Exception |
||
| 227 | * |
||
| 228 | * @return array |
||
| 229 | */ |
||
| 230 | public function cashup($dealerMsisdn, $start, $end) |
||
| 261 | |||
| 262 | /** |
||
| 263 | * Authenticate and request current day cashup report. |
||
| 264 | * |
||
| 265 | * @param string $dealerMsisdn |
||
| 266 | * |
||
| 267 | * @throws Exception |
||
| 268 | * |
||
| 269 | * @return array |
||
| 270 | */ |
||
| 271 | View Code Duplication | public function cashupToday($dealerMsisdn) |
|
| 300 | |||
| 301 | /** |
||
| 302 | * Authenticate and retrieves a list of all available networks. |
||
| 303 | * |
||
| 304 | * @throws Exception |
||
| 305 | * |
||
| 306 | * @return array |
||
| 307 | */ |
||
| 308 | 2 | View Code Duplication | public function network($id) |
| 337 | |||
| 338 | /** |
||
| 339 | * Authenticate and retrieves a list of all available networks. |
||
| 340 | * |
||
| 341 | * @throws Exception |
||
| 342 | * |
||
| 343 | * @return array |
||
| 344 | */ |
||
| 345 | 2 | View Code Duplication | public function networks() |
| 371 | |||
| 372 | /** |
||
| 373 | * Test SmartCall is responding. |
||
| 374 | * |
||
| 375 | * @throws Exception |
||
| 376 | * |
||
| 377 | * @return array |
||
| 378 | */ |
||
| 379 | 1 | public function ping() |
|
| 397 | |||
| 398 | /** |
||
| 399 | * Authenticate and retrieves a list of all available networks. |
||
| 400 | * |
||
| 401 | * @throws Exception |
||
| 402 | * |
||
| 403 | * @return array |
||
| 404 | */ |
||
| 405 | 2 | View Code Duplication | public function products($id) |
| 434 | |||
| 435 | /** |
||
| 436 | * Parse the java exception that we receive from Smartcall's Tomcat's. |
||
| 437 | * |
||
| 438 | * @param \GuzzleHttp\Exception\ServerException $exception |
||
| 439 | * |
||
| 440 | * @return array |
||
| 441 | */ |
||
| 442 | 9 | View Code Duplication | private function clientError(\GuzzleHttp\Exception\ClientException $exception) |
| 452 | |||
| 453 | /** |
||
| 454 | * Parse the java exception that we receive from Smartcall's Tomcat's. |
||
| 455 | * |
||
| 456 | * @param \GuzzleHttp\Exception\ServerException $exception |
||
| 457 | * |
||
| 458 | * @return array |
||
| 459 | */ |
||
| 460 | View Code Duplication | private function parseError(\GuzzleHttp\Exception\ServerException $exception) |
|
| 470 | |||
| 471 | /** |
||
| 472 | * Use basic authentication header content if bearer token is not set. |
||
| 473 | * |
||
| 474 | * @param string $username |
||
| 475 | * @param string $password |
||
| 476 | * |
||
| 477 | * @return string |
||
| 478 | */ |
||
| 479 | 6 | private function bearerOrBasic($username = null, $password = null) |
|
| 499 | } |
||
| 500 |
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..