3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Contribute_BAO_ContributionRecur
extends CRM_Contribute_DAO_ContributionRecur
{
20 * Create recurring contribution.
22 * @param array $params
23 * (reference ) an assoc array of name/value pairs.
26 * activity contact object
28 public static function create(&$params) {
29 return self
::add($params);
33 * Takes an associative array and creates a contribution object.
35 * the function extract all the params it needs to initialize the create a
36 * contribution object. the params array could contain additional unused name/value
39 * @param array $params
40 * (reference ) an assoc array of name/value pairs.
42 * @return \CRM_Contribute_BAO_ContributionRecur|\CRM_Core_Error
43 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
45 public static function add(&$params) {
46 if (!empty($params['id'])) {
47 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
50 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
53 // make sure we're not creating a new recurring contribution with the same transaction ID
54 // or invoice ID as an existing recurring contribution
56 if (self
::checkDuplicate($params, $duplicates)) {
57 $error = CRM_Core_Error
::singleton();
58 $d = implode(', ', $duplicates);
59 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
62 "Found matching recurring contribution(s): $d"
67 $recurring = new CRM_Contribute_BAO_ContributionRecur();
68 $recurring->copyValues($params);
69 $recurring->id
= $params['id'] ??
NULL;
71 // set currency for CRM-1496
72 if (empty($params['id']) && !isset($recurring->currency
)) {
73 $config = CRM_Core_Config
::singleton();
74 $recurring->currency
= $config->defaultCurrency
;
78 if (!empty($params['id'])) {
79 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
82 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
85 if (!empty($params['custom']) &&
86 is_array($params['custom'])
88 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution_recur', $recurring->id
);
95 * Check if there is a recurring contribution with the same trxn_id or invoice_id.
97 * @param array $params
98 * (reference ) an assoc array of name/value pairs.
99 * @param array $duplicates
100 * (reference ) store ids of duplicate contributions.
103 * true if duplicate, false otherwise
105 public static function checkDuplicate($params, &$duplicates) {
106 $id = $params['id'] ??
NULL;
107 $trxn_id = $params['trxn_id'] ??
NULL;
108 $invoice_id = $params['invoice_id'] ??
NULL;
114 $clause[] = "trxn_id = %1";
115 $params[1] = [$trxn_id, 'String'];
119 $clause[] = "invoice_id = %2";
120 $params[2] = [$invoice_id, 'String'];
123 if (empty($clause)) {
127 $clause = implode(' OR ', $clause);
129 $clause = "( $clause ) AND id != %3";
130 $params[3] = [$id, 'Integer'];
133 $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
134 $dao = CRM_Core_DAO
::executeQuery($query, $params);
136 while ($dao->fetch()) {
137 $duplicates[] = $dao->id
;
144 * Get the payment processor (array) for a recurring processor.
150 public static function getPaymentProcessor($id) {
151 $paymentProcessorID = self
::getPaymentProcessorID($id);
152 return CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID);
156 * Get the processor object for the recurring contribution record.
160 * @return CRM_Core_Payment|NULL
161 * Returns a processor object or NULL if the processor is disabled.
162 * Note this returns the 'Manual' processor object if no processor is attached
163 * (since it still makes sense to update / cancel
165 public static function getPaymentProcessorObject($id) {
166 $processor = self
::getPaymentProcessor($id);
167 return is_array($processor) ?
$processor['object'] : NULL;
171 * Get the payment processor for the given recurring contribution.
173 * @param int $recurID
176 * Payment processor id. If none found return 0 which represents the
177 * pseudo processor used for pay-later.
179 public static function getPaymentProcessorID($recurID) {
180 $recur = civicrm_api3('ContributionRecur', 'getsingle', [
182 'return' => ['payment_processor_id'],
184 return (int) ($recur['payment_processor_id'] ??
0);
188 * Get the number of installment done/completed for each recurring contribution.
191 * (reference ) an array of recurring contribution ids.
194 * an array of recurring ids count
196 public static function getCount(&$ids) {
197 $recurID = implode(',', $ids);
201 SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
202 FROM civicrm_contribution
203 WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
204 GROUP BY contribution_recur_id";
206 $res = CRM_Core_DAO
::executeQuery($query);
208 while ($res->fetch()) {
209 $totalCount[$res->contribution_recur_id
] = $res->commpleted
;
215 * Delete Recurring contribution.
217 * @param int $recurId
221 public static function deleteRecurContribution($recurId) {
227 $recur = new CRM_Contribute_DAO_ContributionRecur();
228 $recur->id
= $recurId;
229 $result = $recur->delete();
235 * Cancel Recurring contribution.
237 * @param array $params
238 * Recur contribution params
242 public static function cancelRecurContribution($params) {
243 if (is_numeric($params)) {
244 CRM_Core_Error
::deprecatedFunctionWarning('You are using a BAO function whose signature has changed. Please use the ContributionRecur.cancel api');
245 $params = ['id' => $params];
247 $recurId = $params['id'];
252 'subject' => !empty($params['membership_id']) ?
ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'),
253 'details' => $params['processor_message'] ??
NULL,
256 $cancelledId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Cancelled');
257 $recur = new CRM_Contribute_DAO_ContributionRecur();
258 $recur->id
= $recurId;
259 $recur->whereAdd("contribution_status_id != $cancelledId");
261 if ($recur->find(TRUE)) {
262 $transaction = new CRM_Core_Transaction();
263 $recur->contribution_status_id
= $cancelledId;
264 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
265 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
266 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
267 $recur->cancel_reason
= $params['cancel_reason'] ??
NULL;
268 $recur->cancel_date
= date('YmdHis');
271 // @fixme https://lab.civicrm.org/dev/core/issues/927 Cancelling membership etc is not desirable for all use-cases and we should be able to disable it
272 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
273 if ($dao && $dao->recur_id
) {
274 $details = $activityParams['details'] ??
NULL;
275 if ($dao->auto_renew
&& $dao->membership_id
) {
276 // its auto-renewal membership mode
277 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
278 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
279 $membershipType = $membershipTypes[$membershipType] ??
NULL;
281 <br/>' . ts('Automatic renewal of %1 membership cancelled.', [1 => $membershipType]);
284 $details .= '<br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', [
286 2 => $dao->frequency_interval
,
287 3 => $dao->frequency_unit
,
291 'source_contact_id' => $dao->contact_id
,
292 'source_record_id' => $dao->recur_id
,
293 'activity_type_id' => 'Cancel Recurring Contribution',
294 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
295 'details' => $details,
296 'status_id' => 'Completed',
299 $cid = CRM_Core_Session
::singleton()->get('userID');
301 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
302 $activityParams['source_contact_id'] = $cid;
304 civicrm_api3('Activity', 'create', $activityParams);
307 $transaction->commit();
311 // if already cancelled, return true
313 $recur->whereAdd("contribution_status_id = $cancelledId");
314 if ($recur->find(TRUE)) {
323 * @param int $entityID
324 * @param string $entity
326 * @return null|Object
328 public static function getSubscriptionDetails($entityID, $entity = 'recur') {
329 // Note: processor_id used to be aliased as subscription_id so we include it here
330 // both as processor_id and subscription_id for legacy compatibility.
332 SELECT rec.id as recur_id,
333 rec.processor_id as subscription_id,
335 rec.frequency_interval,
343 rec.financial_type_id,
344 rec.next_sched_contribution_date,
345 rec.failure_retry_date,
347 con.id as contribution_id,
348 con.contribution_page_id,
352 if ($entity == 'recur') {
354 FROM civicrm_contribution_recur rec
355 LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
356 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
359 elseif ($entity == 'contribution') {
361 FROM civicrm_contribution con
362 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
363 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
366 elseif ($entity == 'membership') {
368 FROM civicrm_membership_payment mp
369 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
370 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
371 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
372 WHERE mp.membership_id = %1";
375 $dao = CRM_Core_DAO
::executeQuery($sql, [1 => [$entityID, 'Integer']]);
385 * Does the recurring contribution support financial type change.
387 * This is conditional on there being only one line item or if there are no contributions as yet.
389 * (This second is a bit of an unusual condition but might occur in the context of a
395 public static function supportsFinancialTypeChange($id) {
396 // At this stage only sites with no Financial ACLs will have the opportunity to edit the financial type.
397 // this is to limit the scope of the change and because financial ACLs are still fairly new & settling down.
398 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
401 $contribution = self
::getTemplateContribution($id);
402 return CRM_Contribute_BAO_Contribution
::isSingleLineItem($contribution['id']);
406 * Get the contribution to be used as the template for later contributions.
408 * Later we might merge in data stored against the contribution recur record rather than just return the contribution.
411 * @param array $overrides
412 * Parameters that should be overriden. Add unit tests if using parameters other than total_amount & financial_type_id.
416 * @throws \CiviCRM_API3_Exception
417 * @throws \Civi\API\Exception\UnauthorizedException
418 * @throws \API_Exception
420 public static function getTemplateContribution($id, $overrides = []) {
421 // use api3 because api4 doesn't handle ContributionRecur yet...
422 $is_test = civicrm_api3('ContributionRecur', 'getvalue', [
423 'return' => "is_test",
426 // First look for new-style template contribution with is_template=1
427 $templateContributions = \Civi\Api4\Contribution
::get(FALSE)
428 ->addWhere('contribution_recur_id', '=', $id)
429 ->addWhere('is_template', '=', 1)
430 ->addWhere('is_test', '=', $is_test)
431 ->addOrderBy('id', 'DESC')
434 if (!$templateContributions->count()) {
435 // Fall back to old style template contributions
436 $templateContributions = \Civi\Api4\Contribution
::get(FALSE)
437 ->addWhere('contribution_recur_id', '=', $id)
438 ->addWhere('is_test', '=', $is_test)
439 ->addOrderBy('id', 'DESC')
443 if ($templateContributions->count()) {
444 $templateContribution = $templateContributions->first();
445 $result = array_merge($templateContribution, $overrides);
446 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($templateContribution['id']);
447 $result['line_item'] = self
::reformatLineItemsForRepeatContribution($result['total_amount'], $result['financial_type_id'], $lineItems, (array) $templateContribution);
453 public static function setSubscriptionContext() {
454 // handle context redirection for subscription url
455 $session = CRM_Core_Session
::singleton();
456 if ($session->get('userID')) {
458 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
459 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer');
460 $qfkey = CRM_Utils_Request
::retrieve('key', 'String');
461 $context = CRM_Utils_Request
::retrieve('context', 'Alphanumeric');
465 $url = CRM_Utils_System
::url('civicrm/contact/view',
466 "reset=1&selectedChild=contribute&cid={$cid}"
471 $url = CRM_Utils_System
::url('civicrm/contact/view',
472 "reset=1&selectedChild=member&cid={$cid}"
477 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
484 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
488 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
493 $session->pushUserContext($url);
499 * CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
501 * @param array $fields
502 * The input form values.
503 * @param array $files
504 * The uploaded files if any.
505 * @param CRM_Core_Form $self
506 * @param array $errors
508 public static function validateRecurContribution($fields, $files, $self, &$errors) {
509 if (!empty($fields['is_recur'])) {
510 if ($fields['frequency_interval'] <= 0) {
511 $errors['frequency_interval'] = ts('Please enter a number for how often you want to make this recurring contribution (EXAMPLE: Every 3 months).');
513 if ($fields['frequency_unit'] == '0') {
514 $errors['frequency_unit'] = ts('Please select a period (e.g. months, years ...) for how often you want to make this recurring contribution (EXAMPLE: Every 3 MONTHS).');
520 * Send start or end notification for recurring payments.
523 * @param CRM_Contribute_BAO_ContributionRecur $recur
524 * @param bool $isFirstOrLastRecurringPayment
526 public static function sendRecurringStartOrEndNotification($ids, $recur, $isFirstOrLastRecurringPayment) {
527 if ($isFirstOrLastRecurringPayment) {
528 $autoRenewMembership = FALSE;
530 isset($ids['membership']) && $ids['membership']
532 $autoRenewMembership = TRUE;
535 //send recurring Notification email for user
536 CRM_Contribute_BAO_ContributionPage
::recurringNotify($isFirstOrLastRecurringPayment,
538 $ids['contributionPage'],
546 * Copy custom data of the initial contribution into its recurring contributions.
550 * @param int $recurId
551 * @param int $targetContributionId
553 public static function copyCustomValues($recurId, $targetContributionId) {
554 if ($recurId && $targetContributionId) {
555 // get the initial contribution id of recur id
556 $sourceContributionId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
558 // if the same contribution is being processed then return
559 if ($sourceContributionId == $targetContributionId) {
562 // check if proper recurring contribution record is being processed
563 $targetConRecurId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id');
564 if ($targetConRecurId != $recurId) {
569 $extends = ['Contribution'];
570 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
572 foreach ($groupTree as $groupID => $group) {
573 $table[$groupTree[$groupID]['table_name']] = ['entity_id'];
574 foreach ($group['fields'] as $fieldID => $field) {
575 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
579 foreach ($table as $tableName => $tableColumns) {
580 $insert = 'INSERT IGNORE INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
581 $tableColumns[0] = $targetContributionId;
582 $select = 'SELECT ' . implode(', ', $tableColumns);
583 $from = ' FROM ' . $tableName;
584 $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}";
585 $query = $insert . $select . $from . $where;
586 CRM_Core_DAO
::executeQuery($query);
593 * Add soft credit to for recurring payment.
595 * copy soft credit record of first recurring contribution.
596 * and add new soft credit against $targetContributionId
598 * @param int $recurId
599 * @param int $targetContributionId
601 public static function addrecurSoftCredit($recurId, $targetContributionId) {
602 $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
603 $soft_contribution->contribution_id
= CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
605 // Check if first recurring contribution has any associated soft credit.
606 if ($soft_contribution->find(TRUE)) {
607 $soft_contribution->contribution_id
= $targetContributionId;
608 unset($soft_contribution->id
);
609 $soft_contribution->save();
614 * Add line items for recurring contribution.
616 * @param int $recurId
617 * @param \CRM_Contribute_BAO_Contribution $contribution
620 * @throws \CRM_Core_Exception
621 * @throws \CiviCRM_API3_Exception
623 public static function addRecurLineItems($recurId, $contribution) {
624 $foundLineItems = FALSE;
626 $lineSets = self
::calculateRecurLineItems($recurId, $contribution->total_amount
, $contribution->financial_type_id
);
627 foreach ($lineSets as $lineItems) {
628 if (!empty($lineItems)) {
629 foreach ($lineItems as $key => $value) {
630 if ($value['entity_table'] == 'civicrm_membership') {
632 // @todo this should be done by virtue of editing the line item as this link
633 // is deprecated. This may be the case but needs testing.
634 civicrm_api3('membership_payment', 'create', [
635 'membership_id' => $value['entity_id'],
636 'contribution_id' => $contribution->id
,
637 'is_transactional' => FALSE,
640 catch (CiviCRM_API3_Exception
$e) {
641 // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data
642 // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated
646 $foundLineItems = TRUE;
649 if (!$foundLineItems) {
650 CRM_Price_BAO_LineItem
::processPriceSet($contribution->id
, $lineSets, $contribution);
656 * Update pledge associated with a recurring contribution.
658 * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
660 * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution
661 * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge &
662 * it should be assumed they
663 * do so with the intention that all payments will be linked
665 * The pledge payment record should already exist & will need to be updated with the new contribution ID.
666 * If not the contribution will also need to be linked to the pledge
668 * @param int $contributionID
669 * @param int $contributionRecurID
670 * @param int $contributionStatusID
671 * @param float $contributionAmount
673 * @throws \CiviCRM_API3_Exception
675 public static function updateRecurLinkedPledge($contributionID, $contributionRecurID, $contributionStatusID, $contributionAmount) {
676 $returnProperties = ['id', 'pledge_id'];
677 $paymentDetails = $paymentIDs = [];
679 if (CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contributionID,
680 $paymentDetails, $returnProperties
683 foreach ($paymentDetails as $key => $value) {
684 $paymentIDs[] = $value['id'];
685 $pledgeId = $value['pledge_id'];
689 //payment is not already linked - if it is linked with a pledge we need to create a link.
690 // return if it is not recurring contribution
691 if (!$contributionRecurID) {
695 $relatedContributions = new CRM_Contribute_DAO_Contribution();
696 $relatedContributions->contribution_recur_id
= $contributionRecurID;
697 $relatedContributions->find();
699 while ($relatedContributions->fetch()) {
700 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id
,
701 $paymentDetails, $returnProperties
705 if (empty($paymentDetails)) {
706 // payment is not linked with a pledge and neither are any other contributions on this
710 foreach ($paymentDetails as $key => $value) {
711 $pledgeId = $value['pledge_id'];
714 // we have a pledge now we need to get the oldest unpaid payment
715 $paymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($pledgeId);
716 if (empty($paymentDetails['id'])) {
717 // we can assume this pledge is now completed
718 // return now so we don't create a core error & roll back
721 $paymentDetails['contribution_id'] = $contributionID;
722 $paymentDetails['status_id'] = $contributionStatusID;
723 $paymentDetails['actual_amount'] = $contributionAmount;
725 // put contribution against it
726 $payment = civicrm_api3('PledgePayment', 'create', $paymentDetails);
727 $paymentIDs[] = $payment['id'];
730 // update pledge and corresponding payment statuses
731 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contributionStatusID,
732 NULL, $contributionAmount
737 * @param CRM_Core_Form $form
739 public static function recurringContribution(&$form) {
740 // Recurring contribution fields
741 foreach (self
::getRecurringFields() as $key) {
742 if ($key == 'contribution_recur_payment_made' && !empty($form->_formValues
) &&
743 !CRM_Utils_System
::isNull(CRM_Utils_Array
::value($key, $form->_formValues
))
745 $form->assign('contribution_recur_pane_open', TRUE);
748 // If data has been entered for a recurring field, tell the tpl layer to open the pane
749 if (!empty($form->_formValues
) && !empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
750 $form->assign('contribution_recur_pane_open', TRUE);
755 // If values have been supplied for recurring contribution fields, open the recurring contributions pane.
756 foreach (['contribution_status_id', 'payment_processor_id', 'processor_id', 'trxn_id'] as $fieldName) {
757 if (!empty($form->_formValues
['contribution_recur_' . $fieldName])) {
758 $form->assign('contribution_recur_pane_open', TRUE);
763 // Add field to check if payment is made for recurring contribution
764 $recurringPaymentOptions = [
765 1 => ts('All recurring contributions'),
766 2 => ts('Recurring contributions with at least one payment'),
768 $form->addRadio('contribution_recur_payment_made', NULL, $recurringPaymentOptions, ['allowClear' => TRUE]);
770 // Add field for contribution status
771 $form->addSelect('contribution_recur_contribution_status_id',
772 ['entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'search')]
775 $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id'));
776 $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id'));
778 $paymentProcessorOpts = CRM_Contribute_BAO_ContributionRecur
::buildOptions('payment_processor_id', 'get');
779 $form->add('select', 'contribution_recur_payment_processor_id', ts('Payment Processor ID'), $paymentProcessorOpts, FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple']);
781 CRM_Core_BAO_Query
::addCustomFormFields($form, ['ContributionRecur']);
786 * Get the metadata for fields to be included on the search form.
788 * @throws \CiviCRM_API3_Exception
790 public static function getContributionRecurSearchFieldMetadata() {
792 'contribution_recur_start_date',
793 'contribution_recur_next_sched_contribution_date',
794 'contribution_recur_cancel_date',
795 'contribution_recur_end_date',
796 'contribution_recur_create_date',
797 'contribution_recur_modified_date',
798 'contribution_recur_failure_retry_date',
800 $metadata = civicrm_api3('ContributionRecur', 'getfields', [])['values'];
801 return array_intersect_key($metadata, array_flip($fields));
805 * Get fields for recurring contributions.
809 public static function getRecurringFields() {
811 'contribution_recur_payment_made',
812 'contribution_recur_start_date',
813 'contribution_recur_next_sched_contribution_date',
814 'contribution_recur_cancel_date',
815 'contribution_recur_end_date',
816 'contribution_recur_create_date',
817 'contribution_recur_modified_date',
818 'contribution_recur_failure_retry_date',
823 * Update recurring contribution based on incoming payment.
825 * Do not rename or move this function without updating https://issues.civicrm.org/jira/browse/CRM-17655.
827 * @param int $recurringContributionID
828 * @param string $paymentStatus
829 * Payment status - this correlates to the machine name of the contribution status ID ie
832 * @param string $effectiveDate
834 * @throws \CiviCRM_API3_Exception
836 public static function updateOnNewPayment($recurringContributionID, $paymentStatus, $effectiveDate) {
838 if (!in_array($paymentStatus, ['Completed', 'Failed'])) {
842 'id' => $recurringContributionID,
844 'contribution_status_id',
845 'next_sched_contribution_date',
847 'frequency_interval',
853 $existing = civicrm_api3('ContributionRecur', 'getsingle', $params);
855 if ($paymentStatus == 'Completed'
856 && CRM_Contribute_PseudoConstant
::contributionStatus($existing['contribution_status_id'], 'name') == 'Pending') {
857 $params['contribution_status_id'] = 'In Progress';
859 if ($paymentStatus == 'Failed') {
860 $params['failure_count'] = $existing['failure_count'];
862 $params['modified_date'] = date('Y-m-d H:i:s');
864 if (!empty($existing['installments']) && self
::isComplete($recurringContributionID, $existing['installments'])) {
865 $params['contribution_status_id'] = 'Completed';
866 $params['next_sched_contribution_date'] = 'null';
869 // Only update next sched date if it's empty or up to 48 hours away because payment processors may be managing
870 // the scheduled date themselves as core did not previously provide any help. This check can possibly be removed
871 // as it's unclear if it actually is helpful...
872 // We should allow payment processors to pass this value into repeattransaction in future.
873 // Note 48 hours is a bit aribtrary but means that we can hopefully ignore the time being potentially
874 // rounded down to midnight.
875 $upperDateToConsiderProcessed = strtotime('+ 48 hours', ($effectiveDate ?
strtotime($effectiveDate) : time()));
876 if (empty($existing['next_sched_contribution_date']) ||
strtotime($existing['next_sched_contribution_date']) <=
877 $upperDateToConsiderProcessed) {
878 $params['next_sched_contribution_date'] = date('Y-m-d', strtotime('+' . $existing['frequency_interval'] . ' ' . $existing['frequency_unit'], strtotime($effectiveDate)));
881 civicrm_api3('ContributionRecur', 'create', $params);
885 * Is this recurring contribution now complete.
887 * Have all the payments expected been received now.
889 * @param int $recurringContributionID
890 * @param int $installments
894 protected static function isComplete($recurringContributionID, $installments) {
895 $paidInstallments = CRM_Core_DAO
::singleValueQuery(
896 'SELECT count(*) FROM civicrm_contribution
897 WHERE contribution_recur_id = %1
898 AND contribution_status_id = ' . CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
899 [1 => [$recurringContributionID, 'Integer']]
901 if ($paidInstallments >= $installments) {
908 * Calculate line items for the relevant recurring calculation.
910 * @param int $recurId
911 * @param string $total_amount
912 * @param int $financial_type_id
915 * @throws \CiviCRM_API3_Exception
917 public static function calculateRecurLineItems($recurId, $total_amount, $financial_type_id) {
918 $originalContribution = civicrm_api3('Contribution', 'getsingle', [
919 'contribution_recur_id' => $recurId,
920 'contribution_test' => '',
921 'options' => ['limit' => 1],
922 'return' => ['id', 'financial_type_id'],
924 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($originalContribution['id']);
925 return self
::reformatLineItemsForRepeatContribution($total_amount, $financial_type_id, $lineItems, $originalContribution);
929 * Returns array with statuses that are considered to make a recurring contribution inactive.
933 public static function getInactiveStatuses() {
934 return ['Cancelled', 'Failed', 'Completed'];
940 public static function buildOptions($fieldName, $context = NULL, $props = []) {
942 switch ($fieldName) {
943 case 'payment_processor_id':
944 if (isset(\Civi
::$statics[__CLASS__
]['buildoptions_payment_processor_id'])) {
945 return \Civi
::$statics[__CLASS__
]['buildoptions_payment_processor_id'];
947 $baoName = 'CRM_Contribute_BAO_ContributionRecur';
948 $params['condition']['test'] = "is_test = 0";
949 $liveProcessors = CRM_Core_PseudoConstant
::get($baoName, $fieldName, $params, $context);
950 $params['condition']['test'] = "is_test != 0";
951 $testProcessors = CRM_Core_PseudoConstant
::get($baoName, $fieldName, $params, $context);
952 foreach ($testProcessors as $key => $value) {
953 if ($context === 'validate') {
954 // @fixme: Ideally the names would be different in the civicrm_payment_processor table but they are not.
955 // So we append '_test' to the test one so that we can select the correct processor by name using the ContributionRecur.create API.
956 $testProcessors[$key] = $value . '_test';
959 $testProcessors[$key] = CRM_Core_TestEntity
::appendTestText($value);
962 $allProcessors = $liveProcessors +
$testProcessors;
963 ksort($allProcessors);
964 \Civi
::$statics[__CLASS__
]['buildoptions_payment_processor_id'] = $allProcessors;
965 return $allProcessors;
967 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
971 * Reformat line items for getTemplateContribution / repeat contribution.
973 * This is an extraction and may be subject to further cleanup.
975 * @param float $total_amount
976 * @param int $financial_type_id
977 * @param array $lineItems
978 * @param array $originalContribution
982 protected static function reformatLineItemsForRepeatContribution($total_amount, $financial_type_id, array $lineItems, array $originalContribution): array {
984 if (count($lineItems) == 1) {
985 foreach ($lineItems as $index => $lineItem) {
986 if ($lineItem['financial_type_id'] != $originalContribution['financial_type_id']) {
987 // CRM-20685, Repeattransaction produces incorrect Financial Type ID (in specific circumstance) - if number of lineItems = 1, So this conditional will set the financial_type_id as the original if line_item and contribution comes with different data.
988 $financial_type_id = $lineItem['financial_type_id'];
990 if ($financial_type_id) {
991 // CRM-17718 allow for possibility of changed financial type ID having been set prior to calling this.
992 $lineItem['financial_type_id'] = $financial_type_id;
994 $taxAmountMatches = FALSE;
995 if ((!empty($lineItem['tax_amount']) && ($lineItem['line_total'] +
$lineItem['tax_amount']) == $total_amount)) {
996 $taxAmountMatches = TRUE;
998 if ($lineItem['line_total'] != $total_amount && !$taxAmountMatches) {
999 // We are dealing with a changed amount! Per CRM-16397 we can work out what to do with these
1000 // if there is only one line item, and the UI should prevent this situation for those with more than one.
1001 $lineItem['line_total'] = $total_amount;
1002 $lineItem['unit_price'] = round($total_amount / $lineItem['qty'], 2);
1004 $priceField = new CRM_Price_DAO_PriceField();
1005 $priceField->id
= $lineItem['price_field_id'];
1006 $priceField->find(TRUE);
1007 $lineSets[$priceField->price_set_id
][$lineItem['price_field_id']] = $lineItem;
1010 // CRM-19309 if more than one then just pass them through:
1011 elseif (count($lineItems) > 1) {
1012 foreach ($lineItems as $index => $lineItem) {
1013 $lineSets[$index][$lineItem['price_field_id']] = $lineItem;