actions.php ➔ give_bc_v20_get_payment_meta() - Code Metrics - Inspection of "Release/2.0" - WordImpress/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#2668)

by Devin

created 2018-01-17 19:21 UTC

actions.php ➔ give_bc_v20_get_payment_meta() F

↳ Parent: Project

Complexity

Conditions	34
Paths	> 20000

Size

Total Lines	153
Code Lines	69

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	1190

Importance

Changes

Metric	Value
cc	34
eloc	69
nc	268435460
nop	4
dl	0
loc	153
ccs	0
cts	0
cp	0
crap	1190
rs	2
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * Payment Actions
 *
 * @package     Give
 * @subpackage  Payments
 * @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;
}

/**
 * Complete a donation
 *
 * Performs all necessary actions to complete a donation.
 * Triggered by the give_update_payment_status() function.
 *
 * @since  1.0
 *
 * @param  int    $payment_id The ID number of the payment.
 * @param  string $new_status The status of the payment, probably "publish".
 * @param  string $old_status The status of the payment prior to being marked as "complete", probably "pending".
 *
 * @return void
 */
function give_complete_purchase( $payment_id, $new_status, $old_status ) {

	// Make sure that payments are only completed once.
	if ( $old_status == 'publish' || $old_status == 'complete' ) {

		return;
	}

	// Make sure the payment completion is only processed when new status is complete.
	if ( $new_status != 'publish' && $new_status != 'complete' ) {

		return;
	}

	$payment = new Give_Payment( $payment_id );

	$creation_date  = get_post_field( 'post_date', $payment_id, 'raw' );
	$payment_meta   = $payment->payment_meta;
	$completed_date = $payment->completed_date;
	$user_info      = $payment->user_info;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
	$donor_id       = $payment->customer_id;
	$amount         = $payment->total;
	$price_id       = $payment->price_id;
	$form_id        = $payment->form_id;

	/**
	 * Fires before completing donation.
	 *
	 * @since 1.0
	 *
	 * @param int $payment_id The ID of the payment.
	 */
	do_action( 'give_pre_complete_donation', $payment_id );

	// Ensure these actions only run once, ever.
	if ( empty( $completed_date ) ) {

		give_record_donation_in_log( $form_id, $payment_id, $price_id, $creation_date );

		/**
		 * Fires after logging donation record.
		 *
		 * @since 1.0
		 *
		 * @param int   $form_id      The ID number of the form.
		 * @param int   $payment_id   The ID number of the payment.
		 * @param array $payment_meta The payment meta.
		 */
		do_action( 'give_complete_form_donation', $form_id, $payment_id, $payment_meta );

	}

	// Increase the earnings for this form ID.
	give_increase_earnings( $form_id, $amount );
	give_increase_donation_count( $form_id );

	// @todo: Refresh only range related stat cache
	give_delete_donation_stats();

	// Increase the donor's donation stats.
	$donor = new Give_Donor( $donor_id );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	$donor->increase_purchase_count();
	$donor->increase_value( $amount );

	give_increase_total_earnings( $amount );

	// Ensure this action only runs once ever.
	if ( empty( $completed_date ) ) {

		// Save the completed date.
		$payment->completed_date = current_time( 'mysql' );
		$payment->save();

		/**
		 * Fires after a donation successfully complete.
		 *
		 * @since 1.0
		 *
		 * @param int $payment_id The ID of the payment.
		 */
		do_action( 'give_complete_donation', $payment_id );
	}

}

add_action( 'give_update_payment_status', 'give_complete_purchase', 100, 3 );


/**
 * Record payment status change
 *
 * @since  1.0
 *
 * @param  int    $payment_id The ID number of the payment.
 * @param  string $new_status The status of the payment, probably "publish".
 * @param  string $old_status The status of the payment prior to being marked as "complete", probably "pending".
 *
 * @return void
 */
