Skip to content

ESEMM-28: Improvements For Contribution Fix Service #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shahrukh-compuco wants to merge 1 commit into from
Closed

ESEMM-28: Improvements For Contribution Fix Service #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CRM/Financeextras/Upgrader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ public function upgrade_1004(): bool {
try {
$contributionFix = new IncompleteContributionFixService();
$processedContributions = $contributionFix->execute();
$this->ctx->log->info(json_encode($processedContributions));
$this->ctx->log->info('processed contributions' . json_encode($processedContributions));

return TRUE;
}
Expand Down
121 changes: 97 additions & 24 deletions Civi/Financeextras/Service/IncompleteContributionFixService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@ public function execute(): array {
while ($affectedContributions->fetch()) {
$affectedContribution = $affectedContributions->toArray();
$linkedMembership = $this->fetchLinkedMembership((int) $affectedContribution['id']);
if (empty($linkedMembership)) {
continue;
}

$processedContributions[] = $affectedContribution;
$this->createFinancialTrxn($affectedContribution);
$lineItem = $this->createLineItem($affectedContribution, $linkedMembership);

Expand All @@ -29,6 +25,7 @@ public function execute(): array {
}

\CRM_Financial_BAO_FinancialItem::add((object) $lineItem[0], (object) $affectedContribution);
$processedContributions[] = $affectedContribution;
}

return $processedContributions;
Expand Down Expand Up @@ -68,27 +65,25 @@ private function createFinancialTrxn(array $contribution): void {
catch (\Throwable $e) {
$paymentProcessorId = 0;
}
$paymentInstrumentId = 'Credit Card';
$transactionIds = explode(',', $contribution['trxn_id']);
$lastTransactionId = $transactionIds[count($transactionIds) - 1];
$lastTransactionId = $transactionIds[count($transactionIds) - 1] ?? '';

$financialTrxns = \Civi\Api4\FinancialTrxn::get(FALSE)
->addWhere('trxn_id', '=', $contribution['trxn_id'])
->execute()
->getArrayCopy();
$financialTrxns = $this->getFinancialTrxnsByContributionId((int) $contribution['id']);

foreach ($financialTrxns as $financialTrxn) {
$paymentProcessorId = $financialTrxn['payment_processor_id'];
$paymentInstrumentId = $financialTrxn['payment_instrument_id'];
$paymentProcessorId = $financialTrxn['payment_processor_id'] ?? $paymentProcessorId;
if (number_format($financialTrxn['total_amount'], 2) === number_format($contribution['total_amount'], 2)) {
$createFinancialTrxn = FALSE;
break;
}
}

if ($createFinancialTrxn) {
$toFinancialAccountId = $this->getFinancialAccountByPaymentProcessorId((int) $paymentProcessorId);
$paymentInstrumentId = $this->getPaymentInstrumentByPaymentProcessorId((int) $paymentProcessorId);

civicrm_api3('FinancialTrxn', 'create', [
'to_financial_account_id' => 'Payment Processor Account',
'to_financial_account_id' => $toFinancialAccountId ?? 'Payment Processor Account',
'trxn_date' => $contribution['receive_date'],
'total_amount' => $contribution['total_amount'],
'fee_amount' => $contribution['fee_amount'],
Expand All @@ -97,7 +92,7 @@ private function createFinancialTrxn(array $contribution): void {
'is_payment' => 1,
'trxn_id' => $lastTransactionId,
'status_id' => 'Completed',
'payment_instrument_id' => $paymentInstrumentId,
'payment_instrument_id' => $paymentInstrumentId ?? key(\CRM_Core_OptionGroup::values('payment_instrument', FALSE, FALSE, FALSE, 'AND is_default = 1')),
'payment_processor_id' => $paymentProcessorId > 0 ? $paymentProcessorId : NULL,
'entity_id' => $contribution['id'],
'contribution_id' => $contribution['id'],
Expand All @@ -106,20 +101,32 @@ private function createFinancialTrxn(array $contribution): void {
}

private function createLineItem(array $contribution, array $membership): array {
$priceFieldValue = civicrm_api3('PriceFieldValue', 'get', [
'sequential' => 1,
'membership_type_id' => $membership['membership_id.membership_type_id'],
'options' => ['limit' => 1, 'sort' => "id asc"],
])['values'][0] ?? [];
if (isset($membership['membership_id.membership_type_id'], $membership['membership_id'])) {
$priceFieldValue = civicrm_api3('PriceFieldValue', 'get', [
'sequential' => 1,
'membership_type_id' => $membership['membership_id.membership_type_id'],
'options' => ['limit' => 1, 'sort' => "id asc"],
])['values'][0] ?? [];
if (empty($priceFieldValue)) {
$priceFieldValue = $this->getContributionPriceFieldValue();
}
$entityId = $membership['membership_id'];
$entityTable = 'civicrm_membership';
}
else {
$priceFieldValue = $this->getContributionPriceFieldValue();
$entityId = $contribution['id'];
$entityTable = 'civicrm_contribution';
}

$lineItem = civicrm_api3('LineItem', 'create', [
'sequential' => 1,
'entity_table' => 'civicrm_membership',
'entity_id' => $membership['membership_id'],
'entity_table' => $entityTable,
'entity_id' => $entityId,
'contribution_id' => $contribution['id'],
'price_field_id' => $priceFieldValue['price_field_id'],
'price_field_value_id' => $priceFieldValue['id'],
'label' => $priceFieldValue['name'],
'price_field_id' => $priceFieldValue['price_field_id'] ?? NULL,
'price_field_value_id' => $priceFieldValue['id'] ?? NULL,
'label' => $priceFieldValue['label'] ?? '',
'qty' => 1,
'unit_price' => $contribution['total_amount'],
'line_total' => $contribution['total_amount'],
Expand All @@ -129,4 +136,70 @@ private function createLineItem(array $contribution, array $membership): array {
return $lineItem['values'] ?? [];
}

private function getFinancialTrxnsByContributionId(int $contributionId): array {
$sql = "SELECT ft.*
FROM civicrm_financial_trxn ft
INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id
WHERE eft.entity_table = 'civicrm_contribution' AND eft.entity_id = {$contributionId}
ORDER BY ft.id ASC
";

return \CRM_Core_DAO::executeQuery($sql)->fetchAll();
}

private function getFinancialAccountByPaymentProcessorId(int $paymentProcessorId) {
$params = [
'return' => ['financial_account_id'],
'entity_table' => 'civicrm_payment_processor',
'entity_id' => $paymentProcessorId,
'options' => ['limit' => 1],
];

$result = civicrm_api3('EntityFinancialAccount', 'get', $params);
if ($result['count'] === 0) {
return NULL;
}

return $result['values'][$result['id']]['financial_account_id'];
}

private function getPaymentInstrumentByPaymentProcessorId(int $paymentProcessorId) {
$params = [
'return' => ['payment_instrument_id'],
'id' => $paymentProcessorId,
'is_test' => 0,
'options' => ['limit' => 1],
];

$result = civicrm_api3('PaymentProcessor', 'get', $params);
if ($result['count'] === 0) {
return NULL;
}

return $result['values'][$result['id']]['payment_instrument_id'];
}

private function getContributionPriceFieldValue(): array {
$priceFieldValue = [];
$priceSetId = \CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_contribution_amount', 'id', 'name');
$priceSet = current(\CRM_Price_BAO_PriceSet::getSetDetail($priceSetId));
$priceField = NULL;
if (empty($priceSet['fields'])) {
return $priceFieldValue;
}

foreach ($priceSet['fields'] as $field) {
if ($field['name'] == 'contribution_amount') {
$priceField = $field;
break;
}
}

if (empty($priceField)) {
return $priceFieldValue;
}

return !empty($priceField['options']) ? current($priceField['options']) : $priceFieldValue;
}

}