pH7Software /
pH7-Social-Dating-CMS
Complex classes like tmhOAuth 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 tmhOAuth, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | class tmhOAuth { |
||
| 15 | const VERSION = '0.7.2'; |
||
| 16 | |||
| 17 | var $response = array(); |
||
|
|
|||
| 18 | |||
| 19 | /** |
||
| 20 | * Creates a new tmhOAuth object |
||
| 21 | * |
||
| 22 | * @param string $config, the configuration to use for this request |
||
| 23 | */ |
||
| 24 | public function __construct($config=array()) { |
||
| 91 | |||
| 92 | private function set_user_agent() { |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Generates a random OAuth nonce. |
||
| 108 | * If 'force_nonce' is true a nonce is not generated and the value in the configuration will be retained. |
||
| 109 | * |
||
| 110 | * @param string $length how many characters the nonce should be before MD5 hashing. default 12 |
||
| 111 | * @param string $include_time whether to include time at the beginning of the nonce. default true |
||
| 112 | * @return void |
||
| 113 | */ |
||
| 114 | private function create_nonce($length=12, $include_time=true) { |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Generates a timestamp. |
||
| 127 | * If 'force_timestamp' is true a nonce is not generated and the value in the configuration will be retained. |
||
| 128 | * |
||
| 129 | * @return void |
||
| 130 | */ |
||
| 131 | private function create_timestamp() { |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Encodes the string or array passed in a way compatible with OAuth. |
||
| 137 | * If an array is passed each array value will will be encoded. |
||
| 138 | * |
||
| 139 | * @param mixed $data the scalar or array to encode |
||
| 140 | * @return $data encoded in a way compatible with OAuth |
||
| 141 | */ |
||
| 142 | private function safe_encode($data) { |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Decodes the string or array from it's URL encoded form |
||
| 158 | * If an array is passed each array value will will be decoded. |
||
| 159 | * |
||
| 160 | * @param mixed $data the scalar or array to decode |
||
| 161 | * @return $data decoded from the URL encoded form |
||
| 162 | */ |
||
| 163 | private function safe_decode($data) { |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Returns an array of the standard OAuth parameters. |
||
| 175 | * |
||
| 176 | * @return array all required OAuth parameters, safely encoded |
||
| 177 | */ |
||
| 178 | private function get_defaults() { |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Extracts and decodes OAuth parameters from the passed string |
||
| 201 | * |
||
| 202 | * @param string $body the response body from an OAuth flow method |
||
| 203 | * @return array the response body safely decoded to an array of key => values |
||
| 204 | */ |
||
| 205 | public function extract_params($body) { |
||
| 216 | |||
| 217 | /** |
||
| 218 | * Prepares the HTTP method for use in the base string by converting it to |
||
| 219 | * uppercase. |
||
| 220 | * |
||
| 221 | * @param string $method an HTTP method such as GET or POST |
||
| 222 | * @return void value is stored to a class variable |
||
| 223 | * @author themattharris |
||
| 224 | */ |
||
| 225 | private function prepare_method($method) { |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Prepares the URL for use in the base string by ripping it apart and |
||
| 231 | * reconstructing it. |
||
| 232 | * |
||
| 233 | * Ref: 3.4.1.2 |
||
| 234 | * |
||
| 235 | * @param string $url the request URL |
||
| 236 | * @return void value is stored to a class variable |
||
| 237 | * @author themattharris |
||
| 238 | */ |
||
| 239 | private function prepare_url($url) { |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Prepares all parameters for the base string and request. |
||
| 262 | * Multipart parameters are ignored as they are not defined in the specification, |
||
| 263 | * all other types of parameter are encoded for compatibility with OAuth. |
||
| 264 | * |
||
| 265 | * @param array $params the parameters for the request |
||
| 266 | * @return void prepared values are stored in class variables |
||
| 267 | */ |
||
| 268 | private function prepare_params($params) { |
||
| 315 | |||
| 316 | /** |
||
| 317 | * Prepares the OAuth signing key |
||
| 318 | * |
||
| 319 | * @return void prepared signing key is stored in a class variables |
||
| 320 | */ |
||
| 321 | private function prepare_signing_key() { |
||
| 324 | |||
| 325 | /** |
||
| 326 | * Prepare the base string. |
||
| 327 | * Ref: Spec: 9.1.3 ("Concatenate Request Elements") |
||
| 328 | * |
||
| 329 | * @return void prepared base string is stored in a class variables |
||
| 330 | */ |
||
| 331 | private function prepare_base_string() { |
||
| 339 | |||
| 340 | /** |
||
| 341 | * Prepares the Authorization header |
||
| 342 | * |
||
| 343 | * @return void prepared authorization header is stored in a class variables |
||
| 344 | */ |
||
| 345 | private function prepare_auth_header() { |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Signs the request and adds the OAuth signature. This runs all the request |
||
| 362 | * parameter preparation methods. |
||
| 363 | * |
||
| 364 | * @param string $method the HTTP method being used. e.g. POST, GET, HEAD etc |
||
| 365 | * @param string $url the request URL without query string parameters |
||
| 366 | * @param array $params the request parameters as an array of key=value pairs |
||
| 367 | * @param string $useauth whether to use authentication when making the request. |
||
| 368 | */ |
||
| 369 | private function sign($method, $url, $params, $useauth) { |
||
| 388 | |||
| 389 | /** |
||
| 390 | * Make an HTTP request using this library. This method doesn't return anything. |
||
| 391 | * Instead the response should be inspected directly. |
||
| 392 | * |
||
| 393 | * @param string $method the HTTP method being used. e.g. POST, GET, HEAD etc |
||
| 394 | * @param string $url the request URL without query string parameters |
||
| 395 | * @param array $params the request parameters as an array of key=value pairs. Default empty array |
||
| 396 | * @param string $useauth whether to use authentication when making the request. Default true |
||
| 397 | * @param string $multipart whether this request contains multipart data. Default false |
||
| 398 | * @param array $headers any custom headers to send with the request. Default empty array |
||
| 399 | */ |
||
| 400 | public function request($method, $url, $params=array(), $useauth=true, $multipart=false, $headers=array()) { |
||
| 413 | |||
| 414 | /** |
||
| 415 | * Make a long poll HTTP request using this library. This method is |
||
| 416 | * different to the other request methods as it isn't supposed to disconnect |
||
| 417 | * |
||
| 418 | * Using this method expects a callback which will receive the streaming |
||
| 419 | * responses. |
||
| 420 | * |
||
| 421 | * @param string $method the HTTP method being used. e.g. POST, GET, HEAD etc |
||
| 422 | * @param string $url the request URL without query string parameters |
||
| 423 | * @param array $params the request parameters as an array of key=value pairs |
||
| 424 | * @param string $callback the callback function to stream the buffer to. |
||
| 425 | */ |
||
| 426 | public function streaming_request($method, $url, $params=array(), $callback='') { |
||
| 442 | |||
| 443 | /** |
||
| 444 | * Handles the updating of the current Streaming API metrics. |
||
| 445 | */ |
||
| 446 | private function update_metrics() { |
||
| 459 | |||
| 460 | /** |
||
| 461 | * Utility function to create the request URL in the requested format |
||
| 462 | * |
||
| 463 | * @param string $request the API method without extension |
||
| 464 | * @param string $format the format of the response. Default json. Set to an empty string to exclude the format |
||
| 465 | * @return string the concatenation of the host, API version, API method and format |
||
| 466 | */ |
||
| 467 | public function url($request, $format='json') { |
||
| 487 | |||
| 488 | /** |
||
| 489 | * Public access to the private safe decode/encode methods |
||
| 490 | * |
||
| 491 | * @param string $text the text to transform |
||
| 492 | * @param string $mode the transformation mode. either encode or decode |
||
| 493 | * @return the string as transformed by the given mode |
||
| 494 | */ |
||
| 495 | public function transformText($text, $mode='encode') { |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Utility function to parse the returned curl headers and store them in the |
||
| 501 | * class array variable. |
||
| 502 | * |
||
| 503 | * @param object $ch curl handle |
||
| 504 | * @param string $header the response headers |
||
| 505 | * @return the string length of the header |
||
| 506 | */ |
||
| 507 | private function curlHeader($ch, $header) { |
||
| 515 | |||
| 516 | /** |
||
| 517 | * Utility function to parse the returned curl buffer and store them until |
||
| 518 | * an EOL is found. The buffer for curl is an undefined size so we need |
||
| 519 | * to collect the content until an EOL is found. |
||
| 520 | * |
||
| 521 | * This function calls the previously defined streaming callback method. |
||
| 522 | * |
||
| 523 | * @param object $ch curl handle |
||
| 524 | * @param string $data the current curl buffer |
||
| 525 | */ |
||
| 526 | private function curlWrite($ch, $data) { |
||
| 555 | |||
| 556 | /** |
||
| 557 | * Makes a curl request. Takes no parameters as all should have been prepared |
||
| 558 | * by the request method |
||
| 559 | * |
||
| 560 | * @return void response data is stored in the class variable 'response' |
||
| 561 | */ |
||
| 562 | private function curlit() { |
||
| 678 | } |
Loading history...
The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using
the property is implicitly global.
To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.