function give_record_status_change( $payment_id, $new_status, $old_status ) {

	// Get the list of statuses so that status in the payment note can be translated.
	$stati      = give_get_payment_statuses();
	$old_status = isset( $stati[ $old_status ] ) ? $stati[ $old_status ] : $old_status;
	$new_status = isset( $stati[ $new_status ] ) ? $stati[ $new_status ] : $new_status;

	// translators: 1: old status 2: new status.
	$status_change = sprintf( esc_html__( 'Status changed from %1$s to %2$s.', 'give' ), $old_status, $new_status );

	give_insert_payment_note( $payment_id, $status_change );
}

add_action( 'give_update_payment_status', 'give_record_status_change', 100, 3 );


/**
 * Update Old Payments Totals
 *
 * Updates all old payments, prior to 1.2, with new meta for the total donation amount.
 *
 * It's done to query payments by their totals.
 *
 * @since  1.0
 *
 * @param  array $data Arguments passed.
 *
 * @return void
 */
function give_update_old_payments_with_totals( $data ) {
	if ( ! wp_verify_nonce( $data['_wpnonce'], 'give_upgrade_payments_nonce' ) ) {
		return;
	}

	if ( get_option( 'give_payment_totals_upgraded' ) ) {
		return;
	}

	$payments = give_get_payments( array(
		'offset' => 0,
		'number' => - 1,
		'mode'   => 'all',
	) );

	if ( $payments ) {

		foreach ( $payments as $payment ) {

			$payment = new Give_Payment( $payment->ID );
			$meta    = $payment->get_meta();

			$payment->total = $meta['amount'];
			$payment->save();

		}
	}

	add_option( 'give_payment_totals_upgraded', 1 );
}

add_action( 'give_upgrade_payments', 'give_update_old_payments_with_totals' );

/**
 * Mark Abandoned Donations
 *
 * Updates over a week-old 'pending' donations to 'abandoned' status.
 *
 * @since  1.0
 *
 * @return void
 */
function give_mark_abandoned_donations() {
	$args = array(
		'status' => 'pending',
		'number' => - 1,
		'output' => 'give_payments',
	);

	add_filter( 'posts_where', 'give_filter_where_older_than_week' );

	$payments = give_get_payments( $args );

	remove_filter( 'posts_where', 'give_filter_where_older_than_week' );

	if ( $payments ) {

		/**
		 * Filter payment gateways:  Used to set payment gateways which can be skip while transferring pending payment to abandon.
		 *
		 * @since 1.6
		 *
		 * @param array $skip_payment_gateways Array of payment gateways
		 */
		$skip_payment_gateways = apply_filters( 'give_mark_abandoned_donation_gateways', array( 'offline' ) );

		foreach ( $payments as $payment ) {
			$gateway = give_get_payment_gateway( $payment );

			// Skip payment gateways.
			if ( in_array( $gateway, $skip_payment_gateways ) ) {
				continue;
			}

			$payment->status = 'abandoned';
			$payment->save();
		}
	}
}

Give_Cron::add_weekly_event( 'give_mark_abandoned_donations' );


/**
 * Trigger the refresh of this month reports transients
 *
 * @since 1.7
 *
 * @param int $payment_ID Payment ID.
 *
 * @return void
 */
function give_refresh_thismonth_stat_transients( $payment_ID ) {

	// Monthly stats.
	Give_Cache::delete( Give_Cache::get_key( 'give_estimated_monthly_stats' ) );

	// @todo: Refresh only range related stat cache
	give_delete_donation_stats();
}

add_action( 'save_post_give_payment', 'give_refresh_thismonth_stat_transients' );


/**
 * Add support to get all payment meta.
 * Note: only use for internal purpose
 *
 * @since 2.0
 *
 * @param $check
 * @param $object_id
 * @param $meta_key
 * @param $single
 *
 * @return array
 */
