Geodir_Session::__construct() - Code Metrics - Inspection of "code coverge" - GeoDirectory/geodirectory - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#235)

by Viruthagiri

created 2016-05-04 15:31 UTC

Geodir_Session::__construct() C

↳ Parent: Geodir_Session

Complexity

Conditions	8
Paths	20

Size

Total Lines	35
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	0
loc	35
ccs	0
cts	25
cp	0
rs	5.3846
c	1
b	1
f	0
cc	8
eloc	20
nc	20
nop	0
crap	72

<?php
// Exit if accessed directly.
if (!defined( 'ABSPATH' ) ) exit;

/**
 * Geodir_Session Class.
 *
 * @since 1.5.7
 */
class Geodir_Session {
	/**
	 * Holds our session data.
	 *
	 * @var array
	 * @access private
	 * @since 1.5.7
	 */
	private $session;

	/**
	 * Whether to use PHP $_SESSION or WP_Session.
	 *
	 * @var bool
	 * @access private
	 * @since 1.5.7
	 */
	private $use_php_sessions = false;

	/**
	 * Session index prefix.
	 *
	 * @var string
	 * @access private
	 * @since 1.5.7
	 */
	private $prefix = '';

	/**
	 * Get things started.
	 *
	 * Defines our WP_Session constants, includes the necessary libraries and
	 * retrieves the WP Session instance.
	 *
	 * @since 1.5.7
	 */
	public function __construct() {
		$this->use_php_sessions = $this->use_php_sessions();

		if ( $this->use_php_sessions ) {
			if ( is_multisite() ) {
				$this->prefix = '_' . get_current_blog_id();
			}

			// Use PHP SESSION (must be enabled via the GEODIR_USE_PHP_SESSIONS constant)
			add_action( 'init', array( $this, 'maybe_start_session' ), -2 );
		} else {
			// Use WP_Session (default)

			if ( !defined( 'WP_SESSION_COOKIE' ) ) {
				define( 'WP_SESSION_COOKIE', 'geodir_wp_session' );
			}

			if ( !class_exists( 'Recursive_ArrayAccess' ) ) {
				require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/class-recursive-arrayaccess.php';
			}

			if ( !class_exists( 'WP_Session' ) ) {
				require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/class-wp-session.php';
				require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/wp-session.php';
			}

			add_filter( 'wp_session_expiration_variant', array( $this, 'set_expiration_variant_time' ), 99999 );
			add_filter( 'wp_session_expiration', array( $this, 'set_expiration_time' ), 99999 );
		}

		if ( empty( $this->session ) && ! $this->use_php_sessions ) {
			add_action( 'plugins_loaded', array( $this, 'init' ), -1 );
		} else {
			add_action( 'init', array( $this, 'init' ), -1 );
		}
	}

	/**
	 * Setup the WP_Session instance.
	 *
	 * @access public
	 * @since 1.5.7
	 * @return void
	 */
	public function init() {
		if ( $this->use_php_sessions ) {
			$this->session = isset( $_SESSION['gd' . $this->prefix ] ) && is_array( $_SESSION['gd' . $this->prefix ] ) ? $_SESSION['gd' . $this->prefix ] : array();
		} else {
			$this->session = WP_Session::get_instance();

		}

		return $this->session;
	}

	/**
	 * Retrieve session ID.
	 *
	 * @access public
	 * @since 1.5.7
	 * @return string Session ID
	 */
	public function get_id() {
		return $this->session->session_id;
	}

	/**
	 * Retrieve a session variable.
	 *
	 * @access public
	 * @since 1.5.7
	 * @param string $key Session key
	 * @return string Session variable
	 */
	public function get( $key ) {
		$key = sanitize_key( $key );
		return isset( $this->session[ $key ] ) ? maybe_unserialize( $this->session[ $key ] ) : false;
	}

	/**
	 * Set a session variable
	 *
	 * @since 1.5.7
	 *
	 * @param string $key Session key
	 * @param integer $value Session variable
	 * @return string Session variable
	 */
	public function set( $key, $value ) {
		$key = sanitize_key( $key );

		if ( is_array( $value ) ) {
			$this->session[ $key ] = maybe_serialize( $value );
		} else {
			$this->session[ $key ] = $value;
		}

		if ( $this->use_php_sessions ) {
			$_SESSION['gd' . $this->prefix ] = $this->session;
		}

		return $this->session[ $key ];
	}
	
