Give_Cache::group() - Code Metrics - Inspection of "Merge branch 'release/1.8.14' into release/2.0" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — issues/370 ( 90279e )

by Ravinder

created 2017-09-26 05:32 UTC

Give_Cache::group() C

↳ Parent: Give_Cache

Complexity

Conditions	8
Paths	8

Size

Total Lines	25
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	12
nc	8
nop	2
dl	0
loc	25
rs	5.3846
c	0
b	0
f	0

<?php
/**
 * Class for managing cache
 *
 * @package     Give
 * @subpackage  Classes/Give_Cache
 * @copyright   Copyright (c) 2017, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.8.7
 */

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

class Give_Cache {

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

	/**
	 * Singleton pattern.
	 *
	 * @since  1.8.7
	 * @access private
	 * Give_Cache constructor.
	 */
	private function __construct() {
	}


	/**
	 * Get instance.
	 *
	 * @since  1.8.7
	 * @access public
	 * @return static
	 */
	public static function get_instance() {
		if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Give_Cache ) ) {
			self::$instance = new Give_Cache();
		}

		return self::$instance;
	}

	/**
	 * Setup hooks.
	 *
	 * @since  1.8.7
	 * @access public
	 */
	public function setup_hooks() {
		// weekly delete all expired cache.
		Give_Cron::add_weekly_event( array( $this, 'delete_all_expired' ) );
	}

	/**
	 * Get cache key.
	 *
	 * @since  1.8.7
	 *
	 * @param  string $action     Cache key prefix.
	 * @param  array  $query_args (optional) Query array.
	 *
	 * @return string
	 */

	public static function get_key( $action, $query_args = null ) {
		$cache_key = "give_cache_{$action}";

		// Bailout.
		if ( ! empty( $query_args ) ) {
			$cache_key = "{$cache_key}_" . substr( md5( serialize( $query_args ) ), 0, 15 );
		}

		return $cache_key;
	}

	/**
	 * Get cache.
	 *
	 * @since  1.8.7
	 *
	 * @param  string $cache_key
	 * @param  bool   $custom_key
	 * @param  mixed  $query_args
	 *
	 * @return mixed
	 */

	public static function get( $cache_key, $custom_key = false, $query_args = array() ) {
		if ( ! self::is_valid_cache_key( $cache_key ) ) {

			if ( ! $custom_key ) {
				return new WP_Error( 'give_invalid_cache_key', __( 'Cache key format should be give_cache_*', 'give' ) );
			}

			$cache_key = self::get_key( $cache_key, $query_args );
		}

		$option = get_option( $cache_key );

		// Backward compatibility (<1.8.7).
		if ( ! is_array( $option ) || empty( $option ) || ! array_key_exists( 'expiration', $option ) ) {
			return $option;
		}

		// Get current time.
		$current_time = current_time( 'timestamp', 1 );

		if ( empty( $option['expiration'] ) || ( $current_time < $option['expiration'] ) ) {
			$option = $option['data'];
		} else {
			$option = false;
		}

		return $option;
	}

	/**
	 * Set cache.
	 *
	 * @since  1.8.7
	 *
	 * @param  string   $cache_key
	 * @param  mixed    $data
	 * @param  int|null $expiration Timestamp should be in GMT format.
	 * @param  bool     $custom_key
	 * @param  mixed    $query_args
	 *
	 * @return mixed
	 */

	public static function set( $cache_key, $data, $expiration = null, $custom_key = false, $query_args = array() ) {
		if ( ! self::is_valid_cache_key( $cache_key ) ) {

			if ( ! $custom_key ) {
				return new WP_Error( 'give_invalid_cache_key', __( 'Cache key format should be give_cache_*', 'give' ) );
			}

			$cache_key = self::get_key( $cache_key, $query_args );
		}

		$option_value = array(
			'data'       => $data,
			'expiration' => ! is_null( $expiration )
				? ( $expiration + current_time( 'timestamp', 1 ) )
				: null,
		);

		$result = update_option( $cache_key, $option_value, 'no' );

		return $result;
	}

	/**
	 * Delete cache.
	 *
	 * @since  1.8.7
	 *
	 * @param  string|array $cache_keys
	 *
	 * @return bool|WP_Error
	 */

	public static function delete( $cache_keys ) {
		$result       = true;
		$invalid_keys = array();

		if ( ! empty( $cache_keys ) ) {
			$cache_keys = is_array( $cache_keys ) ? $cache_keys : array( $cache_keys );

			foreach ( $cache_keys as $cache_key ) {
				if ( ! self::is_valid_cache_key( $cache_key ) ) {
					$invalid_keys[] = $cache_key;
					$result         = false;
				}

				delete_option( $cache_key );
			}
		}

		if ( ! $result ) {
			$result = new WP_Error(
				'give_invalid_cache_key',
				__( 'Cache key format should be give_cache_*', 'give' ),
				$invalid_keys
			);
		}

		return $result;
	}

	/**
	 * Delete all logging cache.
	 *
	 * @since  1.8.7
	 * @access public
	 * @global wpdb $wpdb
	 *
	 * @param bool  $force If set to true then all cached values will be delete instead of only expired
	 *
	 * @return bool
	 */
	public static function delete_all_expired( $force = false ) {
		global $wpdb;
		$options = $wpdb->get_results(

			$wpdb->prepare(
				"SELECT option_name, option_value
						FROM {$wpdb->options}
						Where option_name
						LIKE '%%%s%%'",
				'give_cache'
			),
			ARRAY_A
		);

		// Bailout.
		if ( empty( $options ) ) {
			return false;
		}

		$current_time = current_time( 'timestamp', 1 );

		// Delete log cache.
		foreach ( $options as $option ) {
			$option['option_value'] = maybe_unserialize( $option['option_value'] );

			if (
				(
					! self::is_valid_cache_key( $option['option_name'] )
					|| ! is_array( $option['option_value'] ) // Backward compatibility (<1.8.7).
					|| ! array_key_exists( 'expiration', $option['option_value'] ) // Backward compatibility (<1.8.7).
					|| empty( $option['option_value']['expiration'] )
					|| ( $current_time < $option['option_value']['expiration'] )
				)
				&& ! $force
			) {
				continue;
			}

			self::delete( $option['option_name'] );
		}
	}


	/**
	 * Get list of options like.
	 *
	 * @since  1.8.7
	 * @access public
	 *
	 * @param string $option_name
	 * @param bool   $fields
	 *
	 * @return array
	 */
	public static function get_options_like( $option_name, $fields = false ) {
		global $wpdb;

		if ( empty( $option_name ) ) {
			return array();
		}

		$field_names = $fields ? 'option_name, option_value' : 'option_name';

		if ( $fields ) {
			$options = $wpdb->get_results(

				$wpdb->prepare(
					"SELECT {$field_names }
						FROM {$wpdb->options}
						Where option_name
						LIKE '%%%s%%'",
					"give_cache_{$option_name}"
				),
				ARRAY_A
			);
		} else {
			$options = $wpdb->get_col(

				$wpdb->prepare(
					"SELECT *
						FROM {$wpdb->options}
						Where option_name
						LIKE '%%%s%%'",
					"give_cache_{$option_name}"
				),
				1
			);
		}

		if ( ! empty( $options ) && $fields ) {
			foreach ( $options as $index => $option ) {
				$option['option_value'] = maybe_unserialize( $option['option_value'] );
				$options[ $index ]      = $option;
			}
		}

		return $options;
	}

	/**
	 * Check cache key validity.
	 *
	 * @since  1.8.7
	 * @access public
	 *
	 * @param $cache_key
	 *
	 * @return bool|int
	 */
	public static function is_valid_cache_key( $cache_key ) {
		return ( false !== strpos( $cache_key, 'give_cache_' ) );
	}


	/**
	 * Cache small chunks inside group
	 *
	 * @since  2.0
	 * @access public
	 *
	 * @param       $group_type
	 * @param array $args {
	 *
	 * @type string $id
	 * @type string $key
	 * @type string $data
	 *
	 * }
	 *
	 * @return bool|array|WP_Error
	 */
	public static function group( $group_type, $args = array() ) {
		// Bailout
		if ( empty( $group_type ) || empty( $args ) || empty( $args['id'] ) ) {
			return false;
		} elseif ( empty( $args['key'] ) ) {
			return new WP_Error( 'give_invalid_payment_cache_key', __( 'We did not find valid payment cache key.', 'give' ) );
		}

		$cache_id = "give_{$group_type}_{$args['id']}";

		// Get cache.
		if ( ! ( $donation_cache = Give_Cache::get( $cache_id, true ) ) ) {
			$donation_cache = array();
		}

		// Get cache.
		if ( empty( $args['data'] ) ) {
			return ( isset( $donation_cache[ $args['key'] ] ) ? $donation_cache[ $args['key'] ] : '' );
		}

		// Store donation address to cache (save queries).
		$donation_cache[ $args['key'] ] = $args['data'];

		return Give_Cache::set( $cache_id, $donation_cache, null, true );
	}

	/**
	 * Delete payment cache.
	 *
	 * @since  2.0
	 * @access public
	 *
	 * @param string $group_type
	 * @param string $id
	 *
	 * @return mixed
	 */
	public static function delete_group( $group_type, $id ) {
		if ( empty( $group_type ) ) {
			return false;
		} elseif ( ! $id ) {
			return new WP_Error( 'give_invalid_payment_cache_id', __( 'We did not find valid payment cache id.', 'give' ) );
		}

		return Give_Cache::delete( "give_cache_give_{$group_type}_{$id}" );
	}
}