function give_bc_v20_get_payment_meta( $check, $object_id, $meta_key, $single ) {
	// Bailout.
	if (
		'give_payment' !== get_post_type( $object_id ) ||
		'_give_payment_meta' !== $meta_key ||
		! give_has_upgrade_completed( 'v20_upgrades_payment_metadata' )
	) {
		return $check;
	}

	$cache_key = "_give_payment_meta_{$object_id}";

	// Get already calculate payment meta from cache.
	$payment_meta = Give_Cache::get_db_query( $cache_key );

	if ( is_null( $payment_meta ) ) {
		// Remove filter.
		remove_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999 );

		$donation = new Give_Payment( $object_id );

		// Get all payment meta.
		$payment_meta = give_get_meta( $object_id );

		// Set default value to array.
		if ( empty( $payment_meta ) ) {
			return $check;
		}

		// Convert all meta key value to string instead of array
		array_walk( $payment_meta, function ( &$meta, $key ) {

			$meta = current( $meta );
		} );

		/**
		 * Add backward compatibility to old meta keys.
		 */
		// Donation key.
		$payment_meta['key'] = ! empty( $payment_meta['_give_payment_purchase_key'] ) ? $payment_meta['_give_payment_purchase_key'] : '';

		// Donation form.
		$payment_meta['form_title'] = ! empty( $payment_meta['_give_payment_form_title'] ) ? $payment_meta['_give_payment_form_title'] : '';

		// Donor email.
		$payment_meta['email'] = ! empty( $payment_meta['_give_payment_donor_email'] ) ? $payment_meta['_give_payment_donor_email'] : '';
		$payment_meta['email'] = ! empty( $payment_meta['email'] ) ?
			$payment_meta['email'] :
			Give()->donors->get_column( 'email', $donation->donor_id );

		// Form id.
		$payment_meta['form_id'] = ! empty( $payment_meta['_give_payment_form_id'] ) ? $payment_meta['_give_payment_form_id'] : '';

		// Price id.
		$payment_meta['price_id'] = ! empty( $payment_meta['_give_payment_price_id'] ) ? $payment_meta['_give_payment_price_id'] : '';

		// Date.
		$payment_meta['date'] = ! empty( $payment_meta['_give_payment_date'] ) ? $payment_meta['_give_payment_date'] : '';
		$payment_meta['date'] = ! empty( $payment_meta['date'] ) ?
			$payment_meta['date'] :
			get_post_field( 'post_date', $object_id );



		// Currency.
		$payment_meta['currency'] = ! empty( $payment_meta['_give_payment_currency'] ) ? $payment_meta['_give_payment_currency'] : '';

		// Decode donor data.
		$donor_id = ! empty( $payment_meta['_give_payment_donor_id'] ) ? $payment_meta['_give_payment_donor_id'] : 0;
		$donor    = new Give_Donor( $donor_id );

		// Donor first name.
		$donor_data['first_name'] = ! empty( $payment_meta['_give_donor_billing_first_name'] ) ? $payment_meta['_give_donor_billing_first_name'] : '';
		$donor_data['first_name'] = ! empty( $donor_data['first_name'] ) ?
			$donor_data['first_name'] :
			$donor->get_first_name();

		// Donor last name.
		$donor_data['last_name'] = ! empty( $payment_meta['_give_donor_billing_last_name'] ) ? $payment_meta['_give_donor_billing_last_name'] : '';
		$donor_data['last_name'] = ! empty( $donor_data['last_name'] ) ?
			$donor_data['last_name'] :
			$donor->get_last_name();

		// Donor email.
		$donor_data['email'] = $payment_meta['email'];

		// User ID.
		$donor_data['id'] = $donation->user_id;

		$donor_data['address'] = false;

		// Address1.
		$address1 = ! empty( $payment_meta['_give_payment_billing_address1'] ) ? $payment_meta['_give_payment_billing_address1'] : '';
		if ( $address1 ) {
			$donor_data['address']['line1'] = $address1;
		}

		// Address2.
		$address2 = ! empty( $payment_meta['_give_payment_billing_address2'] ) ? $payment_meta['_give_payment_billing_address2'] : '';
		if ( $address2 ) {
			$donor_data['address']['line2'] = $address2;
		}

		// City.
		$city = ! empty( $payment_meta['_give_payment_billing_city'] ) ? $payment_meta['_give_payment_billing_city'] : '';
		if ( $city ) {
			$donor_data['address']['city'] = $city;
		}

		// Zip.
		$zip = ! empty( $payment_meta['_give_payment_billing_zip'] ) ? $payment_meta['_give_payment_billing_zip'] : '';
		if ( $zip ) {
			$donor_data['address']['zip'] = $zip;
		}

		// State.
		$state = ! empty( $payment_meta['_give_payment_billing_state'] ) ? $payment_meta['_give_payment_billing_state'] : '';
		if ( $state ) {
			$donor_data['address']['state'] = $state;
		}

		// Country.
		$country = ! empty( $payment_meta['_give_payment_billing_country'] ) ? $payment_meta['_give_payment_billing_country'] : '';
		if ( $country ) {
			$donor_data['address']['country'] = $country;
		}

		$payment_meta['user_info'] = $donor_data;

		// Add filter
		add_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999, 4 );

		// Set custom meta key into payment meta.
		if ( ! empty( $payment_meta['_give_payment_meta'] ) ) {
			$payment_meta = array_merge( maybe_unserialize( $payment_meta['_give_payment_meta'] ), $payment_meta );
		}

		// Set cache.
		Give_Cache::set_db_query( $cache_key, $payment_meta );
	}

	if ( $single ) {
		/**
		 * Filter the payment meta
		 * Add custom meta key to payment meta
		 *
		 * @since 2.0
		 */
		$new_payment_meta[0] = apply_filters( 'give_get_payment_meta', $payment_meta, $object_id, $meta_key );

		$payment_meta = $new_payment_meta;
	}

	return $payment_meta;
}

