Give_DB_Donor_Meta::delete_all_meta() - Code Metrics - Inspection of "Update documentation #2036" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issues-2036 ( 6dd3d7 )

by Ravinder

created 2018-08-27 05:30 UTC

Give_DB_Donor_Meta::delete_all_meta() A

↳ Parent: Give_DB_Donor_Meta

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	4
rs	10
c	0
b	0
f	0

<?php
/**
 * Donor Meta DB class
 *
 * @package     Give
 * @subpackage  Classes/DB Donor Meta
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.6
 */

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

/**
 * Class Give_DB_Donor_Meta
 *
 * This class is for interacting with the donor meta database table.
 *
 * @since 1.6
 */
class Give_DB_Donor_Meta extends Give_DB {

	/**
	 * Give_DB_Donor_Meta constructor.
	 *
	 * @access  public
	 * @since   1.6
	 */
	public function __construct() {
		/* @var WPDB $wpdb */
		global $wpdb;

		$wpdb->customermeta = $this->table_name  = $wpdb->prefix . 'give_customermeta';
		$this->primary_key = 'meta_id';
		$this->version     = '1.0';

		$this->register_table();
	}

	/**
	 * Get table columns and data types.
	 *
	 * @access  public
	 * @since   1.6
	 *
	 * @return  array  Columns and formats.
	 */
	public function get_columns() {
		return array(
			'meta_id'     => '%d',
			'customer_id' => '%d',
			'meta_key'    => '%s',

			'meta_value'  => '%s',

		);
	}

	/**
	 * Retrieve donor meta field for a donor.
	 *
	 * For internal use only. Use Give_Donor->get_meta() for public usage.
	 *
	 * @access  private
	 * @since   1.6
	 *
	 * @param   int    $donor_id Donor ID.
	 * @param   string $meta_key The meta key to retrieve.
	 * @param   bool   $single Whether to return a single value.
	 *
	 * @return  mixed                 Will be an array if $single is false. Will be value of meta data field if $single is true.
	 */
	public function get_meta( $donor_id = 0, $meta_key = '', $single = false ) {

		$donor_id = $this->sanitize_donor_id( $donor_id );
		if ( false === $donor_id ) {
			return false;
		}

		return get_metadata( 'customer', $donor_id, $meta_key, $single );
	}

	/**
	 * Add meta data field to a donor.
	 *
	 * For internal use only. Use Give_Donor->add_meta() for public usage.
	 *
	 * @access  private
	 * @since   1.6
	 *
	 * @param   int    $donor_id Donor ID.
	 * @param   string $meta_key Metadata name.
	 * @param   mixed  $meta_value Metadata value.
	 * @param   bool   $unique Optional, default is false. Whether the same key should not be added.
	 *
	 * @return  bool                  False for failure. True for success.
	 */
	public function add_meta( $donor_id = 0, $meta_key = '', $meta_value, $unique = false ) {

		$donor_id = $this->sanitize_donor_id( $donor_id );
		if ( false === $donor_id ) {
			return false;
		}

		return add_metadata( 'customer', $donor_id, $meta_key, $meta_value, $unique );
	}

	/**
	 * Update donor meta field based on Donor ID.
	 *
	 * For internal use only. Use Give_Donor->update_meta() for public usage.
	 *
	 * Use the $prev_value parameter to differentiate between meta fields with the
	 * same key and Donor ID.
	 *
	 * If the meta field for the donor does not exist, it will be added.
	 *
	 * @access  private
	 * @since   1.6
	 *
	 * @param   int    $donor_id Donor ID.
	 * @param   string $meta_key Metadata key.
	 * @param   mixed  $meta_value Metadata value.
	 * @param   mixed  $prev_value Optional. Previous value to check before removing.
	 *
	 * @return  bool                  False on failure, true if success.
	 */
	public function update_meta( $donor_id = 0, $meta_key = '', $meta_value, $prev_value = '' ) {

		$donor_id = $this->sanitize_donor_id( $donor_id );
		if ( false === $donor_id ) {
			return false;
		}

		return update_metadata( 'customer', $donor_id, $meta_key, $meta_value, $prev_value );
	}

	/**
	 * Remove metadata matching criteria from a donor.
	 *
	 * For internal use only. Use Give_Donor->delete_meta() for public usage.
	 *
	 * You can match based on the key, or key and value. Removing based on key and
	 * value, will keep from removing duplicate metadata with the same key. It also
	 * allows removing all metadata matching key, if needed.
	 *
	 * @access  private
	 * @since   1.6
	 *
	 * @param   int    $donor_id Donor ID.
	 * @param   string $meta_key Metadata name.
	 * @param   mixed  $meta_value Optional. Metadata value.
	 *
	 * @return  bool                  False for failure. True for success.
	 */
	public function delete_meta( $donor_id = 0, $meta_key = '', $meta_value = '' ) {
		return delete_metadata( 'customer', $donor_id, $meta_key, $meta_value );
	}

