Jetpack_Sync_Settings::set_is_syncing() - Code Metrics - Inspection of "Merge pull request #6251 from Automattic/try/merge..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/remove-icon-disconnect-... ( 4b6a2c )

unknown

created 2017-02-01 21:00 UTC

Jetpack_Sync_Settings::set_is_syncing() A

↳ Parent: Jetpack_Sync_Settings

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

require_once dirname( __FILE__ ) . '/class.jetpack-sync-defaults.php';

class Jetpack_Sync_Settings {
	const SETTINGS_OPTION_PREFIX = 'jetpack_sync_settings_';

	static $valid_settings = array(
class A {
    var $property;
}
		'dequeue_max_bytes'       => true,
		'upload_max_bytes'        => true,
		'upload_max_rows'         => true,
		'sync_wait_time'          => true,
		'sync_wait_threshold'     => true,
		'enqueue_wait_time'       => true,
		'max_queue_size'          => true,
		'max_queue_lag'           => true,
		'queue_max_writes_sec'    => true,
		'post_types_blacklist'    => true,
		'disable'                 => true,
		'render_filtered_content' => true,
		'post_meta_whitelist'     => true,
		'comment_meta_whitelist'  => true,
		'max_enqueue_full_sync'   => true,
		'max_queue_size_full_sync'=> true,
		'sync_via_cron'           => true,
		'cron_sync_time_limit'    => true,
	);

	static $is_importing;
class A {
    var $property;
}
	static $is_doing_cron;
class A {
    var $property;
}
	static $is_syncing;
class A {
    var $property;
}
	static $is_sending;
class A {
    var $property;
}

	static $settings_cache = array(); // some settings can be expensive to compute - let's cache them
class A {
    var $property;
}

	static function get_settings() {
		$settings = array();
		foreach ( array_keys( self::$valid_settings ) as $setting ) {
			$settings[ $setting ] = self::get_setting( $setting );
		}

		return $settings;
	}

	// Fetches the setting. It saves it if the setting doesn't exist, so that it gets
	// autoloaded on page load rather than re-queried every time.
	static function get_setting( $setting ) {
		if ( ! isset( self::$valid_settings[ $setting ] ) ) {
			return false;
		}

		if ( isset( self::$settings_cache[ $setting ] ) ) {
			return self::$settings_cache[ $setting ];
		}

		$value = get_option( self::SETTINGS_OPTION_PREFIX . $setting );

		if ( false === $value ) {
			$default_name = "default_$setting"; // e.g. default_dequeue_max_bytes
			$value        = Jetpack_Sync_Defaults::$$default_name;
			update_option( self::SETTINGS_OPTION_PREFIX . $setting, $value, true );
		}

		if ( is_numeric( $value ) ) {
			$value = intval( $value );
		}
		$default_array_value = null;
		switch( $setting ) {
			case 'post_types_blacklist':
				$default_array_value = Jetpack_Sync_Defaults::$blacklisted_post_types;

				break;
			case 'post_meta_whitelist':
				$default_array_value = Jetpack_Sync_Defaults::$post_meta_whitelist;

				break;
			case 'comment_meta_whitelist':
				$default_array_value = Jetpack_Sync_Defaults::$comment_meta_whitelist;

				break;
		}

		if ( $default_array_value ) {
			if ( is_array( $value ) ) {
				$value = array_unique( array_merge( $value, $default_array_value ) );
			} else {
				$value = $default_array_value;
			}
		}

		self::$settings_cache[ $setting ] = $value;

		return $value;
	}

	static function update_settings( $new_settings ) {
		$validated_settings = array_intersect_key( $new_settings, self::$valid_settings );
		foreach ( $validated_settings as $setting => $value ) {
			update_option( self::SETTINGS_OPTION_PREFIX . $setting, $value, true );
			unset( self::$settings_cache[ $setting ] );

			// if we set the disabled option to true, clear the queues
			if ( 'disable' === $setting && !! $value ) {
				require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
				$listener = Jetpack_Sync_Listener::get_instance();
				$listener->get_sync_queue()->reset();
				$listener->get_full_sync_queue()->reset();
			}
		}
	}

	// returns escapted SQL that can be injected into a WHERE clause
	static function get_blacklisted_post_types_sql() {
		return 'post_type NOT IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'post_types_blacklist' ) ) ) . '\')';
	}

	static function get_whitelisted_post_meta_sql() {
		return 'meta_key IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'post_meta_whitelist' ) ) ) . '\')';
	}

	static function get_whitelisted_comment_meta_sql() {
		return 'meta_key IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'comment_meta_whitelist' ) ) ) . '\')';
	}

