Give_Payments_Query - Code Metrics - Inspection of "Fix wrong sql query for automatic upgrade" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — release/1.8.17 ( baf467...e6f68c )

by Ravinder

created 2017-12-01 09:30 UTC

Give_Payments_Query D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	741
Duplicated Lines	6.75 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	50
loc	741
rs	4.4444
c	0
b	0
f	0
wmc	82
lcom	1
cbo	2

23 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	33	1
A	__set()	0	7	2
A	__unset()	0	3	1
A	init()	0	2	1
A	set_filters()	0	21	1
A	unset_filters()	0	4	1
B	get_payments()	0	52	4
C	get_payment_by_group()	0	72	12
A	date_filter_pre()	0	9	3
A	date_filter_post()	0	7	3
A	status()	0	8	2
A	page()	0	8	2
A	per_page()	0	14	3
A	month()	0	8	2
A	orderby()	0	21	4
B	custom_orderby()	0	16	5
A	user()	0	18	3
A	donor()	0	12	3
D	search()	0	106	18
A	mode()	0	14	3
A	children()	0	6	2
B	give_forms()	25	25	3
B	gateway_filter()	25	25	3

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_Payments_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_Payments_Query, and based on these observations, apply Extract Interface, too.

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

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

/**
 * Give_Payments_Query Class
 *
 * This class is for retrieving payments data.
 *
 * Payments can be retrieved for date ranges and pre-defined periods.
 *
 * @since 1.0
 */
class Give_Payments_Query extends Give_Stats {

	/**
	 * Preserve args
	 *
	 * @since  1.8.17
	 * @access public
	 *
	 * @var    array
	 */
	public $_args = array();

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

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

	/**
	 * 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.0
	 * @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(
			'output'          => 'payments',
			'post_type'       => array( 'give_payment' ),
			'start_date'      => false,
			'end_date'        => false,
			'number'          => 20,
			'page'            => null,
			'orderby'         => 'ID',
			'order'           => 'DESC',
			'user'            => null,
			'donor'           => null,
			'status'          => give_get_payment_status_keys(),
			'meta_key'        => null,

			'year'            => null,
			'month'           => null,
			'day'             => null,
			's'               => null,
			'search_in_notes' => false,
			'children'        => false,
			'fields'          => null,
			'gateway'         => null,
			'give_forms'      => null,

			// Currently these params only works with get_payment_by_group
			'group_by'        => '',
			'count'           => false,
		);

		$this->args = $this->_args = wp_parse_args( $args, $defaults );

		$this->init();
	}

	/**
	 * Set a query variable.
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @param $query_var
	 * @param $value
	 */
	public function __set( $query_var, $value ) {
		if ( in_array( $query_var, array( 'meta_query', 'tax_query' ) ) ) {
			$this->args[ $query_var ][] = $value;
		} else {
			$this->args[ $query_var ] = $value;
		}
	}

	/**
	 * Unset a query variable.
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @param $query_var
	 */
	public function __unset( $query_var ) {
		unset( $this->args[ $query_var ] );
	}

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


	/**
	 * Set query filter.
	 *
	 * @since  1.8.9
	 * @access private
	 */
	private function set_filters() {
		// Reset param to apply filters.
		// While set filters $args will get override and multiple get_payments call will not work.
		$this->args = $this->_args;

		$this->date_filter_pre();
		$this->orderby();
		$this->status();
		$this->month();
		$this->per_page();
		$this->page();
		$this->user();
		$this->donor();
		$this->search();
		$this->mode();
		$this->children();
		$this->give_forms();
		$this->gateway_filter();

		add_filter( 'posts_orderby', array( $this, 'custom_orderby' ), 10, 2 );
	}

	/**
	 * Unset query filter.
	 *
	 * @since  1.8.9
	 * @access private
	 */
	private function unset_filters() {
		$this->date_filter_post();
		remove_filter( 'posts_orderby', array( $this, 'custom_orderby' ) );
	}


