FS_Option_Manager::__construct() - Code Metrics - Inspection of "Merge branch 'release/1.3.6'" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 74a577...62d274 )

by Brad

created 2017-07-04 19:20 UTC

FS_Option_Manager::__construct() A

↳ Parent: FS_Option_Manager

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	7
nc	2
nop	2
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0

<?php

	/**
	 * @package     Freemius
	 * @copyright   Copyright (c) 2015, Freemius, Inc.
	 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
	 * @since       1.0.3
	 */

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

	/**
	 * 3-layer lazy options manager.
	 *      layer 3: Memory
	 *      layer 2: Cache (if there's any caching plugin and if WP_FS__DEBUG_SDK is FALSE)
	 *      layer 1: Database (options table). All options stored as one option record in the DB to reduce number of DB
	 *      queries.
	 *
	 * If load() is not explicitly called, starts as empty manager. Same thing about saving the data - you have to
	 * explicitly call store().
	 *
	 * Class Freemius_Option_Manager
	 */
	class FS_Option_Manager {
namespace YourVendor;

class YourClass { }
		/**
		 * @var string
		 */
		private $_id;
		/**
		 * @var array
		 */
		private $_options;
		/**
		 * @var FS_Logger
		 */
		private $_logger;

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

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

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

			$this->_id = $id;

			if ( $load ) {
				$this->load();
			}
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @param $id
		 * @param $load
		 *
		 * @return FS_Option_Manager
		 */
		static function get_manager( $id, $load = false ) {

			$id = strtolower( $id );

			if ( ! isset( self::$_MANAGERS[ $id ] ) ) {
				self::$_MANAGERS[ $id ] = new FS_Option_Manager( $id, $load );
			} // If load required but not yet loaded, load.
			else if ( $load && ! self::$_MANAGERS[ $id ]->is_loaded() ) {
				self::$_MANAGERS[ $id ]->load();
			}

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

		private function _get_option_manager_name() {
//			return WP_FS__SLUG . '_' . $this->_id;
			return $this->_id;
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @param bool $flush
		 */
		function load( $flush = false ) {

			$this->_logger->entrance();

			$option_name = $this->_get_option_manager_name();

			if ( $flush || ! isset( $this->_options ) ) {
				if ( isset( $this->_options ) ) {
					// Clear prev options.
					$this->clear();
				}

				if ( ! WP_FS__DEBUG_SDK ) {
					$this->_options = wp_cache_get( $option_name, WP_FS__SLUG );
				}

//				$this->_logger->info('wp_cache_get = ' . var_export($this->_options, true));


//				if ( is_array( $this->_options ) ) {

//					$this->clear();
//				}

				$cached = true;

				if ( empty( $this->_options ) ) {
					$this->_options = get_option( $option_name );

					if ( is_string( $this->_options ) ) {
						$this->_options = json_decode( $this->_options );

					}

//					$this->_logger->info('get_option = ' . var_export($this->_options, true));


					if ( false === $this->_options ) {
						$this->clear();
					}

					$cached = false;
				}

				if ( ! WP_FS__DEBUG_SDK && ! $cached ) // Set non encoded cache.
				{
					wp_cache_set( $option_name, $this->_options, WP_FS__SLUG );
				}
			}
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @return bool
		 */
		function is_loaded() {

			return isset( $this->_options );
		}

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

			return ( $this->is_loaded() && false === $this->_options );
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.6
		 *
		 * @param bool $flush
		 */
		function clear( $flush = false ) {

			$this->_logger->entrance();

			$this->_options = array();

			if ( $flush ) {
				$this->store();
			}
		}

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

			delete_option( $this->_get_option_manager_name() );
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.6
		 *
		 * @param string $option
		 *
		 * @return bool
		 */
		function has_option( $option ) {

			return array_key_exists( $option, $this->_options );
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @param string $option
		 * @param mixed  $default
		 *
		 * @return mixed
		 */
		function get_option( $option, $default = null ) {

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

			if ( is_array( $this->_options ) ) {
				return isset( $this->_options[ $option ] ) ? $this->_options[ $option ] : $default;
			} else if ( is_object( $this->_options ) ) {
				return isset( $this->_options->{$option} ) ? $this->_options->{$option} : $default;
			}

			return $default;
		}

		/**
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @param string $option
		 * @param mixed  $value
		 * @param bool   $flush
		 */
		function set_option( $option, $value, $flush = false ) {

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

			if ( ! $this->is_loaded() ) {
				$this->clear();
			}

			if ( is_array( $this->_options ) ) {
				$this->_options[ $option ] = $value;
			} else if ( is_object( $this->_options ) ) {
				$this->_options->{$option} = $value;
			}

			if ( $flush ) {
				$this->store();
			}
		}

		/**
		 * Unset option.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 *
		 * @param string $option
		 * @param bool   $flush
		 */
		function unset_option( $option, $flush = false ) {

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

			if ( is_array( $this->_options ) ) {
				if ( ! isset( $this->_options[ $option ] ) ) {
					return;
				}

				unset( $this->_options[ $option ] );

			} else if ( is_object( $this->_options ) ) {
				if ( ! isset( $this->_options->{$option} ) ) {
					return;
				}

				unset( $this->_options->{$option} );
			}

			if ( $flush ) {
				$this->store();
			}
		}

		/**
		 * Dump options to database.
		 *
		 * @author Vova Feldman (@svovaf)
		 * @since  1.0.3
		 */
		function store() {

			$this->_logger->entrance();

			$option_name = $this->_get_option_manager_name();

			if ( $this->_logger->is_on() ) {
				$this->_logger->info( $option_name . ' = ' . var_export( $this->_options, true ) );
			}

			// Update DB.
			update_option( $option_name, $this->_options );

			if ( ! WP_FS__DEBUG_SDK ) {
				wp_cache_set( $option_name, $this->_options, WP_FS__SLUG );
			}
		}
	}

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 25 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 http://opensource.org/licenses/gpl-2.0.php GNU Public License
6			* @since 1.0.3
7			*/
8
9			if ( ! defined( 'ABSPATH' ) ) {
10			exit;
11			}
12
13			/**
14			* 3-layer lazy options manager.
15			* layer 3: Memory
16			* layer 2: Cache (if there's any caching plugin and if WP_FS__DEBUG_SDK is FALSE)
17			* layer 1: Database (options table). All options stored as one option record in the DB to reduce number of DB
18			* queries.
19			*
20			* If load() is not explicitly called, starts as empty manager. Same thing about saving the data - you have to
21			* explicitly call store().
22			*
23			* Class Freemius_Option_Manager
24			*/
25			class FS_Option_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...
26			/**
27			* @var string
28			*/
29			private $_id;
30			/**
31			* @var array
32			*/
33			private $_options;
34			/**
35			* @var FS_Logger
36			*/
37			private $_logger;
38
39			/**
40			* @var FS_Option_Manager[]
41			*/
42			private static $_MANAGERS = array();
43
44			/**
45			* @author Vova Feldman (@svovaf)
46			* @since 1.0.3
47			*
48			* @param string $id
49			* @param bool $load
50			*/
51			private function __construct( $id, $load = false ) {
52			$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_opt_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );
53
54			$this->_logger->entrance();
55			$this->_logger->log( 'id = ' . $id );
56
57			$this->_id = $id;
58
59			if ( $load ) {
60			$this->load();
61			}
62			}
63
64			/**
65			* @author Vova Feldman (@svovaf)
66			* @since 1.0.3
67			*
68			* @param $id
69			* @param $load
70			*
71			* @return FS_Option_Manager
72			*/
73			static function get_manager( $id, $load = false ) {
			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...
74			$id = strtolower( $id );
75
76			if ( ! isset( self::$_MANAGERS[ $id ] ) ) {
77			self::$_MANAGERS[ $id ] = new FS_Option_Manager( $id, $load );
78			} // If load required but not yet loaded, load.
79			else if ( $load && ! self::$_MANAGERS[ $id ]->is_loaded() ) {
80			self::$_MANAGERS[ $id ]->load();
81			}
82
83			return self::$_MANAGERS[ $id ];
84			}
85
86			private function _get_option_manager_name() {
87			// return WP_FS__SLUG . '_' . $this->_id;
88			return $this->_id;
89			}
90
91			/**
92			* @author Vova Feldman (@svovaf)
93			* @since 1.0.3
94			*
95			* @param bool $flush
96			*/
97			function load( $flush = false ) {
			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...
98			$this->_logger->entrance();
99
100			$option_name = $this->_get_option_manager_name();
101
102			if ( $flush \|\| ! isset( $this->_options ) ) {
103			if ( isset( $this->_options ) ) {
104			// Clear prev options.
105			$this->clear();
106			}
107
108			if ( ! WP_FS__DEBUG_SDK ) {
109			$this->_options = wp_cache_get( $option_name, WP_FS__SLUG );
110			}
111
112			// $this->_logger->info('wp_cache_get = ' . var_export($this->_options, true));
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
113
114			// if ( is_array( $this->_options ) ) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
115			// $this->clear();
116			// }
117
118			$cached = true;
119
120			if ( empty( $this->_options ) ) {
121			$this->_options = get_option( $option_name );
122
123			if ( is_string( $this->_options ) ) {
124			$this->_options = json_decode( $this->_options );
			0 ignored issues – show Documentation Bug introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It seems like `json_decode($this->_options)` of type `*` is incompatible with the declared type `array` of property `$_options`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
125			}
126
127			// $this->_logger->info('get_option = ' . var_export($this->_options, true));
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128
129			if ( false === $this->_options ) {
130			$this->clear();
131			}
132
133			$cached = false;
134			}
135
136			if ( ! WP_FS__DEBUG_SDK && ! $cached ) // Set non encoded cache.
137			{
138			wp_cache_set( $option_name, $this->_options, WP_FS__SLUG );
139			}
140			}
141			}
142
143			/**
144			* @author Vova Feldman (@svovaf)
145			* @since 1.0.3
146			*
147			* @return bool
148			*/
149			function is_loaded() {
			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...
150			return isset( $this->_options );
151			}
152
153			/**
154			* @author Vova Feldman (@svovaf)
155			* @since 1.0.3
156			*
157			* @return bool
158			*/
159			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...
160			return ( $this->is_loaded() && false === $this->_options );
161			}
162
163			/**
164			* @author Vova Feldman (@svovaf)
165			* @since 1.0.6
166			*
167			* @param bool $flush
168			*/
169			function clear( $flush = false ) {
			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...
170			$this->_logger->entrance();
171
172			$this->_options = array();
173
174			if ( $flush ) {
175			$this->store();
176			}
177			}
178
179			/**
180			* Delete options manager from DB.
181			*
182			* @author Vova Feldman (@svovaf)
183			* @since 1.0.9
184			*/
185			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...
186			delete_option( $this->_get_option_manager_name() );
187			}
188
189			/**
190			* @author Vova Feldman (@svovaf)
191			* @since 1.0.6
192			*
193			* @param string $option
194			*
195			* @return bool
196			*/
197			function has_option( $option ) {
			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...
198			return array_key_exists( $option, $this->_options );
199			}
200
201			/**
202			* @author Vova Feldman (@svovaf)
203			* @since 1.0.3
204			*
205			* @param string $option
206			* @param mixed $default
207			*
208			* @return mixed
209			*/
210			function get_option( $option, $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...
211			$this->_logger->entrance( 'option = ' . $option );
212
213			if ( is_array( $this->_options ) ) {
214			return isset( $this->_options[ $option ] ) ? $this->_options[ $option ] : $default;
215			} else if ( is_object( $this->_options ) ) {
216			return isset( $this->_options->{$option} ) ? $this->_options->{$option} : $default;
217			}
218
219			return $default;
220			}
221
222			/**
223			* @author Vova Feldman (@svovaf)
224			* @since 1.0.3
225			*
226			* @param string $option
227			* @param mixed $value
228			* @param bool $flush
229			*/
230			function set_option( $option, $value, $flush = false ) {
			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...
231			$this->_logger->entrance( 'option = ' . $option );
232
233			if ( ! $this->is_loaded() ) {
234			$this->clear();
235			}
236
237			if ( is_array( $this->_options ) ) {
238			$this->_options[ $option ] = $value;
239			} else if ( is_object( $this->_options ) ) {
240			$this->_options->{$option} = $value;
241			}
242
243			if ( $flush ) {
244			$this->store();
245			}
246			}
247
248			/**
249			* Unset option.
250			*
251			* @author Vova Feldman (@svovaf)
252			* @since 1.0.3
253			*
254			* @param string $option
255			* @param bool $flush
256			*/
257			function unset_option( $option, $flush = false ) {
			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...
258			$this->_logger->entrance( 'option = ' . $option );
259
260			if ( is_array( $this->_options ) ) {
261			if ( ! isset( $this->_options[ $option ] ) ) {
262			return;
263			}
264
265			unset( $this->_options[ $option ] );
266
267			} else if ( is_object( $this->_options ) ) {
268			if ( ! isset( $this->_options->{$option} ) ) {
269			return;
270			}
271
272			unset( $this->_options->{$option} );
273			}
274
275			if ( $flush ) {
276			$this->store();
277			}
278			}
279
280			/**
281			* Dump options to database.
282			*
283			* @author Vova Feldman (@svovaf)
284			* @since 1.0.3
285			*/
286			function store() {
			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...
287			$this->_logger->entrance();
288
289			$option_name = $this->_get_option_manager_name();
290
291			if ( $this->_logger->is_on() ) {
292			$this->_logger->info( $option_name . ' = ' . var_export( $this->_options, true ) );
293			}
294
295			// Update DB.
296			update_option( $option_name, $this->_options );
297
298			if ( ! WP_FS__DEBUG_SDK ) {
299			wp_cache_set( $option_name, $this->_options, WP_FS__SLUG );
300			}
301			}
302			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — master ( 74a577...62d274 )

FS_Option_Manager::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like