	static function get_comments_filter_sql() {
		return "comment_approved <> 'spam'";
	}

	static function reset_data() {
		$valid_settings       = self::$valid_settings;
		self::$settings_cache = array();
		foreach ( $valid_settings as $option => $value ) {
			delete_option( self::SETTINGS_OPTION_PREFIX . $option );
		}
		self::set_importing( null );
		self::set_doing_cron( null );
		self::set_is_syncing( null );
		self::set_is_sending( null );
	}

	static function set_importing( $is_importing ) {
		// set to NULL to revert to WP_IMPORTING, the standard behaviour
		self::$is_importing = $is_importing;
	}

	static function is_importing() {
		if ( ! is_null( self::$is_importing ) ) {
			return self::$is_importing;
		}

		return defined( 'WP_IMPORTING' ) && WP_IMPORTING;
	}

	static function set_doing_cron( $is_doing_cron ) {
		// set to NULL to revert to WP_IMPORTING, the standard behaviour
		self::$is_doing_cron = $is_doing_cron;
	}

	static function is_doing_cron() {
		if ( ! is_null( self::$is_doing_cron ) ) {
			return self::$is_doing_cron;
		}

		return defined( 'DOING_CRON' ) && DOING_CRON;
	}

	static function is_syncing() {
		return (bool) self::$is_syncing || ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST );
	}

	static function set_is_syncing( $is_syncing ) {
		self::$is_syncing = $is_syncing;
	}

	static function is_sending() {
		return (bool) self::$is_sending;
	}

	static function set_is_sending( $is_sending ) {
		self::$is_sending = $is_sending;
	}
}


