Give_Donors_Query - Code Metrics - Inspection of "style(code): improve code formatting" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — issue/2900 ( f2122b )

by Ravinder

created 2018-04-11 10:28 UTC

Give_Donors_Query B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	499
Duplicated Lines	6.61 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	33
loc	499
rs	8.3673
c	0
b	0
f	0
wmc	45
lcom	1
cbo	4

13 Methods

Rating	Name	Duplication	Size	Complexity
B	get_where_search()	0	22	6
A	get_where_user()	15	15	3
B	__construct()	0	35	1
A	init()	0	2	1
B	get_donors()	0	39	3
D	get_sql()	3	40	9
B	get_where_query()	0	24	2
A	get_where_email()	0	21	3
A	get_where_donor()	15	15	3
A	get_where_date()	0	20	3
A	get_order_query()	0	20	4
A	get_where_purchase_count()	0	16	3
B	get_where_give_forms()	0	39	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Give_Donors_Query often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Give_Donors_Query, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Donors Query
 *
 * @package     Give
 * @subpackage  Classes/Stats
 * @copyright   Copyright (c) 2017, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.8.14
 */

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

/**
 * Give_Donors_Query Class
 *
 * This class is for retrieving donors data.
 *
 * Donors can be retrieved for date ranges and pre-defined periods.
 *
 * @since 1.8.14
 */
class Give_Donors_Query {

	/**
	 * The args to pass to the give_get_donors() query
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @var    array
	 */
	public $args = array();

	/**
	 * The donors found based on the criteria set
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @var    array
	 */
	public $donors = array();

	/**
	 * The donors found based on the criteria set
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @var    string
	 */
	public $table_name = '';

	/**
	 * The donors found based on the criteria set
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @var    string
	 */
	public $meta_table_name = '';

	/**
	 * The donors found based on the criteria set
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @var    string
	 */
	public $meta_type = '';

	/**
	 * Default query arguments.
	 *
	 * Not all of these are valid arguments that can be passed to WP_Query. The ones that are not, are modified before
	 * the query is run to convert them to the proper syntax.
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @param  $args array The array of arguments that can be passed in and used for setting up this payment query.
	 */
	public function __construct( $args = array() ) {
		$defaults = array(
			'number'          => 20,
			'offset'          => 0,
			'paged'           => 1,
			'orderby'         => 'id',
			'order'           => 'DESC',
			'user'            => null,
			'email'           => null,
			'donor'           => null,
			'meta_query'      => array(),

			'date_query'      => array(),
			's'               => null,
			'fields'          => 'all', // Supports donors (all fields) or valid column as string or array list.
			'count'           => false,
			'give_forms'      => array(),

			/*
			 * donation_amount will contain value like:
			 * array(
			 *     'compare' => *compare symbol* (by default set to > )
			 *     'amount'  => *numeric_value*
			 * )
			 *
			 * You can also pass number value to this param then compare symbol will auto set to >
			 */
			'donation_amount' => array()
			// 'form'       => array(),
		);

		$this->args            = wp_parse_args( $args, $defaults );
		$this->table_name      = Give()->donors->table_name;
		$this->meta_table_name = Give()->donor_meta->table_name;
		$this->meta_type       = Give()->donor_meta->meta_type;
	}

	/**
	 * Modify the query/query arguments before we retrieve donors.
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @return void
	 */
	public function init() {
	}


	/**
	 * Retrieve donors.
	 *
	 * The query can be modified in two ways; either the action before the
	 * query is run, or the filter on the arguments (existing mainly for backwards
	 * compatibility).
	 *
	 * @since  1.8.14
	 * @access public
	 *
	 * @global wpdb $wpdb
	 *
	 * @return array
	 */
	public function get_donors() {
		global $wpdb;

		/**
		 * Fires before retrieving donors.
		 *
		 * @since 1.8.14
		 *
		 * @param Give_Donors_Query $this Donors query object.
		 */
		do_action( 'give_pre_get_donors', $this );

		$cache_key = Give_Cache::get_key( 'give_donor', $this->get_sql(), false );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		// Get donors from cache.
		$this->donors = Give_Cache::get_db_query( $cache_key );


		if ( is_null( $this->donors ) ) {
			if ( empty( $this->args['count'] ) ) {
				$this->donors = $wpdb->get_results( $this->get_sql() );

			} else {
				$this->donors = $wpdb->get_var( $this->get_sql() );

			}

			Give_Cache::set_db_query( $cache_key, $this->donors );
		}



		/**
		 * Fires after retrieving donors.
		 *
		 * @since 1.8.14
		 *
		 * @param Give_Donors_Query $this Donors query object.
		 */
		do_action( 'give_post_get_donors', $this );

		return $this->donors;
	}