	/**
	 * Unset a session variable.
	 *
	 * @since 1.5.7
	 *
	 * @param string|array $key Session key.
	 * @param integer $value Session variable.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return string Session variable.
	 */
	public function un_set( $key ) {
		if ( empty( $key ) ) {
			return false;
		}
		
		if ( is_array( $key ) ) {
			foreach ($key as $index) {
				$index = sanitize_key( $index );
			
				if ( $index && isset( $this->session[ $index ] ) ) {
					unset( $this->session[ $index ] );
				}
			}
		} else {
			$key = sanitize_key( $key );
			
			if ( isset( $this->session[ $key ] ) ) {
				unset( $this->session[ $key ] );
			}
		}

		if ( $this->use_php_sessions ) {
			$_SESSION['gd' . $this->prefix ] = $this->session;
		}

		return true;
	}
	
	/**
	 * Check a session variable is set or not.
	 *
	 * @since 1.5.7
	 *
	 * @param string $key Session key.
	 * @param integer $value Session variable.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return string Session variable.
	 */
	public function is_set( $key ) {
		$key = sanitize_key( $key );
		
		if ( empty( $key ) ) {
			return false;
		}

		if ( isset( $this->session[ $key ] ) ) {
			return true;
		}

		return false;
	}

	/**
	 * Force the cookie expiration variant time to 23 hours
	 *
	 * @access public
	 * @since 1.5.7
	 * @param int $exp Default expiration (1 hour)
	 * @return int
	 */
	public function set_expiration_variant_time( $exp ) {

		return ( 30 * 60 * 23 );
	}

	/**
	 * Force the cookie expiration time to 24 hours
	 *
	 * @access public
	 * @since 1.5.7
	 * @param int $exp Default expiration (1 hour)
	 * @return int
	 */
	public function set_expiration_time( $exp ) {

		return ( 30 * 60 * 24 );
	}

	/**
	 * Starts a new session if one hasn't started yet.
	 *
	 * @return boolean
	 * Checks to see if the server supports PHP sessions
	 * or if the GEODIR_USE_PHP_SESSIONS constant is defined
	 *
	 * @access public
	 * @since 1.5.7
	 * @return boolean $ret True if we are using PHP sessions, false otherwise
	 */
	public function use_php_sessions() {
		$ret = false;

		// If the database variable is already set, no need to run autodetection
		$geodir_use_php_sessions = (bool)get_option( 'geodir_use_php_sessions' );

		if (!$geodir_use_php_sessions ) {
			// Attempt to detect if the server supports PHP sessions
			if ( function_exists( 'session_start' ) && ! ini_get( 'safe_mode' ) ) {
				$this->set( 'geodir_use_php_sessions', 1 );
				
				if ( $this->get( 'geodir_use_php_sessions' ) ) {
					$ret = true;

					// Set the database option
					update_option( 'geodir_use_php_sessions', true );
				}
			}
		} else {
			$ret = $geodir_use_php_sessions;
		}

		// Enable or disable PHP Sessions based on the GEODIR_USE_PHP_SESSIONS constant
		if ( defined( 'GEODIR_USE_PHP_SESSIONS' ) && GEODIR_USE_PHP_SESSIONS ) {
			$ret = true;
		} else if ( defined( 'GEODIR_USE_PHP_SESSIONS' ) && ! GEODIR_USE_PHP_SESSIONS ) {
			$ret = false;
		}

		return (bool) apply_filters( 'geodir_use_php_sessions', $ret );
	}

	/**
	 * Starts a new session if one hasn't started yet.
	 */
	public function maybe_start_session() {
		if ( !session_id() && !headers_sent() ) {
			session_start();
		}
	}

	/**
	 * Determines if a user has set the GEODIR_USE_CART_COOKIE
	 *
	 * @since  1.5.7
	 * @return bool If the store should use the geodir_items_in_cart cookie to help avoid caching
	 */
	public function use_cart_cookie() {
		$ret = true;

		if ( defined( 'GEODIR_USE_CART_COOKIE' ) && ! GEODIR_USE_CART_COOKIE ) {
			$ret = false;
		}

		return (bool) apply_filters( 'geodir_use_cart_cookie', $ret );
	}
}

global $gd_session;
$gd_session = new Geodir_Session();


