From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Wed, 27 Oct 2021 19:55:04 +0000 (+1300)
Subject: Move two more functions to financialProcessor
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=213cfa8a8df7b114571baabb0ffd87513ac536c2;p=civicrm-core.git
Move two more functions to financialProcessor
---
diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 5ae6f8b73e..8f1c8b07f0 100644
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -971,108 +971,6 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
])['values'];
}
- /**
- * Do any accounting updates required as a result of a contribution status change.
- *
- * Currently we have a bit of a roundabout where adding a payment results in this being called &
- * this may attempt to add a payment. We need to resolve that....
- *
- * The 'right' way to add payments or refunds is through the Payment.create api. That api
- * then updates the contribution but this process should not also record another financial trxn.
- * Currently we have weak detection fot that scenario & where it is detected the first returned
- * value is FALSE - meaning 'do not continue'.
- *
- * We should also look at the fact that the calling function - updateFinancialAccounts
- * bunches together some disparate processes rather than having separate appropriate
- * functions.
- *
- * @param array $params
- *
- * @return bool
- * Return indicates whether the updateFinancialAccounts function should continue.
- */
- private static function updateFinancialAccountsOnContributionStatusChange(&$params) {
- $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
- $currentContributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
-
- if ((($previousContributionStatus === 'Partially paid' && $currentContributionStatus === 'Completed')
- || ($previousContributionStatus === 'Pending refund' && $currentContributionStatus === 'Completed')
- // This concept of pay_later as different to any other sort of pending is deprecated & it's unclear
- // why it is here or where it is handled instead.
- || ($previousContributionStatus === 'Pending' && $params['prevContribution']->is_pay_later == TRUE
- && $currentContributionStatus === 'Partially paid'))
- ) {
- return FALSE;
- }
-
- if (CRM_Contribute_BAO_FinancialProcessor::isContributionUpdateARefund($params['prevContribution']->contribution_status_id, $params['contribution']->contribution_status_id)) {
- // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
- $params['trxnParams']['total_amount'] = -$params['total_amount'];
- }
- elseif (($previousContributionStatus === 'Pending'
- && $params['prevContribution']->is_pay_later) || $previousContributionStatus === 'In Progress'
- ) {
- $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
- $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
-
- if ($currentContributionStatus === 'Cancelled') {
- // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
- $params['trxnParams']['to_financial_account_id'] = $arAccountId;
- $params['trxnParams']['total_amount'] = -$params['total_amount'];
- }
- else {
- // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
- $params['trxnParams']['from_financial_account_id'] = $arAccountId;
- }
- }
-
- if (($previousContributionStatus === 'Pending'
- || $previousContributionStatus === 'In Progress')
- && ($currentContributionStatus === 'Completed')
- ) {
- if (empty($params['line_item'])) {
- //CRM-15296
- //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
- // when creating recurring membership payment - there are 2 lines to comment out in contributionPageTest if fixed
- // & this can be removed
- return FALSE;
- }
- // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
- // This is an update so original currency if none passed in.
- $params['trxnParams']['currency'] = CRM_Utils_Array::value('currency', $params, $params['prevContribution']->currency);
-
- $transactionIDs[] = CRM_Contribute_BAO_FinancialProcessor::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
- $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
- // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
- $params['entity_id'] = $transactionIDs[] = $trxn->id;
-
- $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
-
- $entityParams = [
- 'entity_table' => 'civicrm_financial_item',
- ];
- foreach ($params['line_item'] as $fieldId => $fields) {
- foreach ($fields as $fieldValueId => $lineItemDetails) {
- self::updateFinancialItemForLineItemToPaid($lineItemDetails['id']);
- $fparams = [
- 1 => [$lineItemDetails['id'], 'Integer'],
- ];
- $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
- while ($financialItem->fetch()) {
- $entityParams['entity_id'] = $financialItem->id;
- $entityParams['amount'] = $financialItem->amount;
- foreach ($transactionIDs as $tID) {
- $entityParams['financial_trxn_id'] = $tID;
- CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
- }
- }
- }
- }
- return FALSE;
- }
- return TRUE;
- }
-
/**
* It is possible to override the membership id that is updated from the payment processor.
*
@@ -1094,23 +992,6 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
}
}
- /**
- * Update all financial items related to the line item tto have a status of paid.
- *
- * @param int $lineItemID
- */
- private static function updateFinancialItemForLineItemToPaid($lineItemID) {
- $fparams = [
- 1 => [
- CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
- 'Integer',
- ],
- 2 => [$lineItemID, 'Integer'],
- ];
- $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
- CRM_Core_DAO::executeQuery($query, $fparams);
- }
-
/**
* Get transaction information about the contribution.
*
@@ -3431,7 +3312,7 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac
$params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
) {
//Update Financial Records
- $callUpdateFinancialAccounts = self::updateFinancialAccountsOnContributionStatusChange($params);
+ $callUpdateFinancialAccounts = CRM_Contribute_BAO_FinancialProcessor::updateFinancialAccountsOnContributionStatusChange($params);
if ($callUpdateFinancialAccounts) {
CRM_Contribute_BAO_FinancialProcessor::updateFinancialAccounts($params, 'changedStatus');
CRM_Core_BAO_FinancialTrxn::createDeferredTrxn(CRM_Utils_Array::value('line_item', $params), $params['contribution'], TRUE, 'changedStatus');
@@ -3448,7 +3329,7 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac
$params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
$params['trxnParams']['check_number'] = $params['check_number'] ?? NULL;
- if (self::isPaymentInstrumentChange($params, $pendingStatus)) {
+ if (CRM_Contribute_BAO_FinancialProcessor::isPaymentInstrumentChange($params, $pendingStatus)) {
$updated = CRM_Core_BAO_FinancialTrxn::updateFinancialAccountsOnPaymentInstrumentChange($params);
}
@@ -4312,46 +4193,6 @@ INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_ac
return self::getValues(['id' => $contributionID]);
}
- /**
- * Does this transaction reflect a payment instrument change.
- *
- * @param array $params
- * @param array $pendingStatuses
- *
- * @return bool
- */
- protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
- $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
-
- if (array_key_exists('payment_instrument_id', $params)) {
- if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
- !CRM_Utils_System::isNull($params['payment_instrument_id'])
- ) {
- //check if status is changed from Pending to Completed
- // do not update payment instrument changes for Pending to Completed
- if (!($contributionStatus == 'Completed' &&
- in_array($params['prevContribution']->contribution_status_id, $pendingStatuses))
- ) {
- return TRUE;
- }
- }
- elseif ((!CRM_Utils_System::isNull($params['payment_instrument_id']) &&
- !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
- $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
- ) {
- return TRUE;
- }
- elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
- $params['contribution']->check_number != $params['prevContribution']->check_number
- ) {
- // another special case when check number is changed, create new financial records
- // create financial trxn with negative amount
- return TRUE;
- }
- }
- return FALSE;
- }
-
/**
* Update the memberships associated with a contribution if it has been completed.
*
diff --git a/CRM/Contribute/BAO/FinancialProcessor.php b/CRM/Contribute/BAO/FinancialProcessor.php
index ab79988084..475caa8165 100644
--- a/CRM/Contribute/BAO/FinancialProcessor.php
+++ b/CRM/Contribute/BAO/FinancialProcessor.php
@@ -241,6 +241,125 @@ class CRM_Contribute_BAO_FinancialProcessor {
return CRM_Contribute_BAO_Contribution::isContributionStatusNegative($currentContributionStatusID);
}
+ /**
+ * Do any accounting updates required as a result of a contribution status change.
+ *
+ * Currently we have a bit of a roundabout where adding a payment results in this being called &
+ * this may attempt to add a payment. We need to resolve that....
+ *
+ * The 'right' way to add payments or refunds is through the Payment.create api. That api
+ * then updates the contribution but this process should not also record another financial trxn.
+ * Currently we have weak detection fot that scenario & where it is detected the first returned
+ * value is FALSE - meaning 'do not continue'.
+ *
+ * We should also look at the fact that the calling function - updateFinancialAccounts
+ * bunches together some disparate processes rather than having separate appropriate
+ * functions.
+ *
+ * @param array $params
+ *
+ * @return bool
+ * Return indicates whether the updateFinancialAccounts function should continue.
+ */
+ public static function updateFinancialAccountsOnContributionStatusChange(&$params) {
+ $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
+ $currentContributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
+
+ if ((($previousContributionStatus === 'Partially paid' && $currentContributionStatus === 'Completed')
+ || ($previousContributionStatus === 'Pending refund' && $currentContributionStatus === 'Completed')
+ // This concept of pay_later as different to any other sort of pending is deprecated & it's unclear
+ // why it is here or where it is handled instead.
+ || ($previousContributionStatus === 'Pending' && $params['prevContribution']->is_pay_later == TRUE
+ && $currentContributionStatus === 'Partially paid'))
+ ) {
+ return FALSE;
+ }
+
+ if (CRM_Contribute_BAO_FinancialProcessor::isContributionUpdateARefund($params['prevContribution']->contribution_status_id, $params['contribution']->contribution_status_id)) {
+ // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
+ $params['trxnParams']['total_amount'] = -$params['total_amount'];
+ }
+ elseif (($previousContributionStatus === 'Pending'
+ && $params['prevContribution']->is_pay_later) || $previousContributionStatus === 'In Progress'
+ ) {
+ $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
+ $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
+
+ if ($currentContributionStatus === 'Cancelled') {
+ // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
+ $params['trxnParams']['to_financial_account_id'] = $arAccountId;
+ $params['trxnParams']['total_amount'] = -$params['total_amount'];
+ }
+ else {
+ // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
+ $params['trxnParams']['from_financial_account_id'] = $arAccountId;
+ }
+ }
+
+ if (($previousContributionStatus === 'Pending'
+ || $previousContributionStatus === 'In Progress')
+ && ($currentContributionStatus === 'Completed')
+ ) {
+ if (empty($params['line_item'])) {
+ //CRM-15296
+ //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
+ // when creating recurring membership payment - there are 2 lines to comment out in contributionPageTest if fixed
+ // & this can be removed
+ return FALSE;
+ }
+ // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
+ // This is an update so original currency if none passed in.
+ $params['trxnParams']['currency'] = CRM_Utils_Array::value('currency', $params, $params['prevContribution']->currency);
+
+ $transactionIDs[] = CRM_Contribute_BAO_FinancialProcessor::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
+ $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
+ // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
+ $params['entity_id'] = $transactionIDs[] = $trxn->id;
+
+ $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
+
+ $entityParams = [
+ 'entity_table' => 'civicrm_financial_item',
+ ];
+ foreach ($params['line_item'] as $fieldId => $fields) {
+ foreach ($fields as $fieldValueId => $lineItemDetails) {
+ self::updateFinancialItemForLineItemToPaid($lineItemDetails['id']);
+ $fparams = [
+ 1 => [$lineItemDetails['id'], 'Integer'],
+ ];
+ $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
+ while ($financialItem->fetch()) {
+ $entityParams['entity_id'] = $financialItem->id;
+ $entityParams['amount'] = $financialItem->amount;
+ foreach ($transactionIDs as $tID) {
+ $entityParams['financial_trxn_id'] = $tID;
+ CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
+ }
+ }
+ }
+ }
+ return FALSE;
+ }
+ return TRUE;
+ }
+
+ /**
+ * Update all financial items related to the line item tto have a status of paid.
+ *
+ * @param int $lineItemID
+ */
+ private static function updateFinancialItemForLineItemToPaid($lineItemID) {
+ $fparams = [
+ 1 => [
+ CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
+ 'Integer',
+ ],
+ 2 => [$lineItemID, 'Integer'],
+ ];
+ $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
+ CRM_Core_DAO::executeQuery($query, $fparams);
+ }
+
/**
* Create Accounts Receivable financial trxn entry for Completed Contribution.
*
@@ -279,4 +398,44 @@ class CRM_Contribute_BAO_FinancialProcessor {
return $trxn->id;
}
+ /**
+ * Does this transaction reflect a payment instrument change.
+ *
+ * @param array $params
+ * @param array $pendingStatuses
+ *
+ * @return bool
+ */
+ public static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
+ $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
+
+ if (array_key_exists('payment_instrument_id', $params)) {
+ if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
+ !CRM_Utils_System::isNull($params['payment_instrument_id'])
+ ) {
+ //check if status is changed from Pending to Completed
+ // do not update payment instrument changes for Pending to Completed
+ if (!($contributionStatus == 'Completed' &&
+ in_array($params['prevContribution']->contribution_status_id, $pendingStatuses))
+ ) {
+ return TRUE;
+ }
+ }
+ elseif ((!CRM_Utils_System::isNull($params['payment_instrument_id']) &&
+ !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
+ $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
+ ) {
+ return TRUE;
+ }
+ elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
+ $params['contribution']->check_number != $params['prevContribution']->check_number
+ ) {
+ // another special case when check number is changed, create new financial records
+ // create financial trxn with negative amount
+ return TRUE;
+ }
+ }
+ return FALSE;
+ }
+
}