Give_Tools_Recount_Donor_Stats

Complexity

Total Complexity

20

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
C	get_data()	0	89	9
A	get_percentage_complete()	0	23	3
A	set_properties()	0	2	1
A	process_step()	0	21	3
A	headers()	0	7	3
A	export()	0	7	1

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 22 and the first side effect is on line 14.

/**
 * Recount all donor stats.
 *
 * This class handles batch processing of recounting all donor stats.
 *
 * @subpackage  Admin/Tools/Give_Tools_Recount_Donor_Stats
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.5
 */

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

/**
 * Give_Tools_Recount_Donor_Stats Class
 *
 * @since 1.5
 */
class Give_Tools_Recount_Donor_Stats extends Give_Batch_Export {

	/**
	 * Our export type. Used for export-type specific filters/actions.
	 *
	 * @var string
	 * @since 1.5
	 */
	public $export_type = '';

	/**
	 * Allows for a non-form batch processing to be run.
	 *
	 * @since  1.5
	 * @var boolean
	 */
	public $is_void = true;

	/**
	 * Sets the number of items to pull on each step
	 *
	 * @since  1.5
	 * @var integer
	 */
	public $per_step = 5;

	/**
	 * Get the Export Data
	 *
	 * @access public
	 * @since 1.5
	 *
	 * @return array $data The data for the CSV file

Should the return type not be boolean?

	 */
	public function get_data() {

		$args = array(
			'number'  => $this->per_step,
			'offset'  => $this->per_step * ( $this->step - 1 ),
			'orderby' => 'id',
			'order'   => 'DESC',
		);

		$donors = Give()->donors->get_donors( $args );

		if ( $donors ) {

			$allowed_payment_status = apply_filters( 'give_recount_donors_donation_statuses', give_get_payment_status_keys() );

			foreach ( $donors as $donor ) {

				$attached_payment_ids = explode( ',', $donor->payment_ids );

				$attached_args = array(
					'post__in' => $attached_payment_ids,
					'number'   => - 1,
					'status'   => $allowed_payment_status,
				);

				$attached_payments = (array) give_get_payments( $attached_args );

				$unattached_args = array(
					'post__not_in' => $attached_payment_ids,
					'number'       => - 1,
					'status'       => $allowed_payment_status,
					'meta_query'   => array(
						array(
							'key'     => '_give_payment_user_email',
							'value'   => $donor->email,
							'compare' => '=',
						),
					),
				);

				$unattached_payments = give_get_payments( $unattached_args );

				$payments = array_merge( $attached_payments, $unattached_payments );

				$purchase_value = 0.00;
				$purchase_count = 0;
				$payment_ids    = array();

				if ( $payments ) {

The expression $payments of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

					foreach ( $payments as $payment ) {

						$should_process_payment = 'publish' == $payment->post_status ? true : false;
						$should_process_payment = apply_filters( 'give_donor_recount_should_process_donation', $should_process_payment, $payment );

						if ( true === $should_process_payment ) {

							if ( apply_filters( 'give_donor_recount_should_increase_value', true, $payment ) ) {
								$purchase_value += give_get_payment_amount( $payment->ID );
							}

							if ( apply_filters( 'give_donor_recount_should_increase_count', true, $payment ) ) {
								$purchase_count ++;
							}
						}

						$payment_ids[] = $payment->ID;
					}
				}

				$payment_ids = implode( ',', $payment_ids );

				$donor_update_data = array(
					'purchase_count' => $purchase_count,
					'purchase_value' => $purchase_value,
					'payment_ids'    => $payment_ids,
				);

				$donor_instance = new Give_Donor( $donor->id );
				$donor_instance->update( $donor_update_data );

			}// End foreach().

43% of this comment could be valid code. Did you maybe forget this after debugging?

			return true;
		}// End if().

43% of this comment could be valid code. Did you maybe forget this after debugging?

		return false;

	}

	/**
	 * Return the calculated completion percentage
	 *
	 * @since 1.5
	 * @return int

Should the return type not be integer|double?

	 */
	public function get_percentage_complete() {

		$args = array(
			'number'  => - 1,
			'orderby' => 'id',
			'order'   => 'DESC',
		);

		$donors = Give()->donors->get_donors( $args );
		$total     = count( $donors );

		$percentage = 100;

		if ( $total > 0 ) {
			$percentage = ( ( $this->per_step * $this->step ) / $total ) * 100;
		}

		if ( $percentage > 100 ) {
			$percentage = 100;
		}

		return $percentage;
	}

	/**
	 * Set the properties specific to the payments export
	 *
	 * @since 1.5
	 *
	 * @param array $request The Form Data passed into the batch processing
	 */
	public function set_properties( $request ) {
	}

	/**
	 * Process a step
	 *
	 * @since 1.5
	 * @return bool
	 */
	public function process_step() {

		if ( ! $this->can_export() ) {
			wp_die( esc_html__( 'You do not have permission to recount stats.', 'give' ), esc_html__( 'Error', 'give' ), array(
				'response' => 403,
			) );
		}

		$had_data = $this->get_data();

		if ( $had_data ) {
			$this->done = false;

			return true;
		} else {
			$this->done    = true;
			$this->message = esc_html__( 'Donor stats have been successfully recounted.', 'give' );

The property message does not exist. Did you maybe forget to declare it?

			return false;
		}
	}

	/**
	 * Headers
	 */
	public function headers() {
		ignore_user_abort( true );

		if ( ! give_is_func_disabled( 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
			set_time_limit( 0 );
		}
	}

	/**
	 * Perform the export
	 *
	 * @access public
	 * @since 1.5
	 * @return void
	 */
	public function export() {

		// Set headers
		$this->headers();

		give_die();
	}

}