1		<?php
2		// Exit if accessed directly.
3		if (!defined( 'ABSPATH' ) ) exit;
4
5		/**
6		* Geodir_Session Class.
7		*
8		* @since 1.5.7
9		*/
10		class Geodir_Session {
11		/**
12		* Holds our session data.
13		*
14		* @var array
15		* @access private
16		* @since 1.5.7
17		*/
18		private $session;
19
20		/**
21		* Whether to use PHP $_SESSION or WP_Session.
22		*
23		* @var bool
24		* @access private
25		* @since 1.5.7
26		*/
27		private $use_php_sessions = false;
28
29		/**
30		* Session index prefix.
31		*
32		* @var string
33		* @access private
34		* @since 1.5.7
35		*/
36		private $prefix = '';
37
38		/**
39		* Get things started.
40		*
41		* Defines our WP_Session constants, includes the necessary libraries and
42		* retrieves the WP Session instance.
43		*
44		* @since 1.5.7
45		*/
46		public function __construct() {
47		$this->use_php_sessions = $this->use_php_sessions();
48
49		if ( $this->use_php_sessions ) {
50		if ( is_multisite() ) {
51		$this->prefix = '_' . get_current_blog_id();
52		}
53
54		// Use PHP SESSION (must be enabled via the GEODIR_USE_PHP_SESSIONS constant)
55		add_action( 'init', array( $this, 'maybe_start_session' ), -2 );
56		} else {
57		// Use WP_Session (default)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-13 11:26 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...
58		if ( !defined( 'WP_SESSION_COOKIE' ) ) {
59		define( 'WP_SESSION_COOKIE', 'geodir_wp_session' );
60		}
61
62		if ( !class_exists( 'Recursive_ArrayAccess' ) ) {
63		require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/class-recursive-arrayaccess.php';
64		}
65
66		if ( !class_exists( 'WP_Session' ) ) {
67		require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/class-wp-session.php';
68		require_once GEODIRECTORY_PLUGIN_DIR . 'geodirectory-functions/wp-session/wp-session.php';
69		}
70
71		add_filter( 'wp_session_expiration_variant', array( $this, 'set_expiration_variant_time' ), 99999 );
72		add_filter( 'wp_session_expiration', array( $this, 'set_expiration_time' ), 99999 );
73		}
74
75		if ( empty( $this->session ) && ! $this->use_php_sessions ) {
76		add_action( 'plugins_loaded', array( $this, 'init' ), -1 );
77		} else {
78		add_action( 'init', array( $this, 'init' ), -1 );
79		}
80		}
81
82		/**
83		* Setup the WP_Session instance.
84		*
85		* @access public
86		* @since 1.5.7
87		* @return void
88		*/
89		public function init() {
90		if ( $this->use_php_sessions ) {
91		$this->session = isset( $_SESSION['gd' . $this->prefix ] ) && is_array( $_SESSION['gd' . $this->prefix ] ) ? $_SESSION['gd' . $this->prefix ] : array();
92		} else {
93		$this->session = WP_Session::get_instance();
		0 ignored issues – show Documentation Bug introduced 2016-02-13 11:26 UTC by Report Bug Copy Issue Report It seems like `\WP_Session::get_instance()` of type `boolean` or `object<WP_Session>` is incompatible with the declared type `array` of property `$session`. 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...
94		}
95
96		return $this->session;
97		}
98
99		/**
100		* Retrieve session ID.
101		*
102		* @access public
103		* @since 1.5.7
104		* @return string Session ID
105		*/
106		public function get_id() {
107		return $this->session->session_id;
108		}
109
110		/**
111		* Retrieve a session variable.
112		*
113		* @access public
114		* @since 1.5.7
115		* @param string $key Session key
116		* @return string Session variable
117		*/
118	26	public function get( $key ) {
119	26	$key = sanitize_key( $key );
120	26	return isset( $this->session[ $key ] ) ? maybe_unserialize( $this->session[ $key ] ) : false;
121		}
122
123		/**
124		* Set a session variable
125		*
126		* @since 1.5.7
127		*
128		* @param string $key Session key
129		* @param integer $value Session variable
130		* @return string Session variable
131		*/
132	3	public function set( $key, $value ) {
133	3	$key = sanitize_key( $key );
134
135	3	if ( is_array( $value ) ) {
136	1	$this->session[ $key ] = maybe_serialize( $value );
137	1	} else {
138	2	$this->session[ $key ] = $value;
139		}
140
141	3	if ( $this->use_php_sessions ) {
142		$_SESSION['gd' . $this->prefix ] = $this->session;
143		}
144
145	3	return $this->session[ $key ];
146		}
147
148		/**
149		* Unset a session variable.
150		*
151		* @since 1.5.7
152		*
153		* @param string\|array $key Session key.
154		* @param integer $value Session variable.
		0 ignored issues – show Bug introduced 2016-02-13 11:26 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
155		* @return string Session variable.
156		*/
157	10	public function un_set( $key ) {
158	10	if ( empty( $key ) ) {
159		return false;
160		}
161
162	10	if ( is_array( $key ) ) {
163		foreach ($key as $index) {
164		$index = sanitize_key( $index );
165
166		if ( $index && isset( $this->session[ $index ] ) ) {
167		unset( $this->session[ $index ] );
168		}
169		}
170		} else {
171	10	$key = sanitize_key( $key );
172
173	10	if ( isset( $this->session[ $key ] ) ) {
174	3	unset( $this->session[ $key ] );
175	3	}
176		}
177
178	10	if ( $this->use_php_sessions ) {
179		$_SESSION['gd' . $this->prefix ] = $this->session;
180		}
181
182	10	return true;
183		}
184
185		/**
186		* Check a session variable is set or not.
187		*
188		* @since 1.5.7
189		*
190		* @param string $key Session key.
191		* @param integer $value Session variable.
		0 ignored issues – show Bug introduced 2016-02-13 11:26 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
192		* @return string Session variable.
193		*/
194		public function is_set( $key ) {
195		$key = sanitize_key( $key );
196
197		if ( empty( $key ) ) {
198		return false;
199		}
200
201		if ( isset( $this->session[ $key ] ) ) {
202		return true;
203		}
204
205		return false;
206		}
207
208		/**
209		* Force the cookie expiration variant time to 23 hours
210		*
211		* @access public
212		* @since 1.5.7
213		* @param int $exp Default expiration (1 hour)
214		* @return int
215		*/
216		public function set_expiration_variant_time( $exp ) {
		0 ignored issues – show Unused Code introduced 2016-02-13 11:26 UTC by Report Bug Copy Issue Report The parameter `$exp` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
217		return ( 30 * 60 * 23 );
218		}
219
220		/**
221		* Force the cookie expiration time to 24 hours
222		*
223		* @access public
224		* @since 1.5.7
225		* @param int $exp Default expiration (1 hour)
226		* @return int
227		*/
228		public function set_expiration_time( $exp ) {
		0 ignored issues – show Unused Code introduced 2016-02-13 11:26 UTC by Report Bug Copy Issue Report The parameter `$exp` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
229		return ( 30 * 60 * 24 );
230		}
231
232		/**
233		* Starts a new session if one hasn't started yet.
234		*
235		* @return boolean
236		* Checks to see if the server supports PHP sessions
237		* or if the GEODIR_USE_PHP_SESSIONS constant is defined
238		*
239		* @access public
240		* @since 1.5.7
241		* @return boolean $ret True if we are using PHP sessions, false otherwise
242		*/
243		public function use_php_sessions() {
244		$ret = false;
245
246		// If the database variable is already set, no need to run autodetection
247		$geodir_use_php_sessions = (bool)get_option( 'geodir_use_php_sessions' );
248
249		if (!$geodir_use_php_sessions ) {
250		// Attempt to detect if the server supports PHP sessions
251		if ( function_exists( 'session_start' ) && ! ini_get( 'safe_mode' ) ) {
252		$this->set( 'geodir_use_php_sessions', 1 );
253
254		if ( $this->get( 'geodir_use_php_sessions' ) ) {
255		$ret = true;
256
257		// Set the database option
258		update_option( 'geodir_use_php_sessions', true );
259		}
260		}
261		} else {
262		$ret = $geodir_use_php_sessions;
263		}
264
265		// Enable or disable PHP Sessions based on the GEODIR_USE_PHP_SESSIONS constant
266		if ( defined( 'GEODIR_USE_PHP_SESSIONS' ) && GEODIR_USE_PHP_SESSIONS ) {
267		$ret = true;
268		} else if ( defined( 'GEODIR_USE_PHP_SESSIONS' ) && ! GEODIR_USE_PHP_SESSIONS ) {
269		$ret = false;
270		}
271
272		return (bool) apply_filters( 'geodir_use_php_sessions', $ret );
273		}
274
275		/**
276		* Starts a new session if one hasn't started yet.
277		*/
278		public function maybe_start_session() {
279		if ( !session_id() && !headers_sent() ) {
280		session_start();
281		}
282		}
283
284		/**
285		* Determines if a user has set the GEODIR_USE_CART_COOKIE
286		*
287		* @since 1.5.7
288		* @return bool If the store should use the geodir_items_in_cart cookie to help avoid caching
289		*/
290		public function use_cart_cookie() {
291		$ret = true;
292
293		if ( defined( 'GEODIR_USE_CART_COOKIE' ) && ! GEODIR_USE_CART_COOKIE ) {
294		$ret = false;
295		}
296
297		return (bool) apply_filters( 'geodir_use_cart_cookie', $ret );
298		}
299		}
300
301		global $gd_session;
302		$gd_session = new Geodir_Session();
303

GeoDirectory / geodirectory

Pull Request — master (#235)

Geodir_Session::__construct() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like