	/**
	 * Remove all meta data matching criteria from a donor id.
	 *
	 * @access  private
	 * @since   1.8.14
	 *
	 * @param   int    $donor_id Donor ID.
	 *
	 * @return  bool  False for failure. True for success.
	 */
	public function delete_all_meta( $donor_id = 0 ) {
		global $wpdb;
		$wpdb->delete( $this->table_name, array( 'customer_id' => $donor_id ), array( '%d' ) );
	}

	/**
	 * Create the table
	 *
	 * @access public
	 * @since  1.6
	 *
	 * @return void
	 */
	public function create_table() {


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

		$sql = "CREATE TABLE {$this->table_name} (
			meta_id bigint(20) NOT NULL AUTO_INCREMENT,
			customer_id bigint(20) NOT NULL,
			meta_key varchar(255) DEFAULT NULL,
			meta_value longtext,
			PRIMARY KEY  (meta_id),
			KEY customer_id (customer_id),
			KEY meta_key (meta_key)
			) CHARACTER SET utf8 COLLATE utf8_general_ci;";

		dbDelta( $sql );

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

	/**
	 * Given a donor ID, make sure it's a positive number, greater than zero before inserting or adding.
	 *
	 * @access private
	 * @since  1.6
	 *
	 * @param  int|stripe $donor_id A passed donor ID.
	 *
	 * @return int|bool                The normalized donor ID or false if it's found to not be valid.
	 */
	private function sanitize_donor_id( $donor_id ) {
		if ( ! is_numeric( $donor_id ) ) {
			return false;
		}

		$donor_id = (int) $donor_id;

		// We were given a non positive number.
		if ( absint( $donor_id ) !== $donor_id ) {
			return false;
		}

		if ( empty( $donor_id ) ) {
			return false;
		}

		return absint( $donor_id );

	}

}


