fooplugins /
foogallery
Complex classes like Freemius_Api_WordPress 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 Freemius_Api_WordPress, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 85 | class Freemius_Api_WordPress extends Freemius_Api_Base {
|
||
| 86 | private static $_logger = array(); |
||
| 87 | |||
| 88 | /** |
||
| 89 | * @param string $pScope 'app', 'developer', 'user' or 'install'. |
||
| 90 | * @param number $pID Element's id. |
||
| 91 | * @param string $pPublic Public key. |
||
| 92 | * @param string|bool $pSecret Element's secret key. |
||
| 93 | * @param bool $pSandbox Whether or not to run API in sandbox mode. |
||
| 94 | */ |
||
| 95 | public function __construct( $pScope, $pID, $pPublic, $pSecret = false, $pSandbox = false ) {
|
||
| 103 | |||
| 104 | public static function GetUrl( $pCanonizedPath = '', $pIsSandbox = false ) {
|
||
| 113 | |||
| 114 | #---------------------------------------------------------------------------------- |
||
| 115 | #region Servers Clock Diff |
||
| 116 | #---------------------------------------------------------------------------------- |
||
| 117 | |||
| 118 | /** |
||
| 119 | * @var int Clock diff in seconds between current server to API server. |
||
| 120 | */ |
||
| 121 | private static $_clock_diff = 0; |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Set clock diff for all API calls. |
||
| 125 | * |
||
| 126 | * @since 1.0.3 |
||
| 127 | * |
||
| 128 | * @param $pSeconds |
||
| 129 | */ |
||
| 130 | public static function SetClockDiff( $pSeconds ) {
|
||
| 133 | |||
| 134 | /** |
||
| 135 | * Find clock diff between current server to API server. |
||
| 136 | * |
||
| 137 | * @since 1.0.2 |
||
| 138 | * @return int Clock diff in seconds. |
||
| 139 | */ |
||
| 140 | public static function FindClockDiff() {
|
||
| 146 | |||
| 147 | #endregion |
||
| 148 | |||
| 149 | /** |
||
| 150 | * @var string http or https |
||
| 151 | */ |
||
| 152 | private static $_protocol = FS_API__PROTOCOL; |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Set API connection protocol. |
||
| 156 | * |
||
| 157 | * @since 1.0.4 |
||
| 158 | */ |
||
| 159 | public static function SetHttp() {
|
||
| 162 | |||
| 163 | /** |
||
| 164 | * @since 1.0.4 |
||
| 165 | * |
||
| 166 | * @return bool |
||
| 167 | */ |
||
| 168 | public static function IsHttps() {
|
||
| 171 | |||
| 172 | /** |
||
| 173 | * Sign request with the following HTTP headers: |
||
| 174 | * Content-MD5: MD5(HTTP Request body) |
||
| 175 | * Date: Current date (i.e Sat, 14 Feb 2016 20:24:46 +0000) |
||
| 176 | * Authorization: FS {scope_entity_id}:{scope_entity_public_key}:base64encode(sha256(string_to_sign,
|
||
| 177 | * {scope_entity_secret_key}))
|
||
| 178 | * |
||
| 179 | * @param string $pResourceUrl |
||
| 180 | * @param array $pWPRemoteArgs |
||
| 181 | * |
||
| 182 | * @return array |
||
| 183 | */ |
||
| 184 | function SignRequest( $pResourceUrl, $pWPRemoteArgs ) {
|
||
| 200 | |||
| 201 | /** |
||
| 202 | * Generate Authorization request headers: |
||
| 203 | * |
||
| 204 | * Content-MD5: MD5(HTTP Request body) |
||
| 205 | * Date: Current date (i.e Sat, 14 Feb 2016 20:24:46 +0000) |
||
| 206 | * Authorization: FS {scope_entity_id}:{scope_entity_public_key}:base64encode(sha256(string_to_sign,
|
||
| 207 | * {scope_entity_secret_key}))
|
||
| 208 | * |
||
| 209 | * @author Vova Feldman |
||
| 210 | * |
||
| 211 | * @param string $pResourceUrl |
||
| 212 | * @param string $pMethod |
||
| 213 | * @param string $pPostParams |
||
| 214 | * |
||
| 215 | * @return array |
||
| 216 | * @throws Freemius_Exception |
||
| 217 | */ |
||
| 218 | function GenerateAuthorizationParams( |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Get API request URL signed via query string. |
||
| 266 | * |
||
| 267 | * @since 1.2.3 Stopped using http_build_query(). Instead, use urlencode(). In some environments the encoding of http_build_query() can generate a URL that once used with a redirect, the `&` querystring separator is escaped to `&` which breaks the URL (Added by @svovaf). |
||
| 268 | * |
||
| 269 | * @param string $pPath |
||
| 270 | * |
||
| 271 | * @throws Freemius_Exception |
||
| 272 | * |
||
| 273 | * @return string |
||
| 274 | */ |
||
| 275 | function GetSignedUrl( $pPath ) {
|
||
| 288 | |||
| 289 | /** |
||
| 290 | * @author Vova Feldman |
||
| 291 | * |
||
| 292 | * @param string $pUrl |
||
| 293 | * @param array $pWPRemoteArgs |
||
| 294 | * |
||
| 295 | * @return mixed |
||
| 296 | */ |
||
| 297 | private static function ExecuteRequest( $pUrl, &$pWPRemoteArgs ) {
|
||
| 326 | |||
| 327 | /** |
||
| 328 | * @return array |
||
| 329 | */ |
||
| 330 | static function GetLogger() {
|
||
| 333 | |||
| 334 | /** |
||
| 335 | * @param string $pCanonizedPath |
||
| 336 | * @param string $pMethod |
||
| 337 | * @param array $pParams |
||
| 338 | * @param null|array $pWPRemoteArgs |
||
| 339 | * @param bool $pIsSandbox |
||
| 340 | * @param null|callable $pBeforeExecutionFunction |
||
| 341 | * |
||
| 342 | * @return object[]|object|null |
||
| 343 | * |
||
| 344 | * @throws \Freemius_Exception |
||
| 345 | */ |
||
| 346 | private static function MakeStaticRequest( |
||
| 479 | |||
| 480 | |||
| 481 | /** |
||
| 482 | * Makes an HTTP request. This method can be overridden by subclasses if |
||
| 483 | * developers want to do fancier things or use something other than wp_remote_request() |
||
| 484 | * to make the request. |
||
| 485 | * |
||
| 486 | * @param string $pCanonizedPath The URL to make the request to |
||
| 487 | * @param string $pMethod HTTP method |
||
| 488 | * @param array $pParams The parameters to use for the POST body |
||
| 489 | * @param null|array $pWPRemoteArgs wp_remote_request options. |
||
| 490 | * |
||
| 491 | * @return object[]|object|null |
||
| 492 | * |
||
| 493 | * @throws Freemius_Exception |
||
| 494 | */ |
||
| 495 | public function MakeRequest( |
||
| 515 | |||
| 516 | /** |
||
| 517 | * Sets CURLOPT_IPRESOLVE to CURL_IPRESOLVE_V4 for cURL-Handle provided as parameter |
||
| 518 | * |
||
| 519 | * @param resource $handle A cURL handle returned by curl_init() |
||
| 520 | * |
||
| 521 | * @return resource $handle A cURL handle returned by curl_init() with CURLOPT_IPRESOLVE set to |
||
| 522 | * CURL_IPRESOLVE_V4 |
||
| 523 | * |
||
| 524 | * @link https://gist.github.com/golderweb/3a2aaec2d56125cc004e |
||
| 525 | */ |
||
| 526 | static function CurlResolveToIPv4( $handle ) {
|
||
| 531 | |||
| 532 | #---------------------------------------------------------------------------------- |
||
| 533 | #region Connectivity Test |
||
| 534 | #---------------------------------------------------------------------------------- |
||
| 535 | |||
| 536 | /** |
||
| 537 | * If successful connectivity to the API endpoint using ping.json endpoint. |
||
| 538 | * |
||
| 539 | * - OR - |
||
| 540 | * |
||
| 541 | * Validate if ping result object is valid. |
||
| 542 | * |
||
| 543 | * @param mixed $pPong |
||
| 544 | * |
||
| 545 | * @return bool |
||
| 546 | */ |
||
| 547 | public static function Test( $pPong = null ) {
|
||
| 558 | |||
| 559 | /** |
||
| 560 | * Ping API to test connectivity. |
||
| 561 | * |
||
| 562 | * @return object |
||
| 563 | */ |
||
| 564 | public static function Ping() {
|
||
| 584 | |||
| 585 | #endregion |
||
| 586 | |||
| 587 | #---------------------------------------------------------------------------------- |
||
| 588 | #region Connectivity Exceptions |
||
| 589 | #---------------------------------------------------------------------------------- |
||
| 590 | |||
| 591 | /** |
||
| 592 | * @param \WP_Error $pError |
||
| 593 | * |
||
| 594 | * @return bool |
||
| 595 | */ |
||
| 596 | private static function IsCurlError( WP_Error $pError ) {
|
||
| 601 | |||
| 602 | /** |
||
| 603 | * @param WP_Error $pError |
||
| 604 | * |
||
| 605 | * @throws Freemius_Exception |
||
| 606 | */ |
||
| 607 | private static function ThrowWPRemoteException( WP_Error $pError ) {
|
||
| 670 | |||
| 671 | /** |
||
| 672 | * @param string $pResult |
||
| 673 | * |
||
| 674 | * @throws Freemius_Exception |
||
| 675 | */ |
||
| 676 | private static function ThrowCloudFlareDDoSException( $pResult = '' ) {
|
||
| 686 | |||
| 687 | /** |
||
| 688 | * @param string $pResult |
||
| 689 | * |
||
| 690 | * @throws Freemius_Exception |
||
| 691 | */ |
||
| 692 | private static function ThrowSquidAclException( $pResult = '' ) {
|
||
| 702 | |||
| 703 | #endregion |
||
| 704 | } |
Loading history...
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.