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

Give_DB_Sessions::__construct() A
last analyzed 2018-09-17 22:00 UTC

↳ Parent: Give_DB_Sessions

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	17
rs	9.7
c	0
b	0
f	0

<?php
/**
 * Session Database Handler
 *
 * @package     Give
 * @subpackage  Classes/Give_Session
 * @copyright   Copyright (c) 2018, WordImpress
 * @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}";

		$this->register_table();

		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, WordImpress
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		$this->register_table();
62
63		parent::__construct();
64		}
65
66
67		/**
68		* Whitelist of columns
69		*
70		* @since 2.2.0
71		* @access public
72		*
73		* @return array Columns and formats.
74		*/
75		public function get_columns() {
76		return array(
77		'session_id' => '%d',
78		'session_key' => '%s',
79		'session_value' => '%s',
80		'session_expiry' => '%d',
81		);
82		}
83
84		/**
85		* Create Meta Tables.
86		*
87		* @since 2.2.0
88		* @access public
89		*/
90	View Code Duplication	public function create_table() {
		0 ignored issues – show Duplication introduced 2018-07-24 22:16 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...
91		global $wpdb;
92
93		$charset_collate = $wpdb->get_charset_collate();
94
95		$sql = "CREATE TABLE {$this->table_name} (
96		session_id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
97		session_key char(32) NOT NULL,
98		session_value longtext NOT NULL,
99		session_expiry BIGINT UNSIGNED NOT NULL,
100		PRIMARY KEY (session_key),
101		UNIQUE KEY session_id (session_id)
102		) {$charset_collate};";
103
104		require_once ABSPATH . 'wp-admin/includes/upgrade.php';
105		dbDelta( $sql );
106
107		update_option( $this->table_name . '_db_version', $this->version, false );
108		}
109
110
111		/**
112		* Returns the session.
113		*
114		* @todo: add cache logic
115		*
116		* @param string $donor_id Donor ID.
117		* @param mixed $default Default session value.
118		*
119		* @return mixed
120		*/
121		public function get_session( $donor_id, $default = false ) {
122		global $wpdb;
123
124		if ( defined( 'WP_SETUP_CONFIG' ) ) {
125		return false;
126		}
127
128		if ( ! ( $value = wp_cache_get( $donor_id, $this->cache_group ) ) ) { // @codingStandardsIgnoreLine
129
130		// @codingStandardsIgnoreStart
131		$value = $wpdb->get_var(
132		$wpdb->prepare(
133		"
134		SELECT session_value
135		FROM $this->table_name
136		WHERE session_key = %s
137		",
138		$donor_id
139		)
140		);
141		// @codingStandardsIgnoreEnd
142
143		if ( is_null( $value ) ) {
144		$value = $default;
145		}
146
147		wp_cache_add( $donor_id, $value, $this->cache_group );
148		}
149
150		return maybe_unserialize( $value );
151		}
152
153		/**
154		* Update the session expiry timestamp.
155		*
156		* @param string $donor_id Donor ID.
157		* @param int $timestamp Timestamp to expire the cookie.
158		*/
159		public function update_session_timestamp( $donor_id, $timestamp ) {
160		global $wpdb;
161
162		// @codingStandardsIgnoreStart.
163		$wpdb->update(
164		$this->table_name,
165		array(
166		'session_expiry' => $timestamp,
167		),
168		array(
169		'session_key' => $donor_id,
170		),
171		array(
172		'%d'
173		)
174		);
175		// @codingStandardsIgnoreEnd.
176		}
177
178		/**
179		* Delete the session from the cache and database.
180		*
181		* @since 2.2.0
182		* @access public
183		*
184		* @param int $donor_id Customer ID.
185		*/
186		public function delete_session( $donor_id ) {
187		global $wpdb;
188
189		wp_cache_delete( $donor_id, $this->cache_group );
190
191		// @codingStandardsIgnoreStart
192		$wpdb->delete(
193		$this->table_name,
194		array(
195		'session_key' => $donor_id,
196		)
197		);
198		// @codingStandardsIgnoreEnd
199		}
200
201
202		/**
203		* Cleanup session data from the database and clear caches.
204		* Note: for internal logic only.
205		*
206		* @since 2.2.0
207		* @access public
208		*/
209		public function delete_expired_sessions() {
210		global $wpdb;
211
212		wp_cache_set( $this->incrementer_name, microtime( true ) );
213
214		// @codingStandardsIgnoreStart
215		$wpdb->query(
216		$wpdb->prepare(
217		"DELETE FROM $this->table_name WHERE session_expiry < %d",
218		time()
219		)
220		);
221		// @codingStandardsIgnoreEnd
222		}
223
224		/**
225		* Replace table data
226		* Note: only for internal use
227		*
228		* @since 2.2.0
229		* @access public
230		*
231		* @param string $table_name Table name.
232		* @param array $data Data.
233		* @param array $format Array for data format of each key:value in data.
234		*/
235		public function __replace( $table_name, $data, $format = null ) {
		0 ignored issues – show Coding Style introduced 2018-07-24 22:16 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...
236		global $wpdb;
237
238		wp_cache_set( $data['session_key'], $data['session_value'], $this->cache_group, $data['session_expiry'] - time() );
239
		0 ignored issues – show Coding Style introduced 2018-07-24 22:16 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
240
241		// @codingStandardsIgnoreStart
242		$wpdb->replace(
243		$table_name,
244		$data,
245		$format
246		);
247		// @codingStandardsIgnoreEnd
248		}
249		}
250

WordImpress / Give

Give_DB_Sessions::__construct() A last analyzed 2018-09-17 22:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Give_DB_Sessions::__construct() A
last analyzed 2018-09-17 22:00 UTC