Jetpack_Components::render_upgrade_nudge() - Code Metrics - Inspection of "Components Lib: Use get_edit_post_link() to build..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eedb5c...726851 )

by Jon

created 2019-09-26 08:56 UTC

Jetpack_Components::render_upgrade_nudge() B

↳ Parent: Jetpack_Components

Complexity

Conditions	8
Paths	25

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	25
nop	1
dl	0
loc	57
rs	7.6937
c	0
b	0
f	0

How to fix Long Method

<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
 * Components Library
 *
 * Load and display a pre-rendered component
 */
class Jetpack_Components {
	/**
	 * Load and display a pre-rendered component
	 *
	 * @since 7.7.0
	 *
	 * @param string $name  Component name.
	 * @param array  $props Component properties.
	 *
	 * @return string The component markup
	 */
	public static function render_component( $name, $props ) {

		$rtl = is_rtl() ? '.rtl' : '';
		wp_enqueue_style( 'jetpack-components', plugins_url( "_inc/blocks/components{$rtl}.css", JETPACK__PLUGIN_FILE ), array( 'wp-components' ), JETPACK__VERSION );

		ob_start();
		// `include` fails gracefully and throws a warning, but doesn't halt execution.
		include JETPACK__PLUGIN_DIR . "_inc/blocks/$name.html";
		$markup = ob_get_clean();

		foreach ( $props as $key => $value ) {
			$markup = str_replace(
				"#$key#",
				$value,
				$markup
			);

			// Workaround, required to replace strings in `sprintf`-expressions.
			// See extensions/i18n-to-php.js for more information.
			$markup = str_replace(
				"%($key)s",
				$value,
				$markup
			);
		}

		return $markup;
	}

	/**
	 * Load and display a pre-rendered component
	 *
	 * @since 7.7.0
	 *
	 * @param array $props Component properties.
	 *
	 * @return string The component markup
	 */
	public static function render_upgrade_nudge( $props ) {
		$plan_slug = $props['plan'];
		jetpack_require_lib( 'plans' );
		$plan = Jetpack_Plans::get_plan( $plan_slug );

		if ( ! $plan ) {
			return self::render_component(
				'upgrade-nudge',
				array(
					'planName'   => __( 'a paid plan', 'jetpack' ),
					'upgradeUrl' => '',
				)
			);
		}

		// WP.com plan objects have a dedicated `path_slug` field, Jetpack plan objects don't
		// For Jetpack, we thus use the plan slug with the 'jetpack_' prefix removed.
		$plan_path_slug = wp_startswith( $plan_slug, 'jetpack_' )
			? substr( $plan_slug, strlen( 'jetpack_' ) )
			: $plan->path_slug;

		$post_id   = get_the_ID();
		$post_type = get_post_type();

		// The editor for CPTs has an `edit/` route fragment prefixed.
		$post_type_editor_route_prefix = in_array( $post_type, array( 'page', 'post' ), true ) ? '' : 'edit';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		if ( method_exists( 'Jetpack', 'build_raw_urls' ) ) {
			$site_slug = Jetpack::build_raw_urls( home_url() );
		} elseif ( class_exists( 'WPCOM_Masterbar' ) && method_exists( 'WPCOM_Masterbar', 'get_calypso_site_slug' ) ) {
			$site_slug = WPCOM_Masterbar::get_calypso_site_slug( get_current_blog_id() );
		}

		// Post-checkout: redirect back to the editor.
		$redirect_to = add_query_arg(
			array(
				'plan_upgraded' => 1,
			),
			get_edit_post_link( $post_id )
		);

		$upgrade_url =
			$plan_path_slug
			? add_query_arg(
				'redirect_to',
				$redirect_to,
				"https://wordpress.com/checkout/${site_slug}/${plan_path_slug}"
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			) : '';

		return self::render_component(
			'upgrade-nudge',
			array(
				'planName'   => $plan->product_name,
				'upgradeUrl' => $upgrade_url,
			)
		);
	}
}


