Give_Cache_Setting::setup() - Code Metrics - Inspection of "Merge pull request #3942 from impress-org/issue/39..." - impress-org/give - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Push — master ( 61ce68...ba3719 )

by Devin

created 2019-01-17 04:20 UTC

Give_Cache_Setting::setup() A

↳ Parent: Give_Cache_Setting

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php
/**
 * Class for managing plugin settings cache
 *
 * Note: only use for internal purpose.
 *
 * @package     Give
 * @subpackage  Classes/Give_Cache_Setting
 * @copyright   Copyright (c) 2018, GiveWP
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       2.4.0
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Give_Cache_Setting
 */
class Give_Cache_Setting {

	/**
	 * Instance.
	 *
	 * @since  2.4.0
	 * @access private
	 * @var Give_Cache_Setting
	 */
	static private $instance;

	/**
	 * Cache key.
	 *
	 * @since  2.4.0
	 * @access private
	 * @var string
	 */
	private $cache_key = 'giveAllOptions';


	/**
	 * Cache group.
	 *
	 * @since  2.4.0
	 * @access private
	 * @var string
	 */
	private $cache_group = 'give-options';

	/**
	 * Array of cached settings
	 *
	 * @since  2.4.0
	 * @access private
	 * @var array
	 */
	private $settings = array(
		'give_settings'           => array(),
		'give_version'            => '',
		'give_completed_upgrades' => array(),
		'currencies'              => array(),
		'gateways'                => array(),
	);

	/**
	 * Array of cached setting db option names
	 *
	 * @since  2.4.0
	 * @access private
	 * @var array
	 */
	private $db_option_ids = array(
		'give_settings',
		'give_version',
		'give_completed_upgrades',
	);

	/**
	 * Array of cached setting option names
	 *
	 * @since  2.4.0
	 * @access private
	 * @var array
	 */
	static private $all_option_ids;

	/**
	 * Singleton pattern.
	 *
	 * @since  2.4.0
	 * @access private
	 */
	private function __construct() {
	}


	/**
	 * Get instance.
	 *
	 * @since  2.4.0
	 * @access public
	 * @return Give_Cache_Setting
	 */
	public static function get_instance() {

		if ( null === static::$instance ) {
			self::$instance = new static();

			self::$instance->setup();
		}

		return self::$instance;
	}

	/**
	 * Setup
	 *
	 * @since  2.4.0
	 * @access private
	 */
	private function setup() {
		self::$all_option_ids = array_keys( $this->settings );

		$this->load_plugin_settings();

		add_action( 'added_option', array( $this, '__reload_plugin_settings' ) );
		add_action( 'updated_option', array( $this, '__reload_plugin_settings' ) );
		add_action( 'deleted_option', array( $this, '__reload_plugin_settings' ) );

		add_action( 'give_init', array( $this, '__setup_currencies_list' ), 11 );
		add_action( 'give_init', array( $this, '__setup_gateways_list' ), 11 );
	}

	/**
	 * Load plugin settings
	 *
	 * @since  2.4.0
	 * @access private
	 */
	private function load_plugin_settings() {
		global $wpdb;

		/**
		 * Fire the filter
		 *
		 * This filter can be used if admin facing any caching issue.
		 * This is a switch to enable or disable setting cache.
		 * Thus filter can be removed in future.
		 *
		 * @since 2.4.1
		 *
		 */
		if( ! apply_filters( 'give_disable_setting_cache', false ) ){

			$cache = wp_cache_get( $this->cache_key, $this->cache_group );

			// Load options from cache.
			if ( ! empty( $cache ) ) {
				$this->settings = $cache;

				return;
			}
		}

		$db_option_ids = '\'' . implode( '\',\'', $this->db_option_ids ) . '\'';

		$sql     = "SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN ({$db_option_ids}) ";
		$results = $wpdb->get_results( $sql );


		if ( ! empty( $results ) ) {

			/* @var  stdClass $result */
			foreach ( $results as $result ) {
				$this->settings[ $result->option_name ] = maybe_unserialize( $result->option_value );
			}

			wp_cache_set( $this->cache_key, $this->settings, $this->cache_group );
		}
	}

	/**
	 * Reload option when add, update or delete
	 * 
	 * Note: only for internal logic
	 *
	 * @since 2.4.0
	 *
	 * @param $option_name
	 */
	public function __reload_plugin_settings( $option_name ) {

		// Bailout.
		if ( ! in_array( $option_name, $this->db_option_ids ) ) {
			return;
		}

		wp_cache_delete( $this->cache_key, $this->cache_group );
		$this->load_plugin_settings();
	}

	/**
	 * Setup currencies list
	 *
	 * @since 2.4.0
	 */
	public function __setup_currencies_list() {

		$currencies = require_once GIVE_PLUGIN_DIR . 'includes/currencies-list.php';

		/**
		 * Filter the supported currency list
		 *
		 * @since 2.4.0
		 */
		$currencies = apply_filters( 'give_register_currency', $currencies );

		$this->settings['currencies'] = $currencies;
	}