1		<?php
2		/**
3		* Donor Meta DB class
4		*
5		* @package Give
6		* @subpackage Classes/DB Donor Meta
7		* @copyright Copyright (c) 2016, WordImpress
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 1.6
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		/**
18		* Class Give_DB_Donor_Meta
19		*
20		* This class is for interacting with the donor meta database table.
21		*
22		* @since 1.6
23		*/
24		class Give_DB_Donor_Meta extends Give_DB {
25
26		/**
27		* Give_DB_Donor_Meta constructor.
28		*
29		* @access public
30		* @since 1.6
31		*/
32		public function __construct() {
33		/* @var WPDB $wpdb */
34		global $wpdb;
35
36		$wpdb->customermeta = $this->table_name = $wpdb->prefix . 'give_customermeta';
37		$this->primary_key = 'meta_id';
38		$this->version = '1.0';
39
40		$this->register_table();
41		}
42
43		/**
44		* Get table columns and data types.
45		*
46		* @access public
47		* @since 1.6
48		*
49		* @return array Columns and formats.
50		*/
51		public function get_columns() {
52		return array(
53		'meta_id' => '%d',
54		'customer_id' => '%d',
55		'meta_key' => '%s',
		0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected usage of meta_key, possible slow query. Loading history...
56		'meta_value' => '%s',
		0 ignored issues – show introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report Detected usage of meta_value, possible slow query. Loading history...
57		);
58		}
59
60		/**
61		* Retrieve donor meta field for a donor.
62		*
63		* For internal use only. Use Give_Donor->get_meta() for public usage.
64		*
65		* @access private
66		* @since 1.6
67		*
68		* @param int $donor_id Donor ID.
69		* @param string $meta_key The meta key to retrieve.
70		* @param bool $single Whether to return a single value.
71		*
72		* @return mixed Will be an array if $single is false. Will be value of meta data field if $single is true.
73		*/
74	View Code Duplication	public function get_meta( $donor_id = 0, $meta_key = '', $single = false ) {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 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...
75		$donor_id = $this->sanitize_donor_id( $donor_id );
76		if ( false === $donor_id ) {
77		return false;
78		}
79
80		return get_metadata( 'customer', $donor_id, $meta_key, $single );
81		}
82
83		/**
84		* Add meta data field to a donor.
85		*
86		* For internal use only. Use Give_Donor->add_meta() for public usage.
87		*
88		* @access private
89		* @since 1.6
90		*
91		* @param int $donor_id Donor ID.
92		* @param string $meta_key Metadata name.
93		* @param mixed $meta_value Metadata value.
94		* @param bool $unique Optional, default is false. Whether the same key should not be added.
95		*
96		* @return bool False for failure. True for success.
97		*/
98	View Code Duplication	public function add_meta( $donor_id = 0, $meta_key = '', $meta_value, $unique = false ) {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 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...
99		$donor_id = $this->sanitize_donor_id( $donor_id );
100		if ( false === $donor_id ) {
101		return false;
102		}
103
104		return add_metadata( 'customer', $donor_id, $meta_key, $meta_value, $unique );
105		}
106
107		/**
108		* Update donor meta field based on Donor ID.
109		*
110		* For internal use only. Use Give_Donor->update_meta() for public usage.
111		*
112		* Use the $prev_value parameter to differentiate between meta fields with the
113		* same key and Donor ID.
114		*
115		* If the meta field for the donor does not exist, it will be added.
116		*
117		* @access private
118		* @since 1.6
119		*
120		* @param int $donor_id Donor ID.
121		* @param string $meta_key Metadata key.
122		* @param mixed $meta_value Metadata value.
123		* @param mixed $prev_value Optional. Previous value to check before removing.
124		*
125		* @return bool False on failure, true if success.
126		*/
127	View Code Duplication	public function update_meta( $donor_id = 0, $meta_key = '', $meta_value, $prev_value = '' ) {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 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...
128		$donor_id = $this->sanitize_donor_id( $donor_id );
129		if ( false === $donor_id ) {
130		return false;
131		}
132
133		return update_metadata( 'customer', $donor_id, $meta_key, $meta_value, $prev_value );
134		}
135
136		/**
137		* Remove metadata matching criteria from a donor.
138		*
139		* For internal use only. Use Give_Donor->delete_meta() for public usage.
140		*
141		* You can match based on the key, or key and value. Removing based on key and
142		* value, will keep from removing duplicate metadata with the same key. It also
143		* allows removing all metadata matching key, if needed.
144		*
145		* @access private
146		* @since 1.6
147		*
148		* @param int $donor_id Donor ID.
149		* @param string $meta_key Metadata name.
150		* @param mixed $meta_value Optional. Metadata value.
151		*
152		* @return bool False for failure. True for success.
153		*/
154		public function delete_meta( $donor_id = 0, $meta_key = '', $meta_value = '' ) {
155		return delete_metadata( 'customer', $donor_id, $meta_key, $meta_value );
156		}
157
158		/**
159		* Remove all meta data matching criteria from a donor id.
160		*
161		* @access private
162		* @since 1.8.14
163		*
164		* @param int $donor_id Donor ID.
165		*
166		* @return bool False for failure. True for success.
167		*/
168		public function delete_all_meta( $donor_id = 0 ) {
169		global $wpdb;
170		$wpdb->delete( $this->table_name, array( 'customer_id' => $donor_id ), array( '%d' ) );
171		}
172
173		/**
174		* Create the table
175		*
176		* @access public
177		* @since 1.6
178		*
179		* @return void
180		*/
181	View Code Duplication	public function create_table() {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 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...
182
183		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
184
185		$sql = "CREATE TABLE {$this->table_name} (
186		meta_id bigint(20) NOT NULL AUTO_INCREMENT,
187		customer_id bigint(20) NOT NULL,
188		meta_key varchar(255) DEFAULT NULL,
189		meta_value longtext,
190		PRIMARY KEY (meta_id),
191		KEY customer_id (customer_id),
192		KEY meta_key (meta_key)
193		) CHARACTER SET utf8 COLLATE utf8_general_ci;";
194
195		dbDelta( $sql );
196
197		update_option( $this->table_name . '_db_version', $this->version );
198		}
199
200		/**
201		* Given a donor ID, make sure it's a positive number, greater than zero before inserting or adding.
202		*
203		* @access private
204		* @since 1.6
205		*
206		* @param int\|stripe $donor_id A passed donor ID.
207		*
208		* @return int\|bool The normalized donor ID or false if it's found to not be valid.
209		*/
210		private function sanitize_donor_id( $donor_id ) {
211		if ( ! is_numeric( $donor_id ) ) {
212		return false;
213		}
214
215		$donor_id = (int) $donor_id;
216
217		// We were given a non positive number.
218		if ( absint( $donor_id ) !== $donor_id ) {
219		return false;
220		}
221
222		if ( empty( $donor_id ) ) {
223		return false;
224		}
225
226		return absint( $donor_id );
227
228		}
229
230		}
231

ravinderk / Give

Push — issues-2036 ( 6dd3d7 )

Give_DB_Donor_Meta::delete_all_meta() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like