Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur { | |
34 | ||
35 | /** | |
fe482240 | 36 | * Create recurring contribution. |
6a488035 | 37 | * |
014c4014 TO |
38 | * @param array $params |
39 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 40 | * |
a6c01b45 CW |
41 | * @return object |
42 | * activity contact object | |
6a488035 | 43 | */ |
00be9182 | 44 | public static function create(&$params) { |
6a488035 TO |
45 | return self::add($params); |
46 | } | |
47 | ||
48 | /** | |
fe482240 | 49 | * Takes an associative array and creates a contribution object. |
6a488035 TO |
50 | * |
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 | |
53 | * pairs | |
54 | * | |
014c4014 TO |
55 | * @param array $params |
56 | * (reference ) an assoc array of name/value pairs. | |
fd31fa4c | 57 | * |
16b10e64 | 58 | * @return CRM_Contribute_BAO_Contribution |
6a488035 TO |
59 | * @todo move hook calls / extended logic to create - requires changing calls to call create not add |
60 | */ | |
00be9182 | 61 | public static function add(&$params) { |
a7488080 | 62 | if (!empty($params['id'])) { |
6a488035 TO |
63 | CRM_Utils_Hook::pre('edit', 'ContributionRecur', $params['id'], $params); |
64 | } | |
65 | else { | |
66 | CRM_Utils_Hook::pre('create', 'ContributionRecur', NULL, $params); | |
67 | } | |
68 | ||
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, | |
76 | 'Fatal', | |
77 | array($d), | |
78 | "Found matching recurring contribution(s): $d" | |
79 | ); | |
80 | return $error; | |
81 | } | |
82 | ||
83 | $recurring = new CRM_Contribute_BAO_ContributionRecur(); | |
84 | $recurring->copyValues($params); | |
85 | $recurring->id = CRM_Utils_Array::value('id', $params); | |
86 | ||
87 | // set currency for CRM-1496 | |
88 | if (!isset($recurring->currency)) { | |
89 | $config = CRM_Core_Config::singleton(); | |
90 | $recurring->currency = $config->defaultCurrency; | |
91 | } | |
92 | $result = $recurring->save(); | |
93 | ||
a7488080 | 94 | if (!empty($params['id'])) { |
6a488035 TO |
95 | CRM_Utils_Hook::post('edit', 'ContributionRecur', $recurring->id, $recurring); |
96 | } | |
97 | else { | |
98 | CRM_Utils_Hook::post('create', 'ContributionRecur', $recurring->id, $recurring); | |
99 | } | |
100 | ||
95974e8e DG |
101 | if (!empty($params['custom']) && |
102 | is_array($params['custom']) | |
103 | ) { | |
104 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution_recur', $recurring->id); | |
105 | } | |
106 | ||
6a488035 TO |
107 | return $result; |
108 | } | |
109 | ||
110 | /** | |
fe482240 | 111 | * Check if there is a recurring contribution with the same trxn_id or invoice_id. |
6a488035 | 112 | * |
014c4014 TO |
113 | * @param array $params |
114 | * (reference ) an assoc array of name/value pairs. | |
115 | * @param array $duplicates | |
c0f62075 | 116 | * (reference ) store ids of duplicate contributions. |
6a488035 | 117 | * |
e7483cbe | 118 | * @return bool |
a6c01b45 | 119 | * true if duplicate, false otherwise |
6a488035 | 120 | */ |
00be9182 | 121 | public static function checkDuplicate($params, &$duplicates) { |
353ffa53 TO |
122 | $id = CRM_Utils_Array::value('id', $params); |
123 | $trxn_id = CRM_Utils_Array::value('trxn_id', $params); | |
6a488035 TO |
124 | $invoice_id = CRM_Utils_Array::value('invoice_id', $params); |
125 | ||
126 | $clause = array(); | |
127 | $params = array(); | |
128 | ||
129 | if ($trxn_id) { | |
130 | $clause[] = "trxn_id = %1"; | |
131 | $params[1] = array($trxn_id, 'String'); | |
132 | } | |
133 | ||
134 | if ($invoice_id) { | |
135 | $clause[] = "invoice_id = %2"; | |
136 | $params[2] = array($invoice_id, 'String'); | |
137 | } | |
138 | ||
139 | if (empty($clause)) { | |
140 | return FALSE; | |
141 | } | |
142 | ||
143 | $clause = implode(' OR ', $clause); | |
144 | if ($id) { | |
145 | $clause = "( $clause ) AND id != %3"; | |
146 | $params[3] = array($id, 'Integer'); | |
147 | } | |
148 | ||
353ffa53 TO |
149 | $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause"; |
150 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
6a488035 TO |
151 | $result = FALSE; |
152 | while ($dao->fetch()) { | |
153 | $duplicates[] = $dao->id; | |
154 | $result = TRUE; | |
155 | } | |
156 | return $result; | |
157 | } | |
158 | ||
186c9c17 | 159 | /** |
c0f62075 | 160 | * Get the payment processor (array) for a recurring processor. |
161 | * | |
100fef9d | 162 | * @param int $id |
c0f62075 | 163 | * @param string $mode |
164 | * - Test or NULL - all other variants are ignored. | |
186c9c17 EM |
165 | * |
166 | * @return array|null | |
167 | */ | |
c0f62075 | 168 | public static function getPaymentProcessor($id, $mode = NULL) { |
6a488035 TO |
169 | $sql = " |
170 | SELECT r.payment_processor_id | |
171 | FROM civicrm_contribution_recur r | |
172 | WHERE r.id = %1"; | |
173 | $params = array(1 => array($id, 'Integer')); | |
c0f62075 | 174 | $paymentProcessorID = CRM_Core_DAO::singleValueQuery($sql, |
6a488035 TO |
175 | $params |
176 | ); | |
177 | if (!$paymentProcessorID) { | |
178 | return NULL; | |
179 | } | |
180 | ||
181 | return CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID, $mode); | |
182 | } | |
183 | ||
184 | /** | |
c0f62075 | 185 | * Get the number of installment done/completed for each recurring contribution. |
6a488035 | 186 | * |
014c4014 TO |
187 | * @param array $ids |
188 | * (reference ) an array of recurring contribution ids. | |
6a488035 | 189 | * |
a6c01b45 CW |
190 | * @return array |
191 | * an array of recurring ids count | |
6a488035 | 192 | */ |
00be9182 | 193 | public static function getCount(&$ids) { |
6a488035 TO |
194 | $recurID = implode(',', $ids); |
195 | $totalCount = array(); | |
196 | ||
d5828a02 | 197 | $query = " |
6a488035 TO |
198 | SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted |
199 | FROM civicrm_contribution | |
200 | WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0 | |
201 | GROUP BY contribution_recur_id"; | |
202 | ||
203 | $res = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
204 | ||
205 | while ($res->fetch()) { | |
206 | $totalCount[$res->contribution_recur_id] = $res->commpleted; | |
207 | } | |
208 | return $totalCount; | |
209 | } | |
210 | ||
211 | /** | |
212 | * Delete Recurring contribution. | |
213 | * | |
100fef9d | 214 | * @param int $recurId |
da6b46f4 | 215 | * |
ca26cb52 | 216 | * @return bool |
6a488035 | 217 | */ |
00be9182 | 218 | public static function deleteRecurContribution($recurId) { |
6a488035 TO |
219 | $result = FALSE; |
220 | if (!$recurId) { | |
221 | return $result; | |
222 | } | |
223 | ||
353ffa53 | 224 | $recur = new CRM_Contribute_DAO_ContributionRecur(); |
6a488035 | 225 | $recur->id = $recurId; |
353ffa53 | 226 | $result = $recur->delete(); |
6a488035 TO |
227 | |
228 | return $result; | |
229 | } | |
230 | ||
231 | /** | |
232 | * Cancel Recurring contribution. | |
233 | * | |
014c4014 TO |
234 | * @param int $recurId |
235 | * Recur contribution id. | |
236 | * @param array $objects | |
237 | * An array of objects that is to be cancelled like. | |
6a488035 TO |
238 | * contribution, membership, event. At least contribution object is a must. |
239 | * | |
dd244018 EM |
240 | * @param array $activityParams |
241 | * | |
ca26cb52 | 242 | * @return bool |
6a488035 | 243 | */ |
00be9182 | 244 | public static function cancelRecurContribution($recurId, $objects, $activityParams = array()) { |
6a488035 TO |
245 | if (!$recurId) { |
246 | return FALSE; | |
247 | } | |
248 | ||
249 | $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'); | |
353ffa53 TO |
250 | $canceledId = array_search('Cancelled', $contributionStatus); |
251 | $recur = new CRM_Contribute_DAO_ContributionRecur(); | |
252 | $recur->id = $recurId; | |
6a488035 TO |
253 | $recur->whereAdd("contribution_status_id != $canceledId"); |
254 | ||
255 | if ($recur->find(TRUE)) { | |
256 | $transaction = new CRM_Core_Transaction(); | |
257 | $recur->contribution_status_id = $canceledId; | |
258 | $recur->start_date = CRM_Utils_Date::isoToMysql($recur->start_date); | |
259 | $recur->create_date = CRM_Utils_Date::isoToMysql($recur->create_date); | |
260 | $recur->modified_date = CRM_Utils_Date::isoToMysql($recur->modified_date); | |
261 | $recur->cancel_date = date('YmdHis'); | |
262 | $recur->save(); | |
263 | ||
264 | $dao = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($recurId); | |
bbf58b03 | 265 | if ($dao && $dao->recur_id) { |
6a488035 TO |
266 | $details = CRM_Utils_Array::value('details', $activityParams); |
267 | if ($dao->auto_renew && $dao->membership_id) { | |
268 | // its auto-renewal membership mode | |
269 | $membershipTypes = CRM_Member_PseudoConstant::membershipType(); | |
353ffa53 TO |
270 | $membershipType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'membership_type_id'); |
271 | $membershipType = CRM_Utils_Array::value($membershipType, $membershipTypes); | |
6a488035 TO |
272 | $details .= ' |
273 | <br/>' . ts('Automatic renewal of %1 membership cancelled.', array(1 => $membershipType)); | |
274 | } | |
275 | else { | |
276 | $details .= ' | |
277 | <br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', array( | |
353ffa53 | 278 | 1 => $dao->amount, |
6a488035 | 279 | 2 => $dao->frequency_interval, |
21dfd5f5 | 280 | 3 => $dao->frequency_unit, |
6a488035 TO |
281 | )); |
282 | } | |
283 | $activityParams = array( | |
284 | 'source_contact_id' => $dao->contact_id, | |
285 | 'source_record_id' => CRM_Utils_Array::value('source_record_id', $activityParams), | |
286 | 'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type', | |
287 | 'Cancel Recurring Contribution', | |
288 | 'name' | |
289 | ), | |
290 | 'subject' => CRM_Utils_Array::value('subject', $activityParams, ts('Recurring contribution cancelled')), | |
291 | 'details' => $details, | |
292 | 'activity_date_time' => date('YmdHis'), | |
293 | 'status_id' => CRM_Core_OptionGroup::getValue('activity_status', | |
294 | 'Completed', | |
295 | 'name' | |
296 | ), | |
297 | ); | |
298 | $session = CRM_Core_Session::singleton(); | |
299 | $cid = $session->get('userID'); | |
300 | if ($cid) { | |
301 | $activityParams['target_contact_id'][] = $activityParams['source_contact_id']; | |
302 | $activityParams['source_contact_id'] = $cid; | |
303 | } | |
304 | CRM_Activity_BAO_Activity::create($activityParams); | |
305 | } | |
306 | ||
307 | // if there are associated objects, cancel them as well | |
308 | if ($objects == CRM_Core_DAO::$_nullObject) { | |
309 | $transaction->commit(); | |
310 | return TRUE; | |
311 | } | |
312 | else { | |
313 | $baseIPN = new CRM_Core_Payment_BaseIPN(); | |
314 | return $baseIPN->cancelled($objects, $transaction); | |
315 | } | |
316 | } | |
317 | else { | |
318 | // if already cancelled, return true | |
319 | $recur->whereAdd(); | |
320 | $recur->whereAdd("contribution_status_id = $canceledId"); | |
321 | if ($recur->find(TRUE)) { | |
322 | return TRUE; | |
323 | } | |
324 | } | |
325 | ||
326 | return FALSE; | |
327 | } | |
328 | ||
329 | /** | |
fe482240 | 330 | * Get list of recurring contribution of contact Ids. |
6a488035 | 331 | * |
014c4014 TO |
332 | * @param int $contactId |
333 | * Contact ID. | |
6a488035 | 334 | * |
a6c01b45 CW |
335 | * @return array |
336 | * list of recurring contribution fields | |
6a488035 | 337 | * |
6a488035 | 338 | */ |
00be9182 | 339 | public static function getRecurContributions($contactId) { |
6a488035 TO |
340 | $params = array(); |
341 | $recurDAO = new CRM_Contribute_DAO_ContributionRecur(); | |
342 | $recurDAO->contact_id = $contactId; | |
343 | $recurDAO->find(); | |
344 | $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(); | |
345 | ||
346 | while ($recurDAO->fetch()) { | |
347 | $params[$recurDAO->id]['id'] = $recurDAO->id; | |
348 | $params[$recurDAO->id]['contactId'] = $recurDAO->contact_id; | |
349 | $params[$recurDAO->id]['start_date'] = $recurDAO->start_date; | |
350 | $params[$recurDAO->id]['end_date'] = $recurDAO->end_date; | |
0d4bfc19 | 351 | $params[$recurDAO->id]['next_sched_contribution_date'] = $recurDAO->next_sched_contribution_date; |
6a488035 TO |
352 | $params[$recurDAO->id]['amount'] = $recurDAO->amount; |
353 | $params[$recurDAO->id]['currency'] = $recurDAO->currency; | |
354 | $params[$recurDAO->id]['frequency_unit'] = $recurDAO->frequency_unit; | |
355 | $params[$recurDAO->id]['frequency_interval'] = $recurDAO->frequency_interval; | |
356 | $params[$recurDAO->id]['installments'] = $recurDAO->installments; | |
357 | $params[$recurDAO->id]['contribution_status_id'] = $recurDAO->contribution_status_id; | |
358 | $params[$recurDAO->id]['contribution_status'] = CRM_Utils_Array::value($recurDAO->contribution_status_id, $contributionStatus); | |
359 | $params[$recurDAO->id]['is_test'] = $recurDAO->is_test; | |
360 | $params[$recurDAO->id]['payment_processor_id'] = $recurDAO->payment_processor_id; | |
361 | } | |
362 | ||
363 | return $params; | |
364 | } | |
365 | ||
186c9c17 | 366 | /** |
100fef9d | 367 | * @param int $entityID |
186c9c17 EM |
368 | * @param string $entity |
369 | * | |
370 | * @return null|Object | |
371 | */ | |
00be9182 | 372 | public static function getSubscriptionDetails($entityID, $entity = 'recur') { |
6a488035 | 373 | $sql = " |
d5828a02 DL |
374 | SELECT rec.id as recur_id, |
375 | rec.processor_id as subscription_id, | |
6a488035 TO |
376 | rec.frequency_interval, |
377 | rec.installments, | |
378 | rec.frequency_unit, | |
379 | rec.amount, | |
380 | rec.is_test, | |
381 | rec.auto_renew, | |
382 | rec.currency, | |
7083dc2a | 383 | rec.campaign_id, |
467fe956 | 384 | rec.financial_type_id, |
0c6c47a5 | 385 | rec.next_sched_contribution_date, |
386 | rec.failure_retry_date, | |
387 | rec.cycle_day, | |
467fe956 | 388 | con.id as contribution_id, |
6a488035 | 389 | con.contribution_page_id, |
f0a7bcb5 | 390 | rec.contact_id, |
6a488035 TO |
391 | mp.membership_id"; |
392 | ||
393 | if ($entity == 'recur') { | |
394 | $sql .= " | |
d5828a02 | 395 | FROM civicrm_contribution_recur rec |
f0a7bcb5 | 396 | LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id ) |
6a488035 TO |
397 | LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id ) |
398 | WHERE rec.id = %1 | |
399 | GROUP BY rec.id"; | |
400 | } | |
401 | elseif ($entity == 'contribution') { | |
402 | $sql .= " | |
403 | FROM civicrm_contribution con | |
d5828a02 | 404 | INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id ) |
6a488035 TO |
405 | LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id ) |
406 | WHERE con.id = %1"; | |
407 | } | |
408 | elseif ($entity == 'membership') { | |
409 | $sql .= " | |
d5828a02 DL |
410 | FROM civicrm_membership_payment mp |
411 | INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id ) | |
6a488035 TO |
412 | INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id ) |
413 | INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id ) | |
414 | WHERE mp.membership_id = %1"; | |
415 | } | |
416 | ||
417 | $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($entityID, 'Integer'))); | |
418 | if ($dao->fetch()) { | |
419 | return $dao; | |
420 | } | |
d5828a02 | 421 | else { |
467fe956 | 422 | return NULL; |
423 | } | |
424 | } | |
425 | ||
426 | /** | |
427 | * Does the recurring contribution support financial type change. | |
428 | * | |
429 | * This is conditional on there being only one line item or if there are no contributions as yet. | |
430 | * | |
431 | * (This second is a bit of an unusual condition but might occur in the context of a | |
432 | * | |
433 | * @param int $id | |
434 | * | |
435 | * @return bool | |
436 | */ | |
437 | public static function supportsFinancialTypeChange($id) { | |
438 | // At this stage only sites with no Financial ACLs will have the opportunity to edit the financial type. | |
439 | // this is to limit the scope of the change and because financial ACLs are still fairly new & settling down. | |
440 | if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) { | |
441 | return FALSE; | |
442 | } | |
443 | $contribution = self::getTemplateContribution($id); | |
444 | return CRM_Contribute_BAO_Contribution::isSingleLineItem($contribution['id']); | |
445 | } | |
446 | ||
447 | /** | |
448 | * Get the contribution to be used as the template for later contributions. | |
449 | * | |
450 | * Later we might merge in data stored against the contribution recur record rather than just return the contribution. | |
451 | * | |
452 | * @param int $id | |
453 | * | |
454 | * @return array | |
455 | * @throws \CiviCRM_API3_Exception | |
456 | */ | |
457 | public static function getTemplateContribution($id) { | |
458 | $templateContribution = civicrm_api3('Contribution', 'get', array( | |
459 | 'contribution_recur_id' => $id, | |
460 | 'options' => array('limit' => 1, 'sort' => array('id DESC')), | |
461 | 'sequential' => 1, | |
462 | )); | |
463 | if ($templateContribution['count']) { | |
464 | return $templateContribution['values'][0]; | |
d5828a02 | 465 | } |
467fe956 | 466 | return array(); |
6a488035 TO |
467 | } |
468 | ||
00be9182 | 469 | public static function setSubscriptionContext() { |
6a488035 TO |
470 | // handle context redirection for subscription url |
471 | $session = CRM_Core_Session::singleton(); | |
472 | if ($session->get('userID')) { | |
c490a46a CW |
473 | $url = FALSE; |
474 | $cid = CRM_Utils_Request::retrieve('cid', 'Integer'); | |
475 | $mid = CRM_Utils_Request::retrieve('mid', 'Integer'); | |
476 | $qfkey = CRM_Utils_Request::retrieve('key', 'String'); | |
477 | $context = CRM_Utils_Request::retrieve('context', 'String'); | |
6a488035 TO |
478 | if ($cid) { |
479 | switch ($context) { | |
480 | case 'contribution': | |
481 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
482 | "reset=1&selectedChild=contribute&cid={$cid}" | |
483 | ); | |
484 | break; | |
485 | ||
486 | case 'membership': | |
487 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
488 | "reset=1&selectedChild=member&cid={$cid}" | |
489 | ); | |
490 | break; | |
491 | ||
492 | case 'dashboard': | |
493 | $url = CRM_Utils_System::url('civicrm/user', "reset=1&id={$cid}"); | |
494 | break; | |
495 | } | |
496 | } | |
497 | if ($mid) { | |
498 | switch ($context) { | |
499 | case 'dashboard': | |
500 | $url = CRM_Utils_System::url('civicrm/member', "force=1&context={$context}&key={$qfkey}"); | |
501 | break; | |
502 | ||
503 | case 'search': | |
504 | $url = CRM_Utils_System::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}"); | |
505 | break; | |
506 | } | |
507 | } | |
508 | if ($url) { | |
509 | $session->pushUserContext($url); | |
510 | } | |
511 | } | |
512 | } | |
96025800 | 513 | |
0223e233 WA |
514 | /** |
515 | * CRM-16285 - Function to handle validation errors on form, for recurring contribution field. | |
ea3ddccf | 516 | * |
0223e233 WA |
517 | * @param array $fields |
518 | * The input form values. | |
519 | * @param array $files | |
520 | * The uploaded files if any. | |
ea3ddccf | 521 | * @param CRM_Core_Form $self |
522 | * @param array $errors | |
0223e233 | 523 | */ |
577d1236 WA |
524 | public static function validateRecurContribution($fields, $files, $self, &$errors) { |
525 | if (!empty($fields['is_recur'])) { | |
526 | if ($fields['frequency_interval'] <= 0) { | |
527 | $errors['frequency_interval'] = ts('Please enter a number for how often you want to make this recurring contribution (EXAMPLE: Every 3 months).'); | |
528 | } | |
529 | if ($fields['frequency_unit'] == '0') { | |
530 | $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 | } | |
532 | } | |
533 | } | |
0223e233 | 534 | |
e577770c EM |
535 | /** |
536 | * Send start or end notification for recurring payments. | |
537 | * | |
538 | * @param array $ids | |
539 | * @param CRM_Contribute_BAO_ContributionRecur $recur | |
540 | * @param bool $isFirstOrLastRecurringPayment | |
541 | */ | |
542 | public static function sendRecurringStartOrEndNotification($ids, $recur, $isFirstOrLastRecurringPayment) { | |
543 | if ($isFirstOrLastRecurringPayment) { | |
544 | $autoRenewMembership = FALSE; | |
545 | if ($recur->id && | |
546 | isset($ids['membership']) && $ids['membership'] | |
547 | ) { | |
548 | $autoRenewMembership = TRUE; | |
549 | } | |
550 | ||
551 | //send recurring Notification email for user | |
552 | CRM_Contribute_BAO_ContributionPage::recurringNotify($isFirstOrLastRecurringPayment, | |
553 | $ids['contact'], | |
554 | $ids['contributionPage'], | |
555 | $recur, | |
556 | $autoRenewMembership | |
557 | ); | |
558 | } | |
559 | } | |
560 | ||
561 | /** | |
562 | * Copy custom data of the initial contribution into its recurring contributions. | |
563 | * | |
564 | * @param int $recurId | |
565 | * @param int $targetContributionId | |
566 | */ | |
567 | static public function copyCustomValues($recurId, $targetContributionId) { | |
568 | if ($recurId && $targetContributionId) { | |
569 | // get the initial contribution id of recur id | |
570 | $sourceContributionId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); | |
571 | ||
572 | // if the same contribution is being processed then return | |
573 | if ($sourceContributionId == $targetContributionId) { | |
574 | return; | |
575 | } | |
576 | // check if proper recurring contribution record is being processed | |
577 | $targetConRecurId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id'); | |
578 | if ($targetConRecurId != $recurId) { | |
579 | return; | |
580 | } | |
581 | ||
582 | // copy custom data | |
583 | $extends = array('Contribution'); | |
584 | $groupTree = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, NULL, $extends); | |
585 | if ($groupTree) { | |
586 | foreach ($groupTree as $groupID => $group) { | |
587 | $table[$groupTree[$groupID]['table_name']] = array('entity_id'); | |
588 | foreach ($group['fields'] as $fieldID => $field) { | |
589 | $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name']; | |
590 | } | |
591 | } | |
592 | ||
593 | foreach ($table as $tableName => $tableColumns) { | |
594 | $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') '; | |
595 | $tableColumns[0] = $targetContributionId; | |
596 | $select = 'SELECT ' . implode(', ', $tableColumns); | |
597 | $from = ' FROM ' . $tableName; | |
598 | $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}"; | |
599 | $query = $insert . $select . $from . $where; | |
600 | CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
601 | } | |
602 | } | |
603 | } | |
604 | } | |
605 | ||
606 | /** | |
607 | * Add soft credit to for recurring payment. | |
608 | * | |
609 | * copy soft credit record of first recurring contribution. | |
610 | * and add new soft credit against $targetContributionId | |
611 | * | |
612 | * @param int $recurId | |
613 | * @param int $targetContributionId | |
614 | */ | |
615 | public static function addrecurSoftCredit($recurId, $targetContributionId) { | |
616 | $soft_contribution = new CRM_Contribute_DAO_ContributionSoft(); | |
617 | $soft_contribution->contribution_id = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); | |
618 | ||
619 | // Check if first recurring contribution has any associated soft credit. | |
620 | if ($soft_contribution->find(TRUE)) { | |
621 | $soft_contribution->contribution_id = $targetContributionId; | |
622 | unset($soft_contribution->id); | |
623 | $soft_contribution->save(); | |
624 | } | |
625 | } | |
626 | ||
627 | /** | |
628 | * Add line items for recurring contribution. | |
629 | * | |
630 | * @param int $recurId | |
631 | * @param $contribution | |
632 | * | |
633 | * @return array | |
634 | */ | |
635 | public static function addRecurLineItems($recurId, $contribution) { | |
636 | $lineSets = array(); | |
637 | ||
638 | $originalContributionID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); | |
639 | $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($originalContributionID); | |
640 | if (count($lineItems) == 1) { | |
641 | foreach ($lineItems as $index => $lineItem) { | |
3c49d90c | 642 | if (isset($contribution->financial_type_id)) { |
643 | // CRM-17718 allow for possibility of changed financial type ID having been set prior to calling this. | |
644 | $lineItems[$index]['financial_type_id'] = $contribution->financial_type_id; | |
645 | } | |
e577770c EM |
646 | if ($lineItem['line_total'] != $contribution->total_amount) { |
647 | // We are dealing with a changed amount! Per CRM-16397 we can work out what to do with these | |
648 | // if there is only one line item, and the UI should prevent this situation for those with more than one. | |
649 | $lineItems[$index]['line_total'] = $contribution->total_amount; | |
650 | $lineItems[$index]['unit_price'] = round($contribution->total_amount / $lineItems[$index]['qty'], 2); | |
651 | } | |
652 | } | |
653 | } | |
654 | if (!empty($lineItems)) { | |
655 | foreach ($lineItems as $key => $value) { | |
656 | $priceField = new CRM_Price_DAO_PriceField(); | |
657 | $priceField->id = $value['price_field_id']; | |
658 | $priceField->find(TRUE); | |
659 | $lineSets[$priceField->price_set_id][] = $value; | |
660 | ||
661 | if ($value['entity_table'] == 'civicrm_membership') { | |
662 | try { | |
663 | civicrm_api3('membership_payment', 'create', array( | |
664 | 'membership_id' => $value['entity_id'], | |
665 | 'contribution_id' => $contribution->id, | |
666 | )); | |
667 | } | |
668 | catch (CiviCRM_API3_Exception $e) { | |
669 | // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data | |
670 | // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated | |
671 | } | |
672 | } | |
673 | } | |
674 | } | |
675 | else { | |
676 | CRM_Price_BAO_LineItem::processPriceSet($contribution->id, $lineSets, $contribution); | |
677 | } | |
678 | return $lineSets; | |
679 | } | |
680 | ||
681 | /** | |
682 | * Update pledge associated with a recurring contribution. | |
683 | * | |
684 | * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage. | |
685 | * | |
686 | * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution | |
687 | * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge & | |
688 | * it should be assumed they | |
689 | * do so with the intention that all payments will be linked | |
690 | * | |
691 | * The pledge payment record should already exist & will need to be updated with the new contribution ID. | |
692 | * If not the contribution will also need to be linked to the pledge | |
693 | * | |
694 | * @param CRM_Contribute_BAO_Contribution $contribution | |
695 | */ | |
696 | public static function updateRecurLinkedPledge($contribution) { | |
697 | $returnProperties = array('id', 'pledge_id'); | |
698 | $paymentDetails = $paymentIDs = array(); | |
699 | ||
700 | if (CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contribution->id, | |
701 | $paymentDetails, $returnProperties | |
702 | ) | |
703 | ) { | |
704 | foreach ($paymentDetails as $key => $value) { | |
705 | $paymentIDs[] = $value['id']; | |
706 | $pledgeId = $value['pledge_id']; | |
707 | } | |
708 | } | |
709 | else { | |
710 | //payment is not already linked - if it is linked with a pledge we need to create a link. | |
711 | // return if it is not recurring contribution | |
712 | if (!$contribution->contribution_recur_id) { | |
713 | return; | |
714 | } | |
715 | ||
716 | $relatedContributions = new CRM_Contribute_DAO_Contribution(); | |
717 | $relatedContributions->contribution_recur_id = $contribution->contribution_recur_id; | |
718 | $relatedContributions->find(); | |
719 | ||
720 | while ($relatedContributions->fetch()) { | |
721 | CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id, | |
722 | $paymentDetails, $returnProperties | |
723 | ); | |
724 | } | |
725 | ||
726 | if (empty($paymentDetails)) { | |
727 | // payment is not linked with a pledge and neither are any other contributions on this | |
728 | return; | |
729 | } | |
730 | ||
731 | foreach ($paymentDetails as $key => $value) { | |
732 | $pledgeId = $value['pledge_id']; | |
733 | } | |
734 | ||
735 | // we have a pledge now we need to get the oldest unpaid payment | |
736 | $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId); | |
737 | if (empty($paymentDetails['id'])) { | |
738 | // we can assume this pledge is now completed | |
739 | // return now so we don't create a core error & roll back | |
740 | return; | |
741 | } | |
742 | $paymentDetails['contribution_id'] = $contribution->id; | |
743 | $paymentDetails['status_id'] = $contribution->contribution_status_id; | |
744 | $paymentDetails['actual_amount'] = $contribution->total_amount; | |
745 | ||
746 | // put contribution against it | |
747 | $payment = CRM_Pledge_BAO_PledgePayment::add($paymentDetails); | |
748 | $paymentIDs[] = $payment->id; | |
749 | } | |
750 | ||
751 | // update pledge and corresponding payment statuses | |
752 | CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contribution->contribution_status_id, | |
753 | NULL, $contribution->total_amount | |
754 | ); | |
755 | } | |
756 | ||
24782d26 | 757 | /** |
758 | * @param $form | |
759 | */ | |
760 | public static function recurringContribution(&$form) { | |
761 | // Recurring contribution fields | |
762 | foreach (self::getRecurringFields() as $key => $label) { | |
55feaf27 | 763 | if ($key == 'contribution_recur_payment_made' && !empty($form->_formValues) && |
24782d26 | 764 | !CRM_Utils_System::isNull(CRM_Utils_Array::value($key, $form->_formValues)) |
765 | ) { | |
766 | $form->assign('contribution_recur_pane_open', TRUE); | |
767 | break; | |
768 | } | |
769 | CRM_Core_Form_Date::buildDateRange($form, $key, 1, '_low', '_high'); | |
770 | // If data has been entered for a recurring field, tell the tpl layer to open the pane | |
55feaf27 | 771 | if (!empty($form->_formValues) && !empty($form->_formValues[$key . '_relative']) || !empty($form->_formValues[$key . '_low']) || !empty($form->_formValues[$key . '_high'])) { |
24782d26 | 772 | $form->assign('contribution_recur_pane_open', TRUE); |
773 | break; | |
774 | } | |
775 | } | |
776 | ||
24782d26 | 777 | // Add field to check if payment is made for recurring contribution |
778 | $recurringPaymentOptions = array( | |
5aae2a90 | 779 | 1 => ts(' All recurring contributions'), |
780 | 2 => ts(' Recurring contributions with at least one payment'), | |
24782d26 | 781 | ); |
5aae2a90 | 782 | $form->addRadio('contribution_recur_payment_made', NULL, $recurringPaymentOptions, array('allowClear' => TRUE)); |
24782d26 | 783 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_start_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); |
784 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_end_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); | |
785 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_modified_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); | |
786 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_next_sched_contribution_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); | |
787 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_failure_retry_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); | |
788 | CRM_Core_Form_Date::buildDateRange($form, 'contribution_recur_cancel_date', 1, '_low', '_high', ts('From'), FALSE, FALSE, 'birth'); | |
789 | $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id')); | |
790 | $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id')); | |
791 | $contributionRecur = array('ContributionRecur'); | |
792 | $groupDetails = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, TRUE, $contributionRecur); | |
793 | if ($groupDetails) { | |
794 | $form->assign('contributeRecurGroupTree', $groupDetails); | |
795 | foreach ($groupDetails as $group) { | |
796 | foreach ($group['fields'] as $field) { | |
797 | $fieldId = $field['id']; | |
798 | $elementName = 'custom_' . $fieldId; | |
3a7773be | 799 | CRM_Core_BAO_CustomField::addQuickFormElement($form, $elementName, $fieldId, FALSE, TRUE); |
24782d26 | 800 | } |
801 | } | |
802 | } | |
803 | } | |
804 | ||
805 | /** | |
806 | * Get fields for recurring contributions. | |
807 | * | |
808 | * @return array | |
809 | */ | |
810 | public static function getRecurringFields() { | |
811 | return array( | |
812 | 'contribution_recur_payment_made' => ts(''), | |
813 | 'contribution_recur_start_date' => ts('Recurring Contribution Start Date'), | |
814 | 'contribution_recur_next_sched_contribution_date' => ts('Next Scheduled Recurring Contribution'), | |
815 | 'contribution_recur_cancel_date' => ts('Recurring Contribution Cancel Date'), | |
816 | 'contribution_recur_end_date' => ts('Recurring Contribution End Date'), | |
817 | 'contribution_recur_create_date' => ('Recurring Contribution Create Date'), | |
818 | 'contribution_recur_modified_date' => ('Recurring Contribution Modified Date'), | |
819 | 'contribution_recur_failure_retry_date' => ts('Failed Recurring Contribution Retry Date'), | |
820 | ); | |
821 | } | |
822 | ||
91259407 | 823 | /** |
824 | * Update recurring contribution based on incoming payment. | |
825 | * | |
826 | * Do not rename or move this function without updating https://issues.civicrm.org/jira/browse/CRM-17655. | |
827 | * | |
828 | * @param int $recurringContributionID | |
829 | * @param string $paymentStatus | |
830 | * Payment status - this correlates to the machine name of the contribution status ID ie | |
831 | * - Completed | |
832 | * - Failed | |
833 | * | |
834 | * @throws \CiviCRM_API3_Exception | |
835 | */ | |
836 | public static function updateOnNewPayment($recurringContributionID, $paymentStatus) { | |
837 | if (!in_array($paymentStatus, array('Completed', 'Failed'))) { | |
838 | return; | |
839 | } | |
840 | $params = array( | |
841 | 'id' => $recurringContributionID, | |
842 | 'return' => array( | |
843 | 'contribution_status_id', | |
844 | 'next_sched_contribution_date', | |
845 | 'frequency_unit', | |
846 | 'frequency_interval', | |
847 | 'installments', | |
848 | 'failure_count', | |
849 | ), | |
850 | ); | |
851 | ||
852 | $existing = civicrm_api3('ContributionRecur', 'getsingle', $params); | |
853 | ||
854 | if ($paymentStatus == 'Completed' | |
855 | && CRM_Contribute_PseudoConstant::contributionStatus($existing['contribution_status_id'], 'name') == 'Pending') { | |
856 | $params['contribution_status_id'] = 'In Progress'; | |
857 | } | |
858 | if ($paymentStatus == 'Failed') { | |
859 | $params['failure_count'] = $existing['failure_count']; | |
860 | } | |
861 | $params['modified_date'] = date('Y-m-d H:i:s'); | |
862 | ||
863 | if (!empty($existing['installments']) && self::isComplete($recurringContributionID, $existing['installments'])) { | |
864 | $params['contribution_status_id'] = 'Completed'; | |
865 | } | |
866 | else { | |
867 | // Only update next sched date if it's empty or 'just now' because payment processors may be managing | |
868 | // the scheduled date themselves as core did not previously provide any help. | |
869 | if (empty($params['next_sched_contribution_date']) || strtotime($params['next_sched_contribution_date']) == | |
870 | strtotime(date('Y-m-d'))) { | |
871 | $params['next_sched_contribution_date'] = date('Y-m-d', strtotime('+' . $existing['frequency_interval'] . ' ' . $existing['frequency_unit'])); | |
872 | } | |
873 | } | |
874 | civicrm_api3('ContributionRecur', 'create', $params); | |
875 | } | |
876 | ||
877 | /** | |
878 | * Is this recurring contribution now complete. | |
879 | * | |
880 | * Have all the payments expected been received now. | |
881 | * | |
882 | * @param int $recurringContributionID | |
883 | * @param int $installments | |
884 | * | |
885 | * @return bool | |
886 | */ | |
887 | protected static function isComplete($recurringContributionID, $installments) { | |
888 | $paidInstallments = CRM_Core_DAO::singleValueQuery( | |
889 | 'SELECT count(*) FROM civicrm_contribution WHERE id = %1', | |
890 | array(1 => array($recurringContributionID, 'Integer')) | |
891 | ); | |
892 | if ($paidInstallments >= $installments) { | |
893 | return TRUE; | |
894 | } | |
895 | return FALSE; | |
896 | } | |
897 | ||
6a488035 | 898 | } |