	/**
	 * Get sql query from queried array.
	 *
	 * @since  2.0
	 * @access public
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	public function get_sql() {
		global $wpdb;

		if ( $this->args['number'] < 1 ) {
			$this->args['number'] = 99999999999;
		}

		$where = $this->get_where_query();



		// Set offset.
		if ( empty( $this->args['offset'] ) && ( 0 < $this->args['paged'] ) ) {
			$this->args['offset'] = $this->args['number'] * ( $this->args['paged'] - 1 );
		}

		// Set fields.
		$fields = "{$this->table_name}.*";
		if ( ! empty( $this->args['fields'] ) && 'all' !== $this->args['fields'] ) {
			if ( is_string( $this->args['fields'] ) ) {
				$fields = "{$this->table_name}.{$this->args['fields']}";
			} elseif ( is_array( $this->args['fields'] ) ) {

				$fields = "{$this->table_name}." . implode( " , {$this->table_name}.", $this->args['fields'] );
			}
		}

		// Set count.
		if ( ! empty( $this->args['count'] ) ) {
			$fields = "COUNT({$this->table_name}.id)";
		}

		$orderby = $this->get_order_query();

		$sql = $wpdb->prepare( "SELECT {$fields} FROM {$this->table_name} LIMIT %d,%d;", absint( $this->args['offset'] ), absint( $this->args['number'] ) );

		// $where, $orderby and order already prepared query they can generate notice if you re prepare them in above.
		// WordPress consider LIKE condition as placeholder if start with s,f, or d.
		$sql = str_replace( 'LIMIT', "{$where} {$orderby} {$this->args['order']} LIMIT", $sql );

		return $sql;
	}

	/**
	 * Set query where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_query() {

		// Get sql query for meta.
		if ( ! empty( $this->args['meta_query'] ) ) {
			$meta_query_object = new WP_Meta_Query( $this->args['meta_query'] );
			$meta_query        = $meta_query_object->get_sql( $this->meta_type, $this->table_name, 'id' );

			$where[] = implode( '', $meta_query );
		}

		$where[] = 'WHERE 1=1';
		$where[] = $this->get_where_search();
		$where[] = $this->get_where_email();
		$where[] = $this->get_where_donor();
		$where[] = $this->get_where_user();
		$where[] = $this->get_where_date();
		$where[] = $this->get_where_purchase_count();
		$where[] = $this->get_where_give_forms();

		$where = array_filter( $where );

		return trim( implode( ' ', array_map( 'trim', $where ) ) );

	}

	/**
	 * Set email where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_email() {
		global $wpdb;

		$where = '';

		if ( ! empty( $this->args['email'] ) ) {

			if ( is_array( $this->args['email'] ) ) {

				$emails_count       = count( $this->args['email'] );
				$emails_placeholder = array_fill( 0, $emails_count, '%s' );
				$emails             = implode( ', ', $emails_placeholder );

				$where .= $wpdb->prepare( "AND {$this->table_name}.email IN( $emails )", $this->args['email'] );
			} else {
				$where .= $wpdb->prepare( "AND {$this->table_name}.email = %s", $this->args['email'] );
			}
		}

		return $where;
	}

	/**
	 * Set donor where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_donor() {

		$where = '';

		// Specific donors.
		if ( ! empty( $this->args['donor'] ) ) {
			if ( ! is_array( $this->args['donor'] ) ) {
				$this->args['donor'] = explode( ',', $this->args['donor'] );
			}
			$donor_ids = implode( ',', array_map( 'intval', $this->args['donor'] ) );

			$where .= "AND {$this->table_name}.id IN( {$donor_ids} )";
		}

		return $where;
	}

	/**
	 * Set date where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_date() {
		$where = '';

		// Donors created for a specific date or in a date range
		if ( ! empty( $this->args['date_query'] ) ) {
			$date_query_object = new WP_Date_Query( is_array( $this->args['date_query'] ) ? $this->args['date_query'] : wp_parse_args( $this->args['date_query'] ), "{$this->table_name}.date_created" );

			$where .= str_replace( array(
				"\n",
				'(   (',
				'))',
			), array(

				'',
				'( (',
				') )',
			), $date_query_object->get_sql() );
		}

		return $where;
	}

	/**
	 * Set search where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_search() {
		$where = '';

		// Donors created for a specific date or in a date range
		if ( ! empty( $this->args['s'] ) && false !== strpos( $this->args['s'], ':' ) ) {
			$search_parts = explode( ':', $this->args['s'] );

			if ( ! empty( $search_parts[0] ) ) {
				switch ( $search_parts[0] ) {
					case 'name':
						$where = "AND {$this->table_name}.name LIKE '%{$search_parts[1]}%'";
						break;

					case 'note':
						$where = "AND {$this->table_name}.notes LIKE '%{$search_parts[1]}%'";
						break;
				}
			}
		}

		return $where;
	}

	/**
	 * Set user where clause.
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_user() {

		$where = '';

		// Donors create for specific wp user.
		if ( ! empty( $this->args['user'] ) ) {
			if ( ! is_array( $this->args['user'] ) ) {
				$this->args['user'] = explode( ',', $this->args['user'] );
			}
			$user_ids = implode( ',', array_map( 'intval', $this->args['user'] ) );

			$where .= "AND {$this->table_name}.user_id IN( {$user_ids} )";
		}

		return $where;
	}

	/**
	 * Set orderby query
	 *
	 * @since  1.8.14
	 * @access private
	 *
	 * @return string
	 */
	private function get_order_query() {
		$table_columns = Give()->donors->get_columns();

		$this->args['orderby'] = ! array_key_exists( $this->args['orderby'], $table_columns ) ? 'id' : $this->args['orderby'];

		$this->args['orderby'] = esc_sql( $this->args['orderby'] );
		$this->args['order']   = esc_sql( $this->args['order'] );

		switch ( $table_columns[ $this->args['orderby'] ] ) {
			case '%d':
			case '%f':
				$query = "ORDER BY {$this->table_name}.{$this->args['orderby']}+0";
				break;

			default:
				$query = "ORDER BY {$this->table_name}.{$this->args['orderby']}";
		}

		return $query;
	}

