Jetpack_Options::get_grouped_option() - Code Metrics - Inspection of "IDC Tracking: Set up basic tracking ability for MC..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/idc-tracking ( d68436...d40db2 )

unknown

created 2016-11-03 19:05 UTC

Jetpack_Options::get_grouped_option() A

↳ Parent: Jetpack_Options

Complexity

Conditions	3
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	2
nop	3
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

class Jetpack_Options {

	private static $grouped_options = array(
		'compact' => 'jetpack_options',
		'private' => 'jetpack_private_options'
	);

	public static function get_option_names( $type = 'compact' ) {
		switch ( $type ) {
		case 'non-compact' :
		case 'non_compact' :
			return array(
				'activated',
				'active_modules',
				'available_modules',
				'do_activate',
				'log',
				'publicize',
				'slideshow_background_color',
				'widget_twitter',
				'wpcc_options',
				'relatedposts',
				'file_data',
				'autoupdate_plugins',          // (array)  An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated
				'autoupdate_themes',           // (array)  An array of theme ids ( eg. twentyfourteen ) that should be autoupdated
				'autoupdate_core',             // (bool)   Whether or not to autoupdate core
				'json_api_full_management',    // (bool)   Allow full management (eg. Activate, Upgrade plugins) of the site via the JSON API.
				'sync_non_public_post_stati',  // (bool)   Allow synchronisation of posts and pages with non-public status.
				'site_icon_url',               // (string) url to the full site icon
				'site_icon_id',                // (int)    Attachment id of the site icon file
				'dismissed_manage_banner',     // (bool) Dismiss Jetpack manage banner allows the user to dismiss the banner permanently
				'restapi_stats_cache',         // (array) Stats Cache data.
				'unique_connection',           // (array)  A flag to determine a unique connection to wordpress.com two values "connected" and "disconnected" with values for how many times each has occured
				'protect_whitelist',           // (array) IP Address for the Protect module to ignore
				'sync_error_idc',              // (bool|array) false or array containing the site's home and siteurl at time of IDC error
				'safe_mode_confirmed'          // (bool) True if someone confirms that a site was correctly put into safe mode automatically after an identity crisis is discovered.
			);

		case 'private' :
			return array(
				'register',
				'authorize',
				'activate_manage',
				'blog_token',                  // (string) The Client Secret/Blog Token of this site.
				'user_token',                  // (string) The User Token of this site. (deprecated)
				'user_tokens'                  // (array)  User Tokens for each user of this site who has connected to jetpack.wordpress.com.
			);
		}

		return array(
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
			'publicize_connections',        // (array)  An array of Publicize connections from WordPress.com
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
			'old_version',                  // (string) Used to determine which modules are the most recently added. previous_version:time
			'fallback_no_verify_ssl_certs', // (int)    Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
			'time_diff',                    // (int)    Offset between Jetpack server's clocks and this server's clocks. Jetpack Server Time = time() + (int) Jetpack_Options::get_option( 'time_diff' )
			'public',                       // (int|bool) If we think this site is public or not (1, 0), false if we haven't yet tried to figure it out.
			'videopress',                   // (array)  VideoPress options array.
			'is_network_site',              // (int|bool) If we think this site is a network or a single blog (1, 0), false if we haven't yet tried to figue it out.
			'social_links',                 // (array)  The specified links for each social networking site.
			'identity_crisis_whitelist',    // (array)  An array of options, each having an array of the values whitelisted for it.
			'gplus_authors',                // (array)  The Google+ authorship information for connected users.
			'last_heartbeat',               // (int)    The timestamp of the last heartbeat that fired.
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
			'hide_jitm'                     // (array)  A list of just in time messages that we should not show because they have been dismissed by the user
		);
	}

	public static function is_valid( $name, $group = null ) {
		if ( is_array( $name ) ) {
			$compact_names = array();
			foreach ( array_keys( self::$grouped_options ) as $_group ) {
				$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
			}

			$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );

			return empty( $result );
		}

		if ( is_null( $group ) || 'non_compact' === $group ) {
			if ( in_array( $name, self::get_option_names( $group ) ) ) {
				return true;
			}
		}

		foreach ( array_keys( self::$grouped_options ) as $_group ) {
			if ( is_null( $group ) || $group === $_group ) {
				if ( in_array( $name, self::get_option_names( $_group ) ) ) {
					return true;
				}
			}
		}