	/**
	 * Retrieve payments.
	 *
	 * 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.0
	 * @access public
	 *
	 * @return array
	 */
	public function get_payments() {
		// Modify the query/query arguments before we retrieve payments.
		$this->set_filters();

		/**
		 * Fires before retrieving payments.
		 *
		 * @since 1.0
		 *
		 * @param Give_Payments_Query $this Payments query object.
		 */
		do_action( 'give_pre_get_payments', $this );

		$query          = new WP_Query( $this->args );
		$this->payments = array();

		$custom_output = array(
			'payments',
			'give_payments',
		);

		if ( ! in_array( $this->args['output'], $custom_output ) ) {
			return $query->posts;
		}

		if ( $query->have_posts() ) {
			while ( $query->have_posts() ) {
				$query->the_post();

				$payment_id = get_post()->ID;
				$payment    = new Give_Payment( $payment_id );

				$this->payments[] = apply_filters( 'give_payment', $payment, $payment_id, $this );
			}

			wp_reset_postdata();
		}

		// Remove query filters after we retrieve payments.
		$this->unset_filters();

		/**
		 * Fires after retrieving payments.
		 *
		 * @since 1.0
		 *
		 * @param Give_Payments_Query $this Payments query object.
		 */
		do_action( 'give_post_get_payments', $this );

		return $this->payments;
	}


	/**
	 * Get payments by group
	 *
	 * @since  1.8.17
	 * @access public
	 *
	 * @return array
	 */
	public function get_payment_by_group() {
		global $wpdb;

		$allowed_groups = array( 'post_status' );
		$result         = array();



		if ( in_array( $this->args['group_by'], $allowed_groups ) ) {
			// Set only count in result.
			if ( $this->args['count'] ) {
				$statuses     = get_post_stati();
				$status_query = '';

				$counter = 0;
				foreach ( $statuses as $status ) {
					$prefix       = $counter ? " OR " : '';
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
					$status_query .= "{$prefix}{$wpdb->posts}.post_status=\"{$status}\"";
					$counter ++;
				}

				$new_results = $wpdb->get_results(

					"
					SELECT {$wpdb->posts}.post_status, COUNT({$wpdb->posts}.ID)
					FROM {$wpdb->posts}
					WHERE 1=1 
					AND {$wpdb->posts}.post_parent = 0 
					AND {$wpdb->posts}.post_type = 'give_payment'
					AND (($status_query))
					GROUP BY {$wpdb->posts}.{$this->args['group_by']}
					ORDER BY {$wpdb->posts}.ID
					DESC
					"
					, ARRAY_N );


				foreach ( $new_results as $results ) {
					$result[ $results[0] ] = $results[1];
				}

				switch ( $this->args['group_by'] ) {
					case 'post_status':

						if ( isset( $statuses['private'] ) && empty( $args['s'] ) ) {
							unset( $statuses['private'] );
						}

						/* @var Give_Payment $donation */
						foreach ( $statuses as $status => $status_label ) {
							if ( ! isset( $result[ $status ] ) ) {
								$result[ $status ] = 0;
							}
						}

						break;
				}
			} else {
				$donations = $this->get_payments();

				/* @var $donation Give_Payment */
				foreach ( $donations as $donation ) {
					$result[ $donation->{$this->args['group_by']} ][] = $donation;
				}
			}
		}



		/**
		 * Filter the result
		 *
		 * @since 1.8.17
		 */
		return apply_filters( 'give_get_payment_by_group', $result, $this );
	}

