3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
33 class CRM_Contribute_BAO_ContributionRecur
extends CRM_Contribute_DAO_ContributionRecur
{
36 * Create recurring contribution.
38 * @param array $params
39 * (reference ) an assoc array of name/value pairs.
42 * activity contact object
44 public static function create(&$params) {
45 return self
::add($params);
49 * Takes an associative array and creates a contribution object.
51 * the function extract all the params it needs to initialize the create a
52 * contribution object. the params array could contain additional unused name/value
55 * @param array $params
56 * (reference ) an assoc array of name/value pairs.
58 * @return CRM_Contribute_BAO_Contribution
59 * @todo move hook calls / extended logic to create - requires changing calls to call create not add
61 public static function add(&$params) {
62 if (!empty($params['id'])) {
63 CRM_Utils_Hook
::pre('edit', 'ContributionRecur', $params['id'], $params);
66 CRM_Utils_Hook
::pre('create', 'ContributionRecur', NULL, $params);
69 // make sure we're not creating a new recurring contribution with the same transaction ID
70 // or invoice ID as an existing recurring contribution
71 $duplicates = array();
72 if (self
::checkDuplicate($params, $duplicates)) {
73 $error = CRM_Core_Error
::singleton();
74 $d = implode(', ', $duplicates);
75 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
78 "Found matching recurring contribution(s): $d"
83 $recurring = new CRM_Contribute_BAO_ContributionRecur();
84 $recurring->copyValues($params);
85 $recurring->id
= CRM_Utils_Array
::value('id', $params);
87 // set currency for CRM-1496
88 if (!isset($recurring->currency
)) {
89 $config = CRM_Core_Config
::singleton();
90 $recurring->currency
= $config->defaultCurrency
;
92 $result = $recurring->save();
94 if (!empty($params['id'])) {
95 CRM_Utils_Hook
::post('edit', 'ContributionRecur', $recurring->id
, $recurring);
98 CRM_Utils_Hook
::post('create', 'ContributionRecur', $recurring->id
, $recurring);
101 if (!empty($params['custom']) &&
102 is_array($params['custom'])
104 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution_recur', $recurring->id
);
111 * Check if there is a recurring contribution with the same trxn_id or invoice_id.
113 * @param array $params
114 * (reference ) an assoc array of name/value pairs.
115 * @param array $duplicates
116 * (reference ) store ids of duplicate contribs.
119 * true if duplicate, false otherwise
121 public static function checkDuplicate($params, &$duplicates) {
122 $id = CRM_Utils_Array
::value('id', $params);
123 $trxn_id = CRM_Utils_Array
::value('trxn_id', $params);
124 $invoice_id = CRM_Utils_Array
::value('invoice_id', $params);
130 $clause[] = "trxn_id = %1";
131 $params[1] = array($trxn_id, 'String');
135 $clause[] = "invoice_id = %2";
136 $params[2] = array($invoice_id, 'String');
139 if (empty($clause)) {
143 $clause = implode(' OR ', $clause);
145 $clause = "( $clause ) AND id != %3";
146 $params[3] = array($id, 'Integer');
149 $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause";
150 $dao = CRM_Core_DAO
::executeQuery($query, $params);
152 while ($dao->fetch()) {
153 $duplicates[] = $dao->id
;
165 public static function getPaymentProcessor($id, $mode) {
168 SELECT r.payment_processor_id
169 FROM civicrm_contribution_recur r
171 $params = array(1 => array($id, 'Integer'));
172 $paymentProcessorID = &CRM_Core_DAO
::singleValueQuery($sql,
175 if (!$paymentProcessorID) {
179 return CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID, $mode);
183 * Get the number of installment done/completed for each recurring contribution
186 * (reference ) an array of recurring contribution ids.
189 * an array of recurring ids count
191 public static function getCount(&$ids) {
192 $recurID = implode(',', $ids);
193 $totalCount = array();
196 SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted
197 FROM civicrm_contribution
198 WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0
199 GROUP BY contribution_recur_id";
201 $res = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
203 while ($res->fetch()) {
204 $totalCount[$res->contribution_recur_id
] = $res->commpleted
;
210 * Delete Recurring contribution.
212 * @param int $recurId
216 public static function deleteRecurContribution($recurId) {
222 $recur = new CRM_Contribute_DAO_ContributionRecur();
223 $recur->id
= $recurId;
224 $result = $recur->delete();
230 * Cancel Recurring contribution.
232 * @param int $recurId
233 * Recur contribution id.
234 * @param array $objects
235 * An array of objects that is to be cancelled like.
236 * contribution, membership, event. At least contribution object is a must.
238 * @param array $activityParams
242 public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) {
247 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
248 $canceledId = array_search('Cancelled', $contributionStatus);
249 $recur = new CRM_Contribute_DAO_ContributionRecur();
250 $recur->id
= $recurId;
251 $recur->whereAdd("contribution_status_id != $canceledId");
253 if ($recur->find(TRUE)) {
254 $transaction = new CRM_Core_Transaction();
255 $recur->contribution_status_id
= $canceledId;
256 $recur->start_date
= CRM_Utils_Date
::isoToMysql($recur->start_date
);
257 $recur->create_date
= CRM_Utils_Date
::isoToMysql($recur->create_date
);
258 $recur->modified_date
= CRM_Utils_Date
::isoToMysql($recur->modified_date
);
259 $recur->cancel_date
= date('YmdHis');
262 $dao = CRM_Contribute_BAO_ContributionRecur
::getSubscriptionDetails($recurId);
263 if ($dao && $dao->recur_id
) {
264 $details = CRM_Utils_Array
::value('details', $activityParams);
265 if ($dao->auto_renew
&& $dao->membership_id
) {
266 // its auto-renewal membership mode
267 $membershipTypes = CRM_Member_PseudoConstant
::membershipType();
268 $membershipType = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id
, 'membership_type_id');
269 $membershipType = CRM_Utils_Array
::value($membershipType, $membershipTypes);
271 <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType));
275 <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array(
277 2 => $dao->frequency_interval
,
278 3 => $dao->frequency_unit
,
281 $activityParams = array(
282 'source_contact_id' => $dao->contact_id
,
283 'source_record_id' => CRM_Utils_Array
::value('source_record_id', $activityParams),
284 'activity_type_id' => CRM_Core_OptionGroup
::getValue('activity_type',
285 'Cancel Recurring Contribution',
288 'subject' => CRM_Utils_Array
::value('subject', $activityParams, ts('Recurring contribution cancelled')),
289 'details' => $details,
290 'activity_date_time' => date('YmdHis'),
291 'status_id' => CRM_Core_OptionGroup
::getValue('activity_status',
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 CRM_Activity_BAO_Activity
::create($activityParams);
305 // if there are associated objects, cancel them as well
306 if ($objects == CRM_Core_DAO
::$_nullObject) {
307 $transaction->commit();
311 $baseIPN = new CRM_Core_Payment_BaseIPN();
312 return $baseIPN->cancelled($objects, $transaction);
316 // if already cancelled, return true
318 $recur->whereAdd("contribution_status_id = $canceledId");
319 if ($recur->find(TRUE)) {
328 * Get list of recurring contribution of contact Ids.
330 * @param int $contactId
334 * list of recurring contribution fields
337 public static function getRecurContributions($contactId) {
339 $recurDAO = new CRM_Contribute_DAO_ContributionRecur();
340 $recurDAO->contact_id
= $contactId;
342 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus();
344 while ($recurDAO->fetch()) {
345 $params[$recurDAO->id
]['id'] = $recurDAO->id
;
346 $params[$recurDAO->id
]['contactId'] = $recurDAO->contact_id
;
347 $params[$recurDAO->id
]['start_date'] = $recurDAO->start_date
;
348 $params[$recurDAO->id
]['end_date'] = $recurDAO->end_date
;
349 $params[$recurDAO->id
]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date
;
350 $params[$recurDAO->id
]['amount'] = $recurDAO->amount
;
351 $params[$recurDAO->id
]['currency'] = $recurDAO->currency
;
352 $params[$recurDAO->id
]['frequency_unit'] = $recurDAO->frequency_unit
;
353 $params[$recurDAO->id
]['frequency_interval'] = $recurDAO->frequency_interval
;
354 $params[$recurDAO->id
]['installments'] = $recurDAO->installments
;
355 $params[$recurDAO->id
]['contribution_status_id'] = $recurDAO->contribution_status_id
;
356 $params[$recurDAO->id
]['contribution_status'] = CRM_Utils_Array
::value($recurDAO->contribution_status_id
, $contributionStatus);
357 $params[$recurDAO->id
]['is_test'] = $recurDAO->is_test
;
358 $params[$recurDAO->id
]['payment_processor_id'] = $recurDAO->payment_processor_id
;
365 * @param int $entityID
366 * @param string $entity
368 * @return null|Object
370 public static function getSubscriptionDetails($entityID, $entity = 'recur') {
372 SELECT rec.id as recur_id,
373 rec.processor_id as subscription_id,
374 rec.frequency_interval,
382 rec.financial_type_id,
383 con.id as contribution_id,
384 con.contribution_page_id,
388 if ($entity == 'recur') {
390 FROM civicrm_contribution_recur rec
391 LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id )
392 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
396 elseif ($entity == 'contribution') {
398 FROM civicrm_contribution con
399 INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id )
400 LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id )
403 elseif ($entity == 'membership') {
405 FROM civicrm_membership_payment mp
406 INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id )
407 INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id )
408 INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id )
409 WHERE mp.membership_id = %1";
412 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($entityID, 'Integer')));
422 * Does the recurring contribution support financial type change.
424 * This is conditional on there being only one line item or if there are no contributions as yet.
426 * (This second is a bit of an unusual condition but might occur in the context of a
432 public static function supportsFinancialTypeChange($id) {
433 // At this stage only sites with no Financial ACLs will have the opportunity to edit the financial type.
434 // this is to limit the scope of the change and because financial ACLs are still fairly new & settling down.
435 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
438 $contribution = self
::getTemplateContribution($id);
439 return CRM_Contribute_BAO_Contribution
::isSingleLineItem($contribution['id']);
443 * Get the contribution to be used as the template for later contributions.
445 * Later we might merge in data stored against the contribution recur record rather than just return the contribution.
450 * @throws \CiviCRM_API3_Exception
452 public static function getTemplateContribution($id) {
453 $templateContribution = civicrm_api3('Contribution', 'get', array(
454 'contribution_recur_id' => $id,
455 'options' => array('limit' => 1, 'sort' => array('id DESC')),
458 if ($templateContribution['count']) {
459 return $templateContribution['values'][0];
464 public static function setSubscriptionContext() {
465 // handle context redirection for subscription url
466 $session = CRM_Core_Session
::singleton();
467 if ($session->get('userID')) {
469 $cid = CRM_Utils_Request
::retrieve('cid', 'Integer');
470 $mid = CRM_Utils_Request
::retrieve('mid', 'Integer');
471 $qfkey = CRM_Utils_Request
::retrieve('key', 'String');
472 $context = CRM_Utils_Request
::retrieve('context', 'String');
476 $url = CRM_Utils_System
::url('civicrm/contact/view',
477 "reset=1&selectedChild=contribute&cid={$cid}"
482 $url = CRM_Utils_System
::url('civicrm/contact/view',
483 "reset=1&selectedChild=member&cid={$cid}"
488 $url = CRM_Utils_System
::url('civicrm/user', "reset=1&id={$cid}");
495 $url = CRM_Utils_System
::url('civicrm/member', "force=1&context={$context}&key={$qfkey}");
499 $url = CRM_Utils_System
::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}");
504 $session->pushUserContext($url);
510 * CRM-16285 - Function to handle validation errors on form, for recurring contribution field.
512 * @param array $fields
513 * The input form values.
514 * @param array $files
515 * The uploaded files if any.
516 * @param CRM_Core_Form $self
517 * @param array $errors
519 public static function validateRecurContribution($fields, $files, $self, &$errors) {
520 if (!empty($fields['is_recur'])) {
521 if ($fields['frequency_interval'] <= 0) {
522 $errors['frequency_interval'] = ts('Please enter a number for how often you want to make this recurring contribution (EXAMPLE: Every 3 months).');
524 if ($fields['frequency_unit'] == '0') {
525 $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).');
531 * Send start or end notification for recurring payments.
534 * @param CRM_Contribute_BAO_ContributionRecur $recur
535 * @param bool $isFirstOrLastRecurringPayment
537 public static function sendRecurringStartOrEndNotification($ids, $recur, $isFirstOrLastRecurringPayment) {
538 if ($isFirstOrLastRecurringPayment) {
539 $autoRenewMembership = FALSE;
541 isset($ids['membership']) && $ids['membership']
543 $autoRenewMembership = TRUE;
546 //send recurring Notification email for user
547 CRM_Contribute_BAO_ContributionPage
::recurringNotify($isFirstOrLastRecurringPayment,
549 $ids['contributionPage'],
557 * Copy custom data of the initial contribution into its recurring contributions.
559 * @param int $recurId
560 * @param int $targetContributionId
562 static public function copyCustomValues($recurId, $targetContributionId) {
563 if ($recurId && $targetContributionId) {
564 // get the initial contribution id of recur id
565 $sourceContributionId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
567 // if the same contribution is being processed then return
568 if ($sourceContributionId == $targetContributionId) {
571 // check if proper recurring contribution record is being processed
572 $targetConRecurId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id');
573 if ($targetConRecurId != $recurId) {
578 $extends = array('Contribution');
579 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
581 foreach ($groupTree as $groupID => $group) {
582 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
583 foreach ($group['fields'] as $fieldID => $field) {
584 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
588 foreach ($table as $tableName => $tableColumns) {
589 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
590 $tableColumns[0] = $targetContributionId;
591 $select = 'SELECT ' . implode(', ', $tableColumns);
592 $from = ' FROM ' . $tableName;
593 $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}";
594 $query = $insert . $select . $from . $where;
595 CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
602 * Add soft credit to for recurring payment.
604 * copy soft credit record of first recurring contribution.
605 * and add new soft credit against $targetContributionId
607 * @param int $recurId
608 * @param int $targetContributionId
610 public static function addrecurSoftCredit($recurId, $targetContributionId) {
611 $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
612 $soft_contribution->contribution_id
= CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
614 // Check if first recurring contribution has any associated soft credit.
615 if ($soft_contribution->find(TRUE)) {
616 $soft_contribution->contribution_id
= $targetContributionId;
617 unset($soft_contribution->id
);
618 $soft_contribution->save();
623 * Add line items for recurring contribution.
625 * @param int $recurId
626 * @param $contribution
630 public static function addRecurLineItems($recurId, $contribution) {
633 $originalContributionID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
634 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($originalContributionID);
635 if (count($lineItems) == 1) {
636 foreach ($lineItems as $index => $lineItem) {
637 if (isset($contribution->financial_type_id
)) {
638 // CRM-17718 allow for possibility of changed financial type ID having been set prior to calling this.
639 $lineItems[$index]['financial_type_id'] = $contribution->financial_type_id
;
641 if ($lineItem['line_total'] != $contribution->total_amount
) {
642 // We are dealing with a changed amount! Per CRM-16397 we can work out what to do with these
643 // if there is only one line item, and the UI should prevent this situation for those with more than one.
644 $lineItems[$index]['line_total'] = $contribution->total_amount
;
645 $lineItems[$index]['unit_price'] = round($contribution->total_amount
/ $lineItems[$index]['qty'], 2);
649 if (!empty($lineItems)) {
650 foreach ($lineItems as $key => $value) {
651 $priceField = new CRM_Price_DAO_PriceField();
652 $priceField->id
= $value['price_field_id'];
653 $priceField->find(TRUE);
654 $lineSets[$priceField->price_set_id
][] = $value;
656 if ($value['entity_table'] == 'civicrm_membership') {
658 civicrm_api3('membership_payment', 'create', array(
659 'membership_id' => $value['entity_id'],
660 'contribution_id' => $contribution->id
,
663 catch (CiviCRM_API3_Exception
$e) {
664 // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data
665 // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated
671 CRM_Price_BAO_LineItem
::processPriceSet($contribution->id
, $lineSets, $contribution);
677 * Update pledge associated with a recurring contribution.
679 * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
681 * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution
682 * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge &
683 * it should be assumed they
684 * do so with the intention that all payments will be linked
686 * The pledge payment record should already exist & will need to be updated with the new contribution ID.
687 * If not the contribution will also need to be linked to the pledge
689 * @param CRM_Contribute_BAO_Contribution $contribution
691 public static function updateRecurLinkedPledge($contribution) {
692 $returnProperties = array('id', 'pledge_id');
693 $paymentDetails = $paymentIDs = array();
695 if (CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contribution->id
,
696 $paymentDetails, $returnProperties
699 foreach ($paymentDetails as $key => $value) {
700 $paymentIDs[] = $value['id'];
701 $pledgeId = $value['pledge_id'];
705 //payment is not already linked - if it is linked with a pledge we need to create a link.
706 // return if it is not recurring contribution
707 if (!$contribution->contribution_recur_id
) {
711 $relatedContributions = new CRM_Contribute_DAO_Contribution();
712 $relatedContributions->contribution_recur_id
= $contribution->contribution_recur_id
;
713 $relatedContributions->find();
715 while ($relatedContributions->fetch()) {
716 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id
,
717 $paymentDetails, $returnProperties
721 if (empty($paymentDetails)) {
722 // payment is not linked with a pledge and neither are any other contributions on this
726 foreach ($paymentDetails as $key => $value) {
727 $pledgeId = $value['pledge_id'];
730 // we have a pledge now we need to get the oldest unpaid payment
731 $paymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($pledgeId);
732 if (empty($paymentDetails['id'])) {
733 // we can assume this pledge is now completed
734 // return now so we don't create a core error & roll back
737 $paymentDetails['contribution_id'] = $contribution->id
;
738 $paymentDetails['status_id'] = $contribution->contribution_status_id
;
739 $paymentDetails['actual_amount'] = $contribution->total_amount
;
741 // put contribution against it
742 $payment = CRM_Pledge_BAO_PledgePayment
::add($paymentDetails);
743 $paymentIDs[] = $payment->id
;
746 // update pledge and corresponding payment statuses
747 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contribution->contribution_status_id
,
748 NULL, $contribution->total_amount
755 public static function recurringContribution(&$form) {
756 // Recurring contribution fields
757 foreach (self
::getRecurringFields() as $key => $label) {
758 if ($key == 'contribution_recur_payment_made' &&
759 !CRM_Utils_System
::isNull(CRM_Utils_Array
::value($key, $form->_formValues
))
761 $form->assign('contribution_recur_pane_open', TRUE);
764 CRM_Core_Form_Date
::buildDateRange($form, $key, 1, '_low', '_high');
765 // If data has been entered for a recurring field, tell the tpl layer to open the pane
766 if (!empty($form->_formValues
[$key . '_relative']) ||
!empty($form->_formValues
[$key . '_low']) ||
!empty($form->_formValues
[$key . '_high'])) {
767 $form->assign('contribution_recur_pane_open', TRUE);
772 // Add field to check if payment is made for recurring contribution
773 $recurringPaymentOptions = array(
774 1 => ts(' All recurring contributions'),
775 2 => ts(' Recurring contributions with at least one payment'),
777 $form->addRadio('contribution_recur_payment_made', NULL, $recurringPaymentOptions, array('allowClear' => TRUE));
778 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_start_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
779 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_end_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
780 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_modified_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
781 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_next_sched_contribution_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
782 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_failure_retry_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
783 CRM_Core_Form_Date
::buildDateRange($form, 'contribution_recur_cancel_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth');
784 $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id'));
785 $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO
::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id'));
786 $contributionRecur = array('ContributionRecur');
787 $groupDetails = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, TRUE, $contributionRecur);
789 $form->assign('contributeRecurGroupTree', $groupDetails);
790 foreach ($groupDetails as $group) {
791 foreach ($group['fields'] as $field) {
792 $fieldId = $field['id'];
793 $elementName = 'custom_' . $fieldId;
794 CRM_Core_BAO_CustomField
::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE);
801 * Get fields for recurring contributions.
805 public static function getRecurringFields() {
807 'contribution_recur_payment_made' => ts(''),
808 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'),
809 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'),
810 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'),
811 'contribution_recur_end_date' => ts('Recurring Contribution End Date'),
812 'contribution_recur_create_date' => ('Recurring Contribution Create Date'),
813 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'),
814 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'),
819 * Update recurring contribution based on incoming payment.
821 * Do not rename or move this function without updating https://issues.civicrm.org/jira/browse/CRM-17655.
823 * @param int $recurringContributionID
824 * @param string $paymentStatus
825 * Payment status - this correlates to the machine name of the contribution status ID ie
829 * @throws \CiviCRM_API3_Exception
831 public static function updateOnNewPayment($recurringContributionID, $paymentStatus) {
832 if (!in_array($paymentStatus, array('Completed', 'Failed'))) {
836 'id' => $recurringContributionID,
838 'contribution_status_id',
839 'next_sched_contribution_date',
841 'frequency_interval',
847 $existing = civicrm_api3('ContributionRecur', 'getsingle', $params);
849 if ($paymentStatus == 'Completed'
850 && CRM_Contribute_PseudoConstant
::contributionStatus($existing['contribution_status_id'], 'name') == 'Pending') {
851 $params['contribution_status_id'] = 'In Progress';
853 if ($paymentStatus == 'Failed') {
854 $params['failure_count'] = $existing['failure_count'];
856 $params['modified_date'] = date('Y-m-d H:i:s');
858 if (!empty($existing['installments']) && self
::isComplete($recurringContributionID, $existing['installments'])) {
859 $params['contribution_status_id'] = 'Completed';
862 // Only update next sched date if it's empty or 'just now' because payment processors may be managing
863 // the scheduled date themselves as core did not previously provide any help.
864 if (empty($params['next_sched_contribution_date']) ||
strtotime($params['next_sched_contribution_date']) ==
865 strtotime(date('Y-m-d'))) {
866 $params['next_sched_contribution_date'] = date('Y-m-d', strtotime('+' . $existing['frequency_interval'] . ' ' . $existing['frequency_unit']));
869 civicrm_api3('ContributionRecur', 'create', $params);
873 * Is this recurring contribution now complete.
875 * Have all the payments expected been received now.
877 * @param int $recurringContributionID
878 * @param int $installments
882 protected static function isComplete($recurringContributionID, $installments) {
883 $paidInstallments = CRM_Core_DAO
::singleValueQuery(
884 'SELECT count(*) FROM civicrm_contribution WHERE id = %1',
885 array(1 => array($recurringContributionID, 'Integer'))
887 if ($paidInstallments >= $installments) {