add_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999, 4 );

/**
 * Add meta in payment that store page id and page url.
 *
 * Will add/update when user add click on the checkout page.
 * The status of the donation doest not matter as it get change when user had made the payment successfully.
 *
 * @since 1.8.13
 *
 * @param int $payment_id Payment id for which the meta value should be updated.
 */
function give_payment_save_page_data( $payment_id ) {
	$page_url = ( ! empty( $_REQUEST['give-current-url'] ) ? esc_url( $_REQUEST['give-current-url'] ) : false );


	// Check $page_url is not empty.
	if ( $page_url ) {
		update_post_meta( $payment_id, '_give_current_url', $page_url );
		$page_id = url_to_postid( $page_url );
		// Check $page_id is not empty.
		if ( $page_id ) {
			update_post_meta( $payment_id, '_give_current_page_id', $page_id );
		}
	}
}

// Fire when payment is save.
add_action( 'give_insert_payment', 'give_payment_save_page_data' );

1		<?php
2		/**
3		* Payment Actions
4		*
5		* @package Give
6		* @subpackage Payments
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		* Complete a donation
19		*
20		* Performs all necessary actions to complete a donation.
21		* Triggered by the give_update_payment_status() function.
22		*
23		* @since 1.0
24		*
25		* @param int $payment_id The ID number of the payment.
26		* @param string $new_status The status of the payment, probably "publish".
27		* @param string $old_status The status of the payment prior to being marked as "complete", probably "pending".
28		*
29		* @return void
30		*/
31		function give_complete_purchase( $payment_id, $new_status, $old_status ) {
32
33		// Make sure that payments are only completed once.
34	42	if ( $old_status == 'publish' \|\| $old_status == 'complete' ) {
		0 ignored issues – show introduced 2017-08-01 08:32 UTC by Report Bug Copy Issue Report Found "== '". Use Yoda Condition checks, you must Loading history...
35	6	return;
36		}
37
38		// Make sure the payment completion is only processed when new status is complete.
39	42	if ( $new_status != 'publish' && $new_status != 'complete' ) {
		0 ignored issues – show introduced 2017-08-01 08:32 UTC by Report Bug Copy Issue Report Found "!= '". Use Yoda Condition checks, you must Loading history...
40	1	return;
41		}
42
43	42	$payment = new Give_Payment( $payment_id );
44
45	42	$creation_date = get_post_field( 'post_date', $payment_id, 'raw' );
46	42	$payment_meta = $payment->payment_meta;
47	42	$completed_date = $payment->completed_date;
48	42	$user_info = $payment->user_info;
		0 ignored issues – show Unused Code introduced 2017-08-01 08:32 UTC by Report Bug Copy Issue Report `$user_info` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
49	42	$donor_id = $payment->customer_id;
50	42	$amount = $payment->total;
51	42	$price_id = $payment->price_id;
52	42	$form_id = $payment->form_id;
53
54	42	/**
55		* Fires before completing donation.
56		*
57	42	* @since 1.0
58		*
59	42	* @param int $payment_id The ID of the payment.
60	42	*/
61		do_action( 'give_pre_complete_donation', $payment_id );
62	42
63		// Ensure these actions only run once, ever.
64		if ( empty( $completed_date ) ) {
65	42
66	42	give_record_donation_in_log( $form_id, $payment_id, $price_id, $creation_date );
67
68		/**
69	42	* Fires after logging donation record.
70		*
71	42	* @since 1.0
72	42	*
73		* @param int $form_id The ID number of the form.
74		* @param int $payment_id The ID number of the payment.
75	42	* @param array $payment_meta The payment meta.
76	42	*/
77	42	do_action( 'give_complete_form_donation', $form_id, $payment_id, $payment_meta );
78
79	42	}
80
81		// Increase the earnings for this form ID.
82	42	give_increase_earnings( $form_id, $amount );
83		give_increase_donation_count( $form_id );
84
85	42	// @todo: Refresh only range related stat cache
86	42	give_delete_donation_stats();
87	42
88	42	// Increase the donor's donation stats.
89		$donor = new Give_Donor( $donor_id );
		0 ignored issues – show Documentation introduced 2017-08-01 08:32 UTC by Report Bug Copy Issue Report `$donor_id` is of type `integer`, but the function expects a `boolean`. 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...
90	42	$donor->increase_purchase_count();
91		$donor->increase_value( $amount );
92
93		give_increase_total_earnings( $amount );
94
95		// Ensure this action only runs once ever.
96		if ( empty( $completed_date ) ) {
97
98		// Save the completed date.
99		$payment->completed_date = current_time( 'mysql' );
100		$payment->save();
101
102		/**
103		* Fires after a donation successfully complete.
104		*
105		* @since 1.0
106		*
107		* @param int $payment_id The ID of the payment.
108		*/
109	42	do_action( 'give_complete_donation', $payment_id );
110	42	}
111	42
112		}
113	42
114		add_action( 'give_update_payment_status', 'give_complete_purchase', 100, 3 );
115	42
116	42
117		/**
118	42	* Record payment status change
119		*
120	42	* @since 1.0
121	42	*
122		* @param int $payment_id The ID number of the payment.
123		* @param string $new_status The status of the payment, probably "publish".
124		* @param string $old_status The status of the payment prior to being marked as "complete", probably "pending".
125		*
126		* @return void
127		*/
128		function give_record_status_change( $payment_id, $new_status, $old_status ) {
129
130		// Get the list of statuses so that status in the payment note can be translated.
131		$stati = give_get_payment_statuses();
132		$old_status = isset( $stati[ $old_status ] ) ? $stati[ $old_status ] : $old_status;
133		$new_status = isset( $stati[ $new_status ] ) ? $stati[ $new_status ] : $new_status;
134
135		// translators: 1: old status 2: new status.
136		$status_change = sprintf( esc_html__( 'Status changed from %1$s to %2$s.', 'give' ), $old_status, $new_status );
137
138	42	give_insert_payment_note( $payment_id, $status_change );
139		}
140	42
141	41	add_action( 'give_update_payment_status', 'give_record_status_change', 100, 3 );
142	41
143
144	42	/**
145		* Update Old Payments Totals
146		*
147		* Updates all old payments, prior to 1.2, with new meta for the total donation amount.
148		*
149		* It's done to query payments by their totals.
150		*
151		* @since 1.0
152		*
153		* @param array $data Arguments passed.
154		*
155		* @return void
156		*/
157		function give_update_old_payments_with_totals( $data ) {
158		if ( ! wp_verify_nonce( $data['_wpnonce'], 'give_upgrade_payments_nonce' ) ) {
159		return;
160		}
161
162		if ( get_option( 'give_payment_totals_upgraded' ) ) {
163		return;
164		}
165
166		$payments = give_get_payments( array(
167		'offset' => 0,
168		'number' => - 1,
169		'mode' => 'all',
170		) );
171
172		if ( $payments ) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-10 20:40 UTC by Report Bug Copy Issue Report 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. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
173		foreach ( $payments as $payment ) {
174
175		$payment = new Give_Payment( $payment->ID );
176		$meta = $payment->get_meta();
177
178		$payment->total = $meta['amount'];
179		$payment->save();
180
181		}
182		}
183
184		add_option( 'give_payment_totals_upgraded', 1 );
185		}
186
187		add_action( 'give_upgrade_payments', 'give_update_old_payments_with_totals' );
188
189		/**
190		* Mark Abandoned Donations
191		*
192		* Updates over a week-old 'pending' donations to 'abandoned' status.
193		*
194		* @since 1.0
195		*
196		* @return void
197		*/
198		function give_mark_abandoned_donations() {
199		$args = array(
200		'status' => 'pending',
201		'number' => - 1,
202		'output' => 'give_payments',
203		);
204
205		add_filter( 'posts_where', 'give_filter_where_older_than_week' );
206
207		$payments = give_get_payments( $args );
208
209		remove_filter( 'posts_where', 'give_filter_where_older_than_week' );
210
211		if ( $payments ) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-10 20:40 UTC by Report Bug Copy Issue Report 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. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
212		/**
213		* Filter payment gateways: Used to set payment gateways which can be skip while transferring pending payment to abandon.
214		*
215		* @since 1.6
216		*
217		* @param array $skip_payment_gateways Array of payment gateways
218		*/
219		$skip_payment_gateways = apply_filters( 'give_mark_abandoned_donation_gateways', array( 'offline' ) );
220
221		foreach ( $payments as $payment ) {
222		$gateway = give_get_payment_gateway( $payment );
223
224		// Skip payment gateways.
225		if ( in_array( $gateway, $skip_payment_gateways ) ) {
226		continue;
227		}
228
229		$payment->status = 'abandoned';
230		$payment->save();
231		}
232		}
233		}
234
235		Give_Cron::add_weekly_event( 'give_mark_abandoned_donations' );
236
237
238		/**
239		* Trigger the refresh of this month reports transients
240		*
241		* @since 1.7
242		*
243		* @param int $payment_ID Payment ID.
244		*
245		* @return void
246		*/
247		function give_refresh_thismonth_stat_transients( $payment_ID ) {
		0 ignored issues – show Unused Code introduced 2016-08-30 23:05 UTC by Report Bug Copy Issue Report The parameter `$payment_ID` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
248		// Monthly stats.
249		Give_Cache::delete( Give_Cache::get_key( 'give_estimated_monthly_stats' ) );
250
251		// @todo: Refresh only range related stat cache
252		give_delete_donation_stats();
253		}
254
255		add_action( 'save_post_give_payment', 'give_refresh_thismonth_stat_transients' );
256
257
258		/**
259		* Add support to get all payment meta.
260		* Note: only use for internal purpose
261		*
262		* @since 2.0
263		*
264		* @param $check
265		* @param $object_id
266		* @param $meta_key
267		* @param $single
268		*
269		* @return array
270		*/
271		function give_bc_v20_get_payment_meta( $check, $object_id, $meta_key, $single ) {
272		// Bailout.
273		if (
274		'give_payment' !== get_post_type( $object_id ) \|\|
275		'_give_payment_meta' !== $meta_key \|\|
276		! give_has_upgrade_completed( 'v20_upgrades_payment_metadata' )
277		) {
278		return $check;
279		}
280
281		$cache_key = "_give_payment_meta_{$object_id}";
282
283		// Get already calculate payment meta from cache.
284		$payment_meta = Give_Cache::get_db_query( $cache_key );
285
286		if ( is_null( $payment_meta ) ) {
287		// Remove filter.
288		remove_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999 );
289
290		$donation = new Give_Payment( $object_id );
291
292		// Get all payment meta.
293		$payment_meta = give_get_meta( $object_id );
294
295		// Set default value to array.
296		if ( empty( $payment_meta ) ) {
297		return $check;
298		}
299
300		// Convert all meta key value to string instead of array
301		array_walk( $payment_meta, function ( &$meta, $key ) {
		0 ignored issues – show Unused Code introduced 2018-01-17 19:08 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
302		$meta = current( $meta );
303		} );
304
305		/**
306		* Add backward compatibility to old meta keys.
307		*/
308		// Donation key.
309		$payment_meta['key'] = ! empty( $payment_meta['_give_payment_purchase_key'] ) ? $payment_meta['_give_payment_purchase_key'] : '';
310
311		// Donation form.
312		$payment_meta['form_title'] = ! empty( $payment_meta['_give_payment_form_title'] ) ? $payment_meta['_give_payment_form_title'] : '';
313
314		// Donor email.
315		$payment_meta['email'] = ! empty( $payment_meta['_give_payment_donor_email'] ) ? $payment_meta['_give_payment_donor_email'] : '';
316		$payment_meta['email'] = ! empty( $payment_meta['email'] ) ?
317		$payment_meta['email'] :
318		Give()->donors->get_column( 'email', $donation->donor_id );
319
320		// Form id.
321		$payment_meta['form_id'] = ! empty( $payment_meta['_give_payment_form_id'] ) ? $payment_meta['_give_payment_form_id'] : '';
322
323		// Price id.
324		$payment_meta['price_id'] = ! empty( $payment_meta['_give_payment_price_id'] ) ? $payment_meta['_give_payment_price_id'] : '';
325
326		// Date.
327		$payment_meta['date'] = ! empty( $payment_meta['_give_payment_date'] ) ? $payment_meta['_give_payment_date'] : '';
328		$payment_meta['date'] = ! empty( $payment_meta['date'] ) ?
329		$payment_meta['date'] :
330		get_post_field( 'post_date', $object_id );
331
		0 ignored issues – show Coding Style introduced 2018-01-17 19:08 UTC by Report Bug Copy Issue Report Functions must not contain multiple empty lines in a row; found 2 empty lines Loading history...
332
333		// Currency.
334		$payment_meta['currency'] = ! empty( $payment_meta['_give_payment_currency'] ) ? $payment_meta['_give_payment_currency'] : '';
335
336		// Decode donor data.
337		$donor_id = ! empty( $payment_meta['_give_payment_donor_id'] ) ? $payment_meta['_give_payment_donor_id'] : 0;
338		$donor = new Give_Donor( $donor_id );
339
340		// Donor first name.
341		$donor_data['first_name'] = ! empty( $payment_meta['_give_donor_billing_first_name'] ) ? $payment_meta['_give_donor_billing_first_name'] : '';
342		$donor_data['first_name'] = ! empty( $donor_data['first_name'] ) ?
343		$donor_data['first_name'] :
344		$donor->get_first_name();
345
346		// Donor last name.
347		$donor_data['last_name'] = ! empty( $payment_meta['_give_donor_billing_last_name'] ) ? $payment_meta['_give_donor_billing_last_name'] : '';
348		$donor_data['last_name'] = ! empty( $donor_data['last_name'] ) ?
349		$donor_data['last_name'] :
350		$donor->get_last_name();
351
352		// Donor email.
353		$donor_data['email'] = $payment_meta['email'];
354
355		// User ID.
356		$donor_data['id'] = $donation->user_id;
357
358		$donor_data['address'] = false;
359
360		// Address1.
361		$address1 = ! empty( $payment_meta['_give_payment_billing_address1'] ) ? $payment_meta['_give_payment_billing_address1'] : '';
362		if ( $address1 ) {
363		$donor_data['address']['line1'] = $address1;
364		}
365
366		// Address2.
367		$address2 = ! empty( $payment_meta['_give_payment_billing_address2'] ) ? $payment_meta['_give_payment_billing_address2'] : '';
368		if ( $address2 ) {
369		$donor_data['address']['line2'] = $address2;
370		}
371
372		// City.
373		$city = ! empty( $payment_meta['_give_payment_billing_city'] ) ? $payment_meta['_give_payment_billing_city'] : '';
374		if ( $city ) {
375		$donor_data['address']['city'] = $city;
376		}
377
378		// Zip.
379		$zip = ! empty( $payment_meta['_give_payment_billing_zip'] ) ? $payment_meta['_give_payment_billing_zip'] : '';
380		if ( $zip ) {
381		$donor_data['address']['zip'] = $zip;
382		}
383
384		// State.
385		$state = ! empty( $payment_meta['_give_payment_billing_state'] ) ? $payment_meta['_give_payment_billing_state'] : '';
386		if ( $state ) {
387		$donor_data['address']['state'] = $state;
388		}
389
390		// Country.
391		$country = ! empty( $payment_meta['_give_payment_billing_country'] ) ? $payment_meta['_give_payment_billing_country'] : '';
392		if ( $country ) {
393		$donor_data['address']['country'] = $country;
394		}
395
396		$payment_meta['user_info'] = $donor_data;
397
398		// Add filter
399		add_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999, 4 );
400
401		// Set custom meta key into payment meta.
402		if ( ! empty( $payment_meta['_give_payment_meta'] ) ) {
403		$payment_meta = array_merge( maybe_unserialize( $payment_meta['_give_payment_meta'] ), $payment_meta );
404		}
405
406		// Set cache.
407		Give_Cache::set_db_query( $cache_key, $payment_meta );
408		}
409
410		if ( $single ) {
411		/**
412		* Filter the payment meta
413		* Add custom meta key to payment meta
414		*
415		* @since 2.0
416		*/
417		$new_payment_meta[0] = apply_filters( 'give_get_payment_meta', $payment_meta, $object_id, $meta_key );
418
419		$payment_meta = $new_payment_meta;
420		}
421
422		return $payment_meta;
423		}
424
425		add_filter( 'get_post_metadata', 'give_bc_v20_get_payment_meta', 999, 4 );
426
427		/**
428		* Add meta in payment that store page id and page url.
429		*
430		* Will add/update when user add click on the checkout page.
431		* The status of the donation doest not matter as it get change when user had made the payment successfully.
432		*
433		* @since 1.8.13
434		*
435		* @param int $payment_id Payment id for which the meta value should be updated.
436		*/
437		function give_payment_save_page_data( $payment_id ) {
438		$page_url = ( ! empty( $_REQUEST['give-current-url'] ) ? esc_url( $_REQUEST['give-current-url'] ) : false );
		0 ignored issues – show introduced 2017-09-07 23:03 UTC by Report Bug Copy Issue Report Detected access of super global var $_REQUEST, probably need manual inspection. Loading history...
439
440		// Check $page_url is not empty.
441		if ( $page_url ) {
442		update_post_meta( $payment_id, '_give_current_url', $page_url );
443		$page_id = url_to_postid( $page_url );
444		// Check $page_id is not empty.
445		if ( $page_id ) {
446		update_post_meta( $payment_id, '_give_current_page_id', $page_id );
447		}
448		}
449		}
450
451		// Fire when payment is save.
452		add_action( 'give_insert_payment', 'give_payment_save_page_data' );

WordImpress / Give

Pull Request — master (#2668)

actions.php ➔ give_bc_v20_get_payment_meta() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like