		return false;
	}

	/**
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
	 *
	 * @param string $name Option name
	 * @param mixed $default (optional)
	 */
	public static function get_option( $name, $default = false ) {
		if ( self::is_valid( $name, 'non_compact' ) ) {
			return get_option( "jetpack_$name", $default );
		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( self::is_valid( $name, $group ) ) {
				return self::get_grouped_option( $group, $name, $default );
			}
		}

		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );

		return $default;
	}

	/**
	 * Returns the requested option, and ensures it's autoloaded in the future.
	 * This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
	 *
	 * @param string $name Option name
	 * @param mixed $default (optional)
	 *
	 * @return mixed|void
	 */
	public static function get_option_and_ensure_autoload( $name, $default ) {
		$value = get_option( $name );

		if ( $value === false && $default !== false ) {
			update_option( $name, $default );
			$value = $default;
		}

		return $value;
	}

	private static function update_grouped_option( $group, $name, $value ) {
		$options = get_option( self::$grouped_options[ $group ] );
		if ( ! is_array( $options ) ) {
			$options = array();
		}
		$options[ $name ] = $value;

		return update_option( self::$grouped_options[ $group ], $options );
	}

	/**
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
	 *
	 * @param string $name Option name
	 * @param mixed $value Option value
	 * @param string $autoload If not compact option, allows specifying whether to autoload or not.

	 */
	public static function update_option( $name, $value, $autoload = null ) {
		/**
		 * Fires before Jetpack updates a specific option.
		 *
		 * @since 3.0.0
		 *
		 * @param str $name The name of the option being updated.
		 * @param mixed $value The new value of the option.
		 */
		do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
		if ( self::is_valid( $name, 'non_compact' ) ) {
			return update_option( "jetpack_$name", $value, $autoload );
		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( self::is_valid( $name, $group ) ) {
				return self::update_grouped_option( $group, $name, $value );
			}
		}

		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );

		return false;
	}

	/**
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
	 *
	 * @param array $array array( option name => option value, ... )
	 */
	public static function update_options( $array ) {
		$names = array_keys( $array );

		foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
			trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
			unset( $array[ $unknown_name ] );
		}

		foreach ( $names as $name ) {
			self::update_option( $name, $array[ $name ] );
		}
	}

	/**
	 * Deletes the given option.  May be passed multiple option names as an array.
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
	 *
	 * @param string|array $names
	 */
	public static function delete_option( $names ) {
		$result = true;
		$names  = (array) $names;

		if ( ! self::is_valid( $names ) ) {
			trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );

			return false;
		}

		foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
			if ( ! delete_option( "jetpack_$name" ) ) {
				$result = false;
			}
		}

		foreach ( array_keys( self::$grouped_options ) as $group ) {
			if ( ! self::delete_grouped_option( $group, $names ) ) {
				$result = false;
			}
		}

		return $result;
	}

	private static function get_grouped_option( $group, $name, $default ) {
		$options = get_option( self::$grouped_options[ $group ] );
		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
			return $options[ $name ];
		}

		return $default;
	}

	private static function delete_grouped_option( $group, $names ) {
		$options = get_option( self::$grouped_options[ $group ], array() );

		$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
		if ( $to_delete ) {

			foreach ( $to_delete as $name ) {
				unset( $options[ $name ] );
			}

			return update_option( self::$grouped_options[ $group ], $options );
		}

		return true;
	}

}


