Jetpack_Plan::get() - Code Metrics - Inspection of "Add the missing use declaration to the compat laye..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/compat-sync-actions-use ( 814f9c )

unknown

created 2019-07-11 17:18 UTC

Jetpack_Plan::get() C

↳ Parent: Jetpack_Plan

Complexity

Conditions	11
Paths	33

Size

Total Lines

Duplication

Lines	14
Ratio	15.22 %

Importance

Changes

Metric	Value
cc	11
nc	33
nop	0
dl	14
loc	92
rs	6.0278
c	0
b	0
f	0

How to fix Long Method Complexity

<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
/**
 * Handles fetching of the site's plan from WordPress.com and caching the value locally.
 *
 * @package Jetpack
 */

use Automattic\Jetpack\Connection\Client;

/**
 * Provides methods methods for fetching the plan from WordPress.com.
 */
class Jetpack_Plan {
	/**
	 * A cache variable to hold the active plan for the current request.
	 *
	 * @var array
	 */
	private static $active_plan_cache;

	const PLAN_OPTION = 'jetpack_active_plan';

	/**
	 * Given a response to the `/sites/%d` endpoint, will parse the response and attempt to set the
	 * plan from the response.
	 *
	 * @param array $response The response from `/sites/%d`.
	 * @return bool Was the plan successfully updated?
	 */
	public static function update_from_sites_response( $response ) {
		// Bail if there was an error or malformed response.
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
			return false;
		}

		$body = wp_remote_retrieve_body( $response );
		if ( is_wp_error( $body ) ) {
			return false;
		}

		// Decode the results.
		$results = json_decode( $body, true );

		// Bail if there were no results or plan details returned.
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
			return false;
		}

		// Store the new plan in an option and return true if updated.
		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
		if ( ! $result ) {
			// If we got to this point, then we know we need to update. So, assume there is an issue
			// with caching. To fix that issue, we can delete the current option and then update.
			delete_option( self::PLAN_OPTION );
			$result = update_option( self::PLAN_OPTION, $results['plan'], true );
		}

		if ( $result ) {
			// Reset the cache since we've just updated the plan.
			self::$active_plan_cache = null;

		}

		return $result;
	}

	/**
	 * Make an API call to WordPress.com for plan status
	 *
	 * @uses Jetpack_Options::get_option()
	 * @uses Client::wpcom_json_api_request_as_blog()
	 * @uses update_option()
	 *
	 * @access public
	 * @static
	 *
	 * @return bool True if plan is updated, false if no update
	 */
	public static function refresh_from_wpcom() {
		// Make the API request.
		$request  = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
		$response = Client::wpcom_json_api_request_as_blog( $request, '1.1' );

		return self::update_from_sites_response( $response );
	}

	/**
	 * Get the plan that this Jetpack site is currently using.
	 *
	 * @uses get_option()
	 *
	 * @access public
	 * @static
	 *
	 * @return array Active Jetpack plan details
	 */
	public static function get() {
		// this can be expensive to compute so we cache for the duration of a request.
		if ( is_array( self::$active_plan_cache ) && ! empty( self::$active_plan_cache ) ) {
			return self::$active_plan_cache;
		}

		$plan = get_option( self::PLAN_OPTION, array() );

		// Set the default options.
		$plan = wp_parse_args(
			$plan,
			array(
				'product_slug' => 'jetpack_free',
				'class'        => 'free',
				'features'     => array(
					'active' => array(),
				),
			)
		);

		$supports = array();

		// Define what paid modules are supported by personal plans.
		$personal_plans = array(
			'jetpack_personal',
			'jetpack_personal_monthly',
			'personal-bundle',
			'personal-bundle-monthly',
			'personal-bundle-2y',
		);

		if ( in_array( $plan['product_slug'], $personal_plans, true ) ) {
			// special support value, not a module but a separate plugin.
			$supports[]    = 'akismet';
			$plan['class'] = 'personal';
		}

		// Define what paid modules are supported by premium plans.
		$premium_plans = array(
			'jetpack_premium',
			'jetpack_premium_monthly',
			'value_bundle',
			'value_bundle-monthly',
			'value_bundle-2y',
		);

		if ( in_array( $plan['product_slug'], $premium_plans, true ) ) {
			$supports[]    = 'akismet';
			$supports[]    = 'simple-payments';
			$supports[]    = 'vaultpress';
			$supports[]    = 'videopress';
			$plan['class'] = 'premium';
		}

		// Define what paid modules are supported by professional plans.
		$business_plans = array(
			'jetpack_business',
			'jetpack_business_monthly',
			'business-bundle',
			'business-bundle-monthly',
			'business-bundle-2y',
			'ecommerce-bundle',
			'ecommerce-bundle-monthly',
			'ecommerce-bundle-2y',
			'vip',
		);

		if ( in_array( $plan['product_slug'], $business_plans, true ) ) {
			$supports[]    = 'akismet';
			$supports[]    = 'simple-payments';
			$supports[]    = 'vaultpress';
			$supports[]    = 'videopress';
			$plan['class'] = 'business';
		}

		// get available features.
		foreach ( Jetpack::get_available_modules() as $module_slug ) {
			$module = Jetpack::get_module( $module_slug );
			if ( ! isset( $module ) || ! is_array( $module ) ) {
				continue;
			}
			if ( in_array( 'free', $module['plan_classes'], true ) || in_array( $plan['class'], $module['plan_classes'], true ) ) {
				$supports[] = $module_slug;
			}
		}

		$plan['supports'] = $supports;

		self::$active_plan_cache = $plan;

		return $plan;
	}

	/**
	 * Determine whether the active plan supports a particular feature
	 *
	 * @uses Jetpack_Plan::get()
	 *
	 * @access public
	 * @static
	 *
	 * @param string $feature The module or feature to check.
	 *
	 * @return bool True if plan supports feature, false if not
	 */
	public static function supports( $feature ) {
		$plan = self::get();

		// Manually mapping WordPress.com features to Jetpack module slugs.
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
			switch ( $wpcom_feature ) {
				case 'wordads-jetpack':
					// WordAds are supported for this site.
					if ( 'wordads' === $feature ) {
						return true;
					}
					break;
			}
		}

		if (
			in_array( $feature, $plan['supports'], true )
			|| in_array( $feature, $plan['features']['active'], true )
		) {
			return true;
		}

		return false;
	}
}


