Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur { | |
18 | ||
19 | /** | |
fe482240 | 20 | * Create recurring contribution. |
6a488035 | 21 | * |
014c4014 TO |
22 | * @param array $params |
23 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 24 | * |
a6c01b45 CW |
25 | * @return object |
26 | * activity contact object | |
6a488035 | 27 | */ |
00be9182 | 28 | public static function create(&$params) { |
6a488035 TO |
29 | return self::add($params); |
30 | } | |
31 | ||
32 | /** | |
fe482240 | 33 | * Takes an associative array and creates a contribution object. |
6a488035 TO |
34 | * |
35 | * the function extract all the params it needs to initialize the create a | |
36 | * contribution object. the params array could contain additional unused name/value | |
37 | * pairs | |
38 | * | |
014c4014 TO |
39 | * @param array $params |
40 | * (reference ) an assoc array of name/value pairs. | |
fd31fa4c | 41 | * |
81716ddb | 42 | * @return \CRM_Contribute_BAO_ContributionRecur|\CRM_Core_Error |
6a488035 TO |
43 | * @todo move hook calls / extended logic to create - requires changing calls to call create not add |
44 | */ | |
00be9182 | 45 | public static function add(&$params) { |
a7488080 | 46 | if (!empty($params['id'])) { |
6a488035 TO |
47 | CRM_Utils_Hook::pre('edit', 'ContributionRecur', $params['id'], $params); |
48 | } | |
49 | else { | |
50 | CRM_Utils_Hook::pre('create', 'ContributionRecur', NULL, $params); | |
51 | } | |
52 | ||
53 | // make sure we're not creating a new recurring contribution with the same transaction ID | |
54 | // or invoice ID as an existing recurring contribution | |
be2fb01f | 55 | $duplicates = []; |
6a488035 TO |
56 | if (self::checkDuplicate($params, $duplicates)) { |
57 | $error = CRM_Core_Error::singleton(); | |
58 | $d = implode(', ', $duplicates); | |
59 | $error->push(CRM_Core_Error::DUPLICATE_CONTRIBUTION, | |
60 | 'Fatal', | |
be2fb01f | 61 | [$d], |
6a488035 TO |
62 | "Found matching recurring contribution(s): $d" |
63 | ); | |
64 | return $error; | |
65 | } | |
66 | ||
67 | $recurring = new CRM_Contribute_BAO_ContributionRecur(); | |
68 | $recurring->copyValues($params); | |
9c1bc317 | 69 | $recurring->id = $params['id'] ?? NULL; |
6a488035 TO |
70 | |
71 | // set currency for CRM-1496 | |
8f7b45b0 | 72 | if (empty($params['id']) && !isset($recurring->currency)) { |
6a488035 TO |
73 | $config = CRM_Core_Config::singleton(); |
74 | $recurring->currency = $config->defaultCurrency; | |
75 | } | |
e06814a5 | 76 | $recurring->save(); |
6a488035 | 77 | |
a7488080 | 78 | if (!empty($params['id'])) { |
6a488035 TO |
79 | CRM_Utils_Hook::post('edit', 'ContributionRecur', $recurring->id, $recurring); |
80 | } | |
81 | else { | |
82 | CRM_Utils_Hook::post('create', 'ContributionRecur', $recurring->id, $recurring); | |
83 | } | |
84 | ||
95974e8e DG |
85 | if (!empty($params['custom']) && |
86 | is_array($params['custom']) | |
87 | ) { | |
88 | CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution_recur', $recurring->id); | |
89 | } | |
90 | ||
e06814a5 | 91 | return $recurring; |
6a488035 TO |
92 | } |
93 | ||
94 | /** | |
fe482240 | 95 | * Check if there is a recurring contribution with the same trxn_id or invoice_id. |
6a488035 | 96 | * |
014c4014 TO |
97 | * @param array $params |
98 | * (reference ) an assoc array of name/value pairs. | |
99 | * @param array $duplicates | |
c0f62075 | 100 | * (reference ) store ids of duplicate contributions. |
6a488035 | 101 | * |
e7483cbe | 102 | * @return bool |
a6c01b45 | 103 | * true if duplicate, false otherwise |
6a488035 | 104 | */ |
00be9182 | 105 | public static function checkDuplicate($params, &$duplicates) { |
9c1bc317 CW |
106 | $id = $params['id'] ?? NULL; |
107 | $trxn_id = $params['trxn_id'] ?? NULL; | |
108 | $invoice_id = $params['invoice_id'] ?? NULL; | |
6a488035 | 109 | |
be2fb01f CW |
110 | $clause = []; |
111 | $params = []; | |
6a488035 TO |
112 | |
113 | if ($trxn_id) { | |
114 | $clause[] = "trxn_id = %1"; | |
be2fb01f | 115 | $params[1] = [$trxn_id, 'String']; |
6a488035 TO |
116 | } |
117 | ||
118 | if ($invoice_id) { | |
119 | $clause[] = "invoice_id = %2"; | |
be2fb01f | 120 | $params[2] = [$invoice_id, 'String']; |
6a488035 TO |
121 | } |
122 | ||
123 | if (empty($clause)) { | |
124 | return FALSE; | |
125 | } | |
126 | ||
127 | $clause = implode(' OR ', $clause); | |
128 | if ($id) { | |
129 | $clause = "( $clause ) AND id != %3"; | |
be2fb01f | 130 | $params[3] = [$id, 'Integer']; |
6a488035 TO |
131 | } |
132 | ||
353ffa53 TO |
133 | $query = "SELECT id FROM civicrm_contribution_recur WHERE $clause"; |
134 | $dao = CRM_Core_DAO::executeQuery($query, $params); | |
6a488035 TO |
135 | $result = FALSE; |
136 | while ($dao->fetch()) { | |
137 | $duplicates[] = $dao->id; | |
138 | $result = TRUE; | |
139 | } | |
140 | return $result; | |
141 | } | |
142 | ||
186c9c17 | 143 | /** |
c0f62075 | 144 | * Get the payment processor (array) for a recurring processor. |
145 | * | |
100fef9d | 146 | * @param int $id |
186c9c17 EM |
147 | * |
148 | * @return array|null | |
149 | */ | |
87011153 | 150 | public static function getPaymentProcessor($id) { |
1a18d24f | 151 | $paymentProcessorID = self::getPaymentProcessorID($id); |
87011153 | 152 | return CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID); |
153 | } | |
6a488035 | 154 | |
87011153 | 155 | /** |
156 | * Get the processor object for the recurring contribution record. | |
157 | * | |
158 | * @param int $id | |
159 | * | |
160 | * @return CRM_Core_Payment|NULL | |
161 | * Returns a processor object or NULL if the processor is disabled. | |
162 | * Note this returns the 'Manual' processor object if no processor is attached | |
163 | * (since it still makes sense to update / cancel | |
164 | */ | |
165 | public static function getPaymentProcessorObject($id) { | |
166 | $processor = self::getPaymentProcessor($id); | |
167 | return is_array($processor) ? $processor['object'] : NULL; | |
6a488035 TO |
168 | } |
169 | ||
1a18d24f | 170 | /** |
171 | * Get the payment processor for the given recurring contribution. | |
172 | * | |
173 | * @param int $recurID | |
174 | * | |
175 | * @return int | |
176 | * Payment processor id. If none found return 0 which represents the | |
177 | * pseudo processor used for pay-later. | |
178 | */ | |
179 | public static function getPaymentProcessorID($recurID) { | |
180 | $recur = civicrm_api3('ContributionRecur', 'getsingle', [ | |
181 | 'id' => $recurID, | |
1330f57a | 182 | 'return' => ['payment_processor_id'], |
1a18d24f | 183 | ]); |
2975f0aa | 184 | return (int) ($recur['payment_processor_id'] ?? 0); |
1a18d24f | 185 | } |
186 | ||
6a488035 | 187 | /** |
c0f62075 | 188 | * Get the number of installment done/completed for each recurring contribution. |
6a488035 | 189 | * |
014c4014 TO |
190 | * @param array $ids |
191 | * (reference ) an array of recurring contribution ids. | |
6a488035 | 192 | * |
a6c01b45 CW |
193 | * @return array |
194 | * an array of recurring ids count | |
6a488035 | 195 | */ |
00be9182 | 196 | public static function getCount(&$ids) { |
6a488035 | 197 | $recurID = implode(',', $ids); |
be2fb01f | 198 | $totalCount = []; |
6a488035 | 199 | |
d5828a02 | 200 | $query = " |
6a488035 TO |
201 | SELECT contribution_recur_id, count( contribution_recur_id ) as commpleted |
202 | FROM civicrm_contribution | |
203 | WHERE contribution_recur_id IN ( {$recurID}) AND is_test = 0 | |
204 | GROUP BY contribution_recur_id"; | |
205 | ||
33621c4f | 206 | $res = CRM_Core_DAO::executeQuery($query); |
6a488035 TO |
207 | |
208 | while ($res->fetch()) { | |
209 | $totalCount[$res->contribution_recur_id] = $res->commpleted; | |
210 | } | |
211 | return $totalCount; | |
212 | } | |
213 | ||
214 | /** | |
215 | * Delete Recurring contribution. | |
216 | * | |
100fef9d | 217 | * @param int $recurId |
da6b46f4 | 218 | * |
ca26cb52 | 219 | * @return bool |
6a488035 | 220 | */ |
00be9182 | 221 | public static function deleteRecurContribution($recurId) { |
6a488035 TO |
222 | $result = FALSE; |
223 | if (!$recurId) { | |
224 | return $result; | |
225 | } | |
226 | ||
353ffa53 | 227 | $recur = new CRM_Contribute_DAO_ContributionRecur(); |
6a488035 | 228 | $recur->id = $recurId; |
353ffa53 | 229 | $result = $recur->delete(); |
6a488035 TO |
230 | |
231 | return $result; | |
232 | } | |
233 | ||
234 | /** | |
235 | * Cancel Recurring contribution. | |
236 | * | |
9cfc631e | 237 | * @param array $params |
238 | * Recur contribution params | |
6a488035 | 239 | * |
ca26cb52 | 240 | * @return bool |
6a488035 | 241 | */ |
3d3449ce | 242 | public static function cancelRecurContribution($params) { |
c3d06508 | 243 | if (is_numeric($params)) { |
9cfc631e | 244 | CRM_Core_Error::deprecatedFunctionWarning('You are using a BAO function whose signature has changed. Please use the ContributionRecur.cancel api'); |
245 | $params = ['id' => $params]; | |
246 | } | |
247 | $recurId = $params['id']; | |
6a488035 TO |
248 | if (!$recurId) { |
249 | return FALSE; | |
250 | } | |
3d3449ce | 251 | $activityParams = [ |
252 | 'subject' => !empty($params['membership_id']) ? ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'), | |
6b409353 | 253 | 'details' => $params['processor_message'] ?? NULL, |
3d3449ce | 254 | ]; |
6a488035 | 255 | |
c50eadbe | 256 | $cancelledId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Cancelled'); |
353ffa53 TO |
257 | $recur = new CRM_Contribute_DAO_ContributionRecur(); |
258 | $recur->id = $recurId; | |
c50eadbe | 259 | $recur->whereAdd("contribution_status_id != $cancelledId"); |
6a488035 TO |
260 | |
261 | if ($recur->find(TRUE)) { | |
262 | $transaction = new CRM_Core_Transaction(); | |
c50eadbe | 263 | $recur->contribution_status_id = $cancelledId; |
6a488035 TO |
264 | $recur->start_date = CRM_Utils_Date::isoToMysql($recur->start_date); |
265 | $recur->create_date = CRM_Utils_Date::isoToMysql($recur->create_date); | |
266 | $recur->modified_date = CRM_Utils_Date::isoToMysql($recur->modified_date); | |
9c1bc317 | 267 | $recur->cancel_reason = $params['cancel_reason'] ?? NULL; |
6a488035 TO |
268 | $recur->cancel_date = date('YmdHis'); |
269 | $recur->save(); | |
270 | ||
e143136a | 271 | // @fixme https://lab.civicrm.org/dev/core/issues/927 Cancelling membership etc is not desirable for all use-cases and we should be able to disable it |
6a488035 | 272 | $dao = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($recurId); |
bbf58b03 | 273 | if ($dao && $dao->recur_id) { |
9c1bc317 | 274 | $details = $activityParams['details'] ?? NULL; |
6a488035 TO |
275 | if ($dao->auto_renew && $dao->membership_id) { |
276 | // its auto-renewal membership mode | |
277 | $membershipTypes = CRM_Member_PseudoConstant::membershipType(); | |
353ffa53 | 278 | $membershipType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $dao->membership_id, 'membership_type_id'); |
9c1bc317 | 279 | $membershipType = $membershipTypes[$membershipType] ?? NULL; |
6a488035 | 280 | $details .= ' |
be2fb01f | 281 | <br/>' . ts('Automatic renewal of %1 membership cancelled.', [1 => $membershipType]); |
6a488035 TO |
282 | } |
283 | else { | |
3d3449ce | 284 | $details .= '<br/>' . ts('The recurring contribution of %1, every %2 %3 has been cancelled.', [ |
1330f57a SL |
285 | 1 => $dao->amount, |
286 | 2 => $dao->frequency_interval, | |
287 | 3 => $dao->frequency_unit, | |
288 | ]); | |
6a488035 | 289 | } |
be2fb01f | 290 | $activityParams = [ |
6a488035 | 291 | 'source_contact_id' => $dao->contact_id, |
fa413ad2 | 292 | 'source_record_id' => $dao->recur_id, |
3d3449ce | 293 | 'activity_type_id' => 'Cancel Recurring Contribution', |
6a488035 TO |
294 | 'subject' => CRM_Utils_Array::value('subject', $activityParams, ts('Recurring contribution cancelled')), |
295 | 'details' => $details, | |
3d3449ce | 296 | 'status_id' => 'Completed', |
be2fb01f | 297 | ]; |
3d3449ce | 298 | |
299 | $cid = CRM_Core_Session::singleton()->get('userID'); | |
6a488035 TO |
300 | if ($cid) { |
301 | $activityParams['target_contact_id'][] = $activityParams['source_contact_id']; | |
302 | $activityParams['source_contact_id'] = $cid; | |
303 | } | |
3d3449ce | 304 | civicrm_api3('Activity', 'create', $activityParams); |
6a488035 TO |
305 | } |
306 | ||
9d9d13dd | 307 | $transaction->commit(); |
308 | return TRUE; | |
6a488035 TO |
309 | } |
310 | else { | |
311 | // if already cancelled, return true | |
312 | $recur->whereAdd(); | |
c50eadbe | 313 | $recur->whereAdd("contribution_status_id = $cancelledId"); |
6a488035 TO |
314 | if ($recur->find(TRUE)) { |
315 | return TRUE; | |
316 | } | |
317 | } | |
318 | ||
319 | return FALSE; | |
320 | } | |
321 | ||
186c9c17 | 322 | /** |
100fef9d | 323 | * @param int $entityID |
186c9c17 EM |
324 | * @param string $entity |
325 | * | |
326 | * @return null|Object | |
327 | */ | |
00be9182 | 328 | public static function getSubscriptionDetails($entityID, $entity = 'recur') { |
6a488035 | 329 | $sql = " |
d5828a02 DL |
330 | SELECT rec.id as recur_id, |
331 | rec.processor_id as subscription_id, | |
6a488035 TO |
332 | rec.frequency_interval, |
333 | rec.installments, | |
334 | rec.frequency_unit, | |
335 | rec.amount, | |
336 | rec.is_test, | |
337 | rec.auto_renew, | |
338 | rec.currency, | |
7083dc2a | 339 | rec.campaign_id, |
467fe956 | 340 | rec.financial_type_id, |
0c6c47a5 | 341 | rec.next_sched_contribution_date, |
342 | rec.failure_retry_date, | |
343 | rec.cycle_day, | |
467fe956 | 344 | con.id as contribution_id, |
6a488035 | 345 | con.contribution_page_id, |
f0a7bcb5 | 346 | rec.contact_id, |
6a488035 TO |
347 | mp.membership_id"; |
348 | ||
349 | if ($entity == 'recur') { | |
350 | $sql .= " | |
d5828a02 | 351 | FROM civicrm_contribution_recur rec |
f0a7bcb5 | 352 | LEFT JOIN civicrm_contribution con ON ( con.contribution_recur_id = rec.id ) |
6a488035 | 353 | LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id ) |
0ee5581e | 354 | WHERE rec.id = %1"; |
6a488035 TO |
355 | } |
356 | elseif ($entity == 'contribution') { | |
357 | $sql .= " | |
358 | FROM civicrm_contribution con | |
d5828a02 | 359 | INNER JOIN civicrm_contribution_recur rec ON ( con.contribution_recur_id = rec.id ) |
6a488035 TO |
360 | LEFT JOIN civicrm_membership_payment mp ON ( mp.contribution_id = con.id ) |
361 | WHERE con.id = %1"; | |
362 | } | |
363 | elseif ($entity == 'membership') { | |
364 | $sql .= " | |
d5828a02 DL |
365 | FROM civicrm_membership_payment mp |
366 | INNER JOIN civicrm_membership mem ON ( mp.membership_id = mem.id ) | |
6a488035 TO |
367 | INNER JOIN civicrm_contribution_recur rec ON ( mem.contribution_recur_id = rec.id ) |
368 | INNER JOIN civicrm_contribution con ON ( con.id = mp.contribution_id ) | |
369 | WHERE mp.membership_id = %1"; | |
370 | } | |
371 | ||
be2fb01f | 372 | $dao = CRM_Core_DAO::executeQuery($sql, [1 => [$entityID, 'Integer']]); |
6a488035 TO |
373 | if ($dao->fetch()) { |
374 | return $dao; | |
375 | } | |
d5828a02 | 376 | else { |
467fe956 | 377 | return NULL; |
378 | } | |
379 | } | |
380 | ||
381 | /** | |
382 | * Does the recurring contribution support financial type change. | |
383 | * | |
384 | * This is conditional on there being only one line item or if there are no contributions as yet. | |
385 | * | |
386 | * (This second is a bit of an unusual condition but might occur in the context of a | |
387 | * | |
388 | * @param int $id | |
389 | * | |
390 | * @return bool | |
391 | */ | |
392 | public static function supportsFinancialTypeChange($id) { | |
393 | // At this stage only sites with no Financial ACLs will have the opportunity to edit the financial type. | |
394 | // this is to limit the scope of the change and because financial ACLs are still fairly new & settling down. | |
395 | if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) { | |
396 | return FALSE; | |
397 | } | |
398 | $contribution = self::getTemplateContribution($id); | |
399 | return CRM_Contribute_BAO_Contribution::isSingleLineItem($contribution['id']); | |
400 | } | |
401 | ||
402 | /** | |
403 | * Get the contribution to be used as the template for later contributions. | |
404 | * | |
405 | * Later we might merge in data stored against the contribution recur record rather than just return the contribution. | |
406 | * | |
407 | * @param int $id | |
43c8d1dd | 408 | * @param array $overrides |
409 | * Parameters that should be overriden. Add unit tests if using parameters other than total_amount & financial_type_id. | |
467fe956 | 410 | * |
411 | * @return array | |
562e4fb8 | 412 | * |
467fe956 | 413 | * @throws \CiviCRM_API3_Exception |
198f304d | 414 | * @throws \Civi\API\Exception\UnauthorizedException |
562e4fb8 | 415 | * @throws \API_Exception |
467fe956 | 416 | */ |
be2fb01f | 417 | public static function getTemplateContribution($id, $overrides = []) { |
0b2f1f29 AS |
418 | // use api3 because api4 doesn't handle ContributionRecur yet... |
419 | $is_test = civicrm_api3('ContributionRecur', 'getvalue', [ | |
420 | 'return' => "is_test", | |
421 | 'id' => $id, | |
422 | ]); | |
f306dbeb | 423 | // First look for new-style template contribution with is_template=1 |
e6e23728 | 424 | $templateContributions = \Civi\Api4\Contribution::get() |
198f304d | 425 | ->setCheckPermissions(FALSE) |
e6e23728 | 426 | ->addWhere('contribution_recur_id', '=', $id) |
f306dbeb | 427 | ->addWhere('is_template', '=', 1) |
0b2f1f29 | 428 | ->addWhere('is_test', '=', $is_test) |
e6e23728 AS |
429 | ->addOrderBy('id', 'DESC') |
430 | ->setLimit(1) | |
431 | ->execute(); | |
f306dbeb AS |
432 | if (!$templateContributions->count()) { |
433 | // Fall back to old style template contributions | |
434 | $templateContributions = \Civi\Api4\Contribution::get() | |
198f304d | 435 | ->setCheckPermissions(FALSE) |
f306dbeb AS |
436 | ->addWhere('contribution_recur_id', '=', $id) |
437 | ->addWhere('is_test', '=', $is_test) | |
438 | ->addOrderBy('id', 'DESC') | |
439 | ->setLimit(1) | |
440 | ->execute(); | |
441 | } | |
e6e23728 AS |
442 | if ($templateContributions->count()) { |
443 | $templateContribution = $templateContributions->first(); | |
444 | $result = array_merge($templateContribution, $overrides); | |
43c8d1dd | 445 | $result['line_item'] = CRM_Contribute_BAO_ContributionRecur::calculateRecurLineItems($id, $result['total_amount'], $result['financial_type_id']); |
446 | return $result; | |
d5828a02 | 447 | } |
be2fb01f | 448 | return []; |
6a488035 TO |
449 | } |
450 | ||
00be9182 | 451 | public static function setSubscriptionContext() { |
6a488035 TO |
452 | // handle context redirection for subscription url |
453 | $session = CRM_Core_Session::singleton(); | |
454 | if ($session->get('userID')) { | |
c490a46a CW |
455 | $url = FALSE; |
456 | $cid = CRM_Utils_Request::retrieve('cid', 'Integer'); | |
457 | $mid = CRM_Utils_Request::retrieve('mid', 'Integer'); | |
458 | $qfkey = CRM_Utils_Request::retrieve('key', 'String'); | |
edc80cda | 459 | $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric'); |
6a488035 TO |
460 | if ($cid) { |
461 | switch ($context) { | |
462 | case 'contribution': | |
463 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
464 | "reset=1&selectedChild=contribute&cid={$cid}" | |
465 | ); | |
466 | break; | |
467 | ||
468 | case 'membership': | |
469 | $url = CRM_Utils_System::url('civicrm/contact/view', | |
470 | "reset=1&selectedChild=member&cid={$cid}" | |
471 | ); | |
472 | break; | |
473 | ||
474 | case 'dashboard': | |
475 | $url = CRM_Utils_System::url('civicrm/user', "reset=1&id={$cid}"); | |
476 | break; | |
477 | } | |
478 | } | |
479 | if ($mid) { | |
480 | switch ($context) { | |
481 | case 'dashboard': | |
482 | $url = CRM_Utils_System::url('civicrm/member', "force=1&context={$context}&key={$qfkey}"); | |
483 | break; | |
484 | ||
485 | case 'search': | |
486 | $url = CRM_Utils_System::url('civicrm/member/search', "force=1&context={$context}&key={$qfkey}"); | |
487 | break; | |
488 | } | |
489 | } | |
490 | if ($url) { | |
491 | $session->pushUserContext($url); | |
492 | } | |
493 | } | |
494 | } | |
96025800 | 495 | |
0223e233 WA |
496 | /** |
497 | * CRM-16285 - Function to handle validation errors on form, for recurring contribution field. | |
ea3ddccf | 498 | * |
0223e233 WA |
499 | * @param array $fields |
500 | * The input form values. | |
501 | * @param array $files | |
502 | * The uploaded files if any. | |
ea3ddccf | 503 | * @param CRM_Core_Form $self |
504 | * @param array $errors | |
0223e233 | 505 | */ |
577d1236 WA |
506 | public static function validateRecurContribution($fields, $files, $self, &$errors) { |
507 | if (!empty($fields['is_recur'])) { | |
508 | if ($fields['frequency_interval'] <= 0) { | |
509 | $errors['frequency_interval'] = ts('Please enter a number for how often you want to make this recurring contribution (EXAMPLE: Every 3 months).'); | |
510 | } | |
511 | if ($fields['frequency_unit'] == '0') { | |
512 | $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).'); | |
513 | } | |
514 | } | |
515 | } | |
0223e233 | 516 | |
e577770c EM |
517 | /** |
518 | * Send start or end notification for recurring payments. | |
519 | * | |
520 | * @param array $ids | |
521 | * @param CRM_Contribute_BAO_ContributionRecur $recur | |
522 | * @param bool $isFirstOrLastRecurringPayment | |
523 | */ | |
524 | public static function sendRecurringStartOrEndNotification($ids, $recur, $isFirstOrLastRecurringPayment) { | |
525 | if ($isFirstOrLastRecurringPayment) { | |
526 | $autoRenewMembership = FALSE; | |
527 | if ($recur->id && | |
528 | isset($ids['membership']) && $ids['membership'] | |
529 | ) { | |
530 | $autoRenewMembership = TRUE; | |
531 | } | |
532 | ||
533 | //send recurring Notification email for user | |
534 | CRM_Contribute_BAO_ContributionPage::recurringNotify($isFirstOrLastRecurringPayment, | |
535 | $ids['contact'], | |
536 | $ids['contributionPage'], | |
537 | $recur, | |
538 | $autoRenewMembership | |
539 | ); | |
540 | } | |
541 | } | |
542 | ||
543 | /** | |
544 | * Copy custom data of the initial contribution into its recurring contributions. | |
545 | * | |
546 | * @param int $recurId | |
547 | * @param int $targetContributionId | |
548 | */ | |
1330f57a | 549 | public static function copyCustomValues($recurId, $targetContributionId) { |
e577770c EM |
550 | if ($recurId && $targetContributionId) { |
551 | // get the initial contribution id of recur id | |
552 | $sourceContributionId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); | |
553 | ||
554 | // if the same contribution is being processed then return | |
555 | if ($sourceContributionId == $targetContributionId) { | |
556 | return; | |
557 | } | |
558 | // check if proper recurring contribution record is being processed | |
559 | $targetConRecurId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id'); | |
560 | if ($targetConRecurId != $recurId) { | |
561 | return; | |
562 | } | |
563 | ||
564 | // copy custom data | |
be2fb01f | 565 | $extends = ['Contribution']; |
e577770c EM |
566 | $groupTree = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, NULL, $extends); |
567 | if ($groupTree) { | |
568 | foreach ($groupTree as $groupID => $group) { | |
be2fb01f | 569 | $table[$groupTree[$groupID]['table_name']] = ['entity_id']; |
e577770c EM |
570 | foreach ($group['fields'] as $fieldID => $field) { |
571 | $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name']; | |
572 | } | |
573 | } | |
574 | ||
575 | foreach ($table as $tableName => $tableColumns) { | |
d4721930 | 576 | $insert = 'INSERT IGNORE INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') '; |
e577770c EM |
577 | $tableColumns[0] = $targetContributionId; |
578 | $select = 'SELECT ' . implode(', ', $tableColumns); | |
579 | $from = ' FROM ' . $tableName; | |
580 | $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}"; | |
581 | $query = $insert . $select . $from . $where; | |
33621c4f | 582 | CRM_Core_DAO::executeQuery($query); |
e577770c EM |
583 | } |
584 | } | |
585 | } | |
586 | } | |
587 | ||
588 | /** | |
589 | * Add soft credit to for recurring payment. | |
590 | * | |
591 | * copy soft credit record of first recurring contribution. | |
592 | * and add new soft credit against $targetContributionId | |
593 | * | |
594 | * @param int $recurId | |
595 | * @param int $targetContributionId | |
596 | */ | |
597 | public static function addrecurSoftCredit($recurId, $targetContributionId) { | |
598 | $soft_contribution = new CRM_Contribute_DAO_ContributionSoft(); | |
599 | $soft_contribution->contribution_id = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id'); | |
600 | ||
601 | // Check if first recurring contribution has any associated soft credit. | |
602 | if ($soft_contribution->find(TRUE)) { | |
603 | $soft_contribution->contribution_id = $targetContributionId; | |
604 | unset($soft_contribution->id); | |
605 | $soft_contribution->save(); | |
606 | } | |
607 | } | |
608 | ||
609 | /** | |
610 | * Add line items for recurring contribution. | |
611 | * | |
612 | * @param int $recurId | |
81716ddb | 613 | * @param \CRM_Contribute_BAO_Contribution $contribution |
e577770c EM |
614 | * |
615 | * @return array | |
616 | */ | |
617 | public static function addRecurLineItems($recurId, $contribution) { | |
43c8d1dd | 618 | $foundLineItems = FALSE; |
619 | ||
620 | $lineSets = self::calculateRecurLineItems($recurId, $contribution->total_amount, $contribution->financial_type_id); | |
621 | foreach ($lineSets as $lineItems) { | |
622 | if (!empty($lineItems)) { | |
623 | foreach ($lineItems as $key => $value) { | |
624 | if ($value['entity_table'] == 'civicrm_membership') { | |
625 | try { | |
626 | // @todo this should be done by virtue of editing the line item as this link | |
627 | // is deprecated. This may be the case but needs testing. | |
be2fb01f | 628 | civicrm_api3('membership_payment', 'create', [ |
43c8d1dd | 629 | 'membership_id' => $value['entity_id'], |
630 | 'contribution_id' => $contribution->id, | |
0e0da23f | 631 | 'is_transactional' => FALSE, |
be2fb01f | 632 | ]); |
43c8d1dd | 633 | } |
634 | catch (CiviCRM_API3_Exception $e) { | |
635 | // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data | |
636 | // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated | |
637 | } | |
e577770c EM |
638 | } |
639 | } | |
43c8d1dd | 640 | $foundLineItems = TRUE; |
e577770c EM |
641 | } |
642 | } | |
43c8d1dd | 643 | if (!$foundLineItems) { |
e577770c EM |
644 | CRM_Price_BAO_LineItem::processPriceSet($contribution->id, $lineSets, $contribution); |
645 | } | |
646 | return $lineSets; | |
647 | } | |
648 | ||
649 | /** | |
650 | * Update pledge associated with a recurring contribution. | |
651 | * | |
652 | * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage. | |
653 | * | |
654 | * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution | |
655 | * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge & | |
656 | * it should be assumed they | |
657 | * do so with the intention that all payments will be linked | |
658 | * | |
659 | * The pledge payment record should already exist & will need to be updated with the new contribution ID. | |
660 | * If not the contribution will also need to be linked to the pledge | |
661 | * | |
294cc627 | 662 | * @param int $contributionID |
663 | * @param int $contributionRecurID | |
664 | * @param int $contributionStatusID | |
665 | * @param float $contributionAmount | |
666 | * | |
667 | * @throws \CiviCRM_API3_Exception | |
e577770c | 668 | */ |
294cc627 | 669 | public static function updateRecurLinkedPledge($contributionID, $contributionRecurID, $contributionStatusID, $contributionAmount) { |
be2fb01f CW |
670 | $returnProperties = ['id', 'pledge_id']; |
671 | $paymentDetails = $paymentIDs = []; | |
e577770c | 672 | |
294cc627 | 673 | if (CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contributionID, |
e577770c EM |
674 | $paymentDetails, $returnProperties |
675 | ) | |
676 | ) { | |
677 | foreach ($paymentDetails as $key => $value) { | |
678 | $paymentIDs[] = $value['id']; | |
679 | $pledgeId = $value['pledge_id']; | |
680 | } | |
681 | } | |
682 | else { | |
683 | //payment is not already linked - if it is linked with a pledge we need to create a link. | |
684 | // return if it is not recurring contribution | |
294cc627 | 685 | if (!$contributionRecurID) { |
e577770c EM |
686 | return; |
687 | } | |
688 | ||
689 | $relatedContributions = new CRM_Contribute_DAO_Contribution(); | |
294cc627 | 690 | $relatedContributions->contribution_recur_id = $contributionRecurID; |
e577770c EM |
691 | $relatedContributions->find(); |
692 | ||
693 | while ($relatedContributions->fetch()) { | |
694 | CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id, | |
695 | $paymentDetails, $returnProperties | |
696 | ); | |
697 | } | |
698 | ||
699 | if (empty($paymentDetails)) { | |
700 | // payment is not linked with a pledge and neither are any other contributions on this | |
701 | return; | |
702 | } | |
703 | ||
704 | foreach ($paymentDetails as $key => $value) { | |
705 | $pledgeId = $value['pledge_id']; | |
706 | } | |
707 | ||
708 | // we have a pledge now we need to get the oldest unpaid payment | |
709 | $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId); | |
710 | if (empty($paymentDetails['id'])) { | |
711 | // we can assume this pledge is now completed | |
712 | // return now so we don't create a core error & roll back | |
713 | return; | |
714 | } | |
294cc627 | 715 | $paymentDetails['contribution_id'] = $contributionID; |
716 | $paymentDetails['status_id'] = $contributionStatusID; | |
717 | $paymentDetails['actual_amount'] = $contributionAmount; | |
e577770c EM |
718 | |
719 | // put contribution against it | |
294cc627 | 720 | $payment = civicrm_api3('PledgePayment', 'create', $paymentDetails); |
721 | $paymentIDs[] = $payment['id']; | |
e577770c EM |
722 | } |
723 | ||
724 | // update pledge and corresponding payment statuses | |
294cc627 | 725 | CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contributionStatusID, |
726 | NULL, $contributionAmount | |
e577770c EM |
727 | ); |
728 | } | |
729 | ||
24782d26 | 730 | /** |
81716ddb | 731 | * @param CRM_Core_Form $form |
24782d26 | 732 | */ |
733 | public static function recurringContribution(&$form) { | |
734 | // Recurring contribution fields | |
1157f03f | 735 | foreach (self::getRecurringFields() as $key) { |
55feaf27 | 736 | if ($key == 'contribution_recur_payment_made' && !empty($form->_formValues) && |
24782d26 | 737 | !CRM_Utils_System::isNull(CRM_Utils_Array::value($key, $form->_formValues)) |
738 | ) { | |
739 | $form->assign('contribution_recur_pane_open', TRUE); | |
740 | break; | |
741 | } | |
24782d26 | 742 | // If data has been entered for a recurring field, tell the tpl layer to open the pane |
55feaf27 | 743 | if (!empty($form->_formValues) && !empty($form->_formValues[$key . '_relative']) || !empty($form->_formValues[$key . '_low']) || !empty($form->_formValues[$key . '_high'])) { |
24782d26 | 744 | $form->assign('contribution_recur_pane_open', TRUE); |
745 | break; | |
746 | } | |
747 | } | |
748 | ||
64127e03 | 749 | // If values have been supplied for recurring contribution fields, open the recurring contributions pane. |
be2fb01f | 750 | foreach (['contribution_status_id', 'payment_processor_id', 'processor_id', 'trxn_id'] as $fieldName) { |
64127e03 MWMC |
751 | if (!empty($form->_formValues['contribution_recur_' . $fieldName])) { |
752 | $form->assign('contribution_recur_pane_open', TRUE); | |
753 | break; | |
754 | } | |
755 | } | |
756 | ||
24782d26 | 757 | // Add field to check if payment is made for recurring contribution |
be2fb01f | 758 | $recurringPaymentOptions = [ |
c6021c27 ML |
759 | 1 => ts('All recurring contributions'), |
760 | 2 => ts('Recurring contributions with at least one payment'), | |
be2fb01f CW |
761 | ]; |
762 | $form->addRadio('contribution_recur_payment_made', NULL, $recurringPaymentOptions, ['allowClear' => TRUE]); | |
5af1389d VH |
763 | |
764 | // Add field for contribution status | |
765 | $form->addSelect('contribution_recur_contribution_status_id', | |
c0aaecf9 | 766 | ['entity' => 'contribution', 'multiple' => 'multiple', 'context' => 'search', 'options' => CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'search')] |
5af1389d VH |
767 | ); |
768 | ||
24782d26 | 769 | $form->addElement('text', 'contribution_recur_processor_id', ts('Processor ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'processor_id')); |
770 | $form->addElement('text', 'contribution_recur_trxn_id', ts('Transaction ID'), CRM_Core_DAO::getAttribute('CRM_Contribute_DAO_ContributionRecur', 'trxn_id')); | |
86a0d21e | 771 | |
46e67587 | 772 | $paymentProcessorOpts = CRM_Contribute_BAO_ContributionRecur::buildOptions('payment_processor_id', 'get'); |
5951bdaa MWMC |
773 | $form->add('select', 'contribution_recur_payment_processor_id', ts('Payment Processor ID'), $paymentProcessorOpts, FALSE, ['class' => 'crm-select2', 'multiple' => 'multiple']); |
774 | ||
be2fb01f | 775 | CRM_Core_BAO_Query::addCustomFormFields($form, ['ContributionRecur']); |
86a0d21e | 776 | |
24782d26 | 777 | } |
778 | ||
1157f03f SL |
779 | /** |
780 | * Get the metadata for fields to be included on the search form. | |
781 | * | |
782 | * @throws \CiviCRM_API3_Exception | |
783 | */ | |
784 | public static function getContributionRecurSearchFieldMetadata() { | |
785 | $fields = [ | |
786 | 'contribution_recur_start_date', | |
787 | 'contribution_recur_next_sched_contribution_date', | |
788 | 'contribution_recur_cancel_date', | |
789 | 'contribution_recur_end_date', | |
790 | 'contribution_recur_create_date', | |
791 | 'contribution_recur_modified_date', | |
792 | 'contribution_recur_failure_retry_date', | |
793 | ]; | |
794 | $metadata = civicrm_api3('ContributionRecur', 'getfields', [])['values']; | |
795 | return array_intersect_key($metadata, array_flip($fields)); | |
796 | } | |
797 | ||
24782d26 | 798 | /** |
799 | * Get fields for recurring contributions. | |
800 | * | |
801 | * @return array | |
802 | */ | |
803 | public static function getRecurringFields() { | |
be2fb01f | 804 | return [ |
1157f03f SL |
805 | 'contribution_recur_payment_made', |
806 | 'contribution_recur_start_date', | |
807 | 'contribution_recur_next_sched_contribution_date', | |
808 | 'contribution_recur_cancel_date', | |
809 | 'contribution_recur_end_date', | |
810 | 'contribution_recur_create_date', | |
811 | 'contribution_recur_modified_date', | |
812 | 'contribution_recur_failure_retry_date', | |
be2fb01f | 813 | ]; |
24782d26 | 814 | } |
815 | ||
91259407 | 816 | /** |
817 | * Update recurring contribution based on incoming payment. | |
818 | * | |
819 | * Do not rename or move this function without updating https://issues.civicrm.org/jira/browse/CRM-17655. | |
820 | * | |
821 | * @param int $recurringContributionID | |
822 | * @param string $paymentStatus | |
823 | * Payment status - this correlates to the machine name of the contribution status ID ie | |
824 | * - Completed | |
825 | * - Failed | |
1330f57a | 826 | * @param string $effectiveDate |
91259407 | 827 | * |
828 | * @throws \CiviCRM_API3_Exception | |
829 | */ | |
050e11d5 | 830 | public static function updateOnNewPayment($recurringContributionID, $paymentStatus, $effectiveDate) { |
46f459f2 | 831 | |
832 | $effectiveDate = $effectiveDate ? date('Y-m-d', strtotime($effectiveDate)) : date('Y-m-d'); | |
be2fb01f | 833 | if (!in_array($paymentStatus, ['Completed', 'Failed'])) { |
91259407 | 834 | return; |
835 | } | |
be2fb01f | 836 | $params = [ |
91259407 | 837 | 'id' => $recurringContributionID, |
be2fb01f | 838 | 'return' => [ |
91259407 | 839 | 'contribution_status_id', |
840 | 'next_sched_contribution_date', | |
841 | 'frequency_unit', | |
842 | 'frequency_interval', | |
843 | 'installments', | |
844 | 'failure_count', | |
be2fb01f CW |
845 | ], |
846 | ]; | |
91259407 | 847 | |
848 | $existing = civicrm_api3('ContributionRecur', 'getsingle', $params); | |
849 | ||
850 | if ($paymentStatus == 'Completed' | |
851 | && CRM_Contribute_PseudoConstant::contributionStatus($existing['contribution_status_id'], 'name') == 'Pending') { | |
852 | $params['contribution_status_id'] = 'In Progress'; | |
853 | } | |
854 | if ($paymentStatus == 'Failed') { | |
855 | $params['failure_count'] = $existing['failure_count']; | |
856 | } | |
857 | $params['modified_date'] = date('Y-m-d H:i:s'); | |
858 | ||
859 | if (!empty($existing['installments']) && self::isComplete($recurringContributionID, $existing['installments'])) { | |
860 | $params['contribution_status_id'] = 'Completed'; | |
861 | } | |
862 | else { | |
863 | // Only update next sched date if it's empty or 'just now' because payment processors may be managing | |
864 | // the scheduled date themselves as core did not previously provide any help. | |
48f50324 | 865 | if (empty($existing['next_sched_contribution_date']) || strtotime($existing['next_sched_contribution_date']) == |
050e11d5 | 866 | strtotime($effectiveDate)) { |
867 | $params['next_sched_contribution_date'] = date('Y-m-d', strtotime('+' . $existing['frequency_interval'] . ' ' . $existing['frequency_unit'], strtotime($effectiveDate))); | |
91259407 | 868 | } |
869 | } | |
870 | civicrm_api3('ContributionRecur', 'create', $params); | |
871 | } | |
872 | ||
873 | /** | |
874 | * Is this recurring contribution now complete. | |
875 | * | |
876 | * Have all the payments expected been received now. | |
877 | * | |
878 | * @param int $recurringContributionID | |
879 | * @param int $installments | |
880 | * | |
881 | * @return bool | |
882 | */ | |
883 | protected static function isComplete($recurringContributionID, $installments) { | |
884 | $paidInstallments = CRM_Core_DAO::singleValueQuery( | |
28cfbff7 | 885 | 'SELECT count(*) FROM civicrm_contribution |
050e11d5 | 886 | WHERE contribution_recur_id = %1 |
887 | AND contribution_status_id = ' . CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'), | |
be2fb01f | 888 | [1 => [$recurringContributionID, 'Integer']] |
91259407 | 889 | ); |
890 | if ($paidInstallments >= $installments) { | |
891 | return TRUE; | |
892 | } | |
893 | return FALSE; | |
894 | } | |
895 | ||
43c8d1dd | 896 | /** |
897 | * Calculate line items for the relevant recurring calculation. | |
898 | * | |
899 | * @param int $recurId | |
900 | * @param string $total_amount | |
901 | * @param int $financial_type_id | |
902 | * | |
903 | * @return array | |
904 | */ | |
905 | public static function calculateRecurLineItems($recurId, $total_amount, $financial_type_id) { | |
be2fb01f | 906 | $originalContribution = civicrm_api3('Contribution', 'getsingle', [ |
1330f57a SL |
907 | 'contribution_recur_id' => $recurId, |
908 | 'contribution_test' => '', | |
909 | 'options' => ['limit' => 1], | |
910 | 'return' => ['id', 'financial_type_id'], | |
be2fb01f | 911 | ]); |
2b0de476 | 912 | $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($originalContribution['id']); |
be2fb01f | 913 | $lineSets = []; |
43c8d1dd | 914 | if (count($lineItems) == 1) { |
915 | foreach ($lineItems as $index => $lineItem) { | |
2b0de476 E |
916 | if ($lineItem['financial_type_id'] != $originalContribution['financial_type_id']) { |
917 | // 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. | |
918 | $financial_type_id = $lineItem['financial_type_id']; | |
919 | } | |
43c8d1dd | 920 | if ($financial_type_id) { |
921 | // CRM-17718 allow for possibility of changed financial type ID having been set prior to calling this. | |
922 | $lineItem['financial_type_id'] = $financial_type_id; | |
923 | } | |
5d8c94bc JP |
924 | $taxAmountMatches = FALSE; |
925 | if ((!empty($lineItem['tax_amount']) && ($lineItem['line_total'] + $lineItem['tax_amount']) == $total_amount)) { | |
926 | $taxAmountMatches = TRUE; | |
927 | } | |
928 | if ($lineItem['line_total'] != $total_amount && !$taxAmountMatches) { | |
43c8d1dd | 929 | // We are dealing with a changed amount! Per CRM-16397 we can work out what to do with these |
930 | // if there is only one line item, and the UI should prevent this situation for those with more than one. | |
931 | $lineItem['line_total'] = $total_amount; | |
932 | $lineItem['unit_price'] = round($total_amount / $lineItem['qty'], 2); | |
933 | } | |
934 | $priceField = new CRM_Price_DAO_PriceField(); | |
935 | $priceField->id = $lineItem['price_field_id']; | |
936 | $priceField->find(TRUE); | |
28cfbff7 | 937 | $lineSets[$priceField->price_set_id][$lineItem['price_field_id']] = $lineItem; |
43c8d1dd | 938 | } |
939 | } | |
7150b1c8 | 940 | // CRM-19309 if more than one then just pass them through: |
0e6ccb2e K |
941 | elseif (count($lineItems) > 1) { |
942 | foreach ($lineItems as $index => $lineItem) { | |
28cfbff7 | 943 | $lineSets[$index][$lineItem['price_field_id']] = $lineItem; |
0e6ccb2e K |
944 | } |
945 | } | |
946 | ||
43c8d1dd | 947 | return $lineSets; |
948 | } | |
949 | ||
c2047803 | 950 | /** |
c50eadbe | 951 | * Returns array with statuses that are considered to make a recurring contribution inactive. |
c2047803 CR |
952 | * |
953 | * @return array | |
954 | */ | |
955 | public static function getInactiveStatuses() { | |
c50eadbe | 956 | return ['Cancelled', 'Failed', 'Completed']; |
c2047803 CR |
957 | } |
958 | ||
46e67587 | 959 | /** |
39868387 | 960 | * @inheritDoc |
46e67587 | 961 | */ |
be2fb01f | 962 | public static function buildOptions($fieldName, $context = NULL, $props = []) { |
39868387 | 963 | $params = []; |
46e67587 MWMC |
964 | switch ($fieldName) { |
965 | case 'payment_processor_id': | |
966 | if (isset(\Civi::$statics[__CLASS__]['buildoptions_payment_processor_id'])) { | |
967 | return \Civi::$statics[__CLASS__]['buildoptions_payment_processor_id']; | |
968 | } | |
969 | $baoName = 'CRM_Contribute_BAO_ContributionRecur'; | |
39868387 CW |
970 | $params['condition']['test'] = "is_test = 0"; |
971 | $liveProcessors = CRM_Core_PseudoConstant::get($baoName, $fieldName, $params, $context); | |
972 | $params['condition']['test'] = "is_test != 0"; | |
973 | $testProcessors = CRM_Core_PseudoConstant::get($baoName, $fieldName, $params, $context); | |
46e67587 MWMC |
974 | foreach ($testProcessors as $key => $value) { |
975 | if ($context === 'validate') { | |
976 | // @fixme: Ideally the names would be different in the civicrm_payment_processor table but they are not. | |
977 | // So we append '_test' to the test one so that we can select the correct processor by name using the ContributionRecur.create API. | |
978 | $testProcessors[$key] = $value . '_test'; | |
979 | } | |
980 | else { | |
981 | $testProcessors[$key] = CRM_Core_TestEntity::appendTestText($value); | |
982 | } | |
983 | } | |
984 | $allProcessors = $liveProcessors + $testProcessors; | |
985 | ksort($allProcessors); | |
986 | \Civi::$statics[__CLASS__]['buildoptions_payment_processor_id'] = $allProcessors; | |
987 | return $allProcessors; | |
988 | } | |
39868387 | 989 | return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context); |
46e67587 MWMC |
990 | } |
991 | ||
6a488035 | 992 | } |