	/**
	 * If querying a specific date, add the proper filters.
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function date_filter_pre() {
		if ( ! ( $this->args['start_date'] || $this->args['end_date'] ) ) {
			return;
		}

		$this->setup_dates( $this->args['start_date'], $this->args['end_date'] );

		add_filter( 'posts_where', array( $this, 'payments_where' ) );
	}

	/**
	 * If querying a specific date, remove filters after the query has been run
	 * to avoid affecting future queries.
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function date_filter_post() {
		if ( ! ( $this->args['start_date'] || $this->args['end_date'] ) ) {
			return;
		}

		remove_filter( 'posts_where', array( $this, 'payments_where' ) );
	}

	/**
	 * Post Status
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function status() {
		if ( ! isset( $this->args['status'] ) ) {
			return;
		}

		$this->__set( 'post_status', $this->args['status'] );
		$this->__unset( 'status' );
	}

	/**
	 * Current Page
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function page() {
		if ( ! isset( $this->args['page'] ) ) {
			return;
		}

		$this->__set( 'paged', $this->args['page'] );
		$this->__unset( 'page' );
	}

	/**
	 * Posts Per Page
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function per_page() {

		if ( ! isset( $this->args['number'] ) ) {
			return;
		}

		if ( $this->args['number'] == - 1 ) {
			$this->__set( 'nopaging', true );
		} else {
			$this->__set( 'posts_per_page', $this->args['number'] );
		}

		$this->__unset( 'number' );
	}

	/**
	 * Current Month
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function month() {
		if ( ! isset( $this->args['month'] ) ) {
			return;
		}

		$this->__set( 'monthnum', $this->args['month'] );
		$this->__unset( 'month' );
	}

	/**
	 * Order by
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function orderby() {
		switch ( $this->args['orderby'] ) {
			case 'amount':
				$this->__set( 'orderby', 'meta_value_num' );
				$this->__set( 'meta_key', '_give_payment_total' );
				break;

			case 'status':
				$this->__set( 'orderby', 'post_status' );
				break;

			case 'donation_form':
				$this->__set( 'orderby', 'meta_value' );
				$this->__set( 'meta_key', '_give_payment_form_title' );
				break;

			default:
				$this->__set( 'orderby', $this->args['orderby'] );
				break;
		}
	}

	/**
	 * Custom orderby.
	 * Note: currently custom sorting is only used for donation listing page.
	 *
	 * @since  1.8
	 * @access public
	 *
	 * @param string   $order
	 * @param WP_Query $query
	 *
	 * @return mixed
	 */
	public function custom_orderby( $order, $query ) {
		global $wpdb;

		$post_types = is_array( $query->query['post_type'] ) ? $query->query['post_type'] : array( $query->query['post_type'] );
		if ( ! in_array( 'give_payment', $post_types ) || is_array( $query->query['orderby'] ) ) {
			return $order;
		}

		switch ( $query->query['orderby'] ) {
			case 'post_status':
				$order = $wpdb->posts . '.post_status ' . strtoupper( $query->query['order'] );
				break;
		}

		return $order;
	}

	/**
	 * Specific User
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function user() {
		if ( is_null( $this->args['user'] ) ) {
			return;
		}

		if ( is_numeric( $this->args['user'] ) ) {
			$user_key = '_give_payment_user_id';
		} else {
			$user_key = '_give_payment_user_email';
		}

		$this->__set(
			'meta_query', array(
				'key'   => $user_key,
				'value' => $this->args['user'],
			)
		);
	}

	/**
	 * Specific donor id
	 *
	 * @access  public
	 * @since   1.8.9
	 * @return  void
	 */
	public function donor() {
		if ( is_null( $this->args['donor'] ) || ! is_numeric( $this->args['donor'] ) ) {
			return;
		}

		$this->__set(
			'meta_query', array(
				'key'   => '_give_payment_customer_id',
				'value' => (int) $this->args['donor'],
			)
		);
	}