	/**
	 * Set purchase value where clause.
	 * @todo: add phpunit test
	 *
	 * @since  2.1.0
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_purchase_count() {
		$where = '';

		if ( ! empty( $this->args['donation_amount'] ) ) {
			$compare = '>';
			$amount  = $this->args['donation_amount'];
			if ( is_array( $this->args['donation_amount'] ) ) {
				$compare = $this->args['donation_amount'] ['compare'];
				$amount = $this->args['donation_amount']['amount'];
			}

			$where .= "AND {$this->table_name}.purchase_value{$compare}{$amount}";
		}

		return $where;
	}

	/**
	 * Set give_forms where clause.
	 *
	 * @todo   : add phpunit test
	 *
	 * @since  2.1.0
	 * @access private
	 *
	 * @global wpdb $wpdb
	 * @return string
	 */
	private function get_where_give_forms() {
		global $wpdb;
		$where = '';

		if ( ! empty( $this->args['give_forms'] ) ) {
			if ( ! is_array( $this->args['give_forms'] ) ) {
				$this->args['give_forms'] = explode( ',', $this->args['give_forms'] );
			}

			$form_ids = implode( ',', array_map( 'intval', $this->args['give_forms'] ) );

			$query = $wpdb->prepare(
				"
			SELECT DISTINCT meta_value as donor_id
			FROM {$wpdb->paymentmeta}
			WHERE meta_key=%s
			AND payment_id IN(
				SELECT payment_id
				FROM {$wpdb->paymentmeta}
				WHERE meta_key=%s
				AND meta_value IN (%s)
			)
			",
				'_give_payment_donor_id',
				'_give_payment_form_id',
				$form_ids
			);

			$donor_ids = $wpdb->get_results( $query, ARRAY_A );


			if ( ! empty( $donor_ids ) ) {
				$donor_ids = wp_list_pluck( $donor_ids, 'donor_id' );
				$donor_ids = implode( ',', array_map( 'intval', $donor_ids ) );
				$where     .= "AND {$this->table_name}.id IN ({$donor_ids})";
			}
		}

		return $where;
	}
}


