Skip to content

Commit

Permalink
[REF] Fix function signature to actually-used variables
Browse files Browse the repository at this point in the history
ids used to hold a whole lotta stuff. Now it just holds contributionRecurID.

This gets rid of ids as a param & just passes contributionRecurID
  • Loading branch information
Your Name committed May 7, 2021
1 parent 638fdb5 commit 5f31e5f
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 30 deletions.
11 changes: 2 additions & 9 deletions CRM/Contribute/BAO/Contribution.php
Original file line number Diff line number Diff line change
Expand Up @@ -4189,7 +4189,7 @@ public static function isSingleLineItem($id) {
* Moving it out of the BaseIPN class is just the first step.
*
* @param array $input
* @param array $ids
* @param int $recurringContributionID
* @param int|null $contributionID
* @param bool $isPostPaymentCreate
* Is this being called from the payment.create api. If so the api has taken care of financial entities.
Expand All @@ -4201,15 +4201,8 @@ public static function isSingleLineItem($id) {
* @throws \CRM_Core_Exception
* @throws \CiviCRM_API3_Exception
*/
public static function completeOrder($input, $ids, $contributionID, $isPostPaymentCreate = FALSE) {
public static function completeOrder($input, $recurringContributionID, $contributionID, $isPostPaymentCreate = FALSE) {
$transaction = new CRM_Core_Transaction();
// @todo see if we even need this - it's used further down to create an activity
// but the BAO layer should create that - we just need to add a test to cover it & can
// maybe remove $ids altogether.
$recurringContributionID = $ids['contributionRecur'];

// Unset ids just to make it clear it's not used again.
unset($ids);

$inputContributionWhiteList = [
'fee_amount',
Expand Down
5 changes: 1 addition & 4 deletions CRM/Core/Payment/AuthorizeNetIPN.php
Original file line number Diff line number Diff line change
Expand Up @@ -170,10 +170,7 @@ public function recur($input, $recur, $contribution, $first) {
return FALSE;
}

CRM_Contribute_BAO_Contribution::completeOrder($input, [
'participant' => NULL,
'contributionRecur' => $recur->id,
], $contribution->id ?? NULL);
CRM_Contribute_BAO_Contribution::completeOrder($input, $recur->id, $contribution->id ?? NULL);
return $isFirstOrLastRecurringPayment;
}

Expand Down
6 changes: 1 addition & 5 deletions CRM/Core/Payment/BaseIPN.php
Original file line number Diff line number Diff line change
Expand Up @@ -421,11 +421,7 @@ private function cancelMembership($membership, $membershipStatusID, $onlyCancelP
*/
public function completeTransaction($input, $ids, $objects) {
CRM_Core_Error::deprecatedFunctionWarning('Use Payment.create api');
CRM_Contribute_BAO_Contribution::completeOrder($input, [
'related_contact' => $ids['related_contact'] ?? NULL,
'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL,
'contributionRecur' => !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
], $objects['contribution']->id ?? NULL);
CRM_Contribute_BAO_Contribution::completeOrder($input, !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL, $objects['contribution']->id ?? NULL);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion CRM/Core/Payment/PayPalIPN.php
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ public function single($input, $ids, $contribution, $recur = FALSE) {
return;
}

CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $contribution->id ?? NULL);
CRM_Contribute_BAO_Contribution::completeOrder($input, $ids['contributionRecur'] ?? NULL, $contribution->id ?? NULL);
}

/**
Expand Down
2 changes: 1 addition & 1 deletion CRM/Core/Payment/PayPalProIPN.php
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ public function single($input, $ids, $contribution, $recur = FALSE, $first = FAL
return;
}

CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $contribution->id ?? NULL);
CRM_Contribute_BAO_Contribution::completeOrder($input, $ids['contributionRecur'] ?? NULL, $contribution->id ?? NULL);
}

/**
Expand Down
6 changes: 1 addition & 5 deletions CRM/Event/Form/Task/Batch.php
Original file line number Diff line number Diff line change
Expand Up @@ -358,11 +358,7 @@ public static function updateContributionStatus($params) {
//complete the contribution.
// @todo use the api - ie civicrm_api3('Contribution', 'completetransaction', $input);
// as this method is not preferred / supported.
CRM_Contribute_BAO_Contribution::completeOrder($input, [
'related_contact' => NULL,
'participant' => $params['component_id'],
'contributionRecur' => NULL,
], $contribution->id ?? NULL);
CRM_Contribute_BAO_Contribution::completeOrder($input, NULL, $contribution->id ?? NULL);

// reset template values before processing next transactions
$template->clearTemplateVars();
Expand Down
8 changes: 3 additions & 5 deletions api/v3/Contribution.php
Original file line number Diff line number Diff line change
Expand Up @@ -681,11 +681,9 @@ function _ipn_process_transaction($params, $contribution, $input, $ids) {
if (!empty($params['payment_instrument_id'])) {
$input['payment_instrument_id'] = $params['payment_instrument_id'];
}
return CRM_Contribute_BAO_Contribution::completeOrder($input, [
'related_contact' => $ids['related_contact'] ?? NULL,
'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL,
'contributionRecur' => !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
], $objects['contribution']->id ?? NULL,
return CRM_Contribute_BAO_Contribution::completeOrder($input,
!empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
$objects['contribution']->id ?? NULL,
$params['is_post_payment_create'] ?? NULL);
}

Expand Down

0 comments on commit 5f31e5f

Please sign in to comment.