	/**
	 * Search
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function search() {

		if ( ! isset( $this->args['s'] ) ) {
			return;
		}

		$search = trim( $this->args['s'] );

		if ( empty( $search ) ) {
			return;
		}

		$is_email = is_email( $search ) || strpos( $search, '@' ) !== false;
		$is_user  = strpos( $search, strtolower( 'user:' ) ) !== false;

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

			$notes = give_get_payment_notes( 0, $search );

			if ( ! empty( $notes ) ) {

				$payment_ids = wp_list_pluck( (array) $notes, 'comment_post_ID' );

				$this->__set( 'post__in', $payment_ids );
			}

			$this->__unset( 's' );

		} elseif ( $is_email || strlen( $search ) == 32 ) {

			$key         = $is_email ? '_give_payment_user_email' : '_give_payment_purchase_key';
			$search_meta = array(
				'key'     => $key,
				'value'   => $search,
				'compare' => 'LIKE',
			);

			$this->__set( 'meta_query', $search_meta );
			$this->__unset( 's' );

		} elseif ( $is_user ) {

			$search_meta = array(
				'key'   => '_give_payment_user_id',
				'value' => trim( str_replace( 'user:', '', strtolower( $search ) ) ),
			);

			$this->__set( 'meta_query', $search_meta );

			if ( give_get_option( 'enable_sequential' ) ) {

				$search_meta = array(
					'key'     => '_give_payment_number',
					'value'   => $search,
					'compare' => 'LIKE',
				);

				$this->__set( 'meta_query', $search_meta );

				$this->args['meta_query']['relation'] = 'OR';

			}

			$this->__unset( 's' );

		} elseif (
			give_get_option( 'enable_sequential' ) &&
			(
				false !== strpos( $search, give_get_option( 'sequential_prefix' ) ) ||
				false !== strpos( $search, give_get_option( 'sequential_postfix' ) )
			)
		) {

			$search_meta = array(
				'key'     => '_give_payment_number',
				'value'   => $search,
				'compare' => 'LIKE',
			);

			$this->__set( 'meta_query', $search_meta );
			$this->__unset( 's' );

		} elseif ( is_numeric( $search ) ) {

			$post = get_post( $search );

			if ( is_object( $post ) && $post->post_type == 'give_payment' ) {


				$arr   = array();
				$arr[] = $search;
				$this->__set( 'post__in', $arr );
				$this->__unset( 's' );
			}
		} elseif ( '#' == substr( $search, 0, 1 ) ) {

			$search = str_replace( '#:', '', $search );
			$search = str_replace( '#', '', $search );
			$this->__set( 'give_forms', $search );
			$this->__unset( 's' );

		} else {
			$this->__set( 's', $search );

		}

	}

	/**
	 * Payment Mode
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function mode() {
		if ( empty( $this->args['mode'] ) || $this->args['mode'] == 'all' ) {

			$this->__unset( 'mode' );

			return;
		}

		$this->__set(
			'meta_query', array(
				'key'   => '_give_payment_mode',
				'value' => $this->args['mode'],
			)
		);
	}

	/**
	 * Children
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function children() {
		if ( empty( $this->args['children'] ) ) {
			$this->__set( 'post_parent', 0 );
		}
		$this->__unset( 'children' );
	}

	/**
	 * Specific Give Form
	 *
	 * @since  1.0
	 * @access public
	 *
	 * @return void
	 */
	public function give_forms() {


		if ( empty( $this->args['give_forms'] ) ) {
			return;
		}

		$compare = '=';

		if ( is_array( $this->args['give_forms'] ) ) {
			$compare = 'IN';
		}

		$this->__set(
			'meta_query', array(
				array(
					'key'     => '_give_payment_form_id',
					'value'   => $this->args['give_forms'],
					'compare' => $compare,
				),
			)
		);

		$this->__unset( 'give_forms' );

	}

	/**
	 * Specific Gateway
	 *
	 * @since  1.8.17
	 * @access public
	 *
	 * @return void
	 */
	public function gateway_filter() {


		if ( empty( $this->args['gateway'] ) ) {
			return;
		}

		$compare = '=';

		if ( is_array( $this->args['gateway'] ) ) {
			$compare = 'IN';
		}

		$this->__set(
			'meta_query', array(
				array(
					'key'     => '_give_payment_gateway',
					'value'   => $this->args['gateway'],
					'compare' => $compare,
				),
			)
		);

		$this->__unset( 'gateway' );

	}

}


