Conditions | 25 |
Paths | 5337 |
Total Lines | 174 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
1 | <?php |
||
461 | public function get_messages( $message_path, $query ) { |
||
462 | // Custom filters go here. |
||
463 | add_filter( 'jitm_woocommerce_services_msg', array( $this, 'jitm_woocommerce_services_msg' ) ); |
||
464 | add_filter( 'jitm_jetpack_woo_services_install', array( $this, 'jitm_jetpack_woo_services_install' ) ); |
||
465 | add_filter( 'jitm_jetpack_woo_services_activate', array( $this, 'jitm_jetpack_woo_services_activate' ) ); |
||
466 | |||
467 | $user = wp_get_current_user(); |
||
468 | |||
469 | // Unauthenticated or invalid requests just bail. |
||
470 | if ( ! $user ) { |
||
471 | return array(); |
||
472 | } |
||
473 | |||
474 | $user_roles = implode( ',', $user->roles ); |
||
475 | $site_id = \Jetpack_Options::get_option( 'id' ); |
||
476 | |||
477 | // Build our jitm request. |
||
478 | $path = add_query_arg( |
||
479 | array( |
||
480 | 'external_user_id' => urlencode_deep( $user->ID ), |
||
481 | 'user_roles' => urlencode_deep( $user_roles ), |
||
482 | 'query_string' => urlencode_deep( $query ), |
||
483 | 'mobile_browser' => jetpack_is_mobile( 'smart' ) ? 1 : 0, |
||
484 | '_locale' => get_user_locale(), |
||
485 | ), |
||
486 | sprintf( '/sites/%d/jitm/%s', $site_id, $message_path ) |
||
487 | ); |
||
488 | |||
489 | // Attempt to get from cache. |
||
490 | $envelopes = get_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ) ); |
||
491 | |||
492 | // If something is in the cache and it was put in the cache after the last sync we care about, use it. |
||
493 | $use_cache = false; |
||
494 | |||
495 | /** This filter is documented in class.jetpack.php */ |
||
496 | if ( apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) { |
||
497 | $use_cache = true; |
||
498 | } |
||
499 | |||
500 | if ( $use_cache ) { |
||
501 | $last_sync = (int) get_transient( 'jetpack_last_plugin_sync' ); |
||
502 | $from_cache = $envelopes && $last_sync > 0 && $last_sync < $envelopes['last_response_time']; |
||
503 | } else { |
||
504 | $from_cache = false; |
||
505 | } |
||
506 | |||
507 | // Otherwise, ask again. |
||
508 | if ( ! $from_cache ) { |
||
509 | $wpcom_response = Client::wpcom_json_api_request_as_blog( |
||
510 | $path, |
||
511 | '2', |
||
512 | array( |
||
513 | 'user_id' => $user->ID, |
||
514 | 'user_roles' => implode( ',', $user->roles ), |
||
515 | ), |
||
516 | null, |
||
517 | 'wpcom' |
||
518 | ); |
||
519 | |||
520 | // silently fail...might be helpful to track it? |
||
521 | if ( is_wp_error( $wpcom_response ) ) { |
||
522 | return array(); |
||
523 | } |
||
524 | |||
525 | $envelopes = json_decode( $wpcom_response['body'] ); |
||
526 | |||
527 | if ( ! is_array( $envelopes ) ) { |
||
528 | return array(); |
||
529 | } |
||
530 | |||
531 | $expiration = isset( $envelopes[0] ) ? $envelopes[0]->ttl : 300; |
||
532 | |||
533 | // Do not cache if expiration is 0 or we're not using the cache. |
||
534 | if ( 0 !== $expiration && $use_cache ) { |
||
535 | $envelopes['last_response_time'] = time(); |
||
536 | |||
537 | set_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ), $envelopes, $expiration ); |
||
538 | } |
||
539 | } |
||
540 | |||
541 | $hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' ); |
||
542 | unset( $envelopes['last_response_time'] ); |
||
543 | |||
544 | /** |
||
545 | * Allow adding your own custom JITMs after a set of JITMs has been received. |
||
546 | * |
||
547 | * @since 6.9.0 |
||
548 | * |
||
549 | * @param array $envelopes array of existing JITMs. |
||
550 | */ |
||
551 | $envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes ); |
||
552 | |||
553 | foreach ( $envelopes as $idx => &$envelope ) { |
||
554 | |||
555 | $dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null; |
||
556 | |||
557 | // If the this feature class has been dismissed and the request has not passed the ttl, skip it as it's been dismissed. |
||
558 | if ( is_array( $dismissed_feature ) && ( time() - $dismissed_feature['last_dismissal'] < $envelope->expires || $dismissed_feature['number'] >= $envelope->max_dismissal ) ) { |
||
559 | unset( $envelopes[ $idx ] ); |
||
560 | continue; |
||
561 | } |
||
562 | |||
563 | $this->tracking->record_user_event( |
||
564 | 'jitm_view_client', |
||
565 | array( |
||
566 | 'jitm_id' => $envelope->id, |
||
567 | ) |
||
568 | ); |
||
569 | |||
570 | $normalized_site_url = \Jetpack::build_raw_urls( get_home_url() ); |
||
571 | |||
572 | $url_params = array( |
||
573 | 'source' => "jitm-$envelope->id", |
||
574 | 'site' => $normalized_site_url, |
||
575 | 'u' => $user->ID, |
||
576 | ); |
||
577 | |||
578 | // Get affiliate code and add it to the array of URL parameters. |
||
579 | $aff = Partner::init()->get_partner_code( Partner::AFFILIATE_CODE ); |
||
580 | if ( '' !== $aff ) { |
||
581 | $url_params['aff'] = $aff; |
||
582 | } |
||
583 | |||
584 | $envelope->url = add_query_arg( $url_params, 'https://jetpack.com/redirect/' ); |
||
585 | |||
586 | $envelope->jitm_stats_url = \Jetpack::build_stats_url( array( 'x_jetpack-jitm' => $envelope->id ) ); |
||
587 | |||
588 | // phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase |
||
589 | // $CTA is not valid per PHPCS, but it is part of the return from WordPress.com, so allowing. |
||
590 | if ( $envelope->CTA->hook ) { |
||
591 | $envelope->url = apply_filters( 'jitm_' . $envelope->CTA->hook, $envelope->url ); |
||
592 | unset( $envelope->CTA->hook ); |
||
593 | } |
||
594 | // phpcs:enable |
||
595 | |||
596 | if ( isset( $envelope->content->hook ) ) { |
||
597 | $envelope->content = apply_filters( 'jitm_' . $envelope->content->hook, $envelope->content ); |
||
598 | unset( $envelope->content->hook ); |
||
599 | } |
||
600 | |||
601 | // No point in showing an empty message. |
||
602 | if ( empty( $envelope->content->message ) ) { |
||
603 | unset( $envelopes[ $idx ] ); |
||
604 | continue; |
||
605 | } |
||
606 | |||
607 | switch ( $envelope->content->icon ) { |
||
608 | case 'jetpack': |
||
609 | $jetpack_logo = new Jetpack_Logo(); |
||
610 | $envelope->content->icon = '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>'; |
||
611 | break; |
||
612 | case 'woocommerce': |
||
613 | $envelope->content->icon = '<div class="jp-emblem"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 168 100" xml:space="preserve" enable-background="new 0 0 168 100" width="50" height="30"><style type="text/css"> |
||
614 | .st0{clip-path:url(#SVGID_2_);enable-background:new ;} |
||
615 | .st1{clip-path:url(#SVGID_4_);} |
||
616 | .st2{clip-path:url(#SVGID_6_);} |
||
617 | .st3{clip-path:url(#SVGID_8_);fill:#8F567F;} |
||
618 | .st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;} |
||
619 | .st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;} |
||
620 | .st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;} |
||
621 | </style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>'; |
||
622 | break; |
||
623 | default: |
||
624 | $envelope->content->icon = ''; |
||
625 | break; |
||
626 | } |
||
627 | |||
628 | $jetpack = \Jetpack::init(); |
||
629 | $jetpack->stat( 'jitm', $envelope->id . '-viewed-' . JETPACK__VERSION ); |
||
630 | $jetpack->do_stats( 'server_side' ); |
||
631 | } |
||
632 | |||
633 | return $envelopes; |
||
634 | } |
||
635 | |||
646 |
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..