1		<?php
2		/**
3		* Donors Query
4		*
5		* @package Give
6		* @subpackage Classes/Stats
7		* @copyright Copyright (c) 2017, WordImpress
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 1.8.14
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		/**
18		* Give_Donors_Query Class
19		*
20		* This class is for retrieving donors data.
21		*
22		* Donors can be retrieved for date ranges and pre-defined periods.
23		*
24		* @since 1.8.14
25		*/
26		class Give_Donors_Query {
27
28		/**
29		* The args to pass to the give_get_donors() query
30		*
31		* @since 1.8.14
32		* @access public
33		*
34		* @var array
35		*/
36		public $args = array();
37
38		/**
39		* The donors found based on the criteria set
40		*
41		* @since 1.8.14
42		* @access public
43		*
44		* @var array
45		*/
46		public $donors = array();
47
48		/**
49		* The donors found based on the criteria set
50		*
51		* @since 1.8.14
52		* @access public
53		*
54		* @var string
55		*/
56		public $table_name = '';
57
58		/**
59		* The donors found based on the criteria set
60		*
61		* @since 1.8.14
62		* @access public
63		*
64		* @var string
65		*/
66		public $meta_table_name = '';
67
68		/**
69		* The donors found based on the criteria set
70		*
71		* @since 1.8.14
72		* @access public
73		*
74		* @var string
75		*/
76		public $meta_type = '';
77
78		/**
79		* Default query arguments.
80		*
81		* Not all of these are valid arguments that can be passed to WP_Query. The ones that are not, are modified before
82		* the query is run to convert them to the proper syntax.
83		*
84		* @since 1.8.14
85		* @access public
86		*
87		* @param $args array The array of arguments that can be passed in and used for setting up this payment query.
88		*/
89		public function __construct( $args = array() ) {
90		$defaults = array(
91		'number' => 20,
92		'offset' => 0,
93		'paged' => 1,
94		'orderby' => 'id',
95		'order' => 'DESC',
96		'user' => null,
97		'email' => null,
98		'donor' => null,
99		'meta_query' => array(),
		0 ignored issues – show introduced 2017-09-21 15:47 UTC by Report Bug Copy Issue Report Detected usage of meta_query, possible slow query. Loading history...
100		'date_query' => array(),
101		's' => null,
102		'fields' => 'all', // Supports donors (all fields) or valid column as string or array list.
103		'count' => false,
104		'give_forms' => array(),
105
106		/*
107		* donation_amount will contain value like:
108		* array(
109		* 'compare' => compare symbol (by default set to > )
110		* 'amount' => numeric_value
111		* )
112		*
113		* You can also pass number value to this param then compare symbol will auto set to >
114		*/
115		'donation_amount' => array()
116		// 'form' => array(),
117		);
118
119		$this->args = wp_parse_args( $args, $defaults );
120		$this->table_name = Give()->donors->table_name;
121		$this->meta_table_name = Give()->donor_meta->table_name;
122		$this->meta_type = Give()->donor_meta->meta_type;
123		}
124
125		/**
126		* Modify the query/query arguments before we retrieve donors.
127		*
128		* @since 1.8.14
129		* @access public
130		*
131		* @return void
132		*/
133		public function init() {
134		}
135
136
137		/**
138		* Retrieve donors.
139		*
140		* The query can be modified in two ways; either the action before the
141		* query is run, or the filter on the arguments (existing mainly for backwards
142		* compatibility).
143		*
144		* @since 1.8.14
145		* @access public
146		*
147		* @global wpdb $wpdb
148		*
149		* @return array
150		*/
151		public function get_donors() {
152		global $wpdb;
153
154		/**
155		* Fires before retrieving donors.
156		*
157		* @since 1.8.14
158		*
159		* @param Give_Donors_Query $this Donors query object.
160		*/
161		do_action( 'give_pre_get_donors', $this );
162
163		$cache_key = Give_Cache::get_key( 'give_donor', $this->get_sql(), false );
		0 ignored issues – show Documentation introduced 2017-11-23 10:59 UTC by Report Bug Copy Issue Report `$this->get_sql()` is of type `string`, but the function expects a `array\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
164
165		// Get donors from cache.
166		$this->donors = Give_Cache::get_db_query( $cache_key );
		0 ignored issues – show Documentation Bug introduced 2017-11-30 05:48 UTC by Report Bug Copy Issue Report It seems like `\Give_Cache::get_db_query($cache_key)` of type `*` is incompatible with the declared type `array` of property `$donors`. 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...
167
168		if ( is_null( $this->donors ) ) {
169		if ( empty( $this->args['count'] ) ) {
170		$this->donors = $wpdb->get_results( $this->get_sql() );
		0 ignored issues – show introduced 2017-09-21 15:47 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-09-21 15:47 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
171		} else {
172		$this->donors = $wpdb->get_var( $this->get_sql() );
		0 ignored issues – show introduced 2017-09-21 15:47 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-09-21 15:47 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
173		}
174
175		Give_Cache::set_db_query( $cache_key, $this->donors );
176		}
177
		0 ignored issues – show Coding Style introduced 2017-11-30 05:48 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
178
179		/**
180		* Fires after retrieving donors.
181		*
182		* @since 1.8.14
183		*
184		* @param Give_Donors_Query $this Donors query object.
185		*/
186		do_action( 'give_post_get_donors', $this );
187
188		return $this->donors;
189		}
190
191		/**
192		* Get sql query from queried array.
193		*
194		* @since 2.0
195		* @access public
196		*
197		* @global wpdb $wpdb
198		* @return string
199		*/
200		public function get_sql() {
201		global $wpdb;
202
203		if ( $this->args['number'] < 1 ) {
204		$this->args['number'] = 99999999999;
205		}
206
207		$where = $this->get_where_query();
208
		0 ignored issues – show Coding Style introduced 2017-09-22 09:31 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
209
210		// Set offset.
211		if ( empty( $this->args['offset'] ) && ( 0 < $this->args['paged'] ) ) {
212		$this->args['offset'] = $this->args['number'] * ( $this->args['paged'] - 1 );
213		}
214
215		// Set fields.
216		$fields = "{$this->table_name}.*";
217		if ( ! empty( $this->args['fields'] ) && 'all' !== $this->args['fields'] ) {
218		if ( is_string( $this->args['fields'] ) ) {
219		$fields = "{$this->table_name}.{$this->args['fields']}";
220	View Code Duplication	} elseif ( is_array( $this->args['fields'] ) ) {
		0 ignored issues – show Duplication introduced 2017-12-11 15:04 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
221		$fields = "{$this->table_name}." . implode( " , {$this->table_name}.", $this->args['fields'] );
222		}
223		}
224
225		// Set count.
226		if ( ! empty( $this->args['count'] ) ) {
227		$fields = "COUNT({$this->table_name}.id)";
228		}
229
230		$orderby = $this->get_order_query();
231
232		$sql = $wpdb->prepare( "SELECT {$fields} FROM {$this->table_name} LIMIT %d,%d;", absint( $this->args['offset'] ), absint( $this->args['number'] ) );
233
234		// $where, $orderby and order already prepared query they can generate notice if you re prepare them in above.
235		// WordPress consider LIKE condition as placeholder if start with s,f, or d.
236		$sql = str_replace( 'LIMIT', "{$where} {$orderby} {$this->args['order']} LIMIT", $sql );
237
238		return $sql;
239		}
240
241		/**
242		* Set query where clause.
243		*
244		* @since 1.8.14
245		* @access private
246		*
247		* @global wpdb $wpdb
248		* @return string
249		*/
250		private function get_where_query() {
251
252		// Get sql query for meta.
253		if ( ! empty( $this->args['meta_query'] ) ) {
254		$meta_query_object = new WP_Meta_Query( $this->args['meta_query'] );
255		$meta_query = $meta_query_object->get_sql( $this->meta_type, $this->table_name, 'id' );
256
257		$where[] = implode( '', $meta_query );
258		}
259
260		$where[] = 'WHERE 1=1';
261		$where[] = $this->get_where_search();
262		$where[] = $this->get_where_email();
263		$where[] = $this->get_where_donor();
264		$where[] = $this->get_where_user();
265		$where[] = $this->get_where_date();
266		$where[] = $this->get_where_purchase_count();
267		$where[] = $this->get_where_give_forms();
268
269		$where = array_filter( $where );
270
271		return trim( implode( ' ', array_map( 'trim', $where ) ) );
272
273		}
274
275		/**
276		* Set email where clause.
277		*
278		* @since 1.8.14
279		* @access private
280		*
281		* @global wpdb $wpdb
282		* @return string
283		*/
284		private function get_where_email() {
285		global $wpdb;
286
287		$where = '';
288
289		if ( ! empty( $this->args['email'] ) ) {
290
291		if ( is_array( $this->args['email'] ) ) {
292
293		$emails_count = count( $this->args['email'] );
294		$emails_placeholder = array_fill( 0, $emails_count, '%s' );
295		$emails = implode( ', ', $emails_placeholder );
296
297		$where .= $wpdb->prepare( "AND {$this->table_name}.email IN( $emails )", $this->args['email'] );
298		} else {
299		$where .= $wpdb->prepare( "AND {$this->table_name}.email = %s", $this->args['email'] );
300		}
301		}
302
303		return $where;
304		}
305
306		/**
307		* Set donor where clause.
308		*
309		* @since 1.8.14
310		* @access private
311		*
312		* @global wpdb $wpdb
313		* @return string
314		*/
315	View Code Duplication	private function get_where_donor() {
		0 ignored issues – show Duplication introduced 2017-09-22 09:31 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...
316		$where = '';
317
318		// Specific donors.
319		if ( ! empty( $this->args['donor'] ) ) {
320		if ( ! is_array( $this->args['donor'] ) ) {
321		$this->args['donor'] = explode( ',', $this->args['donor'] );
322		}
323		$donor_ids = implode( ',', array_map( 'intval', $this->args['donor'] ) );
324
325		$where .= "AND {$this->table_name}.id IN( {$donor_ids} )";
326		}
327
328		return $where;
329		}
330
331		/**
332		* Set date where clause.
333		*
334		* @since 1.8.14
335		* @access private
336		*
337		* @global wpdb $wpdb
338		* @return string
339		*/
340		private function get_where_date() {
341		$where = '';
342
343		// Donors created for a specific date or in a date range
344		if ( ! empty( $this->args['date_query'] ) ) {
345		$date_query_object = new WP_Date_Query( is_array( $this->args['date_query'] ) ? $this->args['date_query'] : wp_parse_args( $this->args['date_query'] ), "{$this->table_name}.date_created" );
346
347		$where .= str_replace( array(
348		"\n",
349		'( (',
350		'))',
351		), array(
		0 ignored issues – show Coding Style introduced 2018-04-11 10:35 UTC by Report Bug Copy Issue Report This line of the multi-line function call does not seem to be indented correctly. Expected `16` spaces, but found `12`. Loading history...
352		'',
353		'( (',
354		') )',
355		), $date_query_object->get_sql() );
356		}
357
358		return $where;
359		}
360
361		/**
362		* Set search where clause.
363		*
364		* @since 1.8.14
365		* @access private
366		*
367		* @global wpdb $wpdb
368		* @return string
369		*/
370		private function get_where_search() {
371		$where = '';
372
373		// Donors created for a specific date or in a date range
374		if ( ! empty( $this->args['s'] ) && false !== strpos( $this->args['s'], ':' ) ) {
375		$search_parts = explode( ':', $this->args['s'] );
376
377		if ( ! empty( $search_parts[0] ) ) {
378		switch ( $search_parts[0] ) {
379		case 'name':
380		$where = "AND {$this->table_name}.name LIKE '%{$search_parts[1]}%'";
381		break;
382
383		case 'note':
384		$where = "AND {$this->table_name}.notes LIKE '%{$search_parts[1]}%'";
385		break;
386		}
387		}
388		}
389
390		return $where;
391		}
392
393		/**
394		* Set user where clause.
395		*
396		* @since 1.8.14
397		* @access private
398		*
399		* @global wpdb $wpdb
400		* @return string
401		*/
402	View Code Duplication	private function get_where_user() {
		0 ignored issues – show Duplication introduced 2017-09-22 09:31 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...
403		$where = '';
404
405		// Donors create for specific wp user.
406		if ( ! empty( $this->args['user'] ) ) {
407		if ( ! is_array( $this->args['user'] ) ) {
408		$this->args['user'] = explode( ',', $this->args['user'] );
409		}
410		$user_ids = implode( ',', array_map( 'intval', $this->args['user'] ) );
411
412		$where .= "AND {$this->table_name}.user_id IN( {$user_ids} )";
413		}
414
415		return $where;
416		}
417
418		/**
419		* Set orderby query
420		*
421		* @since 1.8.14
422		* @access private
423		*
424		* @return string
425		*/
426		private function get_order_query() {
427		$table_columns = Give()->donors->get_columns();
428
429		$this->args['orderby'] = ! array_key_exists( $this->args['orderby'], $table_columns ) ? 'id' : $this->args['orderby'];
430
431		$this->args['orderby'] = esc_sql( $this->args['orderby'] );
432		$this->args['order'] = esc_sql( $this->args['order'] );
433
434		switch ( $table_columns[ $this->args['orderby'] ] ) {
435		case '%d':
436		case '%f':
437		$query = "ORDER BY {$this->table_name}.{$this->args['orderby']}+0";
438		break;
439
440		default:
441		$query = "ORDER BY {$this->table_name}.{$this->args['orderby']}";
442		}
443
444		return $query;
445		}
446
447		/**
448		* Set purchase value where clause.
449		* @todo: add phpunit test
450		*
451		* @since 2.1.0
452		* @access private
453		*
454		* @global wpdb $wpdb
455		* @return string
456		*/
457		private function get_where_purchase_count() {
458		$where = '';
459
460		if ( ! empty( $this->args['donation_amount'] ) ) {
461		$compare = '>';
462		$amount = $this->args['donation_amount'];
463		if ( is_array( $this->args['donation_amount'] ) ) {
464		$compare = $this->args['donation_amount'] ['compare'];
465		$amount = $this->args['donation_amount']['amount'];
466		}
467
468		$where .= "AND {$this->table_name}.purchase_value{$compare}{$amount}";
469		}
470
471		return $where;
472		}
473
474		/**
475		* Set give_forms where clause.
476		*
477		* @todo : add phpunit test
478		*
479		* @since 2.1.0
480		* @access private
481		*
482		* @global wpdb $wpdb
483		* @return string
484		*/
485		private function get_where_give_forms() {
486		global $wpdb;
487		$where = '';
488
489		if ( ! empty( $this->args['give_forms'] ) ) {
490		if ( ! is_array( $this->args['give_forms'] ) ) {
491		$this->args['give_forms'] = explode( ',', $this->args['give_forms'] );
492		}
493
494		$form_ids = implode( ',', array_map( 'intval', $this->args['give_forms'] ) );
495
496		$query = $wpdb->prepare(
497		"
498		SELECT DISTINCT meta_value as donor_id
499		FROM {$wpdb->paymentmeta}
500		WHERE meta_key=%s
501		AND payment_id IN(
502		SELECT payment_id
503		FROM {$wpdb->paymentmeta}
504		WHERE meta_key=%s
505		AND meta_value IN (%s)
506		)
507		",
508		'_give_payment_donor_id',
509		'_give_payment_form_id',
510		$form_ids
511		);
512
513		$donor_ids = $wpdb->get_results( $query, ARRAY_A );
		0 ignored issues – show introduced 2018-04-11 10:35 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2018-04-11 10:35 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
514
515		if ( ! empty( $donor_ids ) ) {
516		$donor_ids = wp_list_pluck( $donor_ids, 'donor_id' );
517		$donor_ids = implode( ',', array_map( 'intval', $donor_ids ) );
518		$where .= "AND {$this->table_name}.id IN ({$donor_ids})";
519		}
520		}
521
522		return $where;
523		}
524		}
525

ravinderk / Give