FS_Cache_Manager::has_valid() - Code Metrics - Inspection of "update to freemius 1.2.2.9" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/gallery-template-clien... ( 80cd5b...be3a46 )

by Brad

created 2017-10-04 17:48 UTC

FS_Cache_Manager::has_valid() D

↳ Parent: FS_Cache_Manager

Complexity

Conditions	9
Paths	8

Size

Total Lines	27
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	13
nc	8
nop	2
dl	0
loc	27
rs	4.909
c	0
b	0
f	0

<?php

	/**
	 * @package     Freemius
	 * @copyright   Copyright (c) 2015, Freemius, Inc.
	 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
	 * @since       1.1.6
	 */

	if ( ! defined( 'ABSPATH' ) ) {
		exit;
	}

	class FS_Cache_Manager {
namespace YourVendor;

class YourClass { }
		/**
		 * @var FS_Option_Manager
		 */
		private $_options;
		/**
		 * @var FS_Logger
		 */
		private $_logger;

		/**
		 * @var FS_Cache_Manager[]
		 */
		private static $_MANAGERS = array();

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.3
		 *
		 * @param string $id
		 */
		private function __construct( $id ) {
			$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_cach_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );

			$this->_logger->entrance();
			$this->_logger->log( 'id = ' . $id );

			$this->_options = FS_Option_Manager::get_manager( $id, true );
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param $id
		 *
		 * @return FS_Cache_Manager
		 */
		static function get_manager( $id ) {

			$id = strtolower( $id );

			if ( ! isset( self::$_MANAGERS[ $id ] ) ) {
				self::$_MANAGERS[ $id ] = new FS_Cache_Manager( $id );
			}

			return self::$_MANAGERS[ $id ];
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @return bool
		 */
		function is_empty() {

			$this->_logger->entrance();

			return $this->_options->is_empty();
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 */
		function clear() {

			$this->_logger->entrance();

			$this->_options->clear( true );
		}

		/**
		 * Delete cache manager from DB.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.9
		 */
		function delete() {

			$this->_options->delete();
		}

		/**
		 * Check if there's a cached item.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string $key
		 *
		 * @return bool
		 */
		function has( $key ) {

			$cache_entry = $this->_options->get_option( $key, false );

			return ( is_object( $cache_entry ) &&
			         isset( $cache_entry->timestamp ) &&
			         is_numeric( $cache_entry->timestamp )
			);
		}

		/**
		 * Check if there's a valid cached item.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string   $key
		 * @param null|int $expiration Since 1.2.2.7
		 *
		 * @return bool
		 */
		function has_valid( $key, $expiration = null ) {

			$cache_entry = $this->_options->get_option( $key, false );

			$is_valid = ( is_object( $cache_entry ) &&
			              isset( $cache_entry->timestamp ) &&
			              is_numeric( $cache_entry->timestamp ) &&
			              $cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
			);

			if ( $is_valid &&
			     is_numeric( $expiration ) &&
			     isset( $cache_entry->created ) &&
			     is_numeric( $cache_entry->created ) &&
			     $cache_entry->created + $expiration < WP_FS__SCRIPT_START_TIME
			) {
				/**
				 * Even if the cache is still valid, since we are checking for validity
				 * with an explicit expiration period, if the period has past, return
				 * `false` as if the cache is invalid.
				 *
				 * @since 1.2.2.7
				 */
				$is_valid = false;
			}

			return $is_valid;
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string $key
		 * @param mixed  $default
		 *
		 * @return mixed
		 */
		function get( $key, $default = null ) {

			$this->_logger->entrance( 'key = ' . $key );

			$cache_entry = $this->_options->get_option( $key, false );

			if ( is_object( $cache_entry ) &&
			     isset( $cache_entry->timestamp ) &&
			     is_numeric( $cache_entry->timestamp )
			) {
				return $cache_entry->result;
			}

			return $default;
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string $key
		 * @param mixed  $default
		 *
		 * @return mixed
		 */
		function get_valid( $key, $default = null ) {

			$this->_logger->entrance( 'key = ' . $key );

			$cache_entry = $this->_options->get_option( $key, false );

			if ( is_object( $cache_entry ) &&
			     isset( $cache_entry->timestamp ) &&
			     is_numeric( $cache_entry->timestamp ) &&
			     $cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
			) {
				return $cache_entry->result;
			}

			return $default;
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string $key
		 * @param mixed  $value
		 * @param int    $expiration
		 */
		function set( $key, $value, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {

			$this->_logger->entrance( 'key = ' . $key );

			$cache_entry            = new stdClass();
			$cache_entry->result    = $value;
			$cache_entry->created   = WP_FS__SCRIPT_START_TIME;
			$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME + $expiration;
			$this->_options->set_option( $key, $cache_entry, true );
		}

		/**
		 * Get cached record expiration, or false if not cached or expired.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.7.3
		 *
		 * @param string $key
		 *
		 * @return bool|int
		 */
		function get_record_expiration( $key ) {

			$this->_logger->entrance( 'key = ' . $key );

			$cache_entry = $this->_options->get_option( $key, false );

			if ( is_object( $cache_entry ) &&
			     isset( $cache_entry->timestamp ) &&
			     is_numeric( $cache_entry->timestamp ) &&
			     $cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
			) {
				return $cache_entry->timestamp;
			}

			return false;
		}

		/**
		 * Purge cached item.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.1.6
		 *
		 * @param string $key
		 */
		function purge( $key ) {

			$this->_logger->entrance( 'key = ' . $key );

			$this->_options->unset_option( $key, true );
		}

		/**
		 * Set cached item as expired.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.2.2.7
		 *
		 * @param string $key
		 */
		function expire( $key ) {

			$this->_logger->entrance( 'key = ' . $key );

			$cache_entry = $this->_options->get_option( $key, false );

			if ( is_object( $cache_entry ) &&
			     isset( $cache_entry->timestamp ) &&
			     is_numeric( $cache_entry->timestamp ))
			{
				// Set to expired.
				$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME;
				$this->_options->set_option( $key, $cache_entry, true );
			}
		}
	}

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 13 and the first side effect is on line 10. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* @package Freemius
4			* @copyright Copyright (c) 2015, Freemius, Inc.
5			* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6			* @since 1.1.6
7			*/
8
9			if ( ! defined( 'ABSPATH' ) ) {
10			exit;
11			}
12
13			class FS_Cache_Manager {
			0 ignored issues – show Coding Style introduced 2017-06-04 19:22 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... Coding Style Compatibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
14			/**
15			* @var FS_Option_Manager
16			*/
17			private $_options;
18			/**
19			* @var FS_Logger
20			*/
21			private $_logger;
22
23			/**
24			* @var FS_Cache_Manager[]
25			*/
26			private static $_MANAGERS = array();
27
28			/**
29			* @author Vova Feldman (@svovaf)
30			* @since 1.1.3
31			*
32			* @param string $id
33			*/
34			private function __construct( $id ) {
35			$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_cach_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
36
37			$this->_logger->entrance();
38			$this->_logger->log( 'id = ' . $id );
39
40			$this->_options = FS_Option_Manager::get_manager( $id, true );
41			}
42
43			/**
44			* @author Vova Feldman (@svovaf)
45			* @since 1.1.6
46			*
47			* @param $id
48			*
49			* @return FS_Cache_Manager
50			*/
51			static function get_manager( $id ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
52			$id = strtolower( $id );
53
54			if ( ! isset( self::$_MANAGERS[ $id ] ) ) {
55			self::$_MANAGERS[ $id ] = new FS_Cache_Manager( $id );
56			}
57
58			return self::$_MANAGERS[ $id ];
59			}
60
61			/**
62			* @author Vova Feldman (@svovaf)
63			* @since 1.1.6
64			*
65			* @return bool
66			*/
67			function is_empty() {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
68			$this->_logger->entrance();
69
70			return $this->_options->is_empty();
71			}
72
73			/**
74			* @author Vova Feldman (@svovaf)
75			* @since 1.1.6
76			*/
77			function clear() {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
78			$this->_logger->entrance();
79
80			$this->_options->clear( true );
81			}
82
83			/**
84			* Delete cache manager from DB.
85			*
86			* @author Vova Feldman (@svovaf)
87			* @since 1.0.9
88			*/
89			function delete() {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
90			$this->_options->delete();
91			}
92
93			/**
94			* Check if there's a cached item.
95			*
96			* @author Vova Feldman (@svovaf)
97			* @since 1.1.6
98			*
99			* @param string $key
100			*
101			* @return bool
102			*/
103			function has( $key ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
104			$cache_entry = $this->_options->get_option( $key, false );
105
106			return ( is_object( $cache_entry ) &&
107			isset( $cache_entry->timestamp ) &&
108			is_numeric( $cache_entry->timestamp )
109			);
110			}
111
112			/**
113			* Check if there's a valid cached item.
114			*
115			* @author Vova Feldman (@svovaf)
116			* @since 1.1.6
117			*
118			* @param string $key
119			* @param null\|int $expiration Since 1.2.2.7
120			*
121			* @return bool
122			*/
123			function has_valid( $key, $expiration = null ) {
			0 ignored issues – show Best Practice introduced 2017-10-04 17:51 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
124			$cache_entry = $this->_options->get_option( $key, false );
125
126			$is_valid = ( is_object( $cache_entry ) &&
127			isset( $cache_entry->timestamp ) &&
128			is_numeric( $cache_entry->timestamp ) &&
129			$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
130			);
131
132			if ( $is_valid &&
133			is_numeric( $expiration ) &&
134			isset( $cache_entry->created ) &&
135			is_numeric( $cache_entry->created ) &&
136			$cache_entry->created + $expiration < WP_FS__SCRIPT_START_TIME
137			) {
138			/**
139			* Even if the cache is still valid, since we are checking for validity
140			* with an explicit expiration period, if the period has past, return
141			* `false` as if the cache is invalid.
142			*
143			* @since 1.2.2.7
144			*/
145			$is_valid = false;
146			}
147
148			return $is_valid;
149			}
150
151			/**
152			* @author Vova Feldman (@svovaf)
153			* @since 1.1.6
154			*
155			* @param string $key
156			* @param mixed $default
157			*
158			* @return mixed
159			*/
160			function get( $key, $default = null ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
161			$this->_logger->entrance( 'key = ' . $key );
162
163			$cache_entry = $this->_options->get_option( $key, false );
164
165			if ( is_object( $cache_entry ) &&
166			isset( $cache_entry->timestamp ) &&
167			is_numeric( $cache_entry->timestamp )
168			) {
169			return $cache_entry->result;
170			}
171
172			return $default;
173			}
174
175			/**
176			* @author Vova Feldman (@svovaf)
177			* @since 1.1.6
178			*
179			* @param string $key
180			* @param mixed $default
181			*
182			* @return mixed
183			*/
184			function get_valid( $key, $default = null ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
185			$this->_logger->entrance( 'key = ' . $key );
186
187			$cache_entry = $this->_options->get_option( $key, false );
188
189			if ( is_object( $cache_entry ) &&
190			isset( $cache_entry->timestamp ) &&
191			is_numeric( $cache_entry->timestamp ) &&
192			$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
193			) {
194			return $cache_entry->result;
195			}
196
197			return $default;
198			}
199
200			/**
201			* @author Vova Feldman (@svovaf)
202			* @since 1.1.6
203			*
204			* @param string $key
205			* @param mixed $value
206			* @param int $expiration
207			*/
208			function set( $key, $value, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
209			$this->_logger->entrance( 'key = ' . $key );
210
211			$cache_entry = new stdClass();
212			$cache_entry->result = $value;
213			$cache_entry->created = WP_FS__SCRIPT_START_TIME;
214			$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME + $expiration;
215			$this->_options->set_option( $key, $cache_entry, true );
216			}
217
218			/**
219			* Get cached record expiration, or false if not cached or expired.
220			*
221			* @author Vova Feldman (@svovaf)
222			* @since 1.1.7.3
223			*
224			* @param string $key
225			*
226			* @return bool\|int
227			*/
228			function get_record_expiration( $key ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
229			$this->_logger->entrance( 'key = ' . $key );
230
231			$cache_entry = $this->_options->get_option( $key, false );
232
233			if ( is_object( $cache_entry ) &&
234			isset( $cache_entry->timestamp ) &&
235			is_numeric( $cache_entry->timestamp ) &&
236			$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME
237			) {
238			return $cache_entry->timestamp;
239			}
240
241			return false;
242			}
243
244			/**
245			* Purge cached item.
246			*
247			* @author Vova Feldman (@svovaf)
248			* @since 1.1.6
249			*
250			* @param string $key
251			*/
252			function purge( $key ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
253			$this->_logger->entrance( 'key = ' . $key );
254
255			$this->_options->unset_option( $key, true );
256			}
257
258			/**
259			* Set cached item as expired.
260			*
261			* @author Vova Feldman (@svovaf)
262			* @since 1.2.2.7
263			*
264			* @param string $key
265			*/
266			function expire( $key ) {
			0 ignored issues – show Best Practice introduced 2017-10-04 17:51 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
267			$this->_logger->entrance( 'key = ' . $key );
268
269			$cache_entry = $this->_options->get_option( $key, false );
270
271			if ( is_object( $cache_entry ) &&
272			isset( $cache_entry->timestamp ) &&
273			is_numeric( $cache_entry->timestamp ))
274			{
275			// Set to expired.
276			$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME;
277			$this->_options->set_option( $key, $cache_entry, true );
278			}
279			}
280			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — feature/gallery-template-clien... ( 80cd5b...be3a46 )

FS_Cache_Manager::has_valid() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like