1		<?php
2		/**
3		* Payments Query
4		*
5		* @package Give
6		* @subpackage Classes/Stats
7		* @copyright Copyright (c) 2016, WordImpress
8		* @license https://opensource.org/licenses/gpl-license GNU Public License
9		* @since 1.0
10		*/
11
12		// Exit if accessed directly.
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit;
15		}
16
17		/**
18		* Give_Payments_Query Class
19		*
20		* This class is for retrieving payments data.
21		*
22		* Payments can be retrieved for date ranges and pre-defined periods.
23		*
24		* @since 1.0
25		*/
26		class Give_Payments_Query extends Give_Stats {
27
28		/**
29		* Preserve args
30		*
31		* @since 1.8.17
32		* @access public
33		*
34		* @var array
35		*/
36		public $_args = array();
37
38		/**
39		* The args to pass to the give_get_payments() query
40		*
41		* @since 1.0
42		* @access public
43		*
44		* @var array
45		*/
46		public $args = array();
47
48		/**
49		* The payments found based on the criteria set
50		*
51		* @since 1.0
52		* @access public
53		*
54		* @var array
55		*/
56		public $payments = array();
57
58		/**
59		* Default query arguments.
60		*
61		* 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.
62		*
63		* @since 1.0
64		* @access public
65		*
66		* @param $args array The array of arguments that can be passed in and used for setting up this payment query.
67		*/
68		public function __construct( $args = array() ) {
69		$defaults = array(
70		'output' => 'payments',
71		'post_type' => array( 'give_payment' ),
72		'start_date' => false,
73		'end_date' => false,
74		'number' => 20,
75		'page' => null,
76		'orderby' => 'ID',
77		'order' => 'DESC',
78		'user' => null,
79		'donor' => null,
80		'status' => give_get_payment_status_keys(),
81		'meta_key' => null,
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Detected usage of meta_key, possible slow query. Loading history...
82		'year' => null,
83		'month' => null,
84		'day' => null,
85		's' => null,
86		'search_in_notes' => false,
87		'children' => false,
88		'fields' => null,
89		'gateway' => null,
90		'give_forms' => null,
91
92		// Currently these params only works with get_payment_by_group
93		'group_by' => '',
94		'count' => false,
95		);
96
97		$this->args = $this->_args = wp_parse_args( $args, $defaults );
98
99		$this->init();
100		}
101
102		/**
103		* Set a query variable.
104		*
105		* @since 1.0
106		* @access public
107		*
108		* @param $query_var
109		* @param $value
110		*/
111		public function __set( $query_var, $value ) {
112		if ( in_array( $query_var, array( 'meta_query', 'tax_query' ) ) ) {
113		$this->args[ $query_var ][] = $value;
114		} else {
115		$this->args[ $query_var ] = $value;
116		}
117		}
118
119		/**
120		* Unset a query variable.
121		*
122		* @since 1.0
123		* @access public
124		*
125		* @param $query_var
126		*/
127		public function __unset( $query_var ) {
128		unset( $this->args[ $query_var ] );
129		}
130
131		/**
132		* Modify the query/query arguments before we retrieve payments.
133		*
134		* @since 1.0
135		* @access public
136		*
137		* @return void
138		*/
139		public function init() {
140		}
141
142
143		/**
144		* Set query filter.
145		*
146		* @since 1.8.9
147		* @access private
148		*/
149		private function set_filters() {
150		// Reset param to apply filters.
151		// While set filters $args will get override and multiple get_payments call will not work.
152		$this->args = $this->_args;
153
154		$this->date_filter_pre();
155		$this->orderby();
156		$this->status();
157		$this->month();
158		$this->per_page();
159		$this->page();
160		$this->user();
161		$this->donor();
162		$this->search();
163		$this->mode();
164		$this->children();
165		$this->give_forms();
166		$this->gateway_filter();
167
168		add_filter( 'posts_orderby', array( $this, 'custom_orderby' ), 10, 2 );
169		}
170
171		/**
172		* Unset query filter.
173		*
174		* @since 1.8.9
175		* @access private
176		*/
177		private function unset_filters() {
178		$this->date_filter_post();
179		remove_filter( 'posts_orderby', array( $this, 'custom_orderby' ) );
180		}
181
182
183		/**
184		* Retrieve payments.
185		*
186		* The query can be modified in two ways; either the action before the
187		* query is run, or the filter on the arguments (existing mainly for backwards
188		* compatibility).
189		*
190		* @since 1.0
191		* @access public
192		*
193		* @return array
194		*/
195		public function get_payments() {
196		// Modify the query/query arguments before we retrieve payments.
197		$this->set_filters();
198
199		/**
200		* Fires before retrieving payments.
201		*
202		* @since 1.0
203		*
204		* @param Give_Payments_Query $this Payments query object.
205		*/
206		do_action( 'give_pre_get_payments', $this );
207
208		$query = new WP_Query( $this->args );
209		$this->payments = array();
210
211		$custom_output = array(
212		'payments',
213		'give_payments',
214		);
215
216		if ( ! in_array( $this->args['output'], $custom_output ) ) {
217		return $query->posts;
218		}
219
220		if ( $query->have_posts() ) {
221		while ( $query->have_posts() ) {
222		$query->the_post();
223
224		$payment_id = get_post()->ID;
225		$payment = new Give_Payment( $payment_id );
226
227		$this->payments[] = apply_filters( 'give_payment', $payment, $payment_id, $this );
228		}
229
230		wp_reset_postdata();
231		}
232
233		// Remove query filters after we retrieve payments.
234		$this->unset_filters();
235
236		/**
237		* Fires after retrieving payments.
238		*
239		* @since 1.0
240		*
241		* @param Give_Payments_Query $this Payments query object.
242		*/
243		do_action( 'give_post_get_payments', $this );
244
245		return $this->payments;
246		}
247
248
249		/**
250		* Get payments by group
251		*
252		* @since 1.8.17
253		* @access public
254		*
255		* @return array
256		*/
257		public function get_payment_by_group() {
258		global $wpdb;
259
260		$allowed_groups = array( 'post_status' );
261		$result = array();
262
		0 ignored issues – show Coding Style introduced 2017-11-24 09:01 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
263
264		if ( in_array( $this->args['group_by'], $allowed_groups ) ) {
265		// Set only count in result.
266		if ( $this->args['count'] ) {
267		$statuses = get_post_stati();
268		$status_query = '';
269
270		$counter = 0;
271		foreach ( $statuses as $status ) {
272		$prefix = $counter ? " OR " : '';
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-11-29 13:03 UTC by Report Bug Copy Issue Report The string literal `OR` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
273		$status_query .= "{$prefix}{$wpdb->posts}.post_status=\"{$status}\"";
274		$counter ++;
275		}
276
277		$new_results = $wpdb->get_results(
		0 ignored issues – show introduced 2017-11-29 13:03 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-11-29 13:03 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...
278		"
279		SELECT {$wpdb->posts}.post_status, COUNT({$wpdb->posts}.ID)
280		FROM {$wpdb->posts}
281		WHERE 1=1
282		AND {$wpdb->posts}.post_parent = 0
283		AND {$wpdb->posts}.post_type = 'give_payment'
284		AND (($status_query))
285		GROUP BY {$wpdb->posts}.{$this->args['group_by']}
286		ORDER BY {$wpdb->posts}.ID
287		DESC
288		"
289		, ARRAY_N );
		0 ignored issues – show Coding Style introduced 2017-11-29 13:03 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 `20`. Loading history...
290
291		foreach ( $new_results as $results ) {
292		$result[ $results[0] ] = $results[1];
293		}
294
295		switch ( $this->args['group_by'] ) {
296		case 'post_status':
297
298		if ( isset( $statuses['private'] ) && empty( $args['s'] ) ) {
299		unset( $statuses['private'] );
300		}
301
302		/* @var Give_Payment $donation */
303		foreach ( $statuses as $status => $status_label ) {
304		if ( ! isset( $result[ $status ] ) ) {
305		$result[ $status ] = 0;
306		}
307		}
308
309		break;
310		}
311		} else {
312		$donations = $this->get_payments();
313
314		/* @var $donation Give_Payment */
315		foreach ( $donations as $donation ) {
316		$result[ $donation->{$this->args['group_by']} ][] = $donation;
317		}
318		}
319		}
320
		0 ignored issues – show Coding Style introduced 2017-11-29 13:03 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
321
322		/**
323		* Filter the result
324		*
325		* @since 1.8.17
326		*/
327		return apply_filters( 'give_get_payment_by_group', $result, $this );
328		}
329
330		/**
331		* If querying a specific date, add the proper filters.
332		*
333		* @since 1.0
334		* @access public
335		*
336		* @return void
337		*/
338		public function date_filter_pre() {
339		if ( ! ( $this->args['start_date'] \|\| $this->args['end_date'] ) ) {
340		return;
341		}
342
343		$this->setup_dates( $this->args['start_date'], $this->args['end_date'] );
344
345		add_filter( 'posts_where', array( $this, 'payments_where' ) );
346		}
347
348		/**
349		* If querying a specific date, remove filters after the query has been run
350		* to avoid affecting future queries.
351		*
352		* @since 1.0
353		* @access public
354		*
355		* @return void
356		*/
357		public function date_filter_post() {
358		if ( ! ( $this->args['start_date'] \|\| $this->args['end_date'] ) ) {
359		return;
360		}
361
362		remove_filter( 'posts_where', array( $this, 'payments_where' ) );
363		}
364
365		/**
366		* Post Status
367		*
368		* @since 1.0
369		* @access public
370		*
371		* @return void
372		*/
373		public function status() {
374		if ( ! isset( $this->args['status'] ) ) {
375		return;
376		}
377
378		$this->__set( 'post_status', $this->args['status'] );
379		$this->__unset( 'status' );
380		}
381
382		/**
383		* Current Page
384		*
385		* @since 1.0
386		* @access public
387		*
388		* @return void
389		*/
390		public function page() {
391		if ( ! isset( $this->args['page'] ) ) {
392		return;
393		}
394
395		$this->__set( 'paged', $this->args['page'] );
396		$this->__unset( 'page' );
397		}
398
399		/**
400		* Posts Per Page
401		*
402		* @since 1.0
403		* @access public
404		*
405		* @return void
406		*/
407		public function per_page() {
408
409		if ( ! isset( $this->args['number'] ) ) {
410		return;
411		}
412
413		if ( $this->args['number'] == - 1 ) {
414		$this->__set( 'nopaging', true );
415		} else {
416		$this->__set( 'posts_per_page', $this->args['number'] );
417		}
418
419		$this->__unset( 'number' );
420		}
421
422		/**
423		* Current Month
424		*
425		* @since 1.0
426		* @access public
427		*
428		* @return void
429		*/
430		public function month() {
431		if ( ! isset( $this->args['month'] ) ) {
432		return;
433		}
434
435		$this->__set( 'monthnum', $this->args['month'] );
436		$this->__unset( 'month' );
437		}
438
439		/**
440		* Order by
441		*
442		* @since 1.0
443		* @access public
444		*
445		* @return void
446		*/
447		public function orderby() {
448		switch ( $this->args['orderby'] ) {
449		case 'amount':
450		$this->__set( 'orderby', 'meta_value_num' );
451		$this->__set( 'meta_key', '_give_payment_total' );
452		break;
453
454		case 'status':
455		$this->__set( 'orderby', 'post_status' );
456		break;
457
458		case 'donation_form':
459		$this->__set( 'orderby', 'meta_value' );
460		$this->__set( 'meta_key', '_give_payment_form_title' );
461		break;
462
463		default:
464		$this->__set( 'orderby', $this->args['orderby'] );
465		break;
466		}
467		}
468
469		/**
470		* Custom orderby.
471		* Note: currently custom sorting is only used for donation listing page.
472		*
473		* @since 1.8
474		* @access public
475		*
476		* @param string $order
477		* @param WP_Query $query
478		*
479		* @return mixed
480		*/
481		public function custom_orderby( $order, $query ) {
482		global $wpdb;
483
484		$post_types = is_array( $query->query['post_type'] ) ? $query->query['post_type'] : array( $query->query['post_type'] );
485		if ( ! in_array( 'give_payment', $post_types ) \|\| is_array( $query->query['orderby'] ) ) {
486		return $order;
487		}
488
489		switch ( $query->query['orderby'] ) {
490		case 'post_status':
491		$order = $wpdb->posts . '.post_status ' . strtoupper( $query->query['order'] );
492		break;
493		}
494
495		return $order;
496		}
497
498		/**
499		* Specific User
500		*
501		* @since 1.0
502		* @access public
503		*
504		* @return void
505		*/
506		public function user() {
507		if ( is_null( $this->args['user'] ) ) {
508		return;
509		}
510
511		if ( is_numeric( $this->args['user'] ) ) {
512		$user_key = '_give_payment_user_id';
513		} else {
514		$user_key = '_give_payment_user_email';
515		}
516
517		$this->__set(
518		'meta_query', array(
519		'key' => $user_key,
520		'value' => $this->args['user'],
521		)
522		);
523		}
524
525		/**
526		* Specific donor id
527		*
528		* @access public
529		* @since 1.8.9
530		* @return void
531		*/
532		public function donor() {
533		if ( is_null( $this->args['donor'] ) \|\| ! is_numeric( $this->args['donor'] ) ) {
534		return;
535		}
536
537		$this->__set(
538		'meta_query', array(
539		'key' => '_give_payment_customer_id',
540		'value' => (int) $this->args['donor'],
541		)
542		);
543		}
544
545		/**
546		* Search
547		*
548		* @since 1.0
549		* @access public
550		*
551		* @return void
552		*/
553		public function search() {
554
555		if ( ! isset( $this->args['s'] ) ) {
556		return;
557		}
558
559		$search = trim( $this->args['s'] );
560
561		if ( empty( $search ) ) {
562		return;
563		}
564
565		$is_email = is_email( $search ) \|\| strpos( $search, '@' ) !== false;
566		$is_user = strpos( $search, strtolower( 'user:' ) ) !== false;
567
568		if ( ! empty( $this->args['search_in_notes'] ) ) {
569
570		$notes = give_get_payment_notes( 0, $search );
571
572		if ( ! empty( $notes ) ) {
573
574		$payment_ids = wp_list_pluck( (array) $notes, 'comment_post_ID' );
575
576		$this->__set( 'post__in', $payment_ids );
577		}
578
579		$this->__unset( 's' );
580
581		} elseif ( $is_email \|\| strlen( $search ) == 32 ) {
582
583		$key = $is_email ? '_give_payment_user_email' : '_give_payment_purchase_key';
584		$search_meta = array(
585		'key' => $key,
586		'value' => $search,
587		'compare' => 'LIKE',
588		);
589
590		$this->__set( 'meta_query', $search_meta );
591		$this->__unset( 's' );
592
593		} elseif ( $is_user ) {
594
595		$search_meta = array(
596		'key' => '_give_payment_user_id',
597		'value' => trim( str_replace( 'user:', '', strtolower( $search ) ) ),
598		);
599
600		$this->__set( 'meta_query', $search_meta );
601
602		if ( give_get_option( 'enable_sequential' ) ) {
603
604		$search_meta = array(
605		'key' => '_give_payment_number',
606		'value' => $search,
607		'compare' => 'LIKE',
608		);
609
610		$this->__set( 'meta_query', $search_meta );
611
612		$this->args['meta_query']['relation'] = 'OR';
613
614		}
615
616		$this->__unset( 's' );
617
618		} elseif (
619		give_get_option( 'enable_sequential' ) &&
620		(
621		false !== strpos( $search, give_get_option( 'sequential_prefix' ) ) \|\|
622		false !== strpos( $search, give_get_option( 'sequential_postfix' ) )
623		)
624		) {
625
626		$search_meta = array(
627		'key' => '_give_payment_number',
628		'value' => $search,
629		'compare' => 'LIKE',
630		);
631
632		$this->__set( 'meta_query', $search_meta );
633		$this->__unset( 's' );
634
635		} elseif ( is_numeric( $search ) ) {
636
637		$post = get_post( $search );
638
639		if ( is_object( $post ) && $post->post_type == 'give_payment' ) {
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Found "== '". Use Yoda Condition checks, you must Loading history...
640
641		$arr = array();
642		$arr[] = $search;
643		$this->__set( 'post__in', $arr );
644		$this->__unset( 's' );
645		}
646		} elseif ( '#' == substr( $search, 0, 1 ) ) {
647
648		$search = str_replace( '#:', '', $search );
649		$search = str_replace( '#', '', $search );
650		$this->__set( 'give_forms', $search );
651		$this->__unset( 's' );
652
653		} else {
654		$this->__set( 's', $search );
655
656		}
657
658		}
659
660		/**
661		* Payment Mode
662		*
663		* @since 1.0
664		* @access public
665		*
666		* @return void
667		*/
668		public function mode() {
669		if ( empty( $this->args['mode'] ) \|\| $this->args['mode'] == 'all' ) {
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Found "== '". Use Yoda Condition checks, you must Loading history...
670		$this->__unset( 'mode' );
671
672		return;
673		}
674
675		$this->__set(
676		'meta_query', array(
677		'key' => '_give_payment_mode',
678		'value' => $this->args['mode'],
679		)
680		);
681		}
682
683		/**
684		* Children
685		*
686		* @since 1.0
687		* @access public
688		*
689		* @return void
690		*/
691		public function children() {
692		if ( empty( $this->args['children'] ) ) {
693		$this->__set( 'post_parent', 0 );
694		}
695		$this->__unset( 'children' );
696		}
697
698		/**
699		* Specific Give Form
700		*
701		* @since 1.0
702		* @access public
703		*
704		* @return void
705		*/
706	View Code Duplication	public function give_forms() {
		0 ignored issues – show Duplication introduced 2017-11-24 03:09 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...
707
708		if ( empty( $this->args['give_forms'] ) ) {
709		return;
710		}
711
712		$compare = '=';
713
714		if ( is_array( $this->args['give_forms'] ) ) {
715		$compare = 'IN';
716		}
717
718		$this->__set(
719		'meta_query', array(
720		array(
721		'key' => '_give_payment_form_id',
722		'value' => $this->args['give_forms'],
723		'compare' => $compare,
724		),
725		)
726		);
727
728		$this->__unset( 'give_forms' );
729
730		}
731
732		/**
733		* Specific Gateway
734		*
735		* @since 1.8.17
736		* @access public
737		*
738		* @return void
739		*/
740	View Code Duplication	public function gateway_filter() {
		0 ignored issues – show Duplication introduced 2017-11-24 03:09 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...
741
742		if ( empty( $this->args['gateway'] ) ) {
743		return;
744		}
745
746		$compare = '=';
747
748		if ( is_array( $this->args['gateway'] ) ) {
749		$compare = 'IN';
750		}
751
752		$this->__set(
753		'meta_query', array(
754		array(
755		'key' => '_give_payment_gateway',
756		'value' => $this->args['gateway'],
757		'compare' => $compare,
758		),
759		)
760		);
761
762		$this->__unset( 'gateway' );
763
764		}
765
766		}
767

ravinderk / Give