Give_DB_Sessions::delete_session() - Code Metrics - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Give_DB_Sessions::delete_session() A
last analyzed 2019-03-08 02:52 UTC

↳ Parent: Give_DB_Sessions

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0

<?php
/**
 * Session Database Handler
 *
 * @package     Give
 * @subpackage  Classes/Give_Session
 * @copyright   Copyright (c) 2018, GiveWP
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       2.2.0
 */

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

/**
 * Class Give_DB_Sessions
 */
class Give_DB_Sessions extends Give_DB {
	/**
	 * Cache group name
	 *
	 * @since  2.2.0
	 * @access private
	 *
	 * @var string
	 */
	private $cache_group = 'give_sessions';

	/**
	 * Cache incrementer name
	 *
	 * @since  2.2.0
	 * @access private
	 *
	 * @var string
	 */
	private $incrementer_name = 'give_sessions';


	/**
	 * Class Constructor
	 *
	 * @since  2.2.0
	 * @access public
	 */
	public function __construct() {
		global $wpdb;
		$this->table_name  = "{$wpdb->prefix}give_sessions";
		$this->primary_key = 'session_key';
		$this->version     = '1.0';

		// Set cache group id.
		$current_blog_id        = get_current_blog_id();
		$this->incrementer_name = "give-cache-incrementer-sessions-{$current_blog_id}";
		$incrementer_value      = wp_cache_get( $this->incrementer_name );
		$incrementer_value      = ! empty( $incrementer_value ) ? $incrementer_value : microtime( true );
		$this->cache_group      = "{$this->cache_group}_{$current_blog_id}_{$incrementer_value}";

		parent::__construct();
	}


	/**
	 * Whitelist of columns
	 *
	 * @since  2.2.0
	 * @access public
	 *
	 * @return array  Columns and formats.
	 */
	public function get_columns() {
		return array(
			'session_id'     => '%d',
			'session_key'    => '%s',
			'session_value'  => '%s',
			'session_expiry' => '%d',
		);
	}

	/**
	 * Create Meta Tables.
	 *
	 * @since  2.2.0
	 * @access public
	 */
	public function create_table() {

		global $wpdb;

		$charset_collate = $wpdb->get_charset_collate();

		$sql = "CREATE TABLE {$this->table_name} (
  				session_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
  				session_key char(32) NOT NULL,
  				session_value longtext NOT NULL,
  				session_expiry BIGINT UNSIGNED NOT NULL,
  				PRIMARY KEY  (session_key),
  				UNIQUE KEY session_id (session_id)
			) {$charset_collate};";

		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
		dbDelta( $sql );