1		<?php
2
3		class Jetpack_Options {
4
5		private static $grouped_options = array(
6		'compact' => 'jetpack_options',
7		'private' => 'jetpack_private_options'
8		);
9
10		public static function get_option_names( $type = 'compact' ) {
11		switch ( $type ) {
12		case 'non-compact' :
13		case 'non_compact' :
14		return array(
15		'activated',
16		'active_modules',
17		'available_modules',
18		'do_activate',
19		'log',
20		'publicize',
21		'slideshow_background_color',
22		'widget_twitter',
23		'wpcc_options',
24		'relatedposts',
25		'file_data',
26		'autoupdate_plugins', // (array) An array of plugin ids ( eg. jetpack/jetpack ) that should be autoupdated
27		'autoupdate_themes', // (array) An array of theme ids ( eg. twentyfourteen ) that should be autoupdated
28		'autoupdate_core', // (bool) Whether or not to autoupdate core
29		'json_api_full_management', // (bool) Allow full management (eg. Activate, Upgrade plugins) of the site via the JSON API.
30		'sync_non_public_post_stati', // (bool) Allow synchronisation of posts and pages with non-public status.
31		'site_icon_url', // (string) url to the full site icon
32		'site_icon_id', // (int) Attachment id of the site icon file
33		'dismissed_manage_banner', // (bool) Dismiss Jetpack manage banner allows the user to dismiss the banner permanently
34		'restapi_stats_cache', // (array) Stats Cache data.
35		'unique_connection', // (array) A flag to determine a unique connection to wordpress.com two values "connected" and "disconnected" with values for how many times each has occured
36		'protect_whitelist', // (array) IP Address for the Protect module to ignore
37		'sync_error_idc', // (bool\|array) false or array containing the site's home and siteurl at time of IDC error
38		'safe_mode_confirmed' // (bool) True if someone confirms that a site was correctly put into safe mode automatically after an identity crisis is discovered.
39		);
40
41		case 'private' :
42		return array(
43		'register',
44		'authorize',
45		'activate_manage',
46		'blog_token', // (string) The Client Secret/Blog Token of this site.
47		'user_token', // (string) The User Token of this site. (deprecated)
48		'user_tokens' // (array) User Tokens for each user of this site who has connected to jetpack.wordpress.com.
49		);
50		}
51
52		return array(
53		'id', // (int) The Client ID/WP.com Blog ID of this site.
54		'publicize_connections', // (array) An array of Publicize connections from WordPress.com
55		'master_user', // (int) The local User ID of the user who connected this site to jetpack.wordpress.com.
56		'version', // (string) Used during upgrade procedure to auto-activate new modules. version:time
57		'old_version', // (string) Used to determine which modules are the most recently added. previous_version:time
58		'fallback_no_verify_ssl_certs', // (int) Flag for determining if this host must skip SSL Certificate verification due to misconfigured SSL.
59		'time_diff', // (int) Offset between Jetpack server's clocks and this server's clocks. Jetpack Server Time = time() + (int) Jetpack_Options::get_option( 'time_diff' )
60		'public', // (int\|bool) If we think this site is public or not (1, 0), false if we haven't yet tried to figure it out.
61		'videopress', // (array) VideoPress options array.
62		'is_network_site', // (int\|bool) If we think this site is a network or a single blog (1, 0), false if we haven't yet tried to figue it out.
63		'social_links', // (array) The specified links for each social networking site.
64		'identity_crisis_whitelist', // (array) An array of options, each having an array of the values whitelisted for it.
65		'gplus_authors', // (array) The Google+ authorship information for connected users.
66		'last_heartbeat', // (int) The timestamp of the last heartbeat that fired.
67		'jumpstart', // (string) A flag for whether or not to show the Jump Start. Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
68		'hide_jitm' // (array) A list of just in time messages that we should not show because they have been dismissed by the user
69		);
70		}
71
72		public static function is_valid( $name, $group = null ) {
73		if ( is_array( $name ) ) {
74		$compact_names = array();
75		foreach ( array_keys( self::$grouped_options ) as $_group ) {
76		$compact_names = array_merge( $compact_names, self::get_option_names( $_group ) );
77		}
78
79		$result = array_diff( $name, self::get_option_names( 'non_compact' ), $compact_names );
80
81		return empty( $result );
82		}
83
84	View Code Duplication	if ( is_null( $group ) \|\| 'non_compact' === $group ) {
85		if ( in_array( $name, self::get_option_names( $group ) ) ) {
86		return true;
87		}
88		}
89
90		foreach ( array_keys( self::$grouped_options ) as $_group ) {
91	View Code Duplication	if ( is_null( $group ) \|\| $group === $_group ) {
92		if ( in_array( $name, self::get_option_names( $_group ) ) ) {
93		return true;
94		}
95		}
96		}
97
98		return false;
99		}
100
101		/**
102		* Returns the requested option. Looks in jetpack_options or jetpack_$name as appropriate.
103		*
104		* @param string $name Option name
105		* @param mixed $default (optional)
106		*/
107		public static function get_option( $name, $default = false ) {
108		if ( self::is_valid( $name, 'non_compact' ) ) {
109		return get_option( "jetpack_$name", $default );
110		}
111
112		foreach ( array_keys( self::$grouped_options ) as $group ) {
113		if ( self::is_valid( $name, $group ) ) {
114		return self::get_grouped_option( $group, $name, $default );
115		}
116		}
117
118		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
119
120		return $default;
121		}
122
123		/**
124		* Returns the requested option, and ensures it's autoloaded in the future.
125		* This does _not_ adjust the prefix in any way (does not prefix jetpack_%)
126		*
127		* @param string $name Option name
128		* @param mixed $default (optional)
129		*
130		* @return mixed\|void
131		*/
132		public static function get_option_and_ensure_autoload( $name, $default ) {
133		$value = get_option( $name );
134
135		if ( $value === false && $default !== false ) {
136		update_option( $name, $default );
137		$value = $default;
138		}
139
140		return $value;
141		}
142
143		private static function update_grouped_option( $group, $name, $value ) {
144		$options = get_option( self::$grouped_options[ $group ] );
145		if ( ! is_array( $options ) ) {
146		$options = array();
147		}
148		$options[ $name ] = $value;
149
150		return update_option( self::$grouped_options[ $group ], $options );
151		}
152
153		/**
154		* Updates the single given option. Updates jetpack_options or jetpack_$name as appropriate.
155		*
156		* @param string $name Option name
157		* @param mixed $value Option value
158		* @param string $autoload If not compact option, allows specifying whether to autoload or not.
		0 ignored issues – show Documentation introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report Should the type for parameter `$autoload` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
159		*/
160		public static function update_option( $name, $value, $autoload = null ) {
161		/**
162		* Fires before Jetpack updates a specific option.
163		*
164		* @since 3.0.0
165		*
166		* @param str $name The name of the option being updated.
167		* @param mixed $value The new value of the option.
168		*/
169		do_action( 'pre_update_jetpack_option_' . $name, $name, $value );
170		if ( self::is_valid( $name, 'non_compact' ) ) {
171		return update_option( "jetpack_$name", $value, $autoload );
172		}
173
174		foreach ( array_keys( self::$grouped_options ) as $group ) {
175		if ( self::is_valid( $name, $group ) ) {
176		return self::update_grouped_option( $group, $name, $value );
177		}
178		}
179
180		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $name ), E_USER_WARNING );
181
182		return false;
183		}
184
185		/**
186		* Updates the multiple given options. Updates jetpack_options and/or jetpack_$name as appropriate.
187		*
188		* @param array $array array( option name => option value, ... )
189		*/
190		public static function update_options( $array ) {
191		$names = array_keys( $array );
192
193		foreach ( array_diff( $names, self::get_option_names(), self::get_option_names( 'non_compact' ), self::get_option_names( 'private' ) ) as $unknown_name ) {
194		trigger_error( sprintf( 'Invalid Jetpack option name: %s', $unknown_name ), E_USER_WARNING );
195		unset( $array[ $unknown_name ] );
196		}
197
198		foreach ( $names as $name ) {
199		self::update_option( $name, $array[ $name ] );
200		}
201		}
202
203		/**
204		* Deletes the given option. May be passed multiple option names as an array.
205		* Updates jetpack_options and/or deletes jetpack_$name as appropriate.
206		*
207		* @param string\|array $names
208		*/
209		public static function delete_option( $names ) {
210		$result = true;
211		$names = (array) $names;
212
213		if ( ! self::is_valid( $names ) ) {
214		trigger_error( sprintf( 'Invalid Jetpack option names: %s', print_r( $names, 1 ) ), E_USER_WARNING );
215
216		return false;
217		}
218
219		foreach ( array_intersect( $names, self::get_option_names( 'non_compact' ) ) as $name ) {
220		if ( ! delete_option( "jetpack_$name" ) ) {
221		$result = false;
222		}
223		}
224
225		foreach ( array_keys( self::$grouped_options ) as $group ) {
226		if ( ! self::delete_grouped_option( $group, $names ) ) {
227		$result = false;
228		}
229		}
230
231		return $result;
232		}
233
234		private static function get_grouped_option( $group, $name, $default ) {
235		$options = get_option( self::$grouped_options[ $group ] );
236		if ( is_array( $options ) && isset( $options[ $name ] ) ) {
237		return $options[ $name ];
238		}
239
240		return $default;
241		}
242
243		private static function delete_grouped_option( $group, $names ) {
244		$options = get_option( self::$grouped_options[ $group ], array() );
245
246		$to_delete = array_intersect( $names, self::get_option_names( $group ), array_keys( $options ) );
247		if ( $to_delete ) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The expression `$to_delete` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
248		foreach ( $to_delete as $name ) {
249		unset( $options[ $name ] );
250		}
251
252		return update_option( self::$grouped_options[ $group ], $options );
253		}
254
255		return true;
256		}
257
258		}
259

Automattic / jetpack

Push — add/idc-tracking ( d68436...d40db2 )

Jetpack_Options::get_grouped_option() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like