1			<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2			/**
3			* Components Library
4			*
5			* Load and display a pre-rendered component
6			*/
7			class Jetpack_Components {
8			/**
9			* Load and display a pre-rendered component
10			*
11			* @since 7.7.0
12			*
13			* @param string $name Component name.
14			* @param array $props Component properties.
15			*
16			* @return string The component markup
17			*/
18			public static function render_component( $name, $props ) {
19
20			$rtl = is_rtl() ? '.rtl' : '';
21			wp_enqueue_style( 'jetpack-components', plugins_url( "_inc/blocks/components{$rtl}.css", JETPACK__PLUGIN_FILE ), array( 'wp-components' ), JETPACK__VERSION );
22
23			ob_start();
24			// `include` fails gracefully and throws a warning, but doesn't halt execution.
25			include JETPACK__PLUGIN_DIR . "_inc/blocks/$name.html";
26			$markup = ob_get_clean();
27
28			foreach ( $props as $key => $value ) {
29			$markup = str_replace(
30			"#$key#",
31			$value,
32			$markup
33			);
34
35			// Workaround, required to replace strings in `sprintf`-expressions.
36			// See extensions/i18n-to-php.js for more information.
37			$markup = str_replace(
38			"%($key)s",
39			$value,
40			$markup
41			);
42			}
43
44			return $markup;
45			}
46
47			/**
48			* Load and display a pre-rendered component
49			*
50			* @since 7.7.0
51			*
52			* @param array $props Component properties.
53			*
54			* @return string The component markup
55			*/
56			public static function render_upgrade_nudge( $props ) {
57			$plan_slug = $props['plan'];
58			jetpack_require_lib( 'plans' );
59			$plan = Jetpack_Plans::get_plan( $plan_slug );
60
61			if ( ! $plan ) {
62			return self::render_component(
63			'upgrade-nudge',
64			array(
65			'planName' => __( 'a paid plan', 'jetpack' ),
66			'upgradeUrl' => '',
67			)
68			);
69			}
70
71			// WP.com plan objects have a dedicated `path_slug` field, Jetpack plan objects don't
72			// For Jetpack, we thus use the plan slug with the 'jetpack_' prefix removed.
73			$plan_path_slug = wp_startswith( $plan_slug, 'jetpack_' )
74			? substr( $plan_slug, strlen( 'jetpack_' ) )
75			: $plan->path_slug;
76
77			$post_id = get_the_ID();
78			$post_type = get_post_type();
79
80			// The editor for CPTs has an `edit/` route fragment prefixed.
81			$post_type_editor_route_prefix = in_array( $post_type, array( 'page', 'post' ), true ) ? '' : 'edit';
			0 ignored issues – show Unused Code introduced 2019-09-23 22:04 UTC by Report Bug Copy Issue Report `$post_type_editor_route_prefix` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
82
83			if ( method_exists( 'Jetpack', 'build_raw_urls' ) ) {
84			$site_slug = Jetpack::build_raw_urls( home_url() );
85			} elseif ( class_exists( 'WPCOM_Masterbar' ) && method_exists( 'WPCOM_Masterbar', 'get_calypso_site_slug' ) ) {
86			$site_slug = WPCOM_Masterbar::get_calypso_site_slug( get_current_blog_id() );
87			}
88
89			// Post-checkout: redirect back to the editor.
90			$redirect_to = add_query_arg(
91			array(
92			'plan_upgraded' => 1,
93			),
94			get_edit_post_link( $post_id )
95			);
96
97			$upgrade_url =
98			$plan_path_slug
99			? add_query_arg(
100			'redirect_to',
101			$redirect_to,
102			"https://wordpress.com/checkout/${site_slug}/${plan_path_slug}"
			0 ignored issues – show Bug introduced 2019-09-23 22:04 UTC by Report Bug Copy Issue Report The variable `$site_slug` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
103			) : '';
104
105			return self::render_component(
106			'upgrade-nudge',
107			array(
108			'planName' => $plan->product_name,
109			'upgradeUrl' => $upgrade_url,
110			)
111			);
112			}
113			}
114

Automattic / jetpack

Push — master ( eedb5c...726851 )

Jetpack_Components::render_upgrade_nudge() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like