		update_option( $this->table_name . '_db_version', $this->version, false );
	}


	/**
	 * Returns the session.
	 *
	 * @todo: add cache logic
	 *
	 * @param string $donor_id Donor ID.
	 * @param mixed  $default  Default session value.
	 *
	 * @return mixed
	 */
	public function get_session( $donor_id, $default = false ) {
		global $wpdb;

		if ( defined( 'WP_SETUP_CONFIG' ) ) {
			return false;
		}

		if ( ! ( $value = wp_cache_get( $donor_id, $this->cache_group ) ) ) { // @codingStandardsIgnoreLine

			// @codingStandardsIgnoreStart
			$value = $wpdb->get_var(
				$wpdb->prepare(
					"
					SELECT session_value
					FROM $this->table_name
					WHERE session_key = %s
					",
					$donor_id
				)
			);
			// @codingStandardsIgnoreEnd

			if ( is_null( $value ) ) {
				$value = $default;
			}

			wp_cache_add( $donor_id, $value, $this->cache_group );
		}

		return maybe_unserialize( $value );
	}

	/**
	 * Update the session expiry timestamp.
	 *
	 * @param string $donor_id  Donor ID.
	 * @param int    $timestamp Timestamp to expire the cookie.
	 */
	public function update_session_timestamp( $donor_id, $timestamp ) {
		global $wpdb;

		// @codingStandardsIgnoreStart.
		$wpdb->update(
			$this->table_name,
			array(
				'session_expiry' => $timestamp,
			),
			array(
				'session_key' => $donor_id,
			),
			array(
				'%d'
			)
		);
		// @codingStandardsIgnoreEnd.
	}

	/**
	 * Delete the session from the cache and database.
	 *
	 * @since  2.2.0
	 * @access public
	 *
	 * @param int $donor_id Customer ID.
	 */
	public function delete_session( $donor_id ) {
		global $wpdb;

		wp_cache_delete( $donor_id, $this->cache_group );

		// @codingStandardsIgnoreStart
		$wpdb->delete(
			$this->table_name,
			array(
				'session_key' => $donor_id,
			)
		);
		// @codingStandardsIgnoreEnd
	}


	/**
	 * Cleanup session data from the database and clear caches.
	 * Note: for internal logic only.
	 *
	 * @since  2.2.0
	 * @access public
	 */
	public function delete_expired_sessions() {
		global $wpdb;

		wp_cache_set( $this->incrementer_name, microtime( true ) );

		// @codingStandardsIgnoreStart
		$wpdb->query(
			$wpdb->prepare(
				"DELETE FROM $this->table_name WHERE session_expiry < %d",
				time()
			)
		);
		// @codingStandardsIgnoreEnd
	}

	/**
	 * Replace table data
	 * Note: only for internal use
	 *
	 * @since  2.2.0
	 * @access public
	 *
	 * @param string $table_name Table name.
	 * @param array  $data       Data.
	 * @param array  $format     Array for data format of each key:value in data.
	 */
	public function __replace( $table_name, $data, $format = null ) {

		global $wpdb;

		wp_cache_set( $data['session_key'], $data['session_value'], $this->cache_group, $data['session_expiry'] - time() );



		// @codingStandardsIgnoreStart
		$wpdb->replace(
			$table_name,
			$data,
			$format
		);
		// @codingStandardsIgnoreEnd
	}
}