	/**
	 * Setup gateway list
	 *
	 * @since 2.4.0
	 */
	public function __setup_gateways_list() {

		// Default, built-in gateways
		$gateways = array(
			'paypal'  => array(
				'admin_label'    => __( 'PayPal Standard', 'give' ),
				'checkout_label' => __( 'PayPal', 'give' ),
			),
			'manual'  => array(
				'admin_label'    => __( 'Test Donation', 'give' ),
				'checkout_label' => __( 'Test Donation', 'give' ),
			),
			'offline' => array(
				'admin_label'    => esc_attr__( 'Offline Donation', 'give' ),
				'checkout_label' => esc_attr__( 'Offline Donation', 'give' ),
			),
		);

		/**
		 * Filter the supported gateways list
		 *
		 * @since 2.4.0
		 */
		$gateways = apply_filters( 'give_register_gateway', $gateways );

		$this->settings['gateways'] = $gateways;
	}


	/**
	 * Get option
	 *
	 * @since  2.4.0
	 * @access public
	 *
	 * @param      $option_name
	 * @param bool $default
	 *
	 * @return mixed
	 */
	public static function get_option( $option_name, $default = false ) {
		$value = $default;

		if ( in_array( $option_name, self::$all_option_ids ) ) {
			$value = ! empty( self::$instance->settings[ $option_name ] )
				? self::$instance->settings[ $option_name ]
				: $default;
		}

		return $value;
	}

	/**
	 * Get plugin settings
	 *
	 * @since  2.4.0
	 * @access public
	 */
	public static function get_settings() {

		/**
		 * Filter the plugin setting
		 */
		return (array) apply_filters( 'give_get_settings', self::$instance->settings['give_settings'] );
	}
}

Give_Cache_Setting::get_instance();