// Initialize
Give_Cache::get_instance()->setup_hooks();


1		<?php
2		/**
3		* Class for managing cache
4		*
5		* @package Give
6		* @subpackage Classes/Give_Cache
7		* @copyright Copyright (c) 2017, WordImpress
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 1.8.7
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		class Give_Cache {
		0 ignored issues – show Coding Style introduced 2017-04-14 10:23 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...
18		/**
19		* Instance.
20		*
21		* @since 1.8.7
22		* @access static
23		* @var
24		*/
25		static private $instance;
26
27		/**
28		* Singleton pattern.
29		*
30		* @since 1.8.7
31		* @access private
32		* Give_Cache constructor.
33		*/
34		private function __construct() {
35		}
36
37
38		/**
39		* Get instance.
40		*
41		* @since 1.8.7
42		* @access public
43		* @return static
44		*/
45		public static function get_instance() {
46		if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Give_Cache ) ) {
47		self::$instance = new Give_Cache();
48		}
49
50		return self::$instance;
51		}
52
53		/**
54		* Setup hooks.
55		*
56		* @since 1.8.7
57		* @access public
58		*/
59		public function setup_hooks() {
60		// weekly delete all expired cache.
61		Give_Cron::add_weekly_event( array( $this, 'delete_all_expired' ) );
62		}
63
64		/**
65		* Get cache key.
66		*
67		* @since 1.8.7
68		*
69		* @param string $action Cache key prefix.
70		* @param array $query_args (optional) Query array.
71		*
72		* @return string
73		*/
74
75		public static function get_key( $action, $query_args = null ) {
76		$cache_key = "give_cache_{$action}";
77
78		// Bailout.
79		if ( ! empty( $query_args ) ) {
80		$cache_key = "{$cache_key}_" . substr( md5( serialize( $query_args ) ), 0, 15 );
81		}
82
83		return $cache_key;
84		}
85
86		/**
87		* Get cache.
88		*
89		* @since 1.8.7
90		*
91		* @param string $cache_key
92		* @param bool $custom_key
93		* @param mixed $query_args
94		*
95		* @return mixed
96		*/
97
98		public static function get( $cache_key, $custom_key = false, $query_args = array() ) {
99	View Code Duplication	if ( ! self::is_valid_cache_key( $cache_key ) ) {
		0 ignored issues – show Duplication introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
100		if ( ! $custom_key ) {
101		return new WP_Error( 'give_invalid_cache_key', __( 'Cache key format should be give_cache_*', 'give' ) );
102		}
103
104		$cache_key = self::get_key( $cache_key, $query_args );
105		}
106
107		$option = get_option( $cache_key );
108
109		// Backward compatibility (<1.8.7).
110		if ( ! is_array( $option ) \|\| empty( $option ) \|\| ! array_key_exists( 'expiration', $option ) ) {
111		return $option;
112		}
113
114		// Get current time.
115		$current_time = current_time( 'timestamp', 1 );
116
117		if ( empty( $option['expiration'] ) \|\| ( $current_time < $option['expiration'] ) ) {
118		$option = $option['data'];
119		} else {
120		$option = false;
121		}
122
123		return $option;
124		}
125
126		/**
127		* Set cache.
128		*
129		* @since 1.8.7
130		*
131		* @param string $cache_key
132		* @param mixed $data
133		* @param int\|null $expiration Timestamp should be in GMT format.
134		* @param bool $custom_key
135		* @param mixed $query_args
136		*
137		* @return mixed
138		*/
139
140		public static function set( $cache_key, $data, $expiration = null, $custom_key = false, $query_args = array() ) {
141	View Code Duplication	if ( ! self::is_valid_cache_key( $cache_key ) ) {
		0 ignored issues – show Duplication introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
142		if ( ! $custom_key ) {
143		return new WP_Error( 'give_invalid_cache_key', __( 'Cache key format should be give_cache_*', 'give' ) );
144		}
145
146		$cache_key = self::get_key( $cache_key, $query_args );
147		}
148
149		$option_value = array(
150		'data' => $data,
151		'expiration' => ! is_null( $expiration )
152		? ( $expiration + current_time( 'timestamp', 1 ) )
153		: null,
154		);
155
156		$result = update_option( $cache_key, $option_value, 'no' );
157
158		return $result;
159		}
160
161		/**
162		* Delete cache.
163		*
164		* @since 1.8.7
165		*
166		* @param string\|array $cache_keys
167		*
168		* @return bool\|WP_Error
169		*/
170
171		public static function delete( $cache_keys ) {
172		$result = true;
173		$invalid_keys = array();
174
175		if ( ! empty( $cache_keys ) ) {
176		$cache_keys = is_array( $cache_keys ) ? $cache_keys : array( $cache_keys );
177
178		foreach ( $cache_keys as $cache_key ) {
179		if ( ! self::is_valid_cache_key( $cache_key ) ) {
180		$invalid_keys[] = $cache_key;
181		$result = false;
182		}
183
184		delete_option( $cache_key );
185		}
186		}
187
188		if ( ! $result ) {
189		$result = new WP_Error(
190		'give_invalid_cache_key',
191		__( 'Cache key format should be give_cache_*', 'give' ),
192		$invalid_keys
193		);
194		}
195
196		return $result;
197		}
198
199		/**
200		* Delete all logging cache.
201		*
202		* @since 1.8.7
203		* @access public
204		* @global wpdb $wpdb
205		*
206		* @param bool $force If set to true then all cached values will be delete instead of only expired
207		*
208		* @return bool
209		*/
210		public static function delete_all_expired( $force = false ) {
211		global $wpdb;
212		$options = $wpdb->get_results(
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
213		$wpdb->prepare(
214		"SELECT option_name, option_value
215		FROM {$wpdb->options}
216		Where option_name
217		LIKE '%%%s%%'",
218		'give_cache'
219		),
220		ARRAY_A
221		);
222
223		// Bailout.
224		if ( empty( $options ) ) {
225		return false;
226		}
227
228		$current_time = current_time( 'timestamp', 1 );
229
230		// Delete log cache.
231		foreach ( $options as $option ) {
232		$option['option_value'] = maybe_unserialize( $option['option_value'] );
233
234		if (
235		(
236		! self::is_valid_cache_key( $option['option_name'] )
237		\|\| ! is_array( $option['option_value'] ) // Backward compatibility (<1.8.7).
238		\|\| ! array_key_exists( 'expiration', $option['option_value'] ) // Backward compatibility (<1.8.7).
239		\|\| empty( $option['option_value']['expiration'] )
240		\|\| ( $current_time < $option['option_value']['expiration'] )
241		)
242		&& ! $force
243		) {
244		continue;
245		}
246
247		self::delete( $option['option_name'] );
248		}
249		}
250
251
252		/**
253		* Get list of options like.
254		*
255		* @since 1.8.7
256		* @access public
257		*
258		* @param string $option_name
259		* @param bool $fields
260		*
261		* @return array
262		*/
263		public static function get_options_like( $option_name, $fields = false ) {
264		global $wpdb;
265
266		if ( empty( $option_name ) ) {
267		return array();
268		}
269
270		$field_names = $fields ? 'option_name, option_value' : 'option_name';
271
272		if ( $fields ) {
273		$options = $wpdb->get_results(
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
274		$wpdb->prepare(
275		"SELECT {$field_names }
276		FROM {$wpdb->options}
277		Where option_name
278		LIKE '%%%s%%'",
279		"give_cache_{$option_name}"
280		),
281		ARRAY_A
282		);
283		} else {
284		$options = $wpdb->get_col(
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
285		$wpdb->prepare(
286		"SELECT *
287		FROM {$wpdb->options}
288		Where option_name
289		LIKE '%%%s%%'",
290		"give_cache_{$option_name}"
291		),
292		1
293		);
294		}
295
296		if ( ! empty( $options ) && $fields ) {
297		foreach ( $options as $index => $option ) {
298		$option['option_value'] = maybe_unserialize( $option['option_value'] );
299		$options[ $index ] = $option;
300		}
301		}
302
303		return $options;
304		}
305
306		/**
307		* Check cache key validity.
308		*
309		* @since 1.8.7
310		* @access public
311		*
312		* @param $cache_key
313		*
314		* @return bool\|int
315		*/
316		public static function is_valid_cache_key( $cache_key ) {
317		return ( false !== strpos( $cache_key, 'give_cache_' ) );
318		}
319
320
321		/**
322		* Cache small chunks inside group
323		*
324		* @since 2.0
325		* @access public
326		*
327		* @param $group_type
328		* @param array $args {
329		*
330		* @type string $id
331		* @type string $key
332		* @type string $data
333		*
334		* }
335		*
336		* @return bool\|array\|WP_Error
337		*/
338		public static function group( $group_type, $args = array() ) {
339		// Bailout
340		if ( empty( $group_type ) \|\| empty( $args ) \|\| empty( $args['id'] ) ) {
341		return false;
342		} elseif ( empty( $args['key'] ) ) {
343		return new WP_Error( 'give_invalid_payment_cache_key', __( 'We did not find valid payment cache key.', 'give' ) );
344		}
345
346		$cache_id = "give_{$group_type}_{$args['id']}";
347
348		// Get cache.
349		if ( ! ( $donation_cache = Give_Cache::get( $cache_id, true ) ) ) {
350		$donation_cache = array();
351		}
352
353		// Get cache.
354		if ( empty( $args['data'] ) ) {
355		return ( isset( $donation_cache[ $args['key'] ] ) ? $donation_cache[ $args['key'] ] : '' );
356		}
357
358		// Store donation address to cache (save queries).
359		$donation_cache[ $args['key'] ] = $args['data'];
360
361		return Give_Cache::set( $cache_id, $donation_cache, null, true );
362		}
363
364		/**
365		* Delete payment cache.
366		*
367		* @since 2.0
368		* @access public
369		*
370		* @param string $group_type
371		* @param string $id
372		*
373		* @return mixed
374		*/
375		public static function delete_group( $group_type, $id ) {
376		if ( empty( $group_type ) ) {
377		return false;
378		} elseif ( ! $id ) {
379		return new WP_Error( 'give_invalid_payment_cache_id', __( 'We did not find valid payment cache id.', 'give' ) );
380		}
381
382		return Give_Cache::delete( "give_cache_give_{$group_type}_{$id}" );
383		}
384		}
385
386		// Initialize
387		Give_Cache::get_instance()->setup_hooks();
388

ravinderk / Give

Push — issues/370 ( 90279e )

Give_Cache::group() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like