1		<?php
2		/**
3		* Session Database Handler
4		*
5		* @package Give
6		* @subpackage Classes/Give_Session
7		* @copyright Copyright (c) 2018, GiveWP
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 2.2.0
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		/**
18		* Class Give_DB_Sessions
19		*/
20		class Give_DB_Sessions extends Give_DB {
21		/**
22		* Cache group name
23		*
24		* @since 2.2.0
25		* @access private
26		*
27		* @var string
28		*/
29		private $cache_group = 'give_sessions';
30
31		/**
32		* Cache incrementer name
33		*
34		* @since 2.2.0
35		* @access private
36		*
37		* @var string
38		*/
39		private $incrementer_name = 'give_sessions';
40
41
42		/**
43		* Class Constructor
44		*
45		* @since 2.2.0
46		* @access public
47		*/
48		public function __construct() {
49		global $wpdb;
50		$this->table_name = "{$wpdb->prefix}give_sessions";
51		$this->primary_key = 'session_key';
52		$this->version = '1.0';
53
54		// Set cache group id.
55		$current_blog_id = get_current_blog_id();
56		$this->incrementer_name = "give-cache-incrementer-sessions-{$current_blog_id}";
57		$incrementer_value = wp_cache_get( $this->incrementer_name );
58		$incrementer_value = ! empty( $incrementer_value ) ? $incrementer_value : microtime( true );
59		$this->cache_group = "{$this->cache_group}_{$current_blog_id}_{$incrementer_value}";
60
61		parent::__construct();
62		}
63
64
65		/**
66		* Whitelist of columns
67		*
68		* @since 2.2.0
69		* @access public
70		*
71		* @return array Columns and formats.
72		*/
73		public function get_columns() {
74		return array(
75		'session_id' => '%d',
76		'session_key' => '%s',
77		'session_value' => '%s',
78		'session_expiry' => '%d',
79		);
80		}
81
82		/**
83		* Create Meta Tables.
84		*
85		* @since 2.2.0
86		* @access public
87		*/
88	View Code Duplication	public function create_table() {
		0 ignored issues – show Duplication introduced 2018-03-20 13:05 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...
89		global $wpdb;
90
91		$charset_collate = $wpdb->get_charset_collate();
92
93		$sql = "CREATE TABLE {$this->table_name} (
94		session_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
95		session_key char(32) NOT NULL,
96		session_value longtext NOT NULL,
97		session_expiry BIGINT UNSIGNED NOT NULL,
98		PRIMARY KEY (session_key),
99		UNIQUE KEY session_id (session_id)
100		) {$charset_collate};";
101
102		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
103		dbDelta( $sql );
104
105		update_option( $this->table_name . '_db_version', $this->version, false );
106		}
107
108
109		/**
110		* Returns the session.
111		*
112		* @todo: add cache logic
113		*
114		* @param string $donor_id Donor ID.
115		* @param mixed $default Default session value.
116		*
117		* @return mixed
118		*/
119		public function get_session( $donor_id, $default = false ) {
120		global $wpdb;
121
122		if ( defined( 'WP_SETUP_CONFIG' ) ) {
123		return false;
124		}
125
126		if ( ! ( $value = wp_cache_get( $donor_id, $this->cache_group ) ) ) { // @codingStandardsIgnoreLine
127
128		// @codingStandardsIgnoreStart
129		$value = $wpdb->get_var(
130		$wpdb->prepare(
131		"
132		SELECT session_value
133		FROM $this->table_name
134		WHERE session_key = %s
135		",
136		$donor_id
137		)
138		);
139		// @codingStandardsIgnoreEnd
140
141		if ( is_null( $value ) ) {
142		$value = $default;
143		}
144
145		wp_cache_add( $donor_id, $value, $this->cache_group );
146		}
147
148		return maybe_unserialize( $value );
149		}
150
151		/**
152		* Update the session expiry timestamp.
153		*
154		* @param string $donor_id Donor ID.
155		* @param int $timestamp Timestamp to expire the cookie.
156		*/
157		public function update_session_timestamp( $donor_id, $timestamp ) {
158		global $wpdb;
159
160		// @codingStandardsIgnoreStart.
161		$wpdb->update(
162		$this->table_name,
163		array(
164		'session_expiry' => $timestamp,
165		),
166		array(
167		'session_key' => $donor_id,
168		),
169		array(
170		'%d'
171		)
172		);
173		// @codingStandardsIgnoreEnd.
174		}
175
176		/**
177		* Delete the session from the cache and database.
178		*
179		* @since 2.2.0
180		* @access public
181		*
182		* @param int $donor_id Customer ID.
183		*/
184		public function delete_session( $donor_id ) {
185		global $wpdb;
186
187		wp_cache_delete( $donor_id, $this->cache_group );
188
189		// @codingStandardsIgnoreStart
190		$wpdb->delete(
191		$this->table_name,
192		array(
193		'session_key' => $donor_id,
194		)
195		);
196		// @codingStandardsIgnoreEnd
197		}
198
199
200		/**
201		* Cleanup session data from the database and clear caches.
202		* Note: for internal logic only.
203		*
204		* @since 2.2.0
205		* @access public
206		*/
207		public function delete_expired_sessions() {
208		global $wpdb;
209
210		wp_cache_set( $this->incrementer_name, microtime( true ) );
211
212		// @codingStandardsIgnoreStart
213		$wpdb->query(
214		$wpdb->prepare(
215		"DELETE FROM $this->table_name WHERE session_expiry < %d",
216		time()
217		)
218		);
219		// @codingStandardsIgnoreEnd
220		}
221
222		/**
223		* Replace table data
224		* Note: only for internal use
225		*
226		* @since 2.2.0
227		* @access public
228		*
229		* @param string $table_name Table name.
230		* @param array $data Data.
231		* @param array $format Array for data format of each key:value in data.
232		*/
233		public function __replace( $table_name, $data, $format = null ) {
		0 ignored issues – show Coding Style introduced 2018-07-09 06:21 UTC by Report Bug Copy Issue Report Method name "Give_DB_Sessions::__replace" is invalid; only PHP magic methods should be prefixed with a double underscore Loading history...
234		global $wpdb;
235
236		wp_cache_set( $data['session_key'], $data['session_value'], $this->cache_group, $data['session_expiry'] - time() );
237
		0 ignored issues – show Coding Style introduced 2018-07-09 06:21 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
238
239		// @codingStandardsIgnoreStart
240		$wpdb->replace(
241		$table_name,
242		$data,
243		$format
244		);
245		// @codingStandardsIgnoreEnd
246		}
247		}
248

ravinderk / Give

Give_DB_Sessions::delete_session() A last analyzed 2019-03-08 02:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Give_DB_Sessions::delete_session() A
last analyzed 2019-03-08 02:52 UTC