actions.php ➔ give_payment_save_page_data() - Code Metrics - Inspection of "Return custom level id from give_get_price_id" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — issues/2042 ( e8b6b5 )

by Ravinder

created 2017-09-04 11:43 UTC

actions.php ➔ give_payment_save_page_data() A

↳ Parent: Project

Complexity

Conditions	4
Paths	6

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	6
nop	1
dl	0
loc	12
rs	9.2
c	0
b	0
f	0

<?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 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 {integer} $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			if ( $old_status == 'publish' \|\| $old_status == 'complete' ) {
			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...
35			return;
36			}
37
38			// Make sure the payment completion is only processed when new status is complete.
39			if ( $new_status != 'publish' && $new_status != 'complete' ) {
			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...
40			return;
41			}
42
43			$payment = new Give_Payment( $payment_id );
44
45			$creation_date = get_post_field( 'post_date', $payment_id, 'raw' );
46			$payment_meta = $payment->payment_meta;
47			$completed_date = $payment->completed_date;
48			$user_info = $payment->user_info;
			0 ignored issues – show Unused Code introduced 2017-07-29 03:17 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			$donor_id = $payment->customer_id;
50			$amount = $payment->total;
51			$price_id = $payment->price_id;
52			$form_id = $payment->form_id;
53
54			/**
55			* Fires before completing donation.
56			*
57			* @since 1.0
58			*
59			* @param int $payment_id The ID of the payment.
60			*/
61			do_action( 'give_pre_complete_donation', $payment_id );
62
63			// Ensure these actions only run once, ever.
64			if ( empty( $completed_date ) ) {
65
66			give_record_donation_in_log( $form_id, $payment_id, $price_id, $creation_date );
67
68			/**
69			* Fires after logging donation record.
70			*
71			* @since 1.0
72			*
73			* @param int $form_id The ID number of the form.
74			* @param int $payment_id The ID number of the payment.
75			* @param array $payment_meta The payment meta.
76			*/
77			do_action( 'give_complete_form_donation', $form_id, $payment_id, $payment_meta );
78
79			}
80
81			// Increase the earnings for this form ID.
82			give_increase_earnings( $form_id, $amount );
83			give_increase_donation_count( $form_id );
84
85			// @todo: Refresh only range related stat cache
86			give_delete_donation_stats();
87
88			// Increase the donor's donation stats.
89			$donor = new Give_Donor( $donor_id );
			0 ignored issues – show Documentation introduced 2017-07-29 03:17 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			$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			do_action( 'give_complete_donation', $payment_id );
110			}
111
112			}
113
114			add_action( 'give_update_payment_status', 'give_complete_purchase', 100, 3 );
115
116
117			/**
118			* Record payment status change
119			*
120			* @since 1.0
121			*
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			give_insert_payment_note( $payment_id, $status_change );
139			}
140
141			add_action( 'give_update_payment_status', 'give_record_status_change', 100, 3 );
142
143
144			/**
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-04 10:10 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-04 10:10 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-12-08 11:11 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			* Add meta in payment that store page id and page url.
259			*
260			* Will add/update when user add click on the checkout page.
261			* The status of the donation doest not matter as it get change when user had made the payment successfully.
262			*
263			* @since 1.8.13
264			*
265			* @param {integer} $payment_id Payment id for which the meta value should be updated.
			0 ignored issues – show Documentation introduced 2017-09-04 11:48 UTC by Report Bug Copy Issue Report The doc-type `{integer}` could not be parsed: Unknown type name "{integer}" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
266			*/
267			function give_payment_save_page_data( $payment_id ) {
268			$page_url = ( ! empty( $_REQUEST['give-current-url'] ) ? esc_url( $_REQUEST['give-current-url'] ) : false );
			0 ignored issues – show introduced 2017-08-28 07:54 UTC by Report Bug Copy Issue Report Detected access of super global var $_REQUEST, probably need manual inspection. Loading history...
269			// Check $page_url is not empty.
270			if ( $page_url ) {
271			update_post_meta( $payment_id, '_give_current_url', $page_url );
272			$page_id = url_to_postid( $page_url );
273			// Check $page_id is not empty.
274			if ( $page_id ) {
275			update_post_meta( $payment_id, '_give_current_page_id', $page_id );
276			}
277			}
278			}
279
280			// Fire when payment is save.
281			add_action( 'give_insert_payment', 'give_payment_save_page_data' );

ravinderk / Give

Push — issues/2042 ( e8b6b5 )

actions.php ➔ give_payment_save_page_data() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like