1			<?php
2
3			require_once dirname( __FILE__ ) . '/class.jetpack-sync-defaults.php';
4
5			class Jetpack_Sync_Settings {
6			const SETTINGS_OPTION_PREFIX = 'jetpack_sync_settings_';
7
8			static $valid_settings = array(
			0 ignored issues – show Coding Style introduced 2016-06-30 21:02 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$valid_settings`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
9			'dequeue_max_bytes' => true,
10			'upload_max_bytes' => true,
11			'upload_max_rows' => true,
12			'sync_wait_time' => true,
13			'sync_wait_threshold' => true,
14			'enqueue_wait_time' => true,
15			'max_queue_size' => true,
16			'max_queue_lag' => true,
17			'queue_max_writes_sec' => true,
18			'post_types_blacklist' => true,
19			'disable' => true,
20			'render_filtered_content' => true,
21			'post_meta_whitelist' => true,
22			'comment_meta_whitelist' => true,
23			'max_enqueue_full_sync' => true,
24			'max_queue_size_full_sync'=> true,
25			'sync_via_cron' => true,
26			'cron_sync_time_limit' => true,
27			);
28
29			static $is_importing;
			0 ignored issues – show Coding Style introduced 2016-08-01 20:51 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_importing`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
30			static $is_doing_cron;
			0 ignored issues – show Coding Style introduced 2016-08-10 03:00 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_doing_cron`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
31			static $is_syncing;
			0 ignored issues – show Coding Style introduced 2016-10-04 18:38 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_syncing`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
32			static $is_sending;
			0 ignored issues – show Coding Style introduced 2016-10-05 21:54 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$is_sending`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
33
34			static $settings_cache = array(); // some settings can be expensive to compute - let's cache them
			0 ignored issues – show Coding Style introduced 2016-08-12 18:29 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$settings_cache`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
35
36			static function get_settings() {
37			$settings = array();
38			foreach ( array_keys( self::$valid_settings ) as $setting ) {
39			$settings[ $setting ] = self::get_setting( $setting );
40			}
41
42			return $settings;
43			}
44
45			// Fetches the setting. It saves it if the setting doesn't exist, so that it gets
46			// autoloaded on page load rather than re-queried every time.
47			static function get_setting( $setting ) {
48			if ( ! isset( self::$valid_settings[ $setting ] ) ) {
49			return false;
50			}
51
52			if ( isset( self::$settings_cache[ $setting ] ) ) {
53			return self::$settings_cache[ $setting ];
54			}
55
56			$value = get_option( self::SETTINGS_OPTION_PREFIX . $setting );
57
58			if ( false === $value ) {
59			$default_name = "default_$setting"; // e.g. default_dequeue_max_bytes
60			$value = Jetpack_Sync_Defaults::$$default_name;
61			update_option( self::SETTINGS_OPTION_PREFIX . $setting, $value, true );
62			}
63
64			if ( is_numeric( $value ) ) {
65			$value = intval( $value );
66			}
67			$default_array_value = null;
68			switch( $setting ) {
69			case 'post_types_blacklist':
70			$default_array_value = Jetpack_Sync_Defaults::$blacklisted_post_types;
			0 ignored issues – show Bug introduced 2016-08-12 17:30 UTC by Report Bug Copy Issue Report The property `blacklisted_post_types` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
71			break;
72			case 'post_meta_whitelist':
73			$default_array_value = Jetpack_Sync_Defaults::$post_meta_whitelist;
			0 ignored issues – show Bug introduced 2016-10-10 22:06 UTC by Report Bug Copy Issue Report The property `post_meta_whitelist` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
74			break;
75			case 'comment_meta_whitelist':
76			$default_array_value = Jetpack_Sync_Defaults::$comment_meta_whitelist;
			0 ignored issues – show Bug introduced 2016-10-10 22:06 UTC by Report Bug Copy Issue Report The property `comment_meta_whitelist` cannot be accessed from this context as it is declared `private` in class `Jetpack_Sync_Defaults`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
77			break;
78			}
79
80			if ( $default_array_value ) {
81			if ( is_array( $value ) ) {
82			$value = array_unique( array_merge( $value, $default_array_value ) );
83			} else {
84			$value = $default_array_value;
85			}
86			}
87
88			self::$settings_cache[ $setting ] = $value;
89
90			return $value;
91			}
92
93			static function update_settings( $new_settings ) {
94			$validated_settings = array_intersect_key( $new_settings, self::$valid_settings );
95			foreach ( $validated_settings as $setting => $value ) {
96			update_option( self::SETTINGS_OPTION_PREFIX . $setting, $value, true );
97			unset( self::$settings_cache[ $setting ] );
98
99			// if we set the disabled option to true, clear the queues
100			if ( 'disable' === $setting && !! $value ) {
101			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
102			$listener = Jetpack_Sync_Listener::get_instance();
103			$listener->get_sync_queue()->reset();
104			$listener->get_full_sync_queue()->reset();
105			}
106			}
107			}
108
109			// returns escapted SQL that can be injected into a WHERE clause
110			static function get_blacklisted_post_types_sql() {
111			return 'post_type NOT IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'post_types_blacklist' ) ) ) . '\')';
112			}
113
114			static function get_whitelisted_post_meta_sql() {
115			return 'meta_key IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'post_meta_whitelist' ) ) ) . '\')';
116			}
117
118			static function get_whitelisted_comment_meta_sql() {
119			return 'meta_key IN (\'' . join( '\', \'', array_map( 'esc_sql', self::get_setting( 'comment_meta_whitelist' ) ) ) . '\')';
120			}
121
122			static function get_comments_filter_sql() {
123			return "comment_approved <> 'spam'";
124			}
125
126			static function reset_data() {
127			$valid_settings = self::$valid_settings;
128			self::$settings_cache = array();
129			foreach ( $valid_settings as $option => $value ) {
130			delete_option( self::SETTINGS_OPTION_PREFIX . $option );
131			}
132			self::set_importing( null );
133			self::set_doing_cron( null );
134			self::set_is_syncing( null );
135			self::set_is_sending( null );
136			}
137
138			static function set_importing( $is_importing ) {
139			// set to NULL to revert to WP_IMPORTING, the standard behaviour
140			self::$is_importing = $is_importing;
141			}
142
143			static function is_importing() {
144			if ( ! is_null( self::$is_importing ) ) {
145			return self::$is_importing;
146			}
147
148			return defined( 'WP_IMPORTING' ) && WP_IMPORTING;
149			}
150
151			static function set_doing_cron( $is_doing_cron ) {
152			// set to NULL to revert to WP_IMPORTING, the standard behaviour
153			self::$is_doing_cron = $is_doing_cron;
154			}
155
156			static function is_doing_cron() {
157			if ( ! is_null( self::$is_doing_cron ) ) {
158			return self::$is_doing_cron;
159			}
160
161			return defined( 'DOING_CRON' ) && DOING_CRON;
162			}
163
164			static function is_syncing() {
165			return (bool) self::$is_syncing \|\| ( defined( 'REST_API_REQUEST' ) && REST_API_REQUEST );
166			}
167
168			static function set_is_syncing( $is_syncing ) {
169			self::$is_syncing = $is_syncing;
170			}
171
172			static function is_sending() {
173			return (bool) self::$is_sending;
174			}
175
176			static function set_is_sending( $is_sending ) {
177			self::$is_sending = $is_sending;
178			}
179			}
180

Automattic / jetpack

Push — update/remove-icon-disconnect-... ( 4b6a2c )

Jetpack_Sync_Settings::set_is_syncing() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like