3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Contribute_BAO_ContributionRecur
extends CRM_Contribute_DAO_ContributionRecur
{
36 * Array with statuses that mark a recurring contribution as inactive.
40 private static $inactiveStatuses = array('Cancelled', 'Chargeback', 'Refunded', 'Completed');
43 * Create recurring contribution.
45 * @param array $params
46 * (reference ) an assoc array of name/value pairs.
49 * activity contact object
51 public static function create(&$params) {
52 return self
::add($params);
56 * Takes an associative array and creates a contribution object.
58 * the function extract all the params it needs to initialize the create a
59 * contribution object. the params array could contain additional unused name/value
62 * @param array $params
63 * (reference ) an assoc array of name/value pairs.
65 * @return \CRM_Contribute_BAO_ContributionRecur|\CRM_Core_Error
66 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
68 public static function add(&$params) {
69 if (!empty($params['id'])) {
70 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
73 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
76 // make sure we're not creating a new recurring contribution with the same transaction ID
77 // or invoice ID as an existing recurring contribution
78 $duplicates = array();
79 if (self
::checkDuplicate($params, $duplicates)) {
80 $error = CRM_Core_Error
::singleton();
81 $d = implode(', ', $duplicates);
82 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
85 "Found matching recurring contribution(s): $d"
90 $recurring = new CRM_Contribute_BAO_ContributionRecur();
91 $recurring->copyValues($params);
92 $recurring->id
= CRM_Utils_Array
::value('id', $params);
94 // set currency for CRM-1496
95 if (empty($params['id']) && !isset($recurring->currency
)) {
96 $config = CRM_Core_Config
::singleton();
97 $recurring->currency
= $config->defaultCurrency
;
99 $result = $recurring->save();
101 if (!empty($params['id'])) {
102 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
105 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
108 if (!empty($params['custom']) &&
109 is_array($params['custom'])
111 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution_recur', $recurring->id
);
118 * Check if there is a recurring contribution with the same trxn_id or invoice_id.
120 * @param array $params
121 * (reference ) an assoc array of name/value pairs.
122 * @param array $duplicates
123 * (reference ) store ids of duplicate contributions.
126 * true if duplicate, false otherwise
128 public static function checkDuplicate($params, &$duplicates) {
129 $id = CRM_Utils_Array
::value('id', $params);
130 $trxn_id = CRM_Utils_Array
::value('trxn_id', $params);
131 $invoice_id = CRM_Utils_Array
::value('invoice_id', $params);
137 $clause[] = "trxn_id = %1";
138 $params[1] = array($trxn_id, 'String');
142 $clause[] = "invoice_id = %2";
143 $params[2] = array($invoice_id, 'String');
146 if (empty($clause)) {
150 $clause = implode(' OR ', $clause);
152 $clause = "( $clause ) AND id != %3";
153 $params[3] = array($id, 'Integer');
156 $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
157 $dao = CRM_Core_DAO
::executeQuery($query, $params);
159 while ($dao->fetch()) {
160 $duplicates[] = $dao->id
;
167 * Get the payment processor (array) for a recurring processor.
170 * @param string $mode
171 * - Test or NULL - all other variants are ignored.
175 public static function getPaymentProcessor($id, $mode = NULL) {
177 SELECT r.payment_processor_id
178 FROM civicrm_contribution_recur r
180 $params = array(1 => array($id, 'Integer'));
181 $paymentProcessorID = CRM_Core_DAO
::singleValueQuery($sql,
184 if (!$paymentProcessorID) {
188 return CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID, $mode);
192 * Get the number of installment done/completed for each recurring contribution.
195 * (reference ) an array of recurring contribution ids.
198 * an array of recurring ids count
200 public static function getCount(&$ids) {
201 $recurID = implode(',', $ids);
202 $totalCount = array();
205 SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
206 FROM civicrm_contribution
207 WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
208 GROUP BY contribution_recur_id";
210 $res = CRM_Core_DAO
::executeQuery($query);
212 while ($res->fetch()) {
213 $totalCount[$res->contribution_recur_id
] = $res->commpleted
;
219 * Delete Recurring contribution.
221 * @param int $recurId
225 public static function deleteRecurContribution($recurId) {
231 $recur = new CRM_Contribute_DAO_ContributionRecur();
232 $recur->id
= $recurId;
233 $result = $recur->delete();
239 * Cancel Recurring contribution.
241 * @param int $recurId
242 * Recur contribution id.
244 * @param array $activityParams
248 public static function cancelRecurContribution($recurId, $activityParams = array()) {
253 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
254 $canceledId = array_search('Cancelled', $contributionStatus);
255 $recur = new CRM_Contribute_DAO_ContributionRecur();
256 $recur->id
= $recurId;
257 $recur->whereAdd("contribution_status_id != $canceledId");
259 if ($recur->find(TRUE)) {
260 $transaction = new CRM_Core_Transaction();
261 $recur->contribution_status_id
= $canceledId;
262 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
263 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
264 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
265 $recur->cancel_date
= date('YmdHis');
268 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
269 if ($dao && $dao->recur_id
) {
270 $details = CRM_Utils_Array
::value('details', $activityParams);
271 if ($dao->auto_renew
&& $dao->membership_id
) {
272 // its auto-renewal membership mode
273 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
274 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
275 $membershipType = CRM_Utils_Array
::value($membershipType, $membershipTypes);
277 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
281 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
283 2 => $dao->frequency_interval
,
284 3 => $dao->frequency_unit
,
287 $activityParams = array(
288 'source_contact_id' => $dao->contact_id
,
289 'source_record_id' => $dao->recur_id
,
290 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Cancel Recurring Contribution'),
291 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
292 'details' => $details,
293 'activity_date_time' => date('YmdHis'),
294 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
296 $session = CRM_Core_Session
::singleton();
297 $cid = $session->get('userID');
299 $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
300 $activityParams['source_contact_id'] = $cid;
302 // @todo use the api & do less wrangling above
303 CRM_Activity_BAO_Activity
::create($activityParams);
306 $transaction->commit();
310 // if already cancelled, return true
312 $recur->whereAdd("contribution_status_id = $canceledId");
313 if ($recur->find(TRUE)) {
322 * @deprecated Get list of recurring contribution of contact Ids.
324 * @param int $contactId
328 * list of recurring contribution fields
331 public static function getRecurContributions($contactId) {
332 CRM_Core_Error
::deprecatedFunctionWarning('ContributionRecur.get API instead');
334 $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
335 $recurDAO->contact_id
= $contactId;
337 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
339 while ($recurDAO->fetch()) {
340 $params[$recurDAO->id
]['id'] = $recurDAO->id
;
341 $params[$recurDAO->id
]['contactId'] = $recurDAO->contact_id
;
342 $params[$recurDAO->id
]['start_date'] = $recurDAO->start_date
;
343 $params[$recurDAO->id
]['end_date'] = $recurDAO->end_date
;
344 $params[$recurDAO->id
]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date
;
345 $params[$recurDAO->id
]['amount'] = $recurDAO->amount
;
346 $params[$recurDAO->id
]['currency'] = $recurDAO->currency
;
347 $params[$recurDAO->id
]['frequency_unit'] = $recurDAO->frequency_unit
;
348 $params[$recurDAO->id
]['frequency_interval'] = $recurDAO->frequency_interval
;
349 $params[$recurDAO->id
]['installments'] = $recurDAO->installments
;
350 $params[$recurDAO->id
]['contribution_status_id'] = $recurDAO->contribution_status_id
;
351 $params[$recurDAO->id
]['contribution_status'] = CRM_Utils_Array
::value($recurDAO->contribution_status_id
, $contributionStatus);
352 $params[$recurDAO->id
]['is_test'] = $recurDAO->is_test
;
353 $params[$recurDAO->id
]['payment_processor_id'] = $recurDAO->payment_processor_id
;
360 * @param int $entityID
361 * @param string $entity
363 * @return null|Object
365 public static function getSubscriptionDetails($entityID, $entity = 'recur') {
367 SELECT rec.id as recur_id,
368 rec.processor_id as subscription_id,
369 rec.frequency_interval,
377 rec.financial_type_id,
378 rec.next_sched_contribution_date,
379 rec.failure_retry_date,
381 con.id as contribution_id,
382 con.contribution_page_id,
386 if ($entity == 'recur') {
388 FROM civicrm_contribution_recur rec
389 LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
390 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
393 elseif ($entity == 'contribution') {
395 FROM civicrm_contribution con
396 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
397 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
400 elseif ($entity == 'membership') {
402 FROM civicrm_membership_payment mp
403 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
404 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
405 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
406 WHERE mp.membership_id = %1";
409 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($entityID, 'Integer')));
419 * Does the recurring contribution support financial type change.
421 * This is conditional on there being only one line item or if there are no contributions as yet.
423 * (This second is a bit of an unusual condition but might occur in the context of a
429 public static function supportsFinancialTypeChange($id) {
430 // At this stage only sites with no Financial ACLs will have the opportunity to edit the financial type.
431 // this is to limit the scope of the change and because financial ACLs are still fairly new & settling down.
432 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
435 $contribution = self
::getTemplateContribution($id);
436 return CRM_Contribute_BAO_Contribution
::isSingleLineItem($contribution['id']);
440 * Get the contribution to be used as the template for later contributions.
442 * Later we might merge in data stored against the contribution recur record rather than just return the contribution.
445 * @param array $overrides
446 * Parameters that should be overriden. Add unit tests if using parameters other than total_amount & financial_type_id.
449 * @throws \CiviCRM_API3_Exception
451 public static function getTemplateContribution($id, $overrides = array()) {
452 $templateContribution = civicrm_api3('Contribution', 'get', array(
453 'contribution_recur_id' => $id,
454 'options' => array('limit' => 1, 'sort' => array('id DESC')),
456 'contribution_test' => '',
458 if ($templateContribution['count']) {
459 $result = array_merge($templateContribution['values'][0], $overrides);
460 $result['line_item'] = CRM_Contribute_BAO_ContributionRecur
::calculateRecurLineItems($id, $result['total_amount'], $result['financial_type_id']);
466 public static function setSubscriptionContext() {
467 // handle context redirection for subscription url
468 $session = CRM_Core_Session
::singleton();
469 if ($session->get('userID')) {
471 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
472 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer');
473 $qfkey = CRM_Utils_Request
::retrieve('key', 'String');
474 $context = CRM_Utils_Request
::retrieve('context', 'String');
478 $url = CRM_Utils_System
::url('civicrm/contact/view',
479 "reset=1&selectedChild=contribute&cid={$cid}"
484 $url = CRM_Utils_System
::url('civicrm/contact/view',
485 "reset=1&selectedChild=member&cid={$cid}"
490 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
497 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
501 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
506 $session->pushUserContext($url);
512 * CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
514 * @param array $fields
515 * The input form values.
516 * @param array $files
517 * The uploaded files if any.
518 * @param CRM_Core_Form $self
519 * @param array $errors
521 public static function validateRecurContribution($fields, $files, $self, &$errors) {
522 if (!empty($fields['is_recur'])) {
523 if ($fields['frequency_interval'] <= 0) {
524 $errors['frequency_interval'] = ts('Please enter a number for how often you want to make this recurring contribution (EXAMPLE: Every 3 months).');
526 if ($fields['frequency_unit'] == '0') {
527 $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).');
533 * Send start or end notification for recurring payments.
536 * @param CRM_Contribute_BAO_ContributionRecur $recur
537 * @param bool $isFirstOrLastRecurringPayment
539 public static function sendRecurringStartOrEndNotification($ids, $recur, $isFirstOrLastRecurringPayment) {
540 if ($isFirstOrLastRecurringPayment) {
541 $autoRenewMembership = FALSE;
543 isset($ids['membership']) && $ids['membership']
545 $autoRenewMembership = TRUE;
548 //send recurring Notification email for user
549 CRM_Contribute_BAO_ContributionPage
::recurringNotify($isFirstOrLastRecurringPayment,
551 $ids['contributionPage'],
559 * Copy custom data of the initial contribution into its recurring contributions.
561 * @param int $recurId
562 * @param int $targetContributionId
564 static public function copyCustomValues($recurId, $targetContributionId) {
565 if ($recurId && $targetContributionId) {
566 // get the initial contribution id of recur id
567 $sourceContributionId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
569 // if the same contribution is being processed then return
570 if ($sourceContributionId == $targetContributionId) {
573 // check if proper recurring contribution record is being processed
574 $targetConRecurId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id');
575 if ($targetConRecurId != $recurId) {
580 $extends = array('Contribution');
581 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
583 foreach ($groupTree as $groupID => $group) {
584 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
585 foreach ($group['fields'] as $fieldID => $field) {
586 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
590 foreach ($table as $tableName => $tableColumns) {
591 $insert = 'INSERT IGNORE INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
592 $tableColumns[0] = $targetContributionId;
593 $select = 'SELECT ' . implode(', ', $tableColumns);
594 $from = ' FROM ' . $tableName;
595 $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}";
596 $query = $insert . $select . $from . $where;
597 CRM_Core_DAO
::executeQuery($query);
604 * Add soft credit to for recurring payment.
606 * copy soft credit record of first recurring contribution.
607 * and add new soft credit against $targetContributionId
609 * @param int $recurId
610 * @param int $targetContributionId
612 public static function addrecurSoftCredit($recurId, $targetContributionId) {
613 $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
614 $soft_contribution->contribution_id
= CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
616 // Check if first recurring contribution has any associated soft credit.
617 if ($soft_contribution->find(TRUE)) {
618 $soft_contribution->contribution_id
= $targetContributionId;
619 unset($soft_contribution->id
);
620 $soft_contribution->save();
625 * Add line items for recurring contribution.
627 * @param int $recurId
628 * @param \CRM_Contribute_BAO_Contribution $contribution
632 public static function addRecurLineItems($recurId, $contribution) {
633 $foundLineItems = FALSE;
635 $lineSets = self
::calculateRecurLineItems($recurId, $contribution->total_amount
, $contribution->financial_type_id
);
636 foreach ($lineSets as $lineItems) {
637 if (!empty($lineItems)) {
638 foreach ($lineItems as $key => $value) {
639 if ($value['entity_table'] == 'civicrm_membership') {
641 // @todo this should be done by virtue of editing the line item as this link
642 // is deprecated. This may be the case but needs testing.
643 civicrm_api3('membership_payment', 'create', array(
644 'membership_id' => $value['entity_id'],
645 'contribution_id' => $contribution->id
,
646 'is_transactional' => FALSE,
649 catch (CiviCRM_API3_Exception
$e) {
650 // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data
651 // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated
655 $foundLineItems = TRUE;
658 if (!$foundLineItems) {
659 CRM_Price_BAO_LineItem
::processPriceSet($contribution->id
, $lineSets, $contribution);
665 * Update pledge associated with a recurring contribution.
667 * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
669 * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution
670 * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge &
671 * it should be assumed they
672 * do so with the intention that all payments will be linked
674 * The pledge payment record should already exist & will need to be updated with the new contribution ID.
675 * If not the contribution will also need to be linked to the pledge
677 * @param int $contributionID
678 * @param int $contributionRecurID
679 * @param int $contributionStatusID
680 * @param float $contributionAmount
682 * @throws \CiviCRM_API3_Exception
684 public static function updateRecurLinkedPledge($contributionID, $contributionRecurID, $contributionStatusID, $contributionAmount) {
685 $returnProperties = array('id', 'pledge_id');
686 $paymentDetails = $paymentIDs = array();
688 if (CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contributionID,
689 $paymentDetails, $returnProperties
692 foreach ($paymentDetails as $key => $value) {
693 $paymentIDs[] = $value['id'];
694 $pledgeId = $value['pledge_id'];
698 //payment is not already linked - if it is linked with a pledge we need to create a link.
699 // return if it is not recurring contribution
700 if (!$contributionRecurID) {
704 $relatedContributions = new CRM_Contribute_DAO_Contribution();
705 $relatedContributions->contribution_recur_id
= $contributionRecurID;
706 $relatedContributions->find();
708 while ($relatedContributions->fetch()) {
709 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id
,
710 $paymentDetails, $returnProperties
714 if (empty($paymentDetails)) {
715 // payment is not linked with a pledge and neither are any other contributions on this
719 foreach ($paymentDetails as $key => $value) {
720 $pledgeId = $value['pledge_id'];
723 // we have a pledge now we need to get the oldest unpaid payment
724 $paymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($pledgeId);
725 if (empty($paymentDetails['id'])) {
726 // we can assume this pledge is now completed
727 // return now so we don't create a core error & roll back
730 $paymentDetails['contribution_id'] = $contributionID;
731 $paymentDetails['status_id'] = $contributionStatusID;
732 $paymentDetails['actual_amount'] = $contributionAmount;
734 // put contribution against it
735 $payment = civicrm_api3('PledgePayment', 'create', $paymentDetails);
736 $paymentIDs[] = $payment['id'];
739 // update pledge and corresponding payment statuses
740 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contributionStatusID,
741 NULL, $contributionAmount
746 * @param CRM_Core_Form $form
748 public static function recurringContribution(&$form) {
749 // Recurring contribution fields
750 foreach (self
::getRecurringFields() as $key => $label) {
751 if ($key == 'contribution_recur_payment_made' && !empty($form->_formValues
) &&
752 !CRM_Utils_System
::isNull(CRM_Utils_Array
::value($key, $form->_formValues
))
754 $form->assign('contribution_recur_pane_open', TRUE);
757 CRM_Core_Form_Date
::buildDateRange($form, $key, 1, '_low', '_high');
758 // If data has been entered for a recurring field, tell the tpl layer to open the pane
759 if (!empty($form->_formValues
) && !empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
760 $form->assign('contribution_recur_pane_open', TRUE);
765 // Add field to check if payment is made for recurring contribution
766 $recurringPaymentOptions = array(
767 1 => ts('All recurring contributions'),
768 2 => ts('Recurring contributions with at least one payment'),
770 $form->addRadio('contribution_recur_payment_made', NULL, $recurringPaymentOptions, array('allowClear' => TRUE));
771 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_start_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
772 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_end_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
773 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_modified_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
774 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_next_sched_contribution_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
775 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_failure_retry_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
776 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_cancel_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
778 // Add field for contribution status
779 $form->addSelect('contribution_recur_contribution_status_id',
780 array('entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => CRM_Contribute_PseudoConstant
::contributionStatus())
783 $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id'));
784 $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id'));
786 CRM_Core_BAO_Query
::addCustomFormFields($form, array('ContributionRecur'));
791 * Get fields for recurring contributions.
795 public static function getRecurringFields() {
797 'contribution_recur_payment_made' => ts(''),
798 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
799 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
800 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
801 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
802 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
803 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
804 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),
809 * Update recurring contribution based on incoming payment.
811 * Do not rename or move this function without updating https://issues.civicrm.org/jira/browse/CRM-17655.
813 * @param int $recurringContributionID
814 * @param string $paymentStatus
815 * Payment status - this correlates to the machine name of the contribution status ID ie
819 * @throws \CiviCRM_API3_Exception
821 public static function updateOnNewPayment($recurringContributionID, $paymentStatus, $effectiveDate) {
823 $effectiveDate = $effectiveDate ?
date('Y-m-d', strtotime($effectiveDate)) : date('Y-m-d');
824 if (!in_array($paymentStatus, array('Completed', 'Failed'))) {
828 'id' => $recurringContributionID,
830 'contribution_status_id',
831 'next_sched_contribution_date',
833 'frequency_interval',
839 $existing = civicrm_api3('ContributionRecur', 'getsingle', $params);
841 if ($paymentStatus == 'Completed'
842 && CRM_Contribute_PseudoConstant
::contributionStatus($existing['contribution_status_id'], 'name') == 'Pending') {
843 $params['contribution_status_id'] = 'In Progress';
845 if ($paymentStatus == 'Failed') {
846 $params['failure_count'] = $existing['failure_count'];
848 $params['modified_date'] = date('Y-m-d H:i:s');
850 if (!empty($existing['installments']) && self
::isComplete($recurringContributionID, $existing['installments'])) {
851 $params['contribution_status_id'] = 'Completed';
854 // Only update next sched date if it's empty or 'just now' because payment processors may be managing
855 // the scheduled date themselves as core did not previously provide any help.
856 if (empty($existing['next_sched_contribution_date']) ||
strtotime($existing['next_sched_contribution_date']) ==
857 strtotime($effectiveDate)) {
858 $params['next_sched_contribution_date'] = date('Y-m-d', strtotime('+' . $existing['frequency_interval'] . ' ' . $existing['frequency_unit'], strtotime($effectiveDate)));
861 civicrm_api3('ContributionRecur', 'create', $params);
865 * Is this recurring contribution now complete.
867 * Have all the payments expected been received now.
869 * @param int $recurringContributionID
870 * @param int $installments
874 protected static function isComplete($recurringContributionID, $installments) {
875 $paidInstallments = CRM_Core_DAO
::singleValueQuery(
876 'SELECT count(*) FROM civicrm_contribution
877 WHERE contribution_recur_id = %1
878 AND contribution_status_id = ' . CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
879 array(1 => array($recurringContributionID, 'Integer'))
881 if ($paidInstallments >= $installments) {
888 * Calculate line items for the relevant recurring calculation.
890 * @param int $recurId
891 * @param string $total_amount
892 * @param int $financial_type_id
896 public static function calculateRecurLineItems($recurId, $total_amount, $financial_type_id) {
897 $originalContribution = civicrm_api3('Contribution', 'getsingle', array(
898 'contribution_recur_id' => $recurId,
899 'contribution_test' => '',
900 'options' => ['limit' => 1],
901 'return' => ['id', 'financial_type_id'],
903 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($originalContribution['id']);
905 if (count($lineItems) == 1) {
906 foreach ($lineItems as $index => $lineItem) {
907 if ($lineItem['financial_type_id'] != $originalContribution['financial_type_id']) {
908 // 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.
909 $financial_type_id = $lineItem['financial_type_id'];
911 if ($financial_type_id) {
912 // CRM-17718 allow for possibility of changed financial type ID having been set prior to calling this.
913 $lineItem['financial_type_id'] = $financial_type_id;
915 if ($lineItem['line_total'] != $total_amount) {
916 // We are dealing with a changed amount! Per CRM-16397 we can work out what to do with these
917 // if there is only one line item, and the UI should prevent this situation for those with more than one.
918 $lineItem['line_total'] = $total_amount;
919 $lineItem['unit_price'] = round($total_amount / $lineItem['qty'], 2);
921 $priceField = new CRM_Price_DAO_PriceField();
922 $priceField->id
= $lineItem['price_field_id'];
923 $priceField->find(TRUE);
924 $lineSets[$priceField->price_set_id
][] = $lineItem;
927 // CRM-19309 if more than one then just pass them through:
928 elseif (count($lineItems) > 1) {
929 foreach ($lineItems as $index => $lineItem) {
930 $lineSets[$index][] = $lineItem;
938 * Returns array with statuses that are considered to make a recurring
939 * contribution inacteve.
943 public static function getInactiveStatuses() {
944 return self
::$inactiveStatuses;