Decrease a customer's lifetime value.
| public decrease_value ( float $value ) : mixed | ||
| $value | float | The value to decrease by. |
| return | mixed | If successful, the new value, otherwise false. |
/**
* Decrements customer purchase stats
*
* @access public
* @since 1.0
*/
public function decrement_stats($customer_id = 0, $amount = 0.0)
{
$customer = new Give_Customer($customer_id);
if (!$customer) {
return false;
}
$decreased_count = $customer->decrease_purchase_count();
$decreased_value = $customer->decrease_value($amount);
return $decreased_count && $decreased_value ? true : false;
}
/**
* Deletes a Donation
*
* @since 1.0
* @global $give_logs
*
* @param int $payment_id Payment ID (default: 0)
* @param bool $update_customer If we should update the customer stats (default:true)
*
* @return void
*/
function give_delete_purchase($payment_id = 0, $update_customer = true)
{
global $give_logs;
$payment = new Give_Payment($payment_id);
$amount = give_get_payment_amount($payment_id);
$status = $payment->post_status;
$customer_id = give_get_payment_customer_id($payment_id);
$customer = new Give_Customer($customer_id);
//Only undo purchases that aren't these statuses
$dont_undo_statuses = apply_filters('give_undo_purchase_statuses', array('pending', 'cancelled'));
if (!in_array($status, $dont_undo_statuses)) {
give_undo_purchase(false, $payment_id);
}
if ($status == 'publish') {
// Only decrease earnings if they haven't already been decreased (or were never increased for this payment)
give_decrease_total_earnings($amount);
// Clear the This Month earnings (this_monththis_month is NOT a typo)
delete_transient(md5('give_earnings_this_monththis_month'));
if ($customer->id && $update_customer) {
// Decrement the stats for the customer
$customer->decrease_purchase_count();
$customer->decrease_value($amount);
}
}
do_action('give_payment_delete', $payment_id);
if ($customer->id && $update_customer) {
// Remove the payment ID from the customer
$customer->remove_payment($payment_id);
}
// Remove the payment
wp_delete_post($payment_id, true);
// Remove related sale log entries
$give_logs->delete_logs(null, 'sale', array(array('key' => '_give_log_payment_id', 'value' => $payment_id)));
do_action('give_payment_deleted', $payment_id);
}
public function test_decrement_stats()
{
$customer = new Give_Customer('*****@*****.**');
$customer->decrease_purchase_count();
$customer->decrease_value(10);
$this->assertEquals($customer->purchase_value, '10');
$this->assertEquals($customer->purchase_count, '0');
$this->assertEquals(give_count_purchases_of_customer($this->_user_id), '0');
$this->assertEquals(give_purchase_total_of_user($this->_user_id), '10');
// Make sure we hit the false conditions
$this->assertFalse($customer->decrease_purchase_count(-1));
$this->assertFalse($customer->decrease_purchase_count('abc'));
$customer->decrease_purchase_count(100);
$customer->decrease_value(100000);
$this->assertEquals($customer->purchase_value, '0');
$this->assertEquals($customer->purchase_count, '0');
}
/**
* Used during the process of moving to refunded or pending, to decrement stats
*
* @since 1.5
* @access private
*
* @param bool $alter_store_earnings If the method should alter the store earnings
* @param bool $alter_customer_value If the method should reduce the customer value
* @param bool $alter_customer_purchase_count If the method should reduce the customer's purchase count
*
* @return void
*/
private function maybe_alter_stats($alter_store_earnings, $alter_customer_value, $alter_customer_purchase_count)
{
give_undo_purchase(false, $this->ID);
// Decrease store earnings
if (true === $alter_store_earnings) {
give_decrease_total_earnings($this->total);
}
// Decrement the stats for the customer
if (!empty($this->customer_id)) {
$customer = new Give_Customer($this->customer_id);
if (true === $alter_customer_value) {
$customer->decrease_value($this->total);
}
if (true === $alter_customer_purchase_count) {
$customer->decrease_purchase_count();
}
}
}
/**
*
* Process the payment details edit
*
* @access private
*
* @param $data
*
* @since 1.0
* @return void
*
*/
function give_update_payment_details($data)
{
if (!current_user_can('edit_give_payments', $data['give_payment_id'])) {
wp_die(__('You do not have permission to edit this payment record', 'give'), __('Error', 'give'), array('response' => 403));
}
check_admin_referer('give_update_payment_details_nonce');
// Retrieve the payment ID
$payment_id = absint($data['give_payment_id']);
// Retrieve existing payment meta
$meta = give_get_payment_meta($payment_id);
$user_info = give_get_payment_meta_user_info($payment_id);
$status = $data['give-payment-status'];
$user_id = isset($data['give-payment-user-id']) ? intval($data['give-payment-user-id']) : '';
$date = sanitize_text_field($data['give-payment-date']);
$hour = sanitize_text_field($data['give-payment-time-hour']);
$form_id = give_get_payment_form_id($payment_id);
// Restrict to our high and low
if ($hour > 23) {
$hour = 23;
} elseif ($hour < 0) {
$hour = 00;
}
$minute = sanitize_text_field($data['give-payment-time-min']);
// Restrict to our high and low
if ($minute > 59) {
$minute = 59;
} elseif ($minute < 0) {
$minute = 00;
}
$address = array_map('trim', $data['give-payment-address'][0]);
$date = date('Y-m-d', strtotime($date)) . ' ' . $hour . ':' . $minute . ':00';
$curr_total = give_sanitize_amount(give_get_payment_amount($payment_id));
$new_total = give_sanitize_amount($_POST['give-payment-total']);
$curr_customer_id = sanitize_text_field($data['give-current-customer']);
$new_customer_id = sanitize_text_field($data['customer-id']);
do_action('give_update_edited_purchase', $payment_id);
// Update main payment record
$updated = wp_update_post(array('ID' => $payment_id, 'edit_date' => true, 'post_date' => $date));
if (0 === $updated) {
wp_die(esc_attr__('Error Updating Payment', 'give'), esc_attr__('Error', 'give'), array('response' => 400));
}
$customer_changed = false;
if (isset($data['give-new-customer']) && $data['give-new-customer'] == '1') {
$email = isset($data['give-new-customer-email']) ? sanitize_text_field($data['give-new-customer-email']) : '';
$names = isset($data['give-new-customer-name']) ? sanitize_text_field($data['give-new-customer-name']) : '';
if (empty($email) || empty($names)) {
wp_die(esc_attr__('New Customers require a name and email address', 'give'));
}
$customer = new Give_Customer($email);
if (empty($customer->id)) {
$customer_data = array('name' => $names, 'email' => $email);
$user_id = email_exists($email);
if (false !== $user_id) {
$customer_data['user_id'] = $user_id;
}
if (!$customer->create($customer_data)) {
// Failed to crete the new customer, assume the previous customer
$customer_changed = false;
$customer = new Give_Customer($curr_customer_id);
give_set_error('give-payment-new-customer-fail', __('Error creating new customer', 'give'));
}
}
$new_customer_id = $customer->id;
$previous_customer = new Give_Customer($curr_customer_id);
$customer_changed = true;
} elseif ($curr_customer_id !== $new_customer_id) {
$customer = new Give_Customer($new_customer_id);
$email = $customer->email;
$names = $customer->name;
$previous_customer = new Give_Customer($curr_customer_id);
$customer_changed = true;
} else {
$customer = new Give_Customer($curr_customer_id);
$email = $customer->email;
$names = $customer->name;
}
// Setup first and last name from input values
$names = explode(' ', $names);
$first_name = !empty($names[0]) ? $names[0] : '';
$last_name = '';
if (!empty($names[1])) {
unset($names[0]);
$last_name = implode(' ', $names);
}
if ($customer_changed) {
// Remove the stats and payment from the previous customer and attach it to the new customer
$previous_customer->remove_payment($payment_id, false);
$customer->attach_payment($payment_id, false);
// If purchase was completed and not ever refunded, adjust stats of customers
if ('revoked' == $status || 'publish' == $status) {
$previous_customer->decrease_purchase_count();
$previous_customer->decrease_value($new_total);
$customer->increase_purchase_count();
$customer->increase_value($new_total);
}
update_post_meta($payment_id, '_give_payment_customer_id', $customer->id);
}
// Set new meta values
$user_info['id'] = $customer->user_id;
$user_info['email'] = $customer->email;
$user_info['first_name'] = $first_name;
$user_info['last_name'] = $last_name;
$user_info['address'] = $address;
$meta['user_info'] = $user_info;
// Check for payment notes
if (!empty($data['give-payment-note'])) {
$note = wp_kses($data['give-payment-note'], array());
give_insert_payment_note($payment_id, $note);
}
// Set new status
give_update_payment_status($payment_id, $status);
give_update_payment_meta($payment_id, '_give_payment_user_id', $customer->user_id);
give_update_payment_meta($payment_id, '_give_payment_user_email', $customer->email);
give_update_payment_meta($payment_id, '_give_payment_meta', $meta);
give_update_payment_meta($payment_id, '_give_payment_total', $new_total);
// Adjust total store earnings if the payment total has been changed
if ($new_total !== $curr_total && ('publish' == $status || 'revoked' == $status)) {
if ($new_total > $curr_total) {
// Increase if our new total is higher
$difference = $new_total - $curr_total;
give_increase_total_earnings($difference);
$form = new Give_Donate_Form($form_id);
$form->increase_earnings($difference);
} elseif ($curr_total > $new_total) {
// Decrease if our new total is lower
$difference = $curr_total - $new_total;
give_decrease_total_earnings($difference);
$form = new Give_Donate_Form($form_id);
$form->decrease_earnings($difference);
}
}
do_action('give_updated_edited_purchase', $payment_id);
wp_safe_redirect(admin_url('edit.php?post_type=give_forms&page=give-payment-history&view=view-order-details&give-message=payment-updated&id=' . $payment_id));
exit;
}
/**
*
* Process the payment details edit
*
* @access private
*
* @param array $data
*
* @since 1.0
* @return void
*
*/
function give_update_payment_details($data)
{
if (!current_user_can('edit_give_payments', $data['give_payment_id'])) {
wp_die(esc_html__('You do not have permission to edit payment records.', 'give'), esc_html__('Error', 'give'), array('response' => 403));
}
check_admin_referer('give_update_payment_details_nonce');
// Retrieve the payment ID
$payment_id = absint($data['give_payment_id']);
/* @var Give_Payment $payment */
$payment = new Give_Payment($payment_id);
// Retrieve existing payment meta
$meta = $payment->get_meta();
$user_info = $payment->user_info;
$status = $data['give-payment-status'];
$date = sanitize_text_field($data['give-payment-date']);
$hour = sanitize_text_field($data['give-payment-time-hour']);
// Restrict to our high and low
if ($hour > 23) {
$hour = 23;
} elseif ($hour < 0) {
$hour = 00;
}
$minute = sanitize_text_field($data['give-payment-time-min']);
// Restrict to our high and low
if ($minute > 59) {
$minute = 59;
} elseif ($minute < 0) {
$minute = 00;
}
$address = array_map('trim', $data['give-payment-address'][0]);
$curr_total = give_sanitize_amount($payment->total);
$new_total = give_sanitize_amount($data['give-payment-total']);
$date = date('Y-m-d', strtotime($date)) . ' ' . $hour . ':' . $minute . ':00';
$curr_customer_id = sanitize_text_field($data['give-current-customer']);
$new_customer_id = sanitize_text_field($data['customer-id']);
/**
* Fires before updating edited purchase.
*
* @since 1.0
*
* @param int $payment_id The ID of the payment.
*/
do_action('give_update_edited_purchase', $payment_id);
$payment->date = $date;
$updated = $payment->save();
if (0 === $updated) {
wp_die(esc_html__('Error Updating Payment.', 'give'), esc_html__('Error', 'give'), array('response' => 400));
}
$customer_changed = false;
if (isset($data['give-new-customer']) && $data['give-new-customer'] == '1') {
$email = isset($data['give-new-customer-email']) ? sanitize_text_field($data['give-new-customer-email']) : '';
$names = isset($data['give-new-customer-name']) ? sanitize_text_field($data['give-new-customer-name']) : '';
if (empty($email) || empty($names)) {
wp_die(esc_html__('New Customers require a name and email address.', 'give'), esc_html__('Error', 'give'), array('response' => 400));
}
$customer = new Give_Customer($email);
if (empty($customer->id)) {
$customer_data = array('name' => $names, 'email' => $email);
$user_id = email_exists($email);
if (false !== $user_id) {
$customer_data['user_id'] = $user_id;
}
if (!$customer->create($customer_data)) {
// Failed to crete the new donor, assume the previous donor
$customer_changed = false;
$customer = new Give_Customer($curr_customer_id);
give_set_error('give-payment-new-customer-fail', esc_html__('Error creating new donor.', 'give'));
}
}
$new_customer_id = $customer->id;
$previous_customer = new Give_Customer($curr_customer_id);
$customer_changed = true;
} elseif ($curr_customer_id !== $new_customer_id) {
$customer = new Give_Customer($new_customer_id);
$email = $customer->email;
$names = $customer->name;
$previous_customer = new Give_Customer($curr_customer_id);
$customer_changed = true;
} else {
$customer = new Give_Customer($curr_customer_id);
$email = $customer->email;
$names = $customer->name;
}
// Setup first and last name from input values
$names = explode(' ', $names);
$first_name = !empty($names[0]) ? $names[0] : '';
$last_name = '';
if (!empty($names[1])) {
unset($names[0]);
$last_name = implode(' ', $names);
}
if ($customer_changed) {
// Remove the stats and payment from the previous customer and attach it to the new customer
$previous_customer->remove_payment($payment_id, false);
$customer->attach_payment($payment_id, false);
if ('publish' == $status) {
// Reduce previous user donation count and amount.
$previous_customer->decrease_purchase_count();
$previous_customer->decrease_value($curr_total);
// If purchase was completed adjust stats of new customers.
$customer->increase_purchase_count();
$customer->increase_value($new_total);
}
$payment->customer_id = $customer->id;
} else {
if ('publish' === $status) {
// Update user donation stat.
$customer->update_donation_value($curr_total, $new_total);
}
}
// Set new meta values
$payment->user_id = $customer->user_id;
$payment->email = $customer->email;
$payment->first_name = $first_name;
$payment->last_name = $last_name;
$payment->address = $address;
$payment->total = $new_total;
// Check for payment notes
if (!empty($data['give-payment-note'])) {
$note = wp_kses($data['give-payment-note'], array());
give_insert_payment_note($payment_id, $note);
}
// Set new status
$payment->status = $status;
// Adjust total store earnings if the payment total has been changed
if ($new_total !== $curr_total && 'publish' == $status) {
if ($new_total > $curr_total) {
// Increase if our new total is higher
$difference = $new_total - $curr_total;
give_increase_total_earnings($difference);
} elseif ($curr_total > $new_total) {
// Decrease if our new total is lower
$difference = $curr_total - $new_total;
give_decrease_total_earnings($difference);
}
}
$payment->save();
// Get new give form ID.
$new_form_id = absint($data['forms']);
$current_form_id = absint($payment->get_meta('_give_payment_form_id'));
// We are adding payment transfer code in last to remove any conflict with above functionality.
// For example: above code will automatically handle form stat (increase/decrease) when payment status changes.
/* Check if user want to transfer current payment to new give form id. */
if ($new_form_id != $current_form_id) {
// Get new give form title.
$new_form_title = get_the_title($new_form_id);
// Update new give form data in payment data.
$payment_meta = $payment->get_meta();
$payment_meta['form_title'] = $new_form_title;
$payment_meta['form_id'] = $new_form_id;
// Update price id post meta data for set donation form.
if (!give_has_variable_prices($new_form_id)) {
$payment_meta['price_id'] = '';
}
// Update payment give form meta data.
$payment->update_meta('_give_payment_form_id', $new_form_id);
$payment->update_meta('_give_payment_form_title', $new_form_title);
$payment->update_meta('_give_payment_meta', $payment_meta);
// Update price id payment metadata.
if (!give_has_variable_prices($new_form_id)) {
$payment->update_meta('_give_payment_price_id', '');
}
// If purchase was completed, adjust stats of forms
if ('publish' == $status) {
// Decrease sale of old give form. For other payment status
$current_form = new Give_Donate_Form($current_form_id);
$current_form->decrease_sales();
$current_form->decrease_earnings($curr_total);
// Increase sale of new give form.
$new_form = new Give_Donate_Form($new_form_id);
$new_form->increase_sales();
$new_form->increase_earnings($new_total);
}
// Re setup payment to update new meta value in object.
$payment->update_payment_setup($payment->ID);
}
// Update price id if current form is variable form.
if (!empty($data['give-variable-price']) && give_has_variable_prices($payment->form_id)) {
// Get payment meta data.
$payment_meta = $payment->get_meta();
// Set payment id to empty string if variable price id is negative ( i.e. custom amount feature enabled ).
$data['give-variable-price'] = 'custom' === $data['give-variable-price'] ? 'custom' : 0 < $data['give-variable-price'] ? $data['give-variable-price'] : '';
// Update payment meta data.
$payment_meta['price_id'] = $data['give-variable-price'];
// Update payment give form meta data.
$payment->update_meta('_give_payment_price_id', $data['give-variable-price']);
$payment->update_meta('_give_payment_meta', $payment_meta);
// Re setup payment to update new meta value in object.
$payment->update_payment_setup($payment->ID);
}
/**
* Fires after updating edited purchase.
*
* @since 1.0
*
* @param int $payment_id The ID of the payment.
*/
do_action('give_updated_edited_purchase', $payment_id);
wp_safe_redirect(admin_url('edit.php?post_type=give_forms&page=give-payment-history&view=view-order-details&give-message=payment-updated&id=' . $payment_id));
exit;
}