1		<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2		/**
3		* Handles fetching of the site's plan from WordPress.com and caching the value locally.
4		*
5		* @package Jetpack
6		*/
7
8		use Automattic\Jetpack\Connection\Client;
9
10		/**
11		* Provides methods methods for fetching the plan from WordPress.com.
12		*/
13		class Jetpack_Plan {
14		/**
15		* A cache variable to hold the active plan for the current request.
16		*
17		* @var array
18		*/
19		private static $active_plan_cache;
20
21		const PLAN_OPTION = 'jetpack_active_plan';
22
23		/**
24		* Given a response to the `/sites/%d` endpoint, will parse the response and attempt to set the
25		* plan from the response.
26		*
27		* @param array $response The response from `/sites/%d`.
28		* @return bool Was the plan successfully updated?
29		*/
30		public static function update_from_sites_response( $response ) {
31		// Bail if there was an error or malformed response.
32		if ( is_wp_error( $response ) \|\| ! is_array( $response ) \|\| ! isset( $response['body'] ) ) {
33		return false;
34		}
35
36		$body = wp_remote_retrieve_body( $response );
37		if ( is_wp_error( $body ) ) {
38		return false;
39		}
40
41		// Decode the results.
42		$results = json_decode( $body, true );
43
44		// Bail if there were no results or plan details returned.
45		if ( ! is_array( $results ) \|\| ! isset( $results['plan'] ) ) {
46		return false;
47		}
48
49		// Store the new plan in an option and return true if updated.
50		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
51		if ( ! $result ) {
52		// If we got to this point, then we know we need to update. So, assume there is an issue
53		// with caching. To fix that issue, we can delete the current option and then update.
54		delete_option( self::PLAN_OPTION );
55		$result = update_option( self::PLAN_OPTION, $results['plan'], true );
56		}
57
58		if ( $result ) {
59		// Reset the cache since we've just updated the plan.
60		self::$active_plan_cache = null;
		0 ignored issues – show Documentation Bug introduced 2019-03-20 21:18 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$active_plan_cache`. 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.. Loading history...
61		}
62
63		return $result;
64		}
65
66		/**
67		* Make an API call to WordPress.com for plan status
68		*
69		* @uses Jetpack_Options::get_option()
70		* @uses Client::wpcom_json_api_request_as_blog()
71		* @uses update_option()
72		*
73		* @access public
74		* @static
75		*
76		* @return bool True if plan is updated, false if no update
77		*/
78		public static function refresh_from_wpcom() {
79		// Make the API request.
80		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
81		$response = Client::wpcom_json_api_request_as_blog( $request, '1.1' );
82
83		return self::update_from_sites_response( $response );
84		}
85
86		/**
87		* Get the plan that this Jetpack site is currently using.
88		*
89		* @uses get_option()
90		*
91		* @access public
92		* @static
93		*
94		* @return array Active Jetpack plan details
95		*/
96		public static function get() {
97		// this can be expensive to compute so we cache for the duration of a request.
98		if ( is_array( self::$active_plan_cache ) && ! empty( self::$active_plan_cache ) ) {
99		return self::$active_plan_cache;
100		}
101
102		$plan = get_option( self::PLAN_OPTION, array() );
103
104		// Set the default options.
105		$plan = wp_parse_args(
106		$plan,
107		array(
108		'product_slug' => 'jetpack_free',
109		'class' => 'free',
110		'features' => array(
111		'active' => array(),
112		),
113		)
114		);
115
116		$supports = array();
117
118		// Define what paid modules are supported by personal plans.
119		$personal_plans = array(
120		'jetpack_personal',
121		'jetpack_personal_monthly',
122		'personal-bundle',
123		'personal-bundle-monthly',
124		'personal-bundle-2y',
125		);
126
127		if ( in_array( $plan['product_slug'], $personal_plans, true ) ) {
128		// special support value, not a module but a separate plugin.
129		$supports[] = 'akismet';
130		$plan['class'] = 'personal';
131		}
132
133		// Define what paid modules are supported by premium plans.
134		$premium_plans = array(
135		'jetpack_premium',
136		'jetpack_premium_monthly',
137		'value_bundle',
138		'value_bundle-monthly',
139		'value_bundle-2y',
140		);
141
142	View Code Duplication	if ( in_array( $plan['product_slug'], $premium_plans, true ) ) {
143		$supports[] = 'akismet';
144		$supports[] = 'simple-payments';
145		$supports[] = 'vaultpress';
146		$supports[] = 'videopress';
147		$plan['class'] = 'premium';
148		}
149
150		// Define what paid modules are supported by professional plans.
151		$business_plans = array(
152		'jetpack_business',
153		'jetpack_business_monthly',
154		'business-bundle',
155		'business-bundle-monthly',
156		'business-bundle-2y',
157		'ecommerce-bundle',
158		'ecommerce-bundle-monthly',
159		'ecommerce-bundle-2y',
160		'vip',
161		);
162
163	View Code Duplication	if ( in_array( $plan['product_slug'], $business_plans, true ) ) {
164		$supports[] = 'akismet';
165		$supports[] = 'simple-payments';
166		$supports[] = 'vaultpress';
167		$supports[] = 'videopress';
168		$plan['class'] = 'business';
169		}
170
171		// get available features.
172		foreach ( Jetpack::get_available_modules() as $module_slug ) {
173		$module = Jetpack::get_module( $module_slug );
174		if ( ! isset( $module ) \|\| ! is_array( $module ) ) {
175		continue;
176		}
177		if ( in_array( 'free', $module['plan_classes'], true ) \|\| in_array( $plan['class'], $module['plan_classes'], true ) ) {
178		$supports[] = $module_slug;
179		}
180		}
181
182		$plan['supports'] = $supports;
183
184		self::$active_plan_cache = $plan;
185
186		return $plan;
187		}
188
189		/**
190		* Determine whether the active plan supports a particular feature
191		*
192		* @uses Jetpack_Plan::get()
193		*
194		* @access public
195		* @static
196		*
197		* @param string $feature The module or feature to check.
198		*
199		* @return bool True if plan supports feature, false if not
200		*/
201		public static function supports( $feature ) {
202		$plan = self::get();
203
204		// Manually mapping WordPress.com features to Jetpack module slugs.
205		foreach ( $plan['features']['active'] as $wpcom_feature ) {
206		switch ( $wpcom_feature ) {
207		case 'wordads-jetpack':
208		// WordAds are supported for this site.
209		if ( 'wordads' === $feature ) {
210		return true;
211		}
212		break;
213		}
214		}
215
216		if (
217		in_array( $feature, $plan['supports'], true )
218		\|\| in_array( $feature, $plan['features']['active'], true )
219		) {
220		return true;
221		}
222
223		return false;
224		}
225		}
226

Automattic / jetpack

Push — fix/compat-sync-actions-use ( 814f9c )

Jetpack_Plan::get() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like