1		<?php
2		/**
3		* Class for managing plugin settings cache
4		*
5		* Note: only use for internal purpose.
6		*
7		* @package Give
8		* @subpackage Classes/Give_Cache_Setting
9		* @copyright Copyright (c) 2018, GiveWP
10		* @license https://opensource.org/licenses/gpl-license GNU Public License
11		* @since 2.4.0
12		*/
13
14		// Exit if accessed directly.
15		if ( ! defined( 'ABSPATH' ) ) {
16		exit;
17		}
18
19		/**
20		* Class Give_Cache_Setting
21		*/
22		class Give_Cache_Setting {
		0 ignored issues – show Coding Style introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Since you have declared the constructor as private, maybe you should also declare the class as final. Loading history...
23		/**
24		* Instance.
25		*
26		* @since 2.4.0
27		* @access private
28		* @var Give_Cache_Setting
29		*/
30		static private $instance;
31
32		/**
33		* Cache key.
34		*
35		* @since 2.4.0
36		* @access private
37		* @var string
38		*/
39		private $cache_key = 'giveAllOptions';
40
41
42		/**
43		* Cache group.
44		*
45		* @since 2.4.0
46		* @access private
47		* @var string
48		*/
49		private $cache_group = 'give-options';
50
51		/**
52		* Array of cached settings
53		*
54		* @since 2.4.0
55		* @access private
56		* @var array
57		*/
58		private $settings = array(
59		'give_settings' => array(),
60		'give_version' => '',
61		'give_completed_upgrades' => array(),
62		'currencies' => array(),
63		'gateways' => array(),
64		);
65
66		/**
67		* Array of cached setting db option names
68		*
69		* @since 2.4.0
70		* @access private
71		* @var array
72		*/
73		private $db_option_ids = array(
74		'give_settings',
75		'give_version',
76		'give_completed_upgrades',
77		);
78
79		/**
80		* Array of cached setting option names
81		*
82		* @since 2.4.0
83		* @access private
84		* @var array
85		*/
86		static private $all_option_ids;
87
88		/**
89		* Singleton pattern.
90		*
91		* @since 2.4.0
92		* @access private
93		*/
94		private function __construct() {
95		}
96
97
98		/**
99		* Get instance.
100		*
101		* @since 2.4.0
102		* @access public
103		* @return Give_Cache_Setting
104		*/
105	View Code Duplication	public static function get_instance() {
		0 ignored issues – show Duplication introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106		if ( null === static::$instance ) {
107		self::$instance = new static();
108
109		self::$instance->setup();
110		}
111
112		return self::$instance;
113		}
114
115		/**
116		* Setup
117		*
118		* @since 2.4.0
119		* @access private
120		*/
121		private function setup() {
122		self::$all_option_ids = array_keys( $this->settings );
123
124		$this->load_plugin_settings();
125
126		add_action( 'added_option', array( $this, '__reload_plugin_settings' ) );
127		add_action( 'updated_option', array( $this, '__reload_plugin_settings' ) );
128		add_action( 'deleted_option', array( $this, '__reload_plugin_settings' ) );
129
130		add_action( 'give_init', array( $this, '__setup_currencies_list' ), 11 );
131		add_action( 'give_init', array( $this, '__setup_gateways_list' ), 11 );
132		}
133
134		/**
135		* Load plugin settings
136		*
137		* @since 2.4.0
138		* @access private
139		*/
140		private function load_plugin_settings() {
141		global $wpdb;
142
143		/**
144		* Fire the filter
145		*
146		* This filter can be used if admin facing any caching issue.
147		* This is a switch to enable or disable setting cache.
148		* Thus filter can be removed in future.
149		*
150		* @since 2.4.1
151		*
152		*/
153		if( ! apply_filters( 'give_disable_setting_cache', false ) ){
		0 ignored issues – show introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Space after opening control structure is required Loading history... introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report No space before opening parenthesis is prohibited Loading history...
154		$cache = wp_cache_get( $this->cache_key, $this->cache_group );
155
156		// Load options from cache.
157		if ( ! empty( $cache ) ) {
158		$this->settings = $cache;
159
160		return;
161		}
162		}
163
164		$db_option_ids = '\'' . implode( '\',\'', $this->db_option_ids ) . '\'';
165
166		$sql = "SELECT option_name, option_value FROM $wpdb->options WHERE option_name IN ({$db_option_ids}) ";
167		$results = $wpdb->get_results( $sql );
		0 ignored issues – show introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history...
168
169		if ( ! empty( $results ) ) {
170
171		/* @var stdClass $result */
172		foreach ( $results as $result ) {
173		$this->settings[ $result->option_name ] = maybe_unserialize( $result->option_value );
174		}
175
176		wp_cache_set( $this->cache_key, $this->settings, $this->cache_group );
177		}
178		}
179
180		/**
181		* Reload option when add, update or delete
182		*
183		* Note: only for internal logic
184		*
185		* @since 2.4.0
186		*
187		* @param $option_name
188		*/
189		public function __reload_plugin_settings( $option_name ) {
		0 ignored issues – show Coding Style introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Method name "Give_Cache_Setting::__reload_plugin_settings" is invalid; only PHP magic methods should be prefixed with a double underscore Loading history...
190		// Bailout.
191		if ( ! in_array( $option_name, $this->db_option_ids ) ) {
192		return;
193		}
194
195		wp_cache_delete( $this->cache_key, $this->cache_group );
196		$this->load_plugin_settings();
197		}
198
199		/**
200		* Setup currencies list
201		*
202		* @since 2.4.0
203		*/
204		public function __setup_currencies_list() {
		0 ignored issues – show Coding Style introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Method name "Give_Cache_Setting::__setup_currencies_list" is invalid; only PHP magic methods should be prefixed with a double underscore Loading history...
205		$currencies = require_once GIVE_PLUGIN_DIR . 'includes/currencies-list.php';
206
207		/**
208		* Filter the supported currency list
209		*
210		* @since 2.4.0
211		*/
212		$currencies = apply_filters( 'give_register_currency', $currencies );
213
214		$this->settings['currencies'] = $currencies;
215		}
216
217
218		/**
219		* Setup gateway list
220		*
221		* @since 2.4.0
222		*/
223		public function __setup_gateways_list() {
		0 ignored issues – show Coding Style introduced 2019-01-17 04:28 UTC by Report Bug Copy Issue Report Method name "Give_Cache_Setting::__setup_gateways_list" is invalid; only PHP magic methods should be prefixed with a double underscore Loading history...
224		// Default, built-in gateways
225		$gateways = array(
226		'paypal' => array(
227		'admin_label' => __( 'PayPal Standard', 'give' ),
228		'checkout_label' => __( 'PayPal', 'give' ),
229		),
230		'manual' => array(
231		'admin_label' => __( 'Test Donation', 'give' ),
232		'checkout_label' => __( 'Test Donation', 'give' ),
233		),
234		'offline' => array(
235		'admin_label' => esc_attr__( 'Offline Donation', 'give' ),
236		'checkout_label' => esc_attr__( 'Offline Donation', 'give' ),
237		),
238		);
239
240		/**
241		* Filter the supported gateways list
242		*
243		* @since 2.4.0
244		*/
245		$gateways = apply_filters( 'give_register_gateway', $gateways );
246
247		$this->settings['gateways'] = $gateways;
248		}
249
250
251		/**
252		* Get option
253		*
254		* @since 2.4.0
255		* @access public
256		*
257		* @param $option_name
258		* @param bool $default
259		*
260		* @return mixed
261		*/
262		public static function get_option( $option_name, $default = false ) {
263		$value = $default;
264
265		if ( in_array( $option_name, self::$all_option_ids ) ) {
266		$value = ! empty( self::$instance->settings[ $option_name ] )
267		? self::$instance->settings[ $option_name ]
268		: $default;
269		}
270
271		return $value;
272		}
273
274		/**
275		* Get plugin settings
276		*
277		* @since 2.4.0
278		* @access public
279		*/
280		public static function get_settings() {
281
282		/**
283		* Filter the plugin setting
284		*/
285		return (array) apply_filters( 'give_get_settings', self::$instance->settings['give_settings'] );
286		}
287		}
288
289		Give_Cache_Setting::get_instance();
290

impress-org / give

Push — master ( 61ce68...ba3719 )

Give_Cache_Setting::setup() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like