3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Contribute_BAO_Contribution
extends CRM_Contribute_DAO_Contribution
{
20 * Static field for all the contribution information that we can potentially import
24 public static $_importableFields = NULL;
27 * Static field for all the contribution information that we can potentially export
31 public static $_exportableFields = NULL;
34 * Static field to hold financial trxn id's.
38 public static $_trxnIDs = NULL;
41 * Field for all the objects related to this contribution
43 * @var \CRM_Member_BAO_Membership|\CRM_Event_BAO_Participant[]
45 public $_relatedObjects = [];
48 * Field for the component - either 'event' (participant) or 'contribute'
49 * (any item related to a contribution page e.g. membership, pledge, contribution)
50 * This is used for composing messages because they have dependency on the
51 * contribution_page or event page - although over time we may eliminate that
54 * "contribution"\"event"
56 public $_component = NULL;
59 * Possibly obsolete variable.
61 * If you use it please explain why it is set in the create function here.
65 public $trxn_result_code;
70 public function __construct() {
71 parent
::__construct();
75 * Takes an associative array and creates a contribution object.
77 * the function extract all the params it needs to initialize the create a
78 * contribution object. the params array could contain additional unused name/value
81 * @param array $params
82 * (reference ) an assoc array of name/value pairs.
84 * The array that holds all the db ids.
86 * @return \CRM_Contribute_BAO_Contribution
87 * @throws \CRM_Core_Exception
88 * @throws \CiviCRM_API3_Exception
90 public static function add(&$params, $ids = []) {
95 CRM_Core_Error
::deprecatedFunctionWarning('ids should not be passed into Contribution.add');
97 //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
98 $contributionID = CRM_Utils_Array
::value('contribution', $ids, CRM_Utils_Array
::value('id', $params));
99 $action = $contributionID ?
'edit' : 'create';
101 if (self
::checkDuplicate($params, $duplicates, $contributionID)) {
102 $message = ts("Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: %1", [1 => implode(', ', $duplicates)]);
103 throw new CRM_Core_Exception($message);
106 //set defaults in create mode
107 if (!$contributionID) {
108 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
109 if (empty($params['invoice_number']) && CRM_Invoicing_Utils
::isInvoicingEnabled()) {
110 $nextContributionID = CRM_Core_DAO
::singleValueQuery("SELECT COALESCE(MAX(id) + 1, 1) FROM civicrm_contribution");
111 $params['invoice_number'] = self
::getInvoiceNumber($nextContributionID);
115 $contributionStatusID = $params['contribution_status_id'] ??
NULL;
116 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', (int) $contributionStatusID) === 'Partially paid' && empty($params['is_post_payment_create'])) {
117 CRM_Core_Error
::deprecatedFunctionWarning('Setting status to partially paid other than by using Payment.create is deprecated and unreliable');
119 if (!$contributionStatusID) {
120 // Since the fee amount is expecting this (later on) ensure it is always set.
121 // It would only not be set for an update where it is unchanged.
122 $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', [
123 'id' => $contributionID,
124 'return' => 'contribution_status_id',
127 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', (int) $params['contribution_status_id']);
130 && CRM_Utils_Array
::value('membership_id', $params)
131 && Civi
::settings()->get('deferred_revenue_enabled')
133 $memberStartDate = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
134 if ($memberStartDate) {
135 $params['revenue_recognition_date'] = date('Ymd', strtotime($memberStartDate));
138 self
::calculateMissingAmountParams($params, $contributionID);
140 if (!empty($params['payment_instrument_id'])) {
141 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument('name');
142 if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
143 $params['check_number'] = 'null';
147 $setPrevContribution = TRUE;
148 // CRM-13964 partial payment
149 if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])) {
150 CRM_Core_Error
::deprecatedFunctionWarning('partial_amount params are deprecated from Contribution.create - use Payment.create');
151 $partialAmtTotal = $params['partial_payment_total'];
152 $partialAmtPay = $params['partial_amount_to_pay'];
153 $params['total_amount'] = $partialAmtTotal;
154 if ($partialAmtPay < $partialAmtTotal) {
155 $params['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Partially paid');
156 $params['is_pay_later'] = 0;
157 $setPrevContribution = FALSE;
160 if ($contributionID && $setPrevContribution) {
161 $params['prevContribution'] = self
::getOriginalContribution($contributionID);
163 $previousContributionStatus = ($contributionID && !empty($params['prevContribution'])) ? CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', (int) $params['prevContribution']->contribution_status_id
) : NULL;
165 if ($contributionID && !empty($params['revenue_recognition_date'])
166 && !($previousContributionStatus === 'Pending')
167 && !self
::allowUpdateRevenueRecognitionDate($contributionID)
169 unset($params['revenue_recognition_date']);
172 if (!isset($params['tax_amount']) && $setPrevContribution && (isset($params['total_amount']) ||
173 isset($params['financial_type_id']))) {
174 $params = CRM_Contribute_BAO_Contribution
::checkTaxAmount($params);
177 CRM_Utils_Hook
::pre($action, 'Contribution', $contributionID, $params);
179 $contribution = new CRM_Contribute_BAO_Contribution();
180 $contribution->copyValues($params);
182 $contribution->id
= $contributionID;
184 if (empty($contribution->id
)) {
185 // (only) on 'create', make sure that a valid currency is set (CRM-16845)
186 if (!CRM_Utils_Rule
::currencyCode($contribution->currency
)) {
187 $contribution->currency
= CRM_Core_Config
::singleton()->defaultCurrency
;
191 $result = $contribution->save();
193 // Add financial_trxn details as part of fix for CRM-4724
194 $contribution->trxn_result_code
= $params['trxn_result_code'] ??
NULL;
195 $contribution->payment_processor
= $params['payment_processor'] ??
NULL;
197 //add Account details
198 $params['contribution'] = $contribution;
199 if (empty($params['is_post_payment_create'])) {
200 // If this is being called from the Payment.create api/ BAO then that Entity
201 // takes responsibility for the financial transactions. In fact calling Payment.create
202 // to add payments & having it call completetransaction and / or contribution.create
203 // to update related entities is the preferred flow.
204 // Note that leveraging this parameter for any other code flow is not supported and
205 // is likely to break in future and / or cause serious problems in your data.
206 // https://github.com/civicrm/civicrm-core/pull/14673
207 self
::recordFinancialAccounts($params);
210 if (self
::isUpdateToRecurringContribution($params)) {
211 CRM_Contribute_BAO_ContributionRecur
::updateOnNewPayment(
212 (!empty($params['contribution_recur_id']) ?
$params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id
),
214 CRM_Utils_Array
::value('receive_date', $params)
218 $params['contribution_id'] = $contribution->id
;
220 if (!empty($params['custom']) &&
221 is_array($params['custom'])
223 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution', $contribution->id
, $action);
226 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
228 CRM_Utils_Hook
::post($action, 'Contribution', $contribution->id
, $contribution);
233 * Is this contribution updating an existing recurring contribution.
235 * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
236 * pending payment is being confirmed (or failing).
238 * @param array $params
242 public static function isUpdateToRecurringContribution($params) {
243 if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
246 if (empty($params['prevContribution']) ||
empty($params['contribution_status_id'])) {
249 if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id
)) {
252 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
253 if ($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatus)) {
260 * Get defaults for new entity.
264 public static function getDefaults() {
266 'payment_instrument_id' => key(CRM_Core_OptionGroup
::values('payment_instrument',
267 FALSE, FALSE, FALSE, 'AND is_default = 1')
269 'contribution_status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
270 'receive_date' => date('Y-m-d H:i:s'),
275 * Fetch the object and store the values in the values array.
277 * @param array $params
278 * Input parameters to find object.
279 * @param array $values
280 * Output values of the object.
282 * The array that holds all the db ids.
284 * @return CRM_Contribute_BAO_Contribution|null
285 * The found object or null
287 public static function getValues($params, &$values = [], &$ids = []) {
288 if (empty($params)) {
291 $contribution = new CRM_Contribute_BAO_Contribution();
293 $contribution->copyValues($params);
295 if ($contribution->find(TRUE)) {
296 $ids['contribution'] = $contribution->id
;
298 CRM_Core_DAO
::storeValues($contribution, $values);
300 return $contribution;
302 // return by reference
308 * Get the values and resolve the most common mappings.
310 * Since contribution status is resolved in almost every function that calls getValues it makes
311 * sense to have an extra function to resolve it rather than repeat the code.
313 * Think carefully before adding more mappings to be resolved as there could be performance implications
314 * if this function starts to be called from more iterative functions.
316 * @param array $params
317 * Input parameters to find object.
320 * Array of the found contribution.
321 * @throws CRM_Core_Exception
323 public static function getValuesWithMappings($params) {
325 $contribution = self
::getValues($params, $values, $ids);
326 if (is_null($contribution)) {
327 throw new CRM_Core_Exception('No contribution found');
329 $values['contribution_status'] = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
334 * Calculate net_amount & fee_amount if they are not set.
336 * Net amount should be total - fee.
337 * This should only be called for new contributions.
339 * @param array $params
340 * Params for a new contribution before they are saved.
341 * @param int|null $contributionID
342 * Contribution ID if we are dealing with an update.
344 * @throws \CiviCRM_API3_Exception
346 public static function calculateMissingAmountParams(&$params, $contributionID) {
347 if (!$contributionID && !isset($params['fee_amount'])) {
348 if (isset($params['total_amount']) && isset($params['net_amount'])) {
349 $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
352 $params['fee_amount'] = 0;
355 if (!isset($params['net_amount'])) {
356 if (!$contributionID) {
357 $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
360 if (isset($params['fee_amount']) ||
isset($params['total_amount'])) {
361 // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
362 // net_amount may need adjusting.
363 $contribution = civicrm_api3('Contribution', 'getsingle', [
364 'id' => $contributionID,
365 'return' => ['total_amount', 'net_amount', 'fee_amount'],
367 $totalAmount = (isset($params['total_amount']) ?
(float) $params['total_amount'] : (float) CRM_Utils_Array
::value('total_amount', $contribution));
368 $feeAmount = (isset($params['fee_amount']) ?
(float) $params['fee_amount'] : (float) CRM_Utils_Array
::value('fee_amount', $contribution));
369 $params['net_amount'] = $totalAmount - $feeAmount;
377 * @param $billingLocationTypeID
381 protected static function getBillingAddressParams($params, $billingLocationTypeID) {
382 $hasBillingField = FALSE;
391 //build address array
393 $addressParams['location_type_id'] = $billingLocationTypeID;
394 $addressParams['is_billing'] = 1;
396 $billingFirstName = $params['billing_first_name'] ??
NULL;
397 $billingMiddleName = $params['billing_middle_name'] ??
NULL;
398 $billingLastName = $params['billing_last_name'] ??
NULL;
399 $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingMiddleName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingLastName}";
401 foreach ($billingFields as $value) {
402 $addressParams[$value] = $params["billing_{$value}-{$billingLocationTypeID}"] ??
NULL;
403 if (!empty($addressParams[$value])) {
404 $hasBillingField = TRUE;
407 return [$hasBillingField, $addressParams];
411 * Get address params ready to be passed to the payment processor.
413 * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
414 * To create an address we need state_province_id.
416 * @param array $params
417 * @param int $billingLocationTypeID
421 public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
422 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
423 foreach ($addressParams as $name => $field) {
424 if (substr($name, 0, 8) == 'billing_') {
425 $addressParams[substr($name, 9)] = $addressParams[$field];
428 return [$hasBillingField, $addressParams];
432 * Get the number of terms for this contribution for a given membership type
433 * based on querying the line item table and relevant price field values
434 * Note that any one contribution should only be able to have one line item relating to a particular membership
437 * @param int $membershipTypeID
439 * @param int $contributionID
443 public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
444 $numTerms = CRM_Core_DAO
::singleValueQuery("
445 SELECT membership_num_terms FROM civicrm_line_item li
446 LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
447 WHERE contribution_id = %1 AND membership_type_id = %2",
448 [1 => [$contributionID, 'Integer'], 2 => [$membershipTypeID, 'Integer']]
450 // default of 1 is precautionary
451 return empty($numTerms) ?
1 : $numTerms;
455 * Takes an associative array and creates a contribution object.
457 * @param array $params
458 * (reference ) an assoc array of name/value pairs.
460 * The array that holds all the db ids.
462 * @return CRM_Contribute_BAO_Contribution
464 * @throws \CRM_Core_Exception
465 * @throws \CiviCRM_API3_Exception
467 public static function create(&$params, $ids = []) {
473 'revenue_recognition_date',
475 foreach ($dateFields as $df) {
476 if (isset($params[$df])) {
477 $params[$df] = CRM_Utils_Date
::isoToMysql($params[$df]);
481 $transaction = new CRM_Core_Transaction();
484 if (!isset($params['id']) && isset($ids['contribution'])) {
485 CRM_Core_Error
::deprecatedFunctionWarning('ids should not be used for contribution create');
486 $params['id'] = $ids['contribution'];
488 $contribution = self
::add($params);
490 catch (CRM_Core_Exception
$e) {
491 $transaction->rollback();
495 $params['contribution_id'] = $contribution->id
;
496 $session = CRM_Core_Session
::singleton();
498 if (!empty($params['note'])) {
500 'entity_table' => 'civicrm_contribution',
501 'note' => $params['note'],
502 'entity_id' => $contribution->id
,
503 'contact_id' => $session->get('userID'),
505 if (!$noteParams['contact_id']) {
506 $noteParams['contact_id'] = $params['contact_id'];
508 CRM_Core_BAO_Note
::add($noteParams);
511 // make entry in batch entity batch table
512 if (!empty($params['batch_id'])) {
513 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
520 $retrieveRequired = 0;
521 foreach ($titleFields as $titleField) {
522 if (!isset($contribution->$titleField)) {
523 $retrieveRequired = 1;
527 if ($retrieveRequired == 1) {
528 $contribution->find(TRUE);
532 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
534 $transaction->commit();
536 $activity = civicrm_api3('Activity', 'get', [
537 'source_record_id' => $contribution->id
,
538 'options' => ['limit' => 1],
540 'activity_type_id' => 'Contribution',
541 'return' => ['id', 'campaign'],
544 //CRM-18406: Update activity when edit contribution.
545 if ($activity['count']) {
546 // CRM-13237 : if activity record found, update it with campaign id of contribution
547 // @todo compare campaign ids first.
548 CRM_Core_DAO
::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id
);
549 $contribution->activity_id
= $activity['id'];
552 if (empty($contribution->contact_id
)) {
553 $contribution->find(TRUE);
555 CRM_Activity_BAO_Activity
::addActivity($contribution, 'Contribution');
557 // do not add to recent items for import, CRM-4399
558 if (empty($params['skipRecentView'])) {
559 $url = CRM_Utils_System
::url('civicrm/contact/view/contribution',
560 "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
562 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
569 $retrieveRequired = 0;
570 foreach ($titleFields as $titleField) {
571 if (!isset($contribution->$titleField)) {
572 $retrieveRequired = 1;
576 if ($retrieveRequired == 1) {
577 $contribution->find(TRUE);
579 $financialType = CRM_Contribute_PseudoConstant
::financialType($contribution->financial_type_id
);
580 $title = CRM_Contact_BAO_Contact
::displayName($contribution->contact_id
) . ' - (' . CRM_Utils_Money
::format($contribution->total_amount
, $contribution->currency
) . ' ' . ' - ' . $financialType . ')';
583 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::UPDATE
)) {
584 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
585 "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
589 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::DELETE
)) {
590 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
591 "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
595 // add the recently created Contribution
596 CRM_Utils_Recent
::add($title,
600 $contribution->contact_id
,
606 return $contribution;
610 * Get the values for pseudoconstants for name->value and reverse.
612 * @param array $defaults
613 * (reference) the default values, some of which need to be resolved.
614 * @param bool $reverse
615 * True if we want to resolve the values in the reverse direction (value -> name).
617 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
618 self
::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant
::financialType(), $reverse);
619 self
::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant
::paymentInstrument(), $reverse);
620 self
::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'label'), $reverse);
621 self
::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant
::pcPage(), $reverse);
625 * Convert associative array names to values and vice-versa.
627 * This function is used by both the web form layer and the api. Note that
628 * the api needs the name => value conversion, also the view layer typically
629 * requires value => name conversion
631 * @param array $defaults
632 * @param string $property
633 * @param array $lookup
634 * @param bool $reverse
638 public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
639 $id = $property . '_id';
641 $src = $reverse ?
$property : $id;
642 $dst = $reverse ?
$id : $property;
644 if (!array_key_exists($src, $defaults)) {
648 $look = $reverse ?
array_flip($lookup) : $lookup;
650 if (is_array($look)) {
651 if (!array_key_exists($defaults[$src], $look)) {
655 $defaults[$dst] = $look[$defaults[$src]];
660 * Retrieve DB object based on input parameters.
662 * It also stores all the retrieved values in the default array.
664 * @param array $params
665 * (reference ) an assoc array of name/value pairs.
666 * @param array $defaults
667 * (reference ) an assoc array to hold the name / value pairs.
668 * in a hierarchical manner
670 * (reference) the array that holds all the db ids.
672 * @return CRM_Contribute_BAO_Contribution
674 public static function retrieve(&$params, &$defaults = [], &$ids = []) {
675 $contribution = CRM_Contribute_BAO_Contribution
::getValues($params, $defaults, $ids);
676 return $contribution;
680 * Combine all the importable fields from the lower levels object.
682 * The ordering is important, since currently we do not have a weight
683 * scheme. Adding weight is super important and should be done in the
684 * next week or so, before this can be called complete.
686 * @param string $contactType
687 * @param bool $status
690 * array of importable Fields
692 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
693 if (!self
::$_importableFields) {
694 if (!self
::$_importableFields) {
695 self
::$_importableFields = [];
699 $fields = ['' => ['title' => ts('- do not import -')]];
702 $fields = ['' => ['title' => ts('- Contribution Fields -')]];
705 $note = CRM_Core_DAO_Note
::import();
706 $tmpFields = CRM_Contribute_DAO_Contribution
::import();
707 unset($tmpFields['option_value']);
708 $optionFields = CRM_Core_OptionValue
::getFields($mode = 'contribute');
709 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
711 // Using new Dedupe rule.
713 'contact_type' => $contactType,
714 'used' => 'Unsupervised',
716 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
717 $tmpContactField = [];
718 if (is_array($fieldsArray)) {
719 foreach ($fieldsArray as $value) {
720 //skip if there is no dupe rule
721 if ($value == 'none') {
724 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
729 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
730 $tmpContactField[trim($value)] = $contactFields[trim($value)];
732 $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
735 $title = $tmpContactField[trim($value)]['title'];
737 $tmpContactField[trim($value)]['title'] = $title;
741 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
742 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
743 $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
744 $fields = array_merge($fields, $tmpContactField);
745 $fields = array_merge($fields, $tmpFields);
746 $fields = array_merge($fields, $note);
747 $fields = array_merge($fields, $optionFields);
748 $fields = array_merge($fields, CRM_Financial_DAO_FinancialType
::export());
749 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
750 self
::$_importableFields = $fields;
752 return self
::$_importableFields;
756 * Combine all the exportable fields from the lower level objects.
758 * @param bool $checkPermission
761 * array of exportable Fields
763 public static function &exportableFields($checkPermission = TRUE) {
764 if (!self
::$_exportableFields) {
765 if (!self
::$_exportableFields) {
766 self
::$_exportableFields = [];
769 $fields = CRM_Contribute_DAO_Contribution
::export();
770 if (CRM_Contribute_BAO_Query
::isSiteHasProducts()) {
771 $fields = array_merge(
773 CRM_Contribute_DAO_Product
::export(),
774 CRM_Contribute_DAO_ContributionProduct
::export(),
775 // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
777 'contribution_product_id' => [
778 'title' => ts('Premium'),
779 'name' => 'contribution_product_id',
780 'where' => 'civicrm_product.id',
781 'data_type' => CRM_Utils_Type
::T_INT
,
787 $financialAccount = CRM_Financial_DAO_FinancialAccount
::export();
789 $contributionPage = [
790 'contribution_page' => [
791 'title' => ts('Contribution Page'),
792 'name' => 'contribution_page',
793 'where' => 'civicrm_contribution_page.title',
794 'data_type' => CRM_Utils_Type
::T_STRING
,
798 $contributionNote = [
799 'contribution_note' => [
800 'title' => ts('Contribution Note'),
801 'name' => 'contribution_note',
802 'data_type' => CRM_Utils_Type
::T_TEXT
,
807 'contribution_batch' => [
808 'title' => ts('Batch Name'),
814 'contribution_campaign_title' => [
815 'title' => ts('Campaign Title'),
816 'name' => 'campaign_title',
817 'where' => 'civicrm_campaign.title',
818 'data_type' => CRM_Utils_Type
::T_STRING
,
821 $softCreditFields = [
822 'contribution_soft_credit_name' => [
823 'name' => 'contribution_soft_credit_name',
824 'title' => ts('Soft Credit For'),
825 'where' => 'civicrm_contact_d.display_name',
826 'data_type' => CRM_Utils_Type
::T_STRING
,
828 'contribution_soft_credit_amount' => [
829 'name' => 'contribution_soft_credit_amount',
830 'title' => ts('Soft Credit Amount'),
831 'where' => 'civicrm_contribution_soft.amount',
832 'data_type' => CRM_Utils_Type
::T_MONEY
,
834 'contribution_soft_credit_type' => [
835 'name' => 'contribution_soft_credit_type',
836 'title' => ts('Soft Credit Type'),
837 'where' => 'contribution_softcredit_type.label',
838 'data_type' => CRM_Utils_Type
::T_STRING
,
840 'contribution_soft_credit_contribution_id' => [
841 'name' => 'contribution_soft_credit_contribution_id',
842 'title' => ts('Soft Credit For Contribution ID'),
843 'where' => 'civicrm_contribution_soft.contribution_id',
844 'data_type' => CRM_Utils_Type
::T_INT
,
846 'contribution_soft_credit_contact_id' => [
847 'name' => 'contribution_soft_credit_contact_id',
848 'title' => ts('Soft Credit For Contact ID'),
849 'where' => 'civicrm_contact_d.id',
850 'data_type' => CRM_Utils_Type
::T_INT
,
854 $fields = array_merge($fields, $contributionPage,
855 $contributionNote, $extraFields, $softCreditFields, $financialAccount, $campaignTitle,
856 CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
859 self
::$_exportableFields = $fields;
862 return self
::$_exportableFields;
866 * Record an activity when a payment is received.
868 * @todo this is intended to be moved to payment BAO class as a protected function
869 * on that class. Currently being cleaned up. The addActivityForPayment doesn't really
870 * merit it's own function as it makes the code less rather than more readable.
872 * @param int $contributionId
873 * @param int $participantId
874 * @param string $totalAmount
875 * @param string $currency
876 * @param string $trxnDate
878 * @throws \CRM_Core_Exception
879 * @throws \CiviCRM_API3_Exception
881 public static function recordPaymentActivity($contributionId, $participantId, $totalAmount, $currency, $trxnDate) {
882 $activityType = ($totalAmount < 0) ?
'Refund' : 'Payment';
884 if ($participantId) {
885 $inputParams['id'] = $participantId;
888 $entityObj = CRM_Event_BAO_Participant
::getValues($inputParams, $values, $ids);
889 $entityObj = $entityObj[$participantId];
890 $title = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id
, 'title');
893 $entityObj = new CRM_Contribute_BAO_Contribution();
894 $entityObj->id
= $contributionId;
895 $entityObj->find(TRUE);
896 $title = ts('Contribution');
898 // @todo per block above this is not a logical splitting off of functionality.
899 self
::addActivityForPayment($entityObj->contact_id
, $activityType, $title, $contributionId, $totalAmount, $currency, $trxnDate);
903 * Get the value for the To Financial Account.
905 * @param $contribution
910 public static function getToFinancialAccount($contribution, $params) {
911 if (!empty($params['payment_processor_id'])) {
912 return CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor_id'], NULL, 'civicrm_payment_processor');
914 if (!empty($params['payment_instrument_id'])) {
915 return CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
918 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
919 $queryParams = [1 => [$relationTypeId, 'Integer']];
920 return CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
925 * Get memberships related to the contribution.
927 * @param int $contributionID
931 protected static function getRelatedMemberships($contributionID) {
932 $membershipPayments = civicrm_api3('MembershipPayment', 'get', [
933 'return' => 'membership_id',
934 'contribution_id' => (int) $contributionID,
937 foreach ($membershipPayments as $membershipPayment) {
938 $membershipIDs[] = $membershipPayment['membership_id'];
940 if (empty($membershipIDs)) {
943 // We could combine this with the MembershipPayment.get - we'd
944 // need to re-wrangle the params (here or in the calling function)
945 // as they would then me membership.contact_id, membership.is_test etc
946 return civicrm_api3('Membership', 'get', [
947 'id' => ['IN' => $membershipIDs],
948 'return' => ['id', 'contact_id', 'membership_type_id', 'is_test', 'status_id', 'end_date'],
953 * Cancel contribution.
955 * This function should only be called from transitioncomponents - it is an interim step in refactoring.
957 * @param $processContributionObject
958 * @param $memberships
959 * @param $contributionId
960 * @param $membershipStatuses
961 * @param $updateResult
962 * @param $participant
964 * @param $pledgePayment
966 * @param $pledgePaymentIDs
967 * @param $contributionStatusId
971 protected static function cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId) {
972 // @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
973 $processContribution = FALSE;
974 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
975 if (is_array($memberships)) {
976 foreach ($memberships as $membership) {
978 //Update Membership status if there is no other completed contribution associated with the membership.
979 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
980 foreach ($relatedContributions as $contriId) {
981 if ($contriId == $contributionId) {
984 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
985 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
989 if ($membership && $update) {
990 $newStatus = array_search('Cancelled', $membershipStatuses);
993 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
995 'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
996 'source_contact_id' => CRM_Core_Session
::singleton()->get('userID'),
997 'target_contact_id' => $membership->contact_id
,
998 'source_record_id' => $membership->id
,
999 'activity_type_id' => 'Change Membership Status',
1000 'status_id' => 'Completed',
1001 'priority_id' => 'Normal',
1002 'activity_date_time' => 'now',
1005 $membership->status_id
= $newStatus;
1006 $membership->is_override
= TRUE;
1007 $membership->status_override_end_date
= 'null';
1008 $membership->save();
1009 civicrm_api3('activity', 'create', $activityParam);
1011 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1012 if ($processContributionObject) {
1013 $processContribution = TRUE;
1020 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1021 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1023 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1024 if ($processContributionObject) {
1025 $processContribution = TRUE;
1029 if ($pledgePayment) {
1030 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1032 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1033 if ($processContributionObject) {
1034 $processContribution = TRUE;
1037 return [$updateResult, $processContribution];
1041 * Do any accounting updates required as a result of a contribution status change.
1043 * Currently we have a bit of a roundabout where adding a payment results in this being called &
1044 * this may attempt to add a payment. We need to resolve that....
1046 * The 'right' way to add payments or refunds is through the Payment.create api. That api
1047 * then updates the contribution but this process should not also record another financial trxn.
1048 * Currently we have weak detection fot that scenario & where it is detected the first returned
1049 * value is FALSE - meaning 'do not continue'.
1051 * We should also look at the fact that the calling function - updateFinancialAccounts
1052 * bunches together some disparate processes rather than having separate appropriate
1055 * @param array $params
1058 * Return indicates whether the updateFinancialAccounts function should continue.
1060 private static function updateFinancialAccountsOnContributionStatusChange(&$params) {
1061 $previousContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['prevContribution']->contribution_status_id
, 'name');
1062 $currentContributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
1064 if ((($previousContributionStatus == 'Partially paid' && $currentContributionStatus == 'Completed')
1065 ||
($previousContributionStatus == 'Pending refund' && $currentContributionStatus == 'Completed')
1066 // This concept of pay_later as different to any other sort of pending is deprecated & it's unclear
1067 // why it is here or where it is handled instead.
1068 ||
($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later
== TRUE
1069 && $currentContributionStatus == 'Partially paid'))
1074 if (self
::isContributionUpdateARefund($params['prevContribution']->contribution_status_id
, $params['contribution']->contribution_status_id
)) {
1075 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1076 $params['trxnParams']['total_amount'] = -$params['total_amount'];
1078 elseif (($previousContributionStatus == 'Pending'
1079 && $params['prevContribution']->is_pay_later
) ||
$previousContributionStatus == 'In Progress'
1081 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
1082 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
1084 if ($currentContributionStatus == 'Cancelled') {
1085 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1086 $params['trxnParams']['to_financial_account_id'] = $arAccountId;
1087 $params['trxnParams']['total_amount'] = -$params['total_amount'];
1090 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1091 $params['trxnParams']['from_financial_account_id'] = $arAccountId;
1095 if (($previousContributionStatus == 'Pending'
1096 ||
$previousContributionStatus == 'In Progress')
1097 && ($currentContributionStatus == 'Completed')
1099 if (empty($params['line_item'])) {
1101 //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
1102 // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
1103 // & this can be removed
1106 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1107 // This is an update so original currency if none passed in.
1108 $params['trxnParams']['currency'] = CRM_Utils_Array
::value('currency', $params, $params['prevContribution']->currency
);
1110 self
::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
1111 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
1112 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1113 $params['entity_id'] = self
::$_trxnIDs[] = $trxn->id
;
1115 $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
1118 'entity_table' => 'civicrm_financial_item',
1120 foreach ($params['line_item'] as $fieldId => $fields) {
1121 foreach ($fields as $fieldValueId => $lineItemDetails) {
1122 self
::updateFinancialItemForLineItemToPaid($lineItemDetails['id']);
1124 1 => [$lineItemDetails['id'], 'Integer'],
1126 $financialItem = CRM_Core_DAO
::executeQuery($sql, $fparams);
1127 while ($financialItem->fetch()) {
1128 $entityParams['entity_id'] = $financialItem->id
;
1129 $entityParams['amount'] = $financialItem->amount
;
1130 foreach (self
::$_trxnIDs as $tID) {
1131 $entityParams['financial_trxn_id'] = $tID;
1132 CRM_Financial_BAO_FinancialItem
::createEntityTrxn($entityParams);
1143 * It is possible to override the membership id that is updated from the payment processor.
1145 * Historically Paypal does this & it still does if it determines data is messed up - see
1146 * https://lab.civicrm.org/dev/membership/issues/13
1148 * Read the comment block on repeattransaction for more information
1149 * about how things should work.
1151 * @param int $contributionID
1152 * @param array $input
1154 * @throws \CiviCRM_API3_Exception
1156 protected static function handleMembershipIDOverride($contributionID, $input) {
1157 if (!empty($input['membership_id'])) {
1158 Civi
::log()->debug('The related membership id has been overridden - this may impact data - see https://github.com/civicrm/civicrm-core/pull/15053');
1159 civicrm_api3('MembershipPayment', 'create', ['contribution_id' => $contributionID, 'membership_id' => $input['membership_id']]);
1164 * Update all financial items related to the line item tto have a status of paid.
1166 * @param int $lineItemID
1168 private static function updateFinancialItemForLineItemToPaid($lineItemID) {
1171 CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
1174 2 => [$lineItemID, 'Integer'],
1176 $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
1177 CRM_Core_DAO
::executeQuery($query, $fparams);
1181 * Create the financial items for the line.
1183 * @param array $params
1184 * @param string $context
1185 * @param array $fields
1186 * @param array $previousLineItems
1187 * @param array $inputParams
1188 * @param bool $isARefund
1189 * @param array $trxnIds
1190 * @param int $fieldId
1194 private static function createFinancialItemsForLine($params, $context, $fields, array $previousLineItems, array $inputParams, bool $isARefund, $trxnIds, $fieldId): array {
1195 foreach ($fields as $fieldValueId => $lineItemDetails) {
1196 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($lineItemDetails['id']);
1197 $receiveDate = CRM_Utils_Date
::isoToMysql($params['prevContribution']->receive_date
);
1198 if ($params['contribution']->receive_date
) {
1199 $receiveDate = CRM_Utils_Date
::isoToMysql($params['contribution']->receive_date
);
1202 $financialAccount = self
::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array
::value('financial_account_id', $prevFinancialItem));
1204 $currency = $params['prevContribution']->currency
;
1205 if ($params['contribution']->currency
) {
1206 $currency = $params['contribution']->currency
;
1208 $previousLineItemTotal = CRM_Utils_Array
::value('line_total', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1210 'transaction_date' => $receiveDate,
1211 'contact_id' => $params['prevContribution']->contact_id
,
1212 'currency' => $currency,
1213 'amount' => self
::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
1214 'description' => $prevFinancialItem['description'] ??
NULL,
1215 'status_id' => $prevFinancialItem['status_id'],
1216 'financial_account_id' => $financialAccount,
1217 'entity_table' => 'civicrm_line_item',
1218 'entity_id' => $lineItemDetails['id'],
1220 $financialItem = CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
1221 $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
1222 $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id
;
1224 if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') ||
($context == 'changeFinancialType')) {
1225 $taxAmount = (float) $lineItemDetails['tax_amount'];
1226 if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
1227 // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
1228 $taxAmount = CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1230 elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
1231 $taxAmount -= CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1233 if ($taxAmount != 0) {
1234 $itemParams['amount'] = self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $taxAmount;
1235 $itemParams['description'] = CRM_Invoicing_Utils
::getTaxTerm();
1236 if ($lineItemDetails['financial_type_id']) {
1237 $itemParams['financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getSalesTaxFinancialAccount($lineItemDetails['financial_type_id']);
1239 CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
1247 * Does this contributtion status update represent a refund.
1249 * @param int $previousContributionStatusID
1250 * @param int $currentContributionStatusID
1254 private static function isContributionUpdateARefund($previousContributionStatusID, $currentContributionStatusID): bool {
1255 if ('Completed' !== CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $previousContributionStatusID)) {
1258 return self
::isContributionStatusNegative($currentContributionStatusID);
1262 * Get transaction information about the contribution.
1264 * @param int $contributionId
1265 * @param int $financialTypeID
1269 protected static function getContributionTransactionInformation($contributionId, int $financialTypeID) {
1271 $feeFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Expense Account is');
1273 // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
1275 SELECT GROUP_CONCAT(fa.`name`) as financial_account,
1277 ft.payment_instrument_id,
1278 ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
1280 FROM civicrm_contribution con
1281 LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
1282 INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
1283 AND ft.to_financial_account_id != %2
1284 LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
1285 LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
1286 LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
1288 WHERE con.id = %1 AND ft.is_payment = 1
1291 1 => [$contributionId, 'Integer'],
1292 2 => [$feeFinancialAccount, 'Integer'],
1294 $resultDAO = CRM_Core_DAO
::executeQuery($sql, $queryParams);
1295 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'label');
1297 while ($resultDAO->fetch()) {
1298 $paidByLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
1299 $paidByName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
1300 if ($resultDAO->card_type_id
) {
1301 $creditCardType = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id
);
1302 $pantruncation = '';
1303 if ($resultDAO->pan_truncation
) {
1304 $pantruncation = ": {$resultDAO->pan_truncation}";
1306 $paidByLabel .= " ({$creditCardType}{$pantruncation})";
1309 // show payment edit link only for payments done via backoffice form
1310 $paymentEditLink = '';
1311 if (empty($resultDAO->payment_processor_id
) && CRM_Core_Permission
::check('edit contributions')) {
1313 CRM_Core_Action
::UPDATE
=> [
1314 'name' => "<i class='crm-i fa-pencil'></i>",
1315 'url' => 'civicrm/payment/edit',
1316 'class' => 'medium-popup',
1317 'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
1318 'title' => ts('Edit Payment'),
1321 $paymentEditLink = CRM_Core_Action
::formLink(
1323 CRM_Core_Action
::mask([CRM_Core_Permission
::EDIT
]),
1325 'id' => $resultDAO->id
,
1326 'contribution_id' => $contributionId,
1330 'Payment.edit.action',
1337 'id' => $resultDAO->id
,
1338 'total_amount' => $resultDAO->total_amount
,
1339 'financial_type' => $resultDAO->financial_account
,
1340 'payment_instrument' => $paidByLabel,
1341 'receive_date' => $resultDAO->trxn_date
,
1342 'trxn_id' => $resultDAO->trxn_id
,
1343 'status' => $statuses[$resultDAO->status_id
],
1344 'currency' => $resultDAO->currency
,
1345 'action' => $paymentEditLink,
1347 if ($paidByName == 'Check') {
1348 $val['check_number'] = $resultDAO->check_number
;
1358 public function addSelectWhereClause() {
1359 $whereClauses = parent
::addSelectWhereClause();
1360 if ($whereClauses !== []) {
1361 // In this case permisssions have been applied & we assume the
1362 // financialaclreport is applying these
1363 // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
1364 return $whereClauses;
1367 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1368 return $whereClauses;
1370 $types = CRM_Financial_BAO_FinancialType
::getAllEnabledAvailableFinancialTypes();
1371 if (empty($types)) {
1372 $whereClauses['financial_type_id'] = 'IN (0)';
1375 $whereClauses['financial_type_id'] = [
1376 'IN (' . implode(',', array_keys($types)) . ')',
1379 return $whereClauses;
1383 * @param null $status
1384 * @param null $startDate
1385 * @param null $endDate
1387 * @return array|null
1389 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1393 $where[] = 'contribution_status_id = 1';
1397 $where[] = 'contribution_status_id = 3';
1402 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
1405 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
1407 $financialTypeACLJoin = '';
1408 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1409 $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1410 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1411 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1412 if ($financialTypes) {
1413 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1414 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1417 $where[] = "c.financial_type_id IN (0)";
1421 $whereCond = implode(' AND ', $where);
1424 SELECT sum( total_amount ) as total_amount,
1425 count( c.id ) as total_count,
1427 FROM civicrm_contribution c
1428 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
1429 $financialTypeACLJoin
1431 AND ( is_test = 0 OR is_test IS NULL )
1432 AND contact.is_deleted = 0
1436 $dao = CRM_Core_DAO
::executeQuery($query);
1439 while ($dao->fetch()) {
1440 $count +
= $dao->total_count
;
1441 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
1445 'amount' => implode(', ', $amount),
1453 * Delete the indirect records associated with this contribution first.
1457 * @return mixed|null
1458 * $results no of deleted Contribution on success, false otherwise
1460 public static function deleteContribution($id) {
1461 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
1463 $transaction = new CRM_Core_Transaction();
1466 //delete activity record
1468 'source_record_id' => $id,
1469 // activity type id for contribution
1470 'activity_type_id' => 6,
1473 CRM_Activity_BAO_Activity
::deleteActivity($params);
1475 //delete billing address if exists for this contribution.
1476 self
::deleteAddress($id);
1478 //update pledge and pledge payment, CRM-3961
1479 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
1481 // remove entry from civicrm_price_set_entity, CRM-5095
1482 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
1483 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
1485 // cleanup line items.
1486 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1488 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1489 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1491 if ($participantId) {
1492 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1495 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1499 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1500 $noteId = key($note);
1502 CRM_Core_BAO_Note
::del($noteId, FALSE);
1505 $dao = new CRM_Contribute_DAO_Contribution();
1508 $results = $dao->delete();
1510 $transaction->commit();
1512 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1514 // delete the recently created Contribution
1515 $contributionRecent = [
1517 'type' => 'Contribution',
1519 CRM_Utils_Recent
::del($contributionRecent);
1525 * React to a financial transaction (payment) failure.
1527 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1528 * payments is important for forensic and outreach reasons.
1530 * @param int $contributionID
1531 * @param int $contactID
1532 * @param string $message
1534 * @throws \CiviCRM_API3_Exception
1536 public static function failPayment($contributionID, $contactID, $message) {
1537 civicrm_api3('activity', 'create', [
1538 'activity_type_id' => 'Failed Payment',
1539 'details' => $message,
1540 'subject' => ts('Payment failed at payment processor'),
1541 'source_record_id' => $contributionID,
1542 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() : $contactID,
1545 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1546 civicrm_api3('contribution', 'create', [
1547 'id' => $contributionID,
1548 'contribution_status_id' => 'Failed',
1553 * Check if there is a contribution with the same trxn_id or invoice_id.
1555 * @param array $input
1556 * An assoc array of name/value pairs.
1557 * @param array $duplicates
1558 * (reference) store ids of duplicate contribs.
1562 * true if duplicate, false otherwise
1564 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1566 $id = $input['id'] ??
NULL;
1568 $trxn_id = $input['trxn_id'] ??
NULL;
1569 $invoice_id = $input['invoice_id'] ??
NULL;
1575 $clause[] = "trxn_id = %1";
1576 $input[1] = [$trxn_id, 'String'];
1580 $clause[] = "invoice_id = %2";
1581 $input[2] = [$invoice_id, 'String'];
1584 if (empty($clause)) {
1588 $clause = implode(' OR ', $clause);
1590 $clause = "( $clause ) AND id != %3";
1591 $input[3] = [$id, 'Integer'];
1594 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1595 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1597 while ($dao->fetch()) {
1598 $duplicates[] = $dao->id
;
1605 * Takes an associative array and creates a contribution_product object.
1607 * the function extract all the params it needs to initialize the create a
1608 * contribution_product object. the params array could contain additional unused name/value
1611 * @param array $params
1612 * (reference) an assoc array of name/value pairs.
1614 * @return CRM_Contribute_DAO_ContributionProduct
1616 public static function addPremium(&$params) {
1617 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1618 $contributionProduct->copyValues($params);
1619 return $contributionProduct->save();
1623 * Get list of contribution fields for profile.
1624 * For now we only allow custom contribution fields to be in
1627 * @param bool $addExtraFields
1628 * True if special fields needs to be added.
1631 * the list of contribution fields
1633 public static function getContributionFields($addExtraFields = TRUE) {
1634 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1635 // @todo remove this - this line was added because payment_instrument_id was not
1636 // set to exportable - but now it is.
1637 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1639 if ($addExtraFields) {
1640 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1643 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1645 foreach ($contributionFields as $key => $var) {
1646 if ($key == 'contribution_contact_id') {
1649 elseif ($key == 'contribution_campaign_id') {
1650 $var['title'] = ts('Campaign');
1652 $fields[$key] = $var;
1655 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1660 * Add extra fields specific to contribution.
1662 public static function getSpecialContributionFields() {
1664 'contribution_soft_credit_name' => [
1665 'name' => 'contribution_soft_credit_name',
1666 'title' => ts('Soft Credit Name'),
1667 'headerPattern' => '/^soft_credit_name$/i',
1668 'where' => 'civicrm_contact_d.display_name',
1670 'contribution_soft_credit_email' => [
1671 'name' => 'contribution_soft_credit_email',
1672 'title' => ts('Soft Credit Email'),
1673 'headerPattern' => '/^soft_credit_email$/i',
1674 'where' => 'soft_email.email',
1676 'contribution_soft_credit_phone' => [
1677 'name' => 'contribution_soft_credit_phone',
1678 'title' => ts('Soft Credit Phone'),
1679 'headerPattern' => '/^soft_credit_phone$/i',
1680 'where' => 'soft_phone.phone',
1682 'contribution_soft_credit_contact_id' => [
1683 'name' => 'contribution_soft_credit_contact_id',
1684 'title' => ts('Soft Credit Contact ID'),
1685 'headerPattern' => '/^soft_credit_contact_id$/i',
1686 'where' => 'civicrm_contribution_soft.contact_id',
1688 'contribution_pcp_title' => [
1689 'name' => 'contribution_pcp_title',
1690 'title' => ts('Personal Campaign Page Title'),
1691 'headerPattern' => '/^contribution_pcp_title$/i',
1692 'where' => 'contribution_pcp.title',
1696 return $extraFields;
1700 * @param int $pageID
1704 public static function getCurrentandGoalAmount($pageID) {
1706 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1707 FROM civicrm_contribution_page p,
1708 civicrm_contribution c
1709 WHERE p.id = c.contribution_page_id
1711 AND c.cancel_date is null
1715 $config = CRM_Core_Config
::singleton();
1716 $params = [1 => [$pageID, 'Integer']];
1717 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1719 if ($dao->fetch()) {
1720 return [$dao->goal
, $dao->total
];
1723 return [NULL, NULL];
1728 * Get list of contributions which credit the passed in contact ID.
1730 * The returned array provides details about the original contribution & donor.
1732 * @param int $honorId
1733 * In Honor of Contact ID.
1736 * list of contribution fields
1737 * @todo - this is a confusing function called from one place. It has a test. It would be
1738 * nice to deprecate it.
1741 public static function getHonorContacts($honorId) {
1743 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1744 $honorDAO->contact_id
= $honorId;
1747 $type = CRM_Contribute_PseudoConstant
::financialType();
1749 while ($honorDAO->fetch()) {
1750 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1751 $contributionDAO->id
= $honorDAO->contribution_id
;
1753 if ($contributionDAO->find(TRUE)) {
1754 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1755 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1756 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1757 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1758 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1759 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1760 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1761 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1762 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
, 'label');
1770 * Get the sort name of a contact for a particular contribution.
1773 * Id of the contribution.
1775 * @return null|string
1776 * sort name of the contact if found
1778 public static function sortName($id) {
1779 $id = CRM_Utils_Type
::escape($id, 'Integer');
1782 SELECT civicrm_contact.sort_name
1783 FROM civicrm_contribution, civicrm_contact
1784 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1785 AND civicrm_contribution.id = {$id}
1787 return CRM_Core_DAO
::singleValueQuery($query);
1791 * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1793 * @param int|array $contactIDs
1797 public static function annual($contactIDs) {
1798 if (!is_array($contactIDs)) {
1799 // In practice I can't fine any evidence that this function is ever called with
1800 // anything other than a single contact id, but left like this due to .... fear.
1801 $contactIDs = explode(',', $contactIDs);
1804 $query = self
::getAnnualQuery($contactIDs);
1805 $dao = CRM_Core_DAO
::executeQuery($query);
1807 $amount = $average = [];
1808 while ($dao->fetch()) {
1809 if ($dao->count
> 0 && $dao->amount
> 0) {
1810 $count +
= $dao->count
;
1811 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1812 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1818 implode(', ', $amount),
1819 implode(', ', $average),
1826 * Check if there is a contribution with the params passed in.
1828 * Used for trxn_id,invoice_id and contribution_id
1830 * @param array $params
1831 * An assoc array of name/value pairs.
1834 * contribution id if success else NULL
1836 public static function checkDuplicateIds($params) {
1837 $dao = new CRM_Contribute_DAO_Contribution();
1841 foreach ($params as $k => $v) {
1843 $clause[] = "$k = '$v'";
1846 $clause = implode(' AND ', $clause);
1847 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1848 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1850 while ($dao->fetch()) {
1858 * Get the contribution details for component export.
1860 * @param int $exportMode
1862 * @param array $componentIds
1868 public static function getContributionDetails($exportMode, $componentIds) {
1869 $paymentDetails = [];
1870 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1872 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1873 $componentSelect = " civicrm_participant_payment.participant_id id";
1874 $additionalClause = "
1875 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1876 AND civicrm_participant_payment.participant_id {$componentClause} )
1879 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1880 $componentSelect = " civicrm_membership_payment.membership_id id";
1881 $additionalClause = "
1882 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1883 AND civicrm_membership_payment.membership_id {$componentClause} )
1886 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1887 $componentSelect = " civicrm_pledge_payment.id id";
1888 $additionalClause = "
1889 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1890 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1894 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1895 trxn_id, {$componentSelect}
1896 FROM civicrm_contribution
1897 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1898 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1899 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1900 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1901 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1902 AND option_group_contribution_status.id = contribution_status.option_group_id )
1906 $dao = CRM_Core_DAO
::executeQuery($query);
1908 while ($dao->fetch()) {
1909 $paymentDetails[$dao->id
] = [
1910 'total_amount' => $dao->total_amount
,
1911 'contribution_status' => $dao->status
,
1912 'receive_date' => $dao->receive_date
,
1913 'pay_instru' => $dao->payment_instrument
,
1914 'trxn_id' => $dao->trxn_id
,
1918 return $paymentDetails;
1922 * Create address associated with contribution record.
1924 * As long as there is one or more billing field in the parameters we will create the address.
1926 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1929 * @param array $params
1930 * @param int $billingLocationTypeID
1935 public static function createAddress($params, $billingLocationTypeID) {
1936 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1937 if ($hasBillingField) {
1938 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1939 return $address->id
;
1946 * Delete billing address record related contribution.
1948 * @param int $contributionId
1949 * @param int $contactId
1951 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1953 $contactJoin = NULL;
1955 if ($contributionId) {
1956 $clauses[] = "cc.id = {$contributionId}";
1960 $clauses[] = "cco.id = {$contactId}";
1961 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1964 if (empty($clauses)) {
1965 CRM_Core_Error
::fatal();
1968 $condition = implode(' OR ', $clauses);
1972 FROM civicrm_address ca
1973 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1977 $dao = CRM_Core_DAO
::executeQuery($query);
1979 while ($dao->fetch()) {
1980 $params = ['id' => $dao->id
];
1981 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1986 * This function check online pending contribution associated w/
1987 * Online Event Registration or Online Membership signup.
1989 * @param int $componentId
1990 * Participant/membership id.
1991 * @param string $componentName
1995 * pending contribution id.
1997 public static function checkOnlinePendingContribution($componentId, $componentName) {
1998 $contributionId = NULL;
1999 if (!$componentId ||
2000 !in_array($componentName, ['Event', 'Membership'])
2002 return $contributionId;
2005 if ($componentName == 'Event') {
2006 $idName = 'participant_id';
2007 $componentTable = 'civicrm_participant';
2008 $paymentTable = 'civicrm_participant_payment';
2009 $source = ts('Online Event Registration');
2012 if ($componentName == 'Membership') {
2013 $idName = 'membership_id';
2014 $componentTable = 'civicrm_membership';
2015 $paymentTable = 'civicrm_membership_payment';
2016 $source = ts('Online Contribution');
2019 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
2022 SELECT component.id as {$idName},
2023 componentPayment.contribution_id as contribution_id,
2024 contribution.source source,
2025 contribution.contribution_status_id as contribution_status_id,
2026 contribution.is_pay_later as is_pay_later
2027 FROM $componentTable component
2028 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
2029 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
2030 WHERE component.id = {$componentId}";
2032 $dao = CRM_Core_DAO
::executeQuery($query);
2034 while ($dao->fetch()) {
2035 if ($dao->contribution_id
&&
2036 $dao->is_pay_later
&&
2037 $dao->contribution_status_id
== $pendingStatusId &&
2038 strpos($dao->source
, $source) !== FALSE
2040 $contributionId = $dao->contribution_id
;
2044 return $contributionId;
2048 * Update contribution as well as related objects.
2050 * This function by-passes hooks - to address this - don't use this function.
2052 * @param array $params
2053 * @param bool $processContributionObject
2057 * @throws CRM_Core_Exception
2058 * @throws \CiviCRM_API3_Exception
2061 * Use api contribute.completetransaction
2062 * For failures use failPayment (preferably exposing by api in the process).
2065 public static function transitionComponents($params, $processContributionObject = FALSE) {
2066 // get minimum required values.
2067 $contactId = $params['contact_id'] ??
NULL;
2068 $componentId = $params['component_id'] ??
NULL;
2069 $componentName = $params['componentName'] ??
NULL;
2070 $contributionId = $params['contribution_id'] ??
NULL;
2071 $contributionStatusId = $params['contribution_status_id'] ??
NULL;
2073 // if we already processed contribution object pass previous status id.
2074 $previousContriStatusId = $params['previous_contribution_status_id'] ??
NULL;
2078 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2080 // we process only ( Completed, Cancelled, or Failed ) contributions.
2081 if (!$contributionId ||
2082 !in_array($contributionStatusId, [
2083 array_search('Completed', $contributionStatuses),
2084 array_search('Cancelled', $contributionStatuses),
2085 array_search('Failed', $contributionStatuses),
2088 return $updateResult;
2091 if (!$componentName ||
!$componentId) {
2092 // get the related component details.
2093 $componentDetails = self
::getComponentDetails($contributionId);
2096 $componentDetails['contact_id'] = $contactId;
2097 $componentDetails['component'] = $componentName;
2099 if ($componentName == 'event') {
2100 $componentDetails['participant'] = $componentId;
2103 $componentDetails['membership'] = $componentId;
2107 if (!empty($componentDetails['contact_id'])) {
2108 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2114 // do check for required ids.
2115 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
2116 return $updateResult;
2119 //now we are ready w/ required ids, start processing.
2121 $baseIPN = new CRM_Core_Payment_BaseIPN();
2123 $input = $ids = $objects = [];
2125 $input['component'] = $componentDetails['component'] ??
NULL;
2126 $ids['contribution'] = $contributionId;
2127 $ids['contact'] = $componentDetails['contact_id'] ??
NULL;
2128 $ids['membership'] = $componentDetails['membership'] ??
NULL;
2129 $ids['participant'] = $componentDetails['participant'] ??
NULL;
2130 $ids['event'] = $componentDetails['event'] ??
NULL;
2131 $ids['pledge_payment'] = $componentDetails['pledge_payment'] ??
NULL;
2132 $ids['contributionRecur'] = NULL;
2133 $ids['contributionPage'] = NULL;
2135 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
2136 CRM_Core_Error
::fatal();
2139 $memberships = &$objects['membership'];
2140 $participant = &$objects['participant'];
2141 $pledgePayment = &$objects['pledge_payment'];
2142 $contribution = &$objects['contribution'];
2143 $pledgeID = $oldStatus = NULL;
2144 $pledgePaymentIDs = [];
2145 if ($pledgePayment) {
2146 foreach ($pledgePayment as $key => $object) {
2147 $pledgePaymentIDs[] = $object->id
;
2149 $pledgeID = $pledgePayment[0]->pledge_id
;
2152 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
2155 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
2156 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
2161 // we might want to process contribution object.
2162 $processContribution = FALSE;
2163 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
2164 // Call interim cancel function - with a goal to cleaning up the signature on it and switching to a tested api Contribution.cancel function.
2165 list($updateResult, $processContribution) = self
::cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId);
2167 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
2168 if (is_array($memberships)) {
2169 foreach ($memberships as $membership) {
2171 //Update Membership status if there is no other completed contribution associated with the membership.
2172 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
2173 foreach ($relatedContributions as $contriId) {
2174 if ($contriId == $contributionId) {
2177 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
2178 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
2182 if ($membership && $update) {
2183 $membership->status_id
= array_search('Expired', $membershipStatuses);
2184 $membership->is_override
= TRUE;
2185 $membership->status_override_end_date
= 'null';
2186 $membership->save();
2188 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2189 if ($processContributionObject) {
2190 $processContribution = TRUE;
2196 $updatedStatusId = array_search('Cancelled', $participantStatuses);
2197 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2199 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2200 if ($processContributionObject) {
2201 $processContribution = TRUE;
2205 if ($pledgePayment) {
2206 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2208 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2209 if ($processContributionObject) {
2210 $processContribution = TRUE;
2214 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
2216 // only pending contribution related object processed.
2217 if ($previousContriStatusId &&
2218 !in_array($contributionStatuses[$previousContriStatusId], [
2223 // this is case when we already processed contribution object.
2224 return $updateResult;
2226 elseif (!$previousContriStatusId &&
2227 !in_array($contributionStatuses[$contribution->contribution_status_id
], [
2232 // this is case when we are going to process contribution object later.
2233 return $updateResult;
2236 if (is_array($memberships)) {
2237 foreach ($memberships as $membership) {
2242 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
2243 $membership->membership_type_id
,
2244 $membership->is_test
, $membership->id
2247 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
2248 // this picks up membership type changes during renewals
2250 SELECT membership_type_id
2251 FROM civicrm_membership_log
2252 WHERE membership_id=$membership->id
2255 $dao = new CRM_Core_DAO();
2257 if ($dao->fetch()) {
2258 if (!empty($dao->membership_type_id
)) {
2259 $membership->membership_type_id
= $dao->membership_type_id
;
2260 $membership->save();
2263 // else fall back to using current membership type
2264 // Figure out number of terms
2266 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
2267 foreach ($lineitems as $lineitem) {
2268 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
2269 $numterms = $lineitem['membership_num_terms'] ??
NULL;
2271 // in case membership_num_terms comes through as null or zero
2272 $numterms = $numterms >= 1 ?
$numterms : 1;
2277 // CRM-15735-to update the membership status as per the contribution receive date
2279 $oldStatus = $membership->status_id
;
2280 if (!empty($params['receive_date'])) {
2281 $joinDate = $params['receive_date'];
2282 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
2283 $membership->end_date
,
2284 $membership->join_date
,
2285 $params['receive_date'],
2287 $membership->membership_type_id
,
2290 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
2291 $membership->save();
2294 if ($currentMembership) {
2295 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
2296 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
2297 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
2300 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
2303 //get the status for membership.
2304 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
2306 $dates['join_date'],
2309 $membership->membership_type_id
,
2313 $formattedParams = [
2314 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
2315 array_search('Current', $membershipStatuses)
2317 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
2318 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
2319 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
2322 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
2324 $membership->copyValues($formattedParams);
2325 $membership->save();
2327 //updating the membership log
2328 $membershipLog = [];
2329 $membershipLog = $formattedParams;
2330 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
2331 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
2333 $membershipLog['start_date'] = $logStartDate;
2334 $membershipLog['membership_id'] = $membership->id
;
2335 $membershipLog['modified_id'] = $membership->contact_id
;
2336 $membershipLog['modified_date'] = date('Ymd');
2337 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
2339 CRM_Member_BAO_MembershipLog
::add($membershipLog);
2341 //update related Memberships.
2342 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
2344 foreach (['Membership Signup', 'Membership Renewal'] as $activityType) {
2345 $scheduledActivityID = CRM_Utils_Array
::value('id',
2346 civicrm_api3('Activity', 'Get',
2348 'source_record_id' => $membership->id
,
2349 'activity_type_id' => $activityType,
2350 'status_id' => 'Scheduled',
2353 'sort' => 'id DESC',
2358 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2359 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2360 if ($scheduledActivityID) {
2361 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, ['id' => $scheduledActivityID]);
2366 // track membership status change if any
2367 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
2368 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
2369 CRM_Activity_BAO_Activity
::addActivity($membership,
2370 'Change Membership Status',
2373 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2374 'source_contact_id' => $membershipLog['modified_id'],
2375 'priority_id' => 'Normal',
2380 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2381 if ($processContributionObject) {
2382 $processContribution = TRUE;
2385 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2391 $updatedStatusId = array_search('Registered', $participantStatuses);
2392 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2394 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2395 if ($processContributionObject) {
2396 $processContribution = TRUE;
2400 if ($pledgePayment) {
2401 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2403 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2404 if ($processContributionObject) {
2405 $processContribution = TRUE;
2410 // process contribution object.
2411 if ($processContribution) {
2412 $contributionParams = [];
2419 'payment_instrument_id',
2422 'financial_type_id',
2423 'contribution_status_id',
2424 'non_deductible_amount',
2428 foreach ($fields as $field) {
2429 if (empty($params[$field])) {
2432 $contributionParams[$field] = $params[$field];
2435 $contributionParams['id'] = $contributionId;
2436 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams);
2439 return $updateResult;
2443 * Returns all contribution related object ids.
2445 * @param $contributionId
2449 public static function getComponentDetails($contributionId) {
2450 $componentDetails = $pledgePayment = [];
2451 if (!$contributionId) {
2452 return $componentDetails;
2456 SELECT c.id as contribution_id,
2457 c.contact_id as contact_id,
2458 c.contribution_recur_id,
2459 mp.membership_id as membership_id,
2460 m.membership_type_id as membership_type_id,
2461 pp.participant_id as participant_id,
2462 p.event_id as event_id,
2463 pgp.id as pledge_payment_id
2464 FROM civicrm_contribution c
2465 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2466 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2467 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2468 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2469 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2470 WHERE c.id = $contributionId";
2472 $dao = CRM_Core_DAO
::executeQuery($query);
2473 $componentDetails = [];
2475 while ($dao->fetch()) {
2476 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2477 $componentDetails['contact_id'] = $dao->contact_id
;
2478 if ($dao->event_id
) {
2479 $componentDetails['event'] = $dao->event_id
;
2481 if ($dao->participant_id
) {
2482 $componentDetails['participant'] = $dao->participant_id
;
2484 if ($dao->membership_id
) {
2485 if (!isset($componentDetails['membership'])) {
2486 $componentDetails['membership'] = $componentDetails['membership_type'] = [];
2488 $componentDetails['membership'][] = $dao->membership_id
;
2489 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2491 if ($dao->pledge_payment_id
) {
2492 $pledgePayment[] = $dao->pledge_payment_id
;
2494 if ($dao->contribution_recur_id
) {
2495 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2499 if ($pledgePayment) {
2500 $componentDetails['pledge_payment'] = $pledgePayment;
2503 return $componentDetails;
2507 * @param int $contactId
2508 * @param bool $includeSoftCredit
2510 * @return null|string
2512 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2516 $financialTypes = CRM_Financial_BAO_FinancialType
::getAllAvailableFinancialTypes();
2517 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2518 $liWhere = " AND i.financial_type_id IN (0)";
2519 if (!empty($financialTypes)) {
2520 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2521 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2523 $contactContributionsSQL = "
2524 SELECT contribution.id AS id
2525 FROM civicrm_contribution contribution
2526 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2527 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2531 $contactSoftCreditContributionsSQL = "
2532 SELECT contribution.id
2533 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2534 ON ( contribution.id = softContribution.contribution_id )
2535 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2536 $query = "SELECT count( x.id ) count FROM ( ";
2537 $query .= $contactContributionsSQL;
2539 if ($includeSoftCredit) {
2540 $query .= " UNION ";
2541 $query .= $contactSoftCreditContributionsSQL;
2546 return CRM_Core_DAO
::singleValueQuery($query);
2550 * Repeat a transaction as part of a recurring series.
2553 * 1) Processor calls contribution.repeattransaction with contribution_status_id = Pending
2554 * 2) The repeattransaction loads the 'template contribution' and calls a hook to allow altering of it .
2555 * 3) Repeat transaction calls order.create to create the pending contribution with correct line items
2556 * and associated entities.
2557 * 4) The calling code calls Payment.create which in turn calls CompleteOrder (if completing)
2558 * which updates the various entities and sends appropriate emails.
2560 * Gaps in the above (@todo)
2561 * 1) many processors still call repeattransaction with contribution_status_id = Completed
2562 * 2) repeattransaction code is current munged into completeTransaction code for historical bad coding reasons
2563 * 3) Repeat transaction duplicates rather than calls Order.create
2564 * 4) Use of payment.create still limited - completetransaction is more common.
2565 * 5) the template transaction is tricky - historically we used the first contribution
2566 * linked to a recurring contribution. More recently that was changed to be the most recent.
2567 * Ideally it would be an actual template - not a contribution used as a template which
2568 * would give more appropriate flexibility. Note line_items have an entity so that table
2569 * could be used for the line item template - the difficulty is the custom fields...
2570 * 6) the determination of the membership to be linked is tricksy. The prioritised method is
2571 * to load the membership(s) referred to via line items in the template transactions. Any other
2572 * method is likely to lead to incorrect line items & related entities being created (as the line_item
2573 * link is a required part of 'correct data'). However there are 3 other methods to determine it
2574 * - membership_payment record
2575 * - civicrm_membership.contribution_recur_id
2577 * Passing in an input override WILL ensure the membership is extended to prevent regressions
2578 * of historical processors since this has been handled 'forever' - specifically for paypal.
2579 * albeit by an even nastier mechanism than the current input override.
2580 * The count is out on how correct related entities wind up in this case.
2582 * @param CRM_Contribute_BAO_Contribution $contribution
2583 * @param array $input
2584 * @param array $contributionParams
2585 * @param int $paymentProcessorID
2588 * @throws CiviCRM_API3_Exception
2590 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2591 if (!empty($contribution->id
)) {
2594 if (empty($contribution->id
)) {
2595 // Unclear why this would only be set for repeats.
2596 if (!empty($input['amount'])) {
2597 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2600 if (!empty($contributionParams['contribution_recur_id'])) {
2601 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', [
2602 'id' => $contributionParams['contribution_recur_id'],
2604 if (!empty($recurringContribution['campaign_id'])) {
2605 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2606 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2608 if (!empty($recurringContribution['financial_type_id'])) {
2609 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2610 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2613 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2614 $contributionParams['contribution_recur_id'],
2615 array_intersect_key($contributionParams, [
2616 'total_amount' => TRUE,
2617 'financial_type_id' => TRUE,
2620 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2622 $contributionParams['status_id'] = 'Pending';
2623 if (isset($contributionParams['financial_type_id'])) {
2624 // Give precedence to passed in type.
2625 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2628 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2630 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2631 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2633 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2634 //do not create CC or BCC emails or profile notifications.
2635 //The if is just to be safe. Not sure if we can ever arrive with this unset
2636 // but per CRM-19478 it seems it can be 'null'
2637 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2638 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2640 if (!empty($contribution->tax_amount
)) {
2641 $contributionParams['tax_amount'] = $contribution->tax_amount
;
2644 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2645 $contribution->id
= $createContribution['id'];
2646 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2647 self
::handleMembershipIDOverride($contribution->id
, $input);
2653 * Get individual id for onbehalf contribution.
2655 * @param int $contributionId
2657 * @param int $contributorId
2661 * containing organization id and individual id
2663 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2667 if (!$contributionId) {
2671 // fetch contributor id if null
2672 if (!$contributorId) {
2673 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2674 $contributionId, 'contact_id'
2678 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2679 $activityTypeId = array_search('Contribution', $activityTypeIds);
2681 if ($activityTypeId && $contributorId) {
2683 SELECT civicrm_activity_contact.contact_id
2684 FROM civicrm_activity_contact
2685 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2686 WHERE civicrm_activity.activity_type_id = %1
2687 AND civicrm_activity.source_record_id = %2
2688 AND civicrm_activity_contact.record_type_id = %3
2691 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2692 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2695 1 => [$activityTypeId, 'Integer'],
2696 2 => [$contributionId, 'Integer'],
2697 3 => [$sourceID, 'Integer'],
2700 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2702 // for on behalf contribution source is individual and contributor is organization
2703 if ($sourceContactId && $sourceContactId != $contributorId) {
2704 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2705 // get rel type id for employee of relation
2706 foreach ($relationshipTypeIds as $id => $typeVals) {
2707 if ($typeVals['name_a_b'] == 'Employee of') {
2708 $relationshipTypeId = $id;
2713 $rel = new CRM_Contact_DAO_Relationship();
2714 $rel->relationship_type_id
= $relationshipTypeId;
2715 $rel->contact_id_a
= $sourceContactId;
2716 $rel->contact_id_b
= $contributorId;
2717 if ($rel->find(TRUE)) {
2718 $ids['individual_id'] = $rel->contact_id_a
;
2719 $ids['organization_id'] = $rel->contact_id_b
;
2730 public static function getContributionDates() {
2731 $config = CRM_Core_Config
::singleton();
2732 $currentMonth = date('m');
2733 $currentDay = date('d');
2734 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2735 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2736 (int ) $config->fiscalYearStart
['d'] > $currentDay
2739 $year = date('Y') - 1;
2744 $year = ['Y' => $year];
2745 $yearDate = $config->fiscalYearStart
;
2746 $yearDate = array_merge($year, $yearDate);
2747 $yearDate = CRM_Utils_Date
::format($yearDate);
2749 $monthDate = date('Ym') . '01';
2755 'yearDate' => $yearDate,
2756 'monthDate' => $monthDate,
2761 * Load objects relations to contribution object.
2762 * Objects are stored in the $_relatedObjects property
2763 * In the first instance we are just moving functionality from BASEIpn -
2765 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2767 * Note that the unit test for the BaseIPN class tests this function
2769 * @param array $input
2770 * Input as delivered from Payment Processor.
2772 * Ids as Loaded by Payment Processor.
2773 * @param bool $loadAll
2774 * Load all related objects - even where id not passed in? (allows API to call this).
2779 public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2780 // @todo deprecate this function - the steps should be
2781 // 1) add additional functions like 'getRelatedMemberships'
2782 // 2) switch all calls that refer to ->_relatedObjects to
2783 // using the helper functions
2784 // 3) make ->_relatedObjects noisy in some way (deprecation won't work for properties - hmm
2785 // 4) make ->_relatedObjects protected
2786 // 5) hone up the individual functions to not use rely on this having been called
2787 // 6) deprecate like mad
2789 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2790 if (empty($ids['contact']) && isset($this->contact_id
)) {
2791 $ids['contact'] = $this->contact_id
;
2794 if (empty($this->_component
)) {
2795 if (!empty($ids['event'])) {
2796 $this->_component
= 'event';
2799 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2803 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2804 // refactoring than anything else, and has unit test coverage.
2805 if (empty($this->financial_type_id
)) {
2809 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2814 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2815 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2816 $this->contribution_page_id
,
2819 if ($paymentProcessorID) {
2820 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2824 $ids['contributionType'] = $this->financial_type_id
;
2825 $ids['financialType'] = $this->financial_type_id
;
2826 if ($this->contribution_page_id
) {
2827 $ids['contributionPage'] = $this->contribution_page_id
;
2830 $this->loadRelatedEntitiesByID($ids);
2832 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2833 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2836 if (!empty($ids['pledge_payment'])) {
2837 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2838 if (empty($paymentID)) {
2841 $payment = new CRM_Pledge_BAO_PledgePayment();
2842 $payment->id
= $paymentID;
2843 if (!$payment->find(TRUE)) {
2844 throw new Exception("Could not find pledge payment record: " . $paymentID);
2846 $this->_relatedObjects
['pledge_payment'][] = $payment;
2850 // These are probably no longer accessed from anywhere
2851 // @todo remove this line, after ensuring not used.
2852 $ids = $this->loadRelatedMembershipObjects($ids);
2854 if ($this->_component
!= 'contribute') {
2855 // we are in event mode
2856 // make sure event exists and is valid
2857 $event = new CRM_Event_BAO_Event();
2858 $event->id
= $ids['event'];
2859 if ($ids['event'] &&
2862 throw new Exception("Could not find event: " . $ids['event']);
2865 $this->_relatedObjects
['event'] = &$event;
2867 $participant = new CRM_Event_BAO_Participant();
2868 $participant->id
= $ids['participant'];
2869 if ($ids['participant'] &&
2870 !$participant->find(TRUE)
2872 throw new Exception("Could not find participant: " . $ids['participant']);
2874 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2876 $this->_relatedObjects
['participant'] = &$participant;
2878 // get the payment processor id from event - this is inaccurate see CRM-16923
2879 // in future we should look at throwing an exception here rather than an dubious guess.
2880 if (!$paymentProcessorID) {
2881 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2882 if ($paymentProcessorID) {
2883 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2888 if ($paymentProcessorID) {
2889 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2890 $this->is_test ?
'test' : 'live'
2892 $ids['paymentProcessor'] = $paymentProcessorID;
2893 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2896 // Add contribution id to $ids. CRM-20401
2897 $ids['contribution'] = $this->id
;
2902 * Create array of message information - ie. return html version, txt version, to field
2904 * @param array $input
2905 * Incoming information.
2906 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2907 * just check presence of recur object but maintaining legacy approach
2910 * IDs of related objects.
2911 * @param array $values
2912 * Any values that may have already been compiled by calling process.
2913 * This is augmented by values 'gathered' by gatherMessageValues
2914 * @param bool $returnMessageText
2915 * Distinguishes between whether to send message or return.
2916 * message text. We are working towards this function ALWAYS returning message text & calling
2917 * function doing emails / pdfs with it
2923 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2924 $this->loadRelatedObjects($input, $ids);
2926 if (empty($this->_component
)) {
2927 $this->_component
= $input['component'] ??
NULL;
2930 //not really sure what params might be passed in but lets merge em into values
2931 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2932 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2933 if (!empty($input['receipt_date'])) {
2934 $values['receipt_date'] = $input['receipt_date'];
2937 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2938 //what does recur 'mean here - to do with payment processor return functionality but
2939 // what is the importance
2940 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2941 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2943 $entityID = $entity = NULL;
2944 if (isset($ids['contribution'])) {
2945 $entity = 'contribution';
2946 $entityID = $ids['contribution'];
2948 if (!empty($ids['membership'])) {
2949 //not sure whether is is possible for this not to be an array - load related contacts loads an array but this code was expecting a string
2950 // the addition of the casting is in case it could get here & be a string. Added in 4.6 - maybe remove later? This AuthorizeNetIPN & PaypalIPN tests hit this
2951 // line having loaded an array
2952 $ids['membership'] = (array) $ids['membership'];
2953 $entity = 'membership';
2954 $entityID = $ids['membership'][0];
2957 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2958 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2959 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2961 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2962 //direct mode showing billing block, so use directIPN for temporary
2963 $template->assign('contributeMode', 'directIPN');
2966 // todo remove strtolower - check consistency
2967 if (strtolower($this->_component
) == 'event') {
2968 $eventParams = ['id' => $this->_relatedObjects
['participant']->event_id
];
2969 $values['event'] = [];
2971 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2973 //get location details
2975 'entity_id' => $this->_relatedObjects
['participant']->event_id
,
2976 'entity_table' => 'civicrm_event',
2978 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2981 'entity_table' => 'civicrm_event',
2982 'entity_id' => $ids['event'],
2983 'module' => 'CiviEvent',
2986 list($custom_pre_id,
2988 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2990 $values['custom_pre_id'] = $custom_pre_id;
2991 $values['custom_post_id'] = $custom_post_ids;
2992 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2993 //and cases involving status updation through ipn
2994 // whatever that means!
2995 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2996 // perhaps we should throw an e-notice if amount is set & force total_amount?
2997 if (!empty($input['amount'])) {
2998 $values['totalAmount'] = $input['amount'];
3000 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
3001 if ($values['event']['is_email_confirm']) {
3002 $values['is_email_receipt'] = 1;
3005 if (!empty($ids['contribution'])) {
3006 $values['contributionId'] = $ids['contribution'];
3009 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
3010 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
3014 $values['contribution_id'] = $this->id
;
3015 if (!empty($ids['related_contact'])) {
3016 $values['related_contact'] = $ids['related_contact'];
3017 if (isset($ids['onbehalf_dupe_alert'])) {
3018 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
3021 'contact_id' => $ids['contact'],
3022 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
3023 'Home', 'id', 'name'
3026 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
3027 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
3030 if ($this->is_test
) {
3033 if (!empty($this->_relatedObjects
['membership'])) {
3034 foreach ($this->_relatedObjects
['membership'] as $membership) {
3035 if ($membership->id
) {
3036 $values['membership_id'] = $membership->id
;
3037 $values['isMembership'] = TRUE;
3038 $values['membership_assign'] = TRUE;
3040 // need to set the membership values here
3041 $template->assign('membership_name',
3042 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
3044 $template->assign('mem_start_date', $membership->start_date
);
3045 $template->assign('mem_join_date', $membership->join_date
);
3046 $template->assign('mem_end_date', $membership->end_date
);
3047 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
3048 $template->assign('mem_status', $membership_status);
3049 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
3050 $values['is_pay_later'] = 1;
3052 // Pass amount to floatval as string '0.00' is considered a
3053 // valid amount and includes Fee section in the mail.
3054 if (isset($values['amount'])) {
3055 $values['amount'] = floatval($values['amount']);
3058 if (!empty($this->contribution_recur_id
) && $paymentObject) {
3059 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
3060 $template->assign('cancelSubscriptionUrl', $url);
3061 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
3062 $template->assign('updateSubscriptionBillingUrl', $url);
3063 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
3064 $template->assign('updateSubscriptionUrl', $url);
3067 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3070 // otherwise if its about sending emails, continue sending without return, as we
3071 // don't want to exit the loop.
3076 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3082 * Gather values for contribution mail - this function has been created
3083 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
3084 * Values related to the contribution in question are gathered
3086 * @param array $input
3087 * Input into function (probably from payment processor).
3088 * @param array $values
3090 * The set of ids related to the input.
3093 * @throws \CRM_Core_Exception
3095 public function _gatherMessageValues($input, &$values, $ids = []) {
3096 // set display address of contributor
3097 $values['billingName'] = '';
3098 if ($this->address_id
) {
3099 $addressDetails = CRM_Core_BAO_Address
::getValues(['id' => $this->address_id
], FALSE, 'id');
3100 $addressDetails = reset($addressDetails);
3101 $values['billingName'] = $addressDetails['name'] ??
'';
3103 // Else we assign the billing address of the contribution contact.
3105 $addressDetails = (array) CRM_Core_BAO_Address
::getValues(['contact_id' => $this->contact_id
, 'is_billing' => 1]);
3106 $addressDetails = reset($addressDetails);
3108 $values['address'] = $addressDetails['display'] ??
'';
3110 if ($this->_component
=== 'contribute') {
3111 //get soft contributions
3112 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
3113 if (!empty($softContributions)) {
3114 $values['softContributions'] = $softContributions['soft_credit'];
3116 if (isset($this->contribution_page_id
)) {
3117 // This is a call we want to use less, in favour of loading related objects.
3118 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
3119 if ($this->contribution_page_id
) {
3120 // This is precautionary as there are some legacy flows, but it should really be
3122 if (!isset($this->_relatedObjects
['contributionPage'])) {
3123 $this->loadRelatedEntitiesByID(['contributionPage' => $this->contribution_page_id
]);
3125 CRM_Contribute_BAO_Contribution_Utils
::overrideDefaultCurrency($values);
3128 // no contribution page -probably back office
3130 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
3131 $values['title'] = 'Contribution';
3133 // set lineItem for contribution
3135 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
3136 if (!empty($lineItems)) {
3137 $firstLineItem = reset($lineItems);
3139 if (!empty($firstLineItem['price_set_id'])) {
3140 $priceSet = civicrm_api3('PriceSet', 'getsingle', [
3141 'id' => $firstLineItem['price_set_id'],
3142 'return' => 'is_quick_config, id',
3144 $values['priceSetID'] = $priceSet['id'];
3146 foreach ($lineItems as &$eachItem) {
3147 if (isset($this->_relatedObjects
['membership'])
3148 && is_array($this->_relatedObjects
['membership'])
3149 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
3150 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
3151 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
3152 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
3154 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
3155 // However, that does create upgrade pain so would be better to be phased in.
3156 $values['useForMember'] = empty($priceSet['is_quick_config']);
3158 $values['lineItem'][0] = $lineItems;
3162 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
3166 // if this is onbehalf of contribution then set related contact
3167 if (!empty($relatedContact['individual_id'])) {
3168 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
3172 $values = array_merge($values, $this->loadEventMessageTemplateParams((int) $ids['event'], (int) $this->_relatedObjects
['participant']->id
, $this->id
));
3175 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', NULL, $this->id
);
3178 foreach ($groupTree as $key => $group) {
3179 if ($key === 'info') {
3183 foreach ($group['fields'] as $k => $customField) {
3184 $groupLabel = $group['title'];
3185 if (!empty($customField['customValue'])) {
3186 foreach ($customField['customValue'] as $customFieldValues) {
3187 $customGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
3192 $values['customGroup'] = $customGroup;
3194 $values['is_pay_later'] = $this->is_pay_later
;
3200 * Assign message variables to template but try to break the habit.
3202 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
3203 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
3204 * multiple recurring payments for processors like IATS that use tokens.
3206 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
3207 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
3208 * Note we send directly from this function in some cases because it is only partly refactored.
3210 * Don't call this function directly as the signature will change.
3214 * @param bool $returnMessageText
3218 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
3219 // @todo - this should have a better separation of concerns - ie.
3220 // gatherMessageValues should build an array of values to be assigned to the template
3221 // and this function should assign them (assigning null if not set).
3222 // the way the pcpParams & honor Params section works is a baby-step towards this.
3223 $template = CRM_Core_Smarty
::singleton();
3224 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
3225 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
3226 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
3227 $template->assign('billingName', $values['billingName']);
3229 // For some unit tests contribution cannot contain paymentProcessor information
3230 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
3231 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
3233 //assign honor information to receipt message
3234 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
3237 'soft_credit_type' => NULL,
3238 'honor_block_is_active' => NULL,
3240 if (isset($softRecord['soft_credit'])) {
3241 //if id of contribution page is present
3242 if (!empty($values['id'])) {
3243 $values['honor'] = [
3244 'honor_profile_values' => [],
3245 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
3246 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
3249 $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
3250 $honorParams['honor_block_is_active'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
3253 //offline contribution
3254 $softCreditTypes = $softCredits = [];
3255 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
3256 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
3257 $softCredits[$key] = [
3258 'Name' => $softCredit['contact_name'],
3259 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
3262 $template->assign('softCreditTypes', $softCreditTypes);
3263 $template->assign('softCredits', $softCredits);
3267 $dao = new CRM_Contribute_DAO_ContributionProduct();
3268 $dao->contribution_id
= $this->id
;
3269 if ($dao->find(TRUE)) {
3270 $premiumId = $dao->product_id
;
3271 $template->assign('option', $dao->product_option
);
3273 $productDAO = new CRM_Contribute_DAO_Product();
3274 $productDAO->id
= $premiumId;
3275 $productDAO->find(TRUE);
3276 $template->assign('selectPremium', TRUE);
3277 $template->assign('product_name', $productDAO->name
);
3278 $template->assign('price', $productDAO->price
);
3279 $template->assign('sku', $productDAO->sku
);
3281 $template->assign('title', CRM_Utils_Array
::value('title', $values));
3282 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
3283 if (!$values['amount'] && isset($this->total_amount
)) {
3284 $values['amount'] = $this->total_amount
;
3289 'pcp_display_in_roll' => NULL,
3290 'pcp_roll_nickname' => NULL,
3291 'pcp_personal_note' => NULL,
3295 if (strtolower($this->_component
) == 'contribute') {
3297 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3298 $softDAO->contribution_id
= $this->id
;
3299 if ($softDAO->find(TRUE)) {
3300 $pcpParams['pcpBlock'] = TRUE;
3301 $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll
;
3302 $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname
;
3303 $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note
;
3305 //assign the pcp page title for email subject
3306 $pcpDAO = new CRM_PCP_DAO_PCP();
3307 $pcpDAO->id
= $softDAO->pcp_id
;
3308 if ($pcpDAO->find(TRUE)) {
3309 $pcpParams['title'] = $pcpDAO->title
;
3313 foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3314 $template->assign($templateKey, $templateValue);
3317 if ($this->financial_type_id
) {
3318 $values['financial_type_id'] = $this->financial_type_id
;
3321 $template->assign('trxn_id', $this->trxn_id
);
3322 $template->assign('receive_date',
3323 CRM_Utils_Date
::processDate($this->receive_date
)
3325 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
3326 $template->assign('action', $this->is_test ?
1024 : 1);
3327 $template->assign('receipt_text',
3328 CRM_Utils_Array
::value('receipt_text',
3332 $template->assign('is_monetary', 1);
3333 $template->assign('is_recur', !empty($this->contribution_recur_id
));
3334 $template->assign('currency', $this->currency
);
3335 $template->assign('address', CRM_Utils_Address
::format($input));
3336 if (!empty($values['customGroup'])) {
3337 $template->assign('customGroup', $values['customGroup']);
3339 if (!empty($values['softContributions'])) {
3340 $template->assign('softContributions', $values['softContributions']);
3342 if ($this->_component
== 'event') {
3343 $template->assign('title', $values['event']['title']);
3344 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
3346 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
3347 $viewRoles[] = $participantRoles[$v];
3349 $values['event']['participant_role'] = implode(', ', $viewRoles);
3350 $template->assign('event', $values['event']);
3351 $template->assign('participant', $values['participant']);
3352 $template->assign('location', $values['location']);
3353 $template->assign('customPre', $values['custom_pre_id']);
3354 $template->assign('customPost', $values['custom_post_id']);
3357 if ($this->_relatedObjects
['participant']->is_test
) {
3361 $values['params'] = [];
3362 //to get email of primary participant.
3363 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
3364 $primaryAmount[] = [
3365 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3366 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3368 //build an array of cId/pId of participants
3369 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3370 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3371 //send receipt to additional participant if exists
3372 if (count($additionalIDs)) {
3373 $template->assign('isPrimary', 0);
3374 $template->assign('customProfile', NULL);
3375 //set additionalParticipant true
3376 $values['params']['additionalParticipant'] = TRUE;
3377 foreach ($additionalIDs as $pId => $cId) {
3379 //to change the status pending to completed
3380 $additional = new CRM_Event_DAO_Participant();
3381 $additional->id
= $pId;
3382 $additional->contact_id
= $cId;
3383 $additional->find(TRUE);
3384 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3385 $additional->status_id
= 1;
3386 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3387 //if additional participant dont have email
3389 if (!$additionalParticipantInfo) {
3390 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3393 'label' => $additional->fee_level
,
3394 'amount' => $additional->fee_amount
,
3396 $primaryAmount[] = [
3397 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3398 'amount' => $additional->fee_amount
,
3400 $additional->save();
3401 $template->assign('amount', $amount);
3402 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3406 //build an array of custom profile and assigning it to template
3407 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3409 if (count($customProfile)) {
3410 $template->assign('customProfile', $customProfile);
3413 // for primary contact
3414 $values['params']['additionalParticipant'] = FALSE;
3415 $template->assign('isPrimary', 1);
3416 $template->assign('amount', $primaryAmount);
3417 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3418 if ($this->payment_instrument_id
) {
3419 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3420 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3422 // carry paylater, since we did not created billing,
3423 // so need to pull email from primary location, CRM-4395
3424 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3430 * Check whether payment processor supports
3431 * cancellation of contribution subscription
3433 * @param int $contributionId
3436 * @param bool $isNotCancelled
3440 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3441 $cacheKeyString = "$contributionId";
3442 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3444 static $supportsCancel = [];
3446 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3447 $supportsCancel[$cacheKeyString] = FALSE;
3448 $isCancelled = FALSE;
3450 if ($isNotCancelled) {
3451 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3454 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3455 if (!empty($paymentObject)) {
3456 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3459 return $supportsCancel[$cacheKeyString];
3463 * Check whether subscription is already cancelled.
3465 * @param int $contributionId
3469 * contribution status
3471 public static function isSubscriptionCancelled($contributionId) {
3473 SELECT cr.contribution_status_id
3474 FROM civicrm_contribution_recur cr
3475 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3476 WHERE con.id = %1 LIMIT 1";
3477 $params = [1 => [$contributionId, 'Integer']];
3478 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3479 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name');
3480 if ($status == 'Cancelled') {
3487 * Create all financial accounts entry.
3489 * @param array $params
3490 * Contribution object, line item array and params for trxn.
3493 * @param array $financialTrxnValues
3495 * @return null|\CRM_Core_BAO_FinancialTrxn
3497 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3498 $skipRecords = $update = $return = $isRelatedId = FALSE;
3500 $additionalParticipantId = [];
3501 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3502 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3504 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3505 $entityId = $params['participant_id'];
3506 $entityTable = 'civicrm_participant';
3507 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3509 elseif (!empty($params['membership_id'])) {
3510 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3511 // are created off one contribution should be handled elsewhere
3512 $entityId = $params['membership_id'];
3513 $entityTable = 'civicrm_membership';
3516 $entityId = $params['contribution']->id
;
3517 $entityTable = 'civicrm_contribution';
3520 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3521 $isRelatedId = TRUE;
3524 $entityID[] = $entityId;
3525 if (!empty($additionalParticipantId)) {
3526 $entityID +
= $additionalParticipantId;
3528 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3529 if (empty($params['prevContribution'])) {
3536 $statusId = $params['contribution']->contribution_status_id
;
3537 // CRM-13964 partial payment
3538 if ($contributionStatus == 'Partially paid'
3539 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3541 CRM_Core_Error
::deprecatedFunctionWarning('partial_amount params are deprecated from Contribution.create - use Payment.create');
3542 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_to_pay']);
3543 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3545 $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3546 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3547 $params['total_amount'] = $partialAmtPay;
3549 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3550 if (empty($balanceTrxnInfo['trxn_id'])) {
3551 // create new balance transaction record
3552 $toFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3554 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3555 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3556 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3557 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3558 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
3559 $balanceTrxnParams['net_amount'] = $params['net_amount'] ??
NULL;
3560 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3561 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3562 $balanceTrxnParams['status_id'] = $statusId;
3563 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3564 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
3565 $balanceTrxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3566 $balanceTrxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3567 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3568 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3570 $balanceTrxnParams['is_payment'] = 1;
3572 if (!empty($params['payment_processor'])) {
3573 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3575 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3579 // build line item array if its not set in $params
3580 if (empty($params['line_item']) ||
$additionalParticipantId) {
3581 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3584 if ($contributionStatus != 'Failed' &&
3585 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3587 $skipRecords = TRUE;
3592 if (in_array($contributionStatus, $pendingStatus)) {
3593 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3594 $params['financial_type_id'],
3595 'Accounts Receivable Account is'
3598 elseif (!empty($params['payment_processor'])) {
3599 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3600 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', [
3601 'id' => $params['payment_processor'],
3602 'return' => 'payment_instrument_id',
3605 elseif (!empty($params['payment_instrument_id'])) {
3606 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3609 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3610 $queryParams = [1 => [$relationTypeId, 'Integer']];
3611 $params['to_financial_account_id'] = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3614 $totalAmount = $params['total_amount'] ??
NULL;
3615 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3616 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3618 //build financial transaction params
3620 'contribution_id' => $params['contribution']->id
,
3621 'to_financial_account_id' => $params['to_financial_account_id'],
3622 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3623 'total_amount' => $totalAmount,
3624 'fee_amount' => $params['fee_amount'] ??
NULL,
3625 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3626 'currency' => $params['contribution']->currency
,
3627 'trxn_id' => $params['contribution']->trxn_id
,
3628 // @todo - this is getting the status id from the contribution - that is BAD - ie the contribution could be partially
3629 // paid but each payment is completed. The work around is to pass in the status_id in the trxn_params but
3630 // this should really default to completed (after discussion).
3631 'status_id' => $statusId,
3632 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3633 'check_number' => $params['check_number'] ??
NULL,
3634 'pan_truncation' => $params['pan_truncation'] ??
NULL,
3635 'card_type_id' => $params['card_type_id'] ??
NULL,
3637 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3638 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3639 if (isset($params['refund_trxn_id'])) {
3640 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3641 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3644 //CRM-16259, set is_payment flag for non pending status
3645 if (!in_array($contributionStatus, $pendingStatus)) {
3646 $trxnParams['is_payment'] = 1;
3648 if (!empty($params['payment_processor'])) {
3649 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3652 if (isset($fromFinancialAccountId)) {
3653 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3656 // consider external values passed for recording transaction entry
3657 if (!empty($financialTrxnValues)) {
3658 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3660 if (empty($trxnParams['payment_processor_id'])) {
3661 unset($trxnParams['payment_processor_id']);
3664 $params['trxnParams'] = $trxnParams;
3666 if (!empty($params['prevContribution'])) {
3668 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3669 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3670 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3671 if (!isset($params['trxnParams']['trxn_id'])) {
3672 // Actually I have no idea why we are overwriting any values from the previous contribution.
3673 // (filling makes sense to me). However, only protecting this value as I really really know we
3674 // don't want this one overwritten.
3676 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3678 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3680 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3681 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3682 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3684 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3685 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3688 //if financial type is changed
3689 if (!empty($params['financial_type_id']) &&
3690 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3692 $accountRelationship = 'Income Account is';
3693 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3694 $accountRelationship = 'Deferred Revenue Account is';
3696 $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id
, $accountRelationship);
3697 $newFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3698 if ($oldFinancialAccount != $newFinancialAccount) {
3699 $params['total_amount'] = 0;
3700 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3701 $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3702 $params['prevContribution']->financial_type_id
, $accountRelationship);
3705 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3706 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3707 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3710 self
::updateFinancialAccounts($params, 'changeFinancialType');
3711 $params['skipLineItem'] = FALSE;
3712 foreach ($params['line_item'] as &$lineItems) {
3713 foreach ($lineItems as &$line) {
3714 $line['financial_type_id'] = $params['financial_type_id'];
3717 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changeFinancialType');
3718 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3719 $params['financial_account_id'] = $newFinancialAccount;
3720 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3721 self
::updateFinancialAccounts($params);
3722 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE);
3723 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3725 $params['deferred_financial_account_id'] = $newFinancialAccount;
3729 //Update contribution status
3730 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3731 if (!isset($params['refund_trxn_id'])) {
3732 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3733 // gets preference over another so I am only 'protecting' a very specific tested flow
3734 // and letting natural justice take care of the rest.
3735 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3737 if (!empty($params['contribution_status_id']) &&
3738 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3740 //Update Financial Records
3741 $callUpdateFinancialAccounts = self
::updateFinancialAccountsOnContributionStatusChange($params);
3742 if ($callUpdateFinancialAccounts) {
3743 self
::updateFinancialAccounts($params, 'changedStatus');
3744 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedStatus');
3749 // change Payment Instrument for a Completed contribution
3750 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3751 // instrument is null and now new payment instrument is added along with the payment
3752 if (!$params['contribution']->payment_instrument_id
) {
3753 $params['contribution']->find(TRUE);
3755 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3756 $params['trxnParams']['check_number'] = $params['check_number'] ??
NULL;
3758 if (self
::isPaymentInstrumentChange($params, $pendingStatus)) {
3759 $updated = CRM_Core_BAO_FinancialTrxn
::updateFinancialAccountsOnPaymentInstrumentChange($params);
3762 //if Change contribution amount
3763 $params['trxnParams']['fee_amount'] = $params['fee_amount'] ??
NULL;
3764 $params['trxnParams']['net_amount'] = $params['net_amount'] ??
NULL;
3765 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3766 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3767 if (isset($totalAmount) &&
3768 $totalAmount != $params['prevContribution']->total_amount
3770 //Update Financial Records
3771 $params['trxnParams']['from_financial_account_id'] = NULL;
3772 self
::updateFinancialAccounts($params, 'changedAmount');
3773 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedAmount');
3778 // Looks like we might have a data correction update.
3779 // This would be a case where a transaction id has been entered but it is incorrect &
3780 // the person goes back in & fixes it, as opposed to a new transaction.
3781 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3782 // the data fix scenario.
3784 if (isset($params['refund_trxn_id'])) {
3785 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3786 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3787 civicrm_api3('FinancialTrxn', 'create', [
3788 'id' => $refundIDs['financialTrxnId'],
3789 'trxn_id' => $params['refund_trxn_id'],
3793 $cardType = $params['card_type_id'] ??
NULL;
3794 $panTruncation = $params['pan_truncation'] ??
NULL;
3795 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3800 // records finanical trxn and entity financial trxn
3801 // also make it available as return value
3802 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3803 $trxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3804 $trxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3805 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3806 $params['entity_id'] = $financialTxn->id
;
3807 if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3808 self
::$_trxnIDs[] = $financialTxn->id
;
3812 // record line items and financial items
3813 if (empty($params['skipLineItem'])) {
3814 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $update);
3817 // create batch entry if batch_id is passed and
3818 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3819 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3821 'batch_id' => $params['batch_id'],
3822 'entity_table' => 'civicrm_financial_trxn',
3823 'entity_id' => $financialTxn->id
,
3825 CRM_Batch_BAO_EntityBatch
::create($entityParams);
3828 // when a fee is charged
3829 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3830 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3833 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3834 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3836 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3837 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3838 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3840 unset($params['line_item']);
3841 self
::$_trxnIDs = NULL;
3846 * Update all financial accounts entry.
3848 * @param array $params
3849 * Contribution object, line item array and params for trxn.
3851 * @param string $context
3854 * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3855 * adds unpredictability.
3858 public static function updateFinancialAccounts(&$params, $context = NULL) {
3860 $inputParams = $params;
3861 $isARefund = self
::isContributionUpdateARefund($params['prevContribution']->contribution_status_id
, $params['contribution']->contribution_status_id
);
3863 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3864 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3865 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3868 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3869 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3870 $params['entity_id'] = $trxn->id
;
3872 $itemParams['entity_table'] = 'civicrm_line_item';
3873 $trxnIds['id'] = $params['entity_id'];
3874 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution']->id
);
3875 foreach ($params['line_item'] as $fieldId => $fields) {
3876 $params = self
::createFinancialItemsForLine($params, $context, $fields, $previousLineItems, $inputParams, $isARefund, $trxnIds, $fieldId);
3881 * Is this contribution status a reversal.
3883 * If so we would expect to record a negative value in the financial_trxn table.
3885 * @param int $status_id
3889 public static function isContributionStatusNegative($status_id) {
3890 $reversalStatuses = ['Cancelled', 'Chargeback', 'Refunded'];
3891 return in_array(CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $status_id), $reversalStatuses, TRUE);
3895 * Check status validation on update of a contribution.
3897 * @param array $values
3898 * Previous form values before submit.
3900 * @param array $fields
3901 * The input form values.
3903 * @param array $errors
3908 public static function checkStatusValidation($values, &$fields, &$errors) {
3909 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3910 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3911 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3915 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3917 'Cancelled' => ['Completed', 'Refunded'],
3918 'Completed' => ['Cancelled', 'Refunded', 'Chargeback'],
3919 'Pending' => ['Cancelled', 'Completed', 'Failed', 'Partially paid'],
3920 'In Progress' => ['Cancelled', 'Completed', 'Failed'],
3921 'Refunded' => ['Cancelled', 'Completed'],
3922 'Partially paid' => ['Completed'],
3923 'Pending refund' => ['Completed', 'Refunded'],
3926 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3927 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, []))
3929 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", [
3930 1 => $contributionStatuses[$values['contribution_status_id']],
3931 2 => $contributionStatuses[$fields['contribution_status_id']],
3937 * Delete contribution of contact.
3941 * @param int $contactId
3945 public static function deleteContactContribution($contactId) {
3946 $contribution = new CRM_Contribute_DAO_Contribution();
3947 $contribution->contact_id
= $contactId;
3948 $contribution->find();
3949 while ($contribution->fetch()) {
3950 self
::deleteContribution($contribution->id
);
3955 * Get options for a given contribution field.
3957 * @param string $fieldName
3958 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3959 * @param array $props whatever is known about this dao object.
3961 * @return array|bool
3962 * @see CRM_Core_DAO::buildOptions
3965 public static function buildOptions($fieldName, $context = NULL, $props = []) {
3966 $className = __CLASS__
;
3968 if (isset($props['orderColumn'])) {
3969 $params['orderColumn'] = $props['orderColumn'];
3971 switch ($fieldName) {
3972 // This field is not part of this object but the api supports it
3973 case 'payment_processor':
3974 $className = 'CRM_Contribute_BAO_ContributionPage';
3975 // Filter results by contribution page
3976 if (!empty($props['contribution_page_id'])) {
3977 $page = civicrm_api('contribution_page', 'getsingle', [
3979 'id' => ($props['contribution_page_id']),
3981 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3982 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3986 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3987 case 'honor_type_id':
3988 $className = 'CRM_Contribute_BAO_ContributionSoft';
3989 $fieldName = 'soft_credit_type_id';
3990 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3993 case 'contribution_status_id':
3994 if ($context !== 'validate') {
3995 $params['condition'] = "v.name <> 'Template'";
3998 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
4002 * Validate financial type.
4006 * @param int $financialTypeId
4007 * Financial Type id.
4009 * @param string $relationName
4011 * @return array|bool
4013 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
4014 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
4016 if (!$financialAccount) {
4017 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
4023 * @param int $targetCid
4024 * @param $activityType
4025 * @param string $title
4026 * @param int $contributionId
4027 * @param string $totalAmount
4028 * @param string $currency
4029 * @param string $trxn_date
4031 * @throws \CRM_Core_Exception
4032 * @throws \CiviCRM_API3_Exception
4034 public static function addActivityForPayment($targetCid, $activityType, $title, $contributionId, $totalAmount, $currency, $trxn_date) {
4035 $paymentAmount = CRM_Utils_Money
::format($totalAmount, $currency);
4036 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
4037 $date = CRM_Utils_Date
::isoToMysql($trxn_date);
4038 // source record id would be the contribution id
4039 $srcRecId = $contributionId;
4043 'source_contact_id' => $targetCid,
4044 'source_record_id' => $srcRecId,
4045 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
4046 'subject' => $subject,
4047 'activity_date_time' => $date,
4048 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
4049 'skipRecentView' => TRUE,
4052 // create activity with target contacts
4053 $session = CRM_Core_Session
::singleton();
4054 $id = $session->get('userID');
4056 $activityParams['source_contact_id'] = $id;
4057 $activityParams['target_contact_id'][] = $targetCid;
4059 civicrm_api3('Activity', 'create', $activityParams);
4063 * Get list of payments displayed by Contribute_Page_PaymentInfo.
4066 * @param string $component
4067 * @param bool $getTrxnInfo
4071 * @throws \CRM_Core_Exception
4072 * @throws \CiviCRM_API3_Exception
4074 public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE) {
4075 // @todo deprecate passing in component - always call with contribution.
4076 if ($component == 'event') {
4077 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
4079 if (!$contributionId) {
4080 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
4081 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
4082 $id = $primaryParticipantId;
4084 if (!$contributionId) {
4089 elseif ($component == 'membership') {
4090 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
4093 $contributionId = $id;
4096 // The balance used to be calculated this way - we really want to remove this 'oldCalculation'
4097 // but need to unpick the whole trxn_id it's returning first.
4098 $oldCalculation = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
4099 $baseTrxnId = !empty($oldCalculation['trxn_id']) ?
$oldCalculation['trxn_id'] : NULL;
4101 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
4102 $baseTrxnId = $baseTrxnId['financialTrxnId'];
4104 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4106 $paymentBalance = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $total);
4108 $contribution = civicrm_api3('Contribution', 'getsingle', [
4109 'id' => $contributionId,
4113 'contribution_status_id',
4114 'financial_type_id',
4118 $info['payLater'] = $contribution['is_pay_later'];
4119 $info['contribution_status'] = $contribution['contribution_status'];
4120 $info['currency'] = $contribution['currency'];
4122 $info['total'] = $total;
4123 $info['paid'] = $total - $paymentBalance;
4124 $info['balance'] = $paymentBalance;
4126 $info['component'] = $component;
4127 if ($getTrxnInfo && $baseTrxnId) {
4128 $info['transaction'] = self
::getContributionTransactionInformation($contributionId, $contribution['financial_type_id']);
4131 $info['payment_links'] = self
::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4136 * Get the outstanding balance on a contribution.
4138 * @param int $contributionId
4139 * @param float $contributionTotal
4140 * Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4144 public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4145 if ($contributionTotal === NULL) {
4146 $contributionTotal = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4149 return (float) CRM_Utils_Money
::subtractCurrencies(
4151 CRM_Core_BAO_FinancialTrxn
::getTotalPayments($contributionId, TRUE),
4152 CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4157 * Get the tax amount (misnamed function).
4159 * @param array $params
4160 * @param bool $isLineItem
4164 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4165 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4167 // This function should be only called after standardisation (removal of
4168 // thousand separator & using a decimal point for cents separator.
4169 // However, we don't know if that is always true :-(
4170 // There is a deprecation notice tho :-)
4171 $unknownIfMoneyIsClean = empty($params['skipCleanMoney']) && !$isLineItem;
4172 // Update contribution.
4173 if (!empty($params['id'])) {
4174 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4175 // there are no tax implications - early return.
4176 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4179 if (empty($params['prevContribution'])) {
4180 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4183 foreach (['total_amount', 'financial_type_id', 'fee_amount'] as $field) {
4184 if (!isset($params[$field])) {
4185 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4186 // Tax amount gets added back on later....
4187 $params['total_amount'] = $params['prevContribution']->total_amount
-
4188 $params['prevContribution']->tax_amount
;
4191 $params[$field] = $params['prevContribution']->$field;
4192 if ($params[$field] != $params['prevContribution']->$field) {
4198 self
::calculateMissingAmountParams($params, $params['id']);
4199 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4200 // Assign tax Amount on update of contribution
4201 if (!empty($params['prevContribution']->tax_amount
)) {
4202 $params['tax_amount'] = 'null';
4203 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4204 foreach ($params['line_item'] as $setID => $priceField) {
4205 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4206 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4213 // New Contribution and update of contribution with tax rate financial type
4214 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4215 empty($params['skipLineItem']) && !$isLineItem
4217 $taxRateParams = $taxRates[$params['financial_type_id']];
4218 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams, $unknownIfMoneyIsClean);
4219 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4221 // Get Line Item on update of contribution
4222 if (isset($params['id'])) {
4223 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4226 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4228 foreach ($params['line_item'] as $setID => $priceField) {
4229 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4230 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4233 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4235 elseif (isset($params['api.line_item.create'])) {
4236 // Update total amount of contribution using lineItem
4237 $taxAmountArray = [];
4238 foreach ($params['api.line_item.create'] as $key => $value) {
4239 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4240 $taxRate = $taxRates[$value['financial_type_id']];
4241 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4242 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4245 $params['tax_amount'] = array_sum($taxAmountArray);
4246 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4249 // update line item of contrbution
4250 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4251 $taxRate = $taxRates[$params['financial_type_id']];
4252 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate, $unknownIfMoneyIsClean);
4253 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4260 * Check financial type validation on update of a contribution.
4262 * @param int $financialTypeId
4263 * Value of latest Financial Type.
4265 * @param int $contributionId
4268 * @param array $errors
4273 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4274 if (!empty($financialTypeId)) {
4275 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4276 if ($oldFinancialTypeId == $financialTypeId) {
4280 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4282 '1' => [$contributionId, 'Integer'],
4284 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4285 if ($result->N
> 1) {
4286 $errors['financial_type_id'] = ts('One or more line items have a different financial type than the contribution. Editing the financial type is not yet supported in this situation.');
4291 * Update related pledge payment payments.
4293 * This function has been refactored out of the back office contribution form and may
4294 * still overlap with other functions.
4296 * @param string $action
4297 * @param int $pledgePaymentID
4298 * @param int $contributionID
4299 * @param bool $adjustTotalAmount
4300 * @param float $total_amount
4301 * @param float $original_total_amount
4302 * @param int $contribution_status_id
4303 * @param int $original_contribution_status_id
4305 public static function updateRelatedPledge(
4311 $original_total_amount,
4312 $contribution_status_id,
4313 $original_contribution_status_id
4315 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4319 if ($pledgePaymentID) {
4320 //store contribution id in payment record.
4321 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4324 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4331 if (!$pledgePaymentID) {
4334 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4340 $updatePledgePaymentStatus = FALSE;
4342 // If either the status or the amount has changed we update the pledge status.
4343 if ($action & CRM_Core_Action
::ADD
) {
4344 $updatePledgePaymentStatus = TRUE;
4346 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4347 ($original_total_amount != $total_amount))
4349 $updatePledgePaymentStatus = TRUE;
4352 if ($updatePledgePaymentStatus) {
4353 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4355 $contribution_status_id,
4364 * Compute the stats values
4366 * @param string $stat either 'mode' or 'median'
4367 * @param string $sql
4368 * @param string $alias of civicrm_contribution
4370 * @return array|null
4374 public static function computeStats($stat, $sql, $alias = NULL) {
4375 CRM_Core_Error
::deprecatedFunctionWarning('computeStats is now deprecated');
4380 * Is there only one line item attached to the contribution.
4386 * @throws \CiviCRM_API3_Exception
4388 public static function isSingleLineItem($id) {
4389 $lineItemCount = civicrm_api3('LineItem', 'getcount', ['contribution_id' => $id]);
4390 return ($lineItemCount == 1);
4394 * Complete an order.
4396 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4398 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4400 * Moving it out of the BaseIPN class is just the first step.
4402 * @param array $input
4404 * @param array $objects
4405 * @param CRM_Core_Transaction $transaction
4406 * It is not recommended to pass this in. The calling function handle it's own roll back if it wants it.
4407 * @param bool $isPostPaymentCreate
4408 * Is this being called from the payment.create api. If so the api has taken care of financial entities.
4409 * Note that our goal is that this would only ever be called from payment.create and never handle financials (only
4410 * transitioning related elements).
4413 * @throws \CRM_Core_Exception
4414 * @throws \CiviCRM_API3_Exception
4416 public static function completeOrder($input, &$ids, $objects, $transaction = NULL, $isPostPaymentCreate = FALSE) {
4417 if (!$transaction) {
4418 $transaction = new CRM_Core_Transaction();
4420 $contribution = $objects['contribution'];
4421 $primaryContributionID = $contribution->id ??
$objects['first_contribution']->id
;
4422 // The previous details are used when calculating line items so keep it before any code that 'does something'
4423 if (!empty($contribution->id
)) {
4424 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(['id' => $contribution->id
]);
4426 $inputContributionWhiteList = [
4431 'payment_instrument_id',
4436 'contribution_status_id',
4440 if (self
::isSingleLineItem($primaryContributionID)) {
4441 $inputContributionWhiteList[] = 'financial_type_id';
4444 $participant = $objects['participant'] ??
NULL;
4445 $recurContrib = $objects['contributionRecur'] ??
NULL;
4446 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4447 $event = $objects['event'] ??
NULL;
4449 $paymentProcessorId = '';
4450 if (isset($objects['paymentProcessor'])) {
4451 if (is_array($objects['paymentProcessor'])) {
4452 $paymentProcessorId = $objects['paymentProcessor']['id'];
4455 $paymentProcessorId = $objects['paymentProcessor']->id
;
4459 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4461 $contributionParams = array_merge([
4462 'contribution_status_id' => $completedContributionStatusID,
4463 'source' => self
::getRecurringContributionDescription($contribution, $event),
4464 ], array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4467 // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4468 if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency
)) {
4469 $contributionParams['currency'] = $objects['first_contribution']->currency
;
4472 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4474 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4475 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4476 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4477 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4480 if ($recurringContributionID) {
4481 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4483 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4485 if (empty($contributionParams['receive_date']) && $changeDate) {
4486 $contributionParams['receive_date'] = $changeDate;
4489 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4490 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4493 if (isset($input['is_email_receipt'])) {
4494 $values['is_email_receipt'] = $input['is_email_receipt'];
4497 if ($input['component'] == 'contribute') {
4498 if ($contribution->contribution_page_id
) {
4499 // Figure out what we gain from this.
4500 // Note that we may have overwritten the is_email_receipt input, fix that below.
4501 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4503 elseif ($recurContrib && $recurringContributionID) {
4504 $values['amount'] = $recurContrib->amount
;
4505 $values['financial_type_id'] = $objects['contributionType']->id
;
4506 $values['title'] = $source = ts('Offline Recurring Contribution');
4509 if (isset($input['is_email_receipt'])) {
4510 // CRM-19601 - we may have overwritten this above.
4511 $values['is_email_receipt'] = $input['is_email_receipt'];
4513 elseif ($recurContrib && $recurringContributionID) {
4514 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4515 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4516 // dev/core#1245 this maybe not the desired effect because the default value for is_email_receipt is set to 0 rather than 1 in
4517 // Instance that had the table added via an upgrade in 4.1
4518 // see also https://github.com/civicrm/civicrm-svn/commit/7f39befd60bc735408d7866b02b3ac7fff1d4eea#diff-9ad8e290180451a2d6eacbd3d1ca7966R354
4519 // https://lab.civicrm.org/dev/core/issues/1245
4520 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4523 if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4524 self
::updateMembershipBasedOnCompletionOfContribution(
4526 $primaryContributionID,
4532 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4533 if ($event->is_email_confirm
) {
4534 // @todo this should be set by the function that sends the mail after sending.
4535 $contributionParams['receipt_date'] = $changeDate;
4537 $participantParams['id'] = $participant->id
;
4538 $participantParams['status_id'] = 'Registered';
4539 civicrm_api3('Participant', 'create', $participantParams);
4543 $contributionParams['id'] = $contribution->id
;
4544 $contributionParams['is_post_payment_create'] = $isPostPaymentCreate;
4546 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4547 // unsetting it here does NOT cause any other contribution test to fail!
4548 unset($contributionParams['financial_type_id']);
4549 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4551 // Add new soft credit against current $contribution.
4552 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
4553 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4556 if (empty($contribution->_relatedObjects
['participant']) && !empty($contribution->_relatedObjects
['membership'])) {
4557 // @fixme Can we remove this if altogether? - we removed the participant if / else and left relatedObjects['participant'] to ensure behaviour didn't change but it is probably not required.
4558 // @todo - use getRelatedMemberships instead
4559 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4560 $contribution->trxn_id
= $input['trxn_id'] ??
NULL;
4561 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4564 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4565 $transaction->commit();
4567 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4568 $contributionParams['contribution_status_id'], $input['amount']);
4570 // create an activity record
4571 if ($input['component'] == 'contribute') {
4573 $targetContactID = NULL;
4574 if (!empty($ids['related_contact'])) {
4575 $targetContactID = $contribution->contact_id
;
4576 $contribution->contact_id
= $ids['related_contact'];
4578 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4581 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4582 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4583 if (!array_key_exists('is_email_receipt', $values) ||
4584 $values['is_email_receipt'] == 1
4586 civicrm_api3('Contribution', 'sendconfirmation', [
4587 'id' => $contribution->id
,
4588 'payment_processor_id' => $paymentProcessorId,
4590 CRM_Core_Error
::debug_log_message("Receipt sent");
4593 CRM_Core_Error
::debug_log_message("Success: Database updated");
4594 return $contributionResult;
4598 * Send receipt from contribution.
4600 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4602 * Note that the compose message part has been moved to contribution
4603 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4605 * @param array $input
4606 * Incoming data from Payment processor.
4608 * Related object IDs.
4609 * @param int $contributionID
4610 * @param array $values
4611 * Values related to objects that have already been loaded.
4612 * @param bool $returnMessageText
4613 * Should text be returned instead of sent. This.
4614 * is because the function is also used to generate pdfs
4617 * @throws \CRM_Core_Exception
4618 * @throws \CiviCRM_API3_Exception
4619 * @throws \Exception
4621 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4622 $returnMessageText = FALSE) {
4624 $contribution = new CRM_Contribute_BAO_Contribution();
4625 $contribution->id
= $contributionID;
4626 if (!$contribution->find(TRUE)) {
4627 throw new CRM_Core_Exception('Contribution does not exist');
4629 $contribution->loadRelatedObjects($input, $ids, TRUE);
4630 // set receipt from e-mail and name in value
4631 if (!$returnMessageText) {
4632 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4634 $values['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id
);
4635 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4636 if ((!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4637 civicrm_api3('Contribution', 'create', [
4638 'receipt_date' => 'now',
4639 'id' => $contribution->id
,
4646 * Generate From email and from name in an array values
4648 * @param array $input
4649 * @param \CRM_Contribute_BAO_Contribution $contribution
4653 public static function generateFromEmailAndName($input, $contribution) {
4654 // Use input value if supplied.
4655 if (!empty($input['receipt_from_email'])) {
4657 CRM_Utils_Array
::value('receipt_from_name', $input, ''),
4658 $input['receipt_from_email'],
4661 // if we are still empty see if we can use anything from a contribution page.
4663 if (!empty($contribution->contribution_page_id
)) {
4664 $pageValues = civicrm_api3('ContributionPage', 'getsingle', ['id' => $contribution->contribution_page_id
]);
4666 // if we are still empty see if we can use anything from a contribution page.
4667 if (!empty($pageValues['receipt_from_email'])) {
4669 CRM_Utils_Array
::value('receipt_from_name', $pageValues),
4670 $pageValues['receipt_from_email'],
4673 // If we are still empty fall back to the domain or logged in user information.
4674 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4678 * Load related memberships.
4682 * @return array $ids
4687 * Note that in theory it should be possible to retrieve these from the line_item table
4688 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4689 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4690 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4691 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4693 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4696 public function loadRelatedMembershipObjects($ids = []) {
4698 SELECT membership_id
4699 FROM civicrm_membership_payment
4700 WHERE contribution_id = %1 ";
4701 $params = [1 => [$this->id
, 'Integer']];
4702 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, []);
4704 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4705 while ($dao->fetch()) {
4706 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4707 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4711 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4712 foreach ($ids['membership'] as $id) {
4714 $membership = new CRM_Member_BAO_Membership();
4715 $membership->id
= $id;
4716 if (!$membership->find(TRUE)) {
4717 throw new Exception("Could not find membership record: $id");
4719 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4720 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4721 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4722 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4730 * This function is used to record partial payments for contribution
4732 * @param array $contribution
4734 * @param array $params
4736 * @return CRM_Financial_DAO_FinancialTrxn
4738 public static function recordPartialPayment($contribution, $params) {
4739 CRM_Core_Error
::deprecatedFunctionWarning('use payment create api');
4740 $balanceTrxnParams['to_financial_account_id'] = self
::getToFinancialAccount($contribution, $params);
4741 $balanceTrxnParams['from_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($contribution['financial_type_id'], 'Accounts Receivable Account is');
4742 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4743 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4744 $balanceTrxnParams['trxn_date'] = CRM_Utils_Array
::value('trxn_date', $params, CRM_Utils_Array
::value('contribution_receive_date', $params, date('YmdHis')));
4745 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
4746 $balanceTrxnParams['net_amount'] = $params['total_amount'] ??
NULL;
4747 $balanceTrxnParams['currency'] = $contribution['currency'];
4748 $balanceTrxnParams['trxn_id'] = $params['contribution_trxn_id'] ??
NULL;
4749 $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4750 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4751 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
4752 $balanceTrxnParams['is_payment'] = 1;
4754 if (!empty($params['payment_processor'])) {
4755 // I can't find evidence this is passed in - I was gonna just remove it but decided to deprecate as I see self::getToFinancialAccount
4756 // also anticipates it.
4757 CRM_Core_Error
::deprecatedFunctionWarning('passing payment_processor is deprecated - use payment_processor_id');
4758 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4760 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4764 * Get the description (source field) for the recurring contribution.
4766 * @param CRM_Contribute_BAO_Contribution $contribution
4767 * @param CRM_Event_DAO_Event|null $event
4770 * @throws \CiviCRM_API3_Exception
4772 protected static function getRecurringContributionDescription($contribution, $event) {
4773 if (!empty($contribution->source
)) {
4774 return $contribution->source
;
4776 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4777 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', [
4778 'id' => $contribution->contribution_page_id
,
4779 'return' => 'title',
4781 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4784 return ts('Online Event Registration') . ': ' . $event->title
;
4786 elseif (!empty($contribution->contribution_recur_id
)) {
4787 return 'recurring contribution';
4793 * Function use to store line item proportionally in in entity financial trxn table
4795 * @param array $trxnParams
4797 * @param int $trxnId
4799 * @param float $contributionTotalAmount
4801 * @throws \CiviCRM_API3_Exception
4803 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4804 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
4805 if (!empty($lineItems)) {
4806 // get financial item
4807 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
4809 'contribution_total_amount' => $contributionTotalAmount,
4810 'trxn_total_amount' => $trxnParams['total_amount'],
4811 'trxn_id' => $trxnId,
4813 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4818 * Checks if line items total amounts
4819 * match the contribution total amount.
4821 * @param array $params
4822 * array of order params.
4824 * @throws \API_Exception
4826 public static function checkLineItems(&$params) {
4827 $totalAmount = $params['total_amount'] ??
NULL;
4828 $lineItemAmount = 0;
4830 foreach ($params['line_items'] as &$lineItems) {
4831 foreach ($lineItems['line_item'] as &$item) {
4832 if (empty($item['financial_type_id'])) {
4833 $item['financial_type_id'] = $params['financial_type_id'];
4835 $lineItemAmount +
= $item['line_total'] + CRM_Utils_Array
::value('tax_amount', $item, 0.00);
4839 if (!isset($totalAmount)) {
4840 $params['total_amount'] = $lineItemAmount;
4843 $currency = CRM_Utils_Array
::value('currency', $params, '');
4845 if (empty($currency)) {
4846 $currency = CRM_Core_Config
::singleton()->defaultCurrency
;
4849 if (!CRM_Utils_Money
::equals($totalAmount, $lineItemAmount, $currency)) {
4850 throw new CRM_Contribute_Exception_CheckLineItemsException();
4856 * Get the financial account for the item associated with the new transaction.
4858 * @param array $params
4859 * @param int $default
4863 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4865 if (!empty($params['financial_account_id'])) {
4866 return $params['financial_account_id'];
4869 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
4870 $preferredAccountsRelationships = [
4871 'Refunded' => 'Credit/Contra Revenue Account is',
4872 'Chargeback' => 'Chargeback Account is',
4875 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4876 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
4877 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
4879 $preferredAccountsRelationships[$contributionStatus]
4887 * ContributionPage values were being imposed onto values.
4889 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4890 * REALLY didn't want superimposed. The rest are left there in their overkill out
4893 * The rationale for making this explicit is that it was a case of carefully set values being
4894 * seemingly randonly overwritten without much care. In general I think array randomly setting
4895 * variables en mass is risky.
4897 * @param array $values
4901 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4902 $contributionPageValues = [];
4903 CRM_Contribute_BAO_ContributionPage
::setValues(
4904 $this->contribution_page_id
,
4905 $contributionPageValues
4908 // These are the values that I believe to be useful.
4911 'pay_later_receipt',
4913 'receipt_from_email',
4914 'receipt_from_name',
4918 'honoree_profile_id',
4919 'onbehalf_profile_id',
4920 'honor_block_is_active',
4921 // Kinda might be - but would be on the contribution...
4924 // Included for 'fear of regression' but can't justify any use for these....
4926 'payment_processor',
4927 'financial_type_id',
4928 'amount_block_is_active',
4933 'default_amount_id',
4937 'initial_amount_help_text',
4938 'initial_amount_label',
4940 'is_allow_other_amount',
4941 'is_billing_required',
4942 'is_confirm_enabled',
4943 'is_credit_card_only',
4945 'is_partial_payment',
4946 'is_recur_installments',
4947 'is_recur_interval',
4951 'min_initial_amount',
4952 'recur_frequency_unit',
4959 foreach ($valuesToCopy as $valueToCopy) {
4960 if (isset($contributionPageValues[$valueToCopy])) {
4961 if ($valueToCopy === 'title') {
4962 $values[$valueToCopy] = CRM_Contribute_BAO_Contribution_Utils
::getContributionPageTitle($this->contribution_page_id
);
4965 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4973 * Get values of CiviContribute Settings
4974 * and check if its enabled or not.
4975 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4976 * in serialized form. Usually this should be stored as flat settings for each form fields
4977 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4978 * settings we will live with an inconsistency because it's too hard to change for now.
4979 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
4982 * @param string $name
4987 public static function checkContributeSettings($name) {
4988 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
4989 return $contributeSettings[$name] ??
NULL;
4993 * This function process contribution related objects.
4995 * @param int $contributionId
4996 * @param int $statusId
4997 * @param int|null $previousStatusId
4999 * @param string $receiveDate
5001 * @return null|string
5003 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
5005 if (!$contributionId ||
!$statusId) {
5010 'contribution_id' => $contributionId,
5011 'contribution_status_id' => $statusId,
5012 'previous_contribution_status_id' => $previousStatusId,
5013 'receive_date' => $receiveDate,
5016 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
5018 if (!is_array($updateResult) ||
5019 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
5020 !is_array($updatedComponents) ||
5021 empty($updatedComponents)
5026 // get the user display name.
5028 SELECT display_name as displayName
5029 FROM civicrm_contact
5030 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5031 WHERE civicrm_contribution.id = {$contributionId}";
5032 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5034 // get the status message for user.
5035 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5037 if ($componentName == 'CiviMember') {
5038 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5039 CRM_Member_PseudoConstant
::membershipStatus()
5042 $statusNameMsgPart = 'updated';
5043 switch ($updatedStatusName) {
5046 $statusNameMsgPart = $updatedStatusName;
5050 $statusMsg .= "<br />" . ts("Membership for %1 has been %2.", [
5051 1 => $userDisplayName,
5052 2 => $statusNameMsgPart,
5056 if ($componentName == 'CiviEvent') {
5057 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5058 CRM_Event_PseudoConstant
::participantStatus()
5060 if ($updatedStatusName == 'Cancelled') {
5061 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", [1 => $userDisplayName]);
5063 elseif ($updatedStatusName == 'Registered') {
5064 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", [1 => $userDisplayName]);
5068 if ($componentName == 'CiviPledge') {
5069 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5070 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5072 if ($updatedStatusName == 'Cancelled') {
5073 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", [1 => $userDisplayName]);
5075 elseif ($updatedStatusName == 'Failed') {
5076 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", [1 => $userDisplayName]);
5078 elseif ($updatedStatusName == 'Completed') {
5079 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", [1 => $userDisplayName]);
5088 * Get the contribution as it is in the database before being updated.
5090 * @param int $contributionID
5092 * @return \CRM_Contribute_BAO_Contribution|null
5094 private static function getOriginalContribution($contributionID) {
5095 return self
::getValues(['id' => $contributionID]);
5099 * Get the amount for the financial item row.
5101 * Helper function to start to break down recordFinancialTransactions for readability.
5103 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5105 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5106 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5109 * @param array $params
5110 * Params as passed to contribution.create
5112 * @param string $context
5113 * changeFinancialType| changedAmount
5114 * @param array $lineItemDetails
5116 * @param bool $isARefund
5117 * Is this a refund / negative transaction.
5118 * @param int $previousLineItemTotal
5121 * @todo move recordFinancialAccounts & helper functions to their own class?
5124 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5125 if ($context == 'changedAmount') {
5126 $lineTotal = $lineItemDetails['line_total'];
5127 if ($lineTotal != $previousLineItemTotal) {
5128 $lineTotal -= $previousLineItemTotal;
5132 elseif ($context == 'changeFinancialType') {
5133 return -$lineItemDetails['line_total'];
5135 elseif ($context == 'changedStatus') {
5136 $cancelledTaxAmount = 0;
5138 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $lineItemDetails, '0.00');
5140 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total'] +
(float) $cancelledTaxAmount);
5142 elseif ($context === NULL) {
5143 // erm, yes because? but, hey, it's tested.
5144 return $lineItemDetails['line_total'];
5146 elseif (empty($lineItemDetails['line_total'])) {
5147 // follow legacy code path
5149 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', ['civi.tag' => 'deprecated']);
5150 return $params['total_amount'];
5153 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total']);
5158 * Get the multiplier for adjusting rows.
5160 * If we are dealing with a refund or cancellation then it will be a negative
5161 * amount to reflect the negative transaction.
5163 * If we are changing Financial Type it will be a negative amount to
5164 * adjust down the old type.
5166 * @param int $contribution_status_id
5167 * @param string $context
5171 protected static function getMultiplier($contribution_status_id, $context) {
5172 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5179 * Does this transaction reflect a payment instrument change.
5181 * @param array $params
5182 * @param array $pendingStatuses
5186 protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5187 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
5189 if (array_key_exists('payment_instrument_id', $params)) {
5190 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
5191 !CRM_Utils_System
::isNull($params['payment_instrument_id'])
5193 //check if status is changed from Pending to Completed
5194 // do not update payment instrument changes for Pending to Completed
5195 if (!($contributionStatus == 'Completed' &&
5196 in_array($params['prevContribution']->contribution_status_id
, $pendingStatuses))
5201 elseif ((!CRM_Utils_System
::isNull($params['payment_instrument_id']) &&
5202 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
5203 $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5207 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
5208 $params['contribution']->check_number
!= $params['prevContribution']->check_number
5210 // another special case when check number is changed, create new financial records
5211 // create financial trxn with negative amount
5219 * Update the memberships associated with a contribution if it has been completed.
5221 * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5222 * load them in this function. Code clean up would compensate for any minor performance implication.
5224 * @param \CRM_Contribute_BAO_Contribution $contribution
5225 * @param int $primaryContributionID
5226 * @param string $changeDate
5228 * @throws \CRM_Core_Exception
5229 * @throws \CiviCRM_API3_Exception
5231 public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5232 $memberships = self
::getRelatedMemberships($contribution->id
);
5233 foreach ($memberships as $membership) {
5234 $membershipParams = [
5235 'id' => $membership['id'],
5236 'contact_id' => $membership['contact_id'],
5237 'is_test' => $membership['is_test'],
5238 'membership_type_id' => $membership['membership_type_id'],
5239 'membership_activity_status' => 'Completed',
5242 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
5243 $membershipParams['membership_type_id'],
5244 $membershipParams['is_test'],
5245 $membershipParams['id']
5248 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5249 // this picks up membership type changes during renewals
5250 // @todo this is almost certainly an obsolete sql call, the pre-change
5251 // membership is accessible via $this->_relatedObjects
5253 SELECT membership_type_id
5254 FROM civicrm_membership_log
5255 WHERE membership_id={$membershipParams['id']}
5258 $dao = CRM_Core_DAO
::executeQuery($sql);
5259 if ($dao->fetch()) {
5260 if (!empty($dao->membership_type_id
)) {
5261 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
5264 if (empty($membership['end_date']) ||
(int) $membership['status_id'] !== CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending')) {
5265 // Passing num_terms to the api triggers date calculations, but for pending memberships these may be already calculated.
5266 // sigh - they should be consistent but removing the end date check causes test failures & maybe UI too?
5267 // The api assumes num_terms is a special sauce for 'is_renewal' so we need to not pass it when updating a pending to completed.
5268 // @todo once apiv4 ships with core switch to that & find sanity.
5269 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5270 $membershipParams['membership_type_id'],
5271 $primaryContributionID
5274 // @todo remove all this stuff in favour of letting the api call further down handle in
5275 // (it is a duplication of what the api does).
5276 $dates = array_fill_keys([
5281 if ($currentMembership) {
5283 * Fixed FOR CRM-4433
5284 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5285 * when Contribution mode is notify and membership is for renewal )
5287 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5289 // @todo - we should pass membership_type_id instead of null here but not
5290 // adding as not sure of testing
5291 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
5292 $changeDate, NULL, $membershipParams['num_terms']
5294 $dates['join_date'] = $currentMembership['join_date'];
5297 //get the status for membership.
5298 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
5300 $dates['join_date'],
5303 $membershipParams['membership_type_id'],
5307 unset($dates['end_date']);
5308 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
5309 //we might be renewing membership,
5310 //so make status override false.
5311 $membershipParams['is_override'] = FALSE;
5312 $membershipParams['status_override_end_date'] = 'null';
5314 //CRM-17723 - reset static $relatedContactIds array()
5315 // @todo move it to Civi Statics.
5317 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
5318 civicrm_api3('Membership', 'create', $membershipParams);
5323 * Get payment links as they relate to a contribution.
5325 * If a payment can be made then include a payment link & if a refund is appropriate
5326 * then a refund link.
5329 * @param float $balance
5330 * @param string $contributionStatus
5333 * $actionLinks Links array containing:
5337 protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5338 if ($contributionStatus === 'Failed' ||
!CRM_Core_Permission
::check('edit contributions')) {
5339 // In general the balance is the best way to determine if a payment can be added or not,
5340 // but not for Failed contributions, where we don't accept additional payments at the moment.
5341 // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5342 // do accept more payments agains them.
5347 'url' => CRM_Utils_System
::url('civicrm/payment', [
5353 'title' => ts('Record Payment'),
5356 if ((int) $balance > 0) {
5357 // @todo - this should be possible even if not > 0 - test & remove this if.
5358 // it is possible to 'overpay' in the real world & we honor that.
5359 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
5361 'url' => CRM_Utils_System
::url('civicrm/payment', [
5368 'title' => ts('Submit Credit Card payment'),
5372 elseif ((int) $balance < 0) {
5373 // @todo - in the future remove this IF - OK to refund money even when not due since
5376 'url' => CRM_Utils_System
::url('civicrm/payment', [
5382 'title' => ts('Record Refund'),
5385 return $actionLinks;
5389 * Get a query to determine the amount donated by the contact/s in the current financial year.
5391 * @param array $contactIDs
5395 public static function getAnnualQuery($contactIDs) {
5396 $contactIDs = implode(',', $contactIDs);
5397 $config = CRM_Core_Config
::singleton();
5398 $currentMonth = date('m');
5399 $currentDay = date('d');
5401 (int) $config->fiscalYearStart
['M'] > $currentMonth ||
5403 (int) $config->fiscalYearStart
['M'] == $currentMonth &&
5404 (int) $config->fiscalYearStart
['d'] > $currentDay
5407 $year = date('Y') - 1;
5412 $nextYear = $year +
1;
5414 if ($config->fiscalYearStart
) {
5415 $newFiscalYearStart = $config->fiscalYearStart
;
5416 if ($newFiscalYearStart['M'] < 10) {
5417 // This is just a clumsy way of adding padding.
5418 // @todo next round look for a nicer way.
5419 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5421 if ($newFiscalYearStart['d'] < 10) {
5422 // This is just a clumsy way of adding padding.
5423 // @todo next round look for a nicer way.
5424 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5426 $config->fiscalYearStart
= $newFiscalYearStart;
5427 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
5430 // First of January.
5433 $startDate = "$year$monthDay";
5434 $endDate = "$nextYear$monthDay";
5437 'contact_id' => 'IN (' . $contactIDs . ')',
5438 'is_test' => ' = 0',
5439 'receive_date' => ['>=' . $startDate, '< ' . $endDate],
5441 $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5442 CRM_Financial_BAO_FinancialType
::addACLClausesToWhereClauses($whereClauses);
5445 foreach ($whereClauses as $key => $clause) {
5446 $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5448 $whereClauseString = implode(' AND ', $clauses);
5450 // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5451 // this group by + having on contribution_status_id improves performance
5453 SELECT COUNT(*) as count,
5454 SUM(total_amount) as amount,
5455 AVG(total_amount) as average,
5457 FROM civicrm_contribution b
5458 WHERE " . $whereClauseString . "
5459 GROUP BY currency, contribution_status_id
5460 HAVING $havingClause
5466 * Assign Test Value.
5468 * @param string $fieldName
5469 * @param array $fieldDef
5470 * @param int $counter
5472 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5473 if ($fieldName == 'tax_amount') {
5474 $this->{$fieldName} = "0.00";
5476 elseif ($fieldName == 'net_amount') {
5477 $this->{$fieldName} = "2.00";
5479 elseif ($fieldName == 'total_amount') {
5480 $this->{$fieldName} = "3.00";
5482 elseif ($fieldName == 'fee_amount') {
5483 $this->{$fieldName} = "1.00";
5486 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5491 * Check if contribution has participant/membership payment.
5493 * @param int $contributionId
5498 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5499 // get line item for contribution
5500 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5501 // check if line item is for membership or participant
5502 foreach ($lineItems as $items) {
5503 if ($items['entity_table'] == 'civicrm_participant') {
5507 elseif ($items['entity_table'] == 'civicrm_membership') {
5519 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5521 * @param array $trxnParams
5522 * Financial trxn params
5523 * @param array $contributionParams
5524 * Contribution Params
5528 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5529 if (!Civi
::settings()->get('always_post_to_accounts_receivable')) {
5532 $statusId = $contributionParams['contribution']->contribution_status_id
;
5533 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5534 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5535 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5536 // Return if contribution status is not completed.
5537 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5538 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5539 && $contributionParams['prevContribution']->is_pay_later
== 0
5545 $params = $trxnParams;
5546 $financialTypeID = !empty($contributionParams['financial_type_id']) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5547 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5548 $params['to_financial_account_id'] = $arAccountId;
5549 $params['status_id'] = array_search('Pending', $contributionStatuses);
5550 $params['is_payment'] = FALSE;
5551 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5552 self
::$_trxnIDs[] = $trxn->id
;
5553 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5557 * Calculate financial item amount when contribution is updated.
5559 * @param array $params
5560 * contribution params
5561 * @param array $amountParams
5563 * @param string $context
5567 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5568 if (!empty($params['is_quick_config'])) {
5569 $amount = $amountParams['item_amount'];
5571 $amount = $params['total_amount'];
5572 if ($context === NULL) {
5573 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5578 $amount = $amountParams['line_total'];
5579 if ($context == 'changedAmount') {
5580 $amount -= $amountParams['previous_line_total'];
5582 $amount *= $amountParams['diff'];
5588 * Retrieve Sales Tax Financial Accounts.
5594 public static function getSalesTaxFinancialAccounts() {
5595 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5596 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5597 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5598 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5599 $queryParams = [1 => [$accountRel, 'Integer']];
5600 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5601 $financialAccount = [];
5602 while ($dao->fetch()) {
5603 $financialAccount[$dao->id
] = $dao->id
;
5605 return $financialAccount;
5609 * Create tax entry in civicrm_entity_financial_trxn table.
5611 * @param array $entityParams
5613 * @param array $eftParams
5615 * @throws \CiviCRM_API3_Exception
5617 public static function createProportionalEntry($entityParams, $eftParams) {
5619 if ($entityParams['contribution_total_amount'] != 0) {
5620 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5622 // Record Entity Financial Trxn; CRM-20145
5623 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5624 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5628 * Create array of last financial item id's.
5630 * @param int $contributionId
5634 public static function getLastFinancialItemIds($contributionId) {
5635 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5636 FROM civicrm_financial_item fi
5637 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5638 WHERE li.contribution_id = %1";
5639 $dao = CRM_Core_DAO
::executeQuery($sql, [
5645 $ftIds = $taxItems = [];
5646 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5647 while ($dao->fetch()) {
5648 /* if sales tax item*/
5649 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5650 $taxItems[$dao->price_field_value_id
] = [
5651 'financial_item_id' => $dao->id
,
5652 'amount' => $dao->tax_amount
,
5656 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5659 return [$ftIds, $taxItems];
5663 * Create proportional entries in civicrm_entity_financial_trxn.
5665 * @param array $entityParams
5667 * @param array $lineItems
5669 * @param array $ftIds
5671 * @param array $taxItems
5673 * @throws \CiviCRM_API3_Exception
5675 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5677 'entity_table' => 'civicrm_financial_item',
5678 'financial_trxn_id' => $entityParams['trxn_id'],
5680 foreach ($lineItems as $key => $value) {
5681 if ($value['qty'] == 0) {
5684 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5685 $entityParams['line_item_amount'] = $value['line_total'];
5686 self
::createProportionalEntry($entityParams, $eftParams);
5687 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5688 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5689 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5690 self
::createProportionalEntry($entityParams, $eftParams);
5696 * Load entities related to the contribution into $this->_relatedObjects.
5700 * @throws \CRM_Core_Exception
5702 protected function loadRelatedEntitiesByID($ids) {
5704 'contact' => 'CRM_Contact_BAO_Contact',
5705 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5706 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5707 'financialType' => 'CRM_Financial_BAO_FinancialType',
5708 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5710 foreach ($entities as $entity => $bao) {
5711 if (!empty($ids[$entity])) {
5712 $this->_relatedObjects
[$entity] = new $bao();
5713 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5714 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5715 throw new CRM_Core_Exception($entity . ' could not be loaded');
5722 * Should an email receipt be sent for this contribution when complete.
5724 * @param array $input
5728 protected function isEmailReceipt($input) {
5729 if (isset($input['is_email_receipt'])) {
5730 return $input['is_email_receipt'];
5732 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5733 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5739 * Function to replace contribution tokens.
5741 * @param array $contributionIds
5743 * @param string $subject
5745 * @param array $subjectToken
5747 * @param string $text
5749 * @param string $html
5751 * @param array $messageToken
5753 * @param bool $escapeSmarty
5756 * @throws \CiviCRM_API3_Exception
5758 public static function replaceContributionTokens(
5767 if (empty($contributionIds)) {
5770 $contributionDetails = [];
5771 foreach ($contributionIds as $id) {
5772 $result = self
::getContributionTokenValues($id, $messageToken);
5773 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5774 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5775 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5777 return $contributionDetails;
5781 * Get the contribution fields for $id and display labels where
5782 * appropriate (if the token is present).
5785 * @param array $messageToken
5788 public static function getContributionTokenValues($id, $messageToken) {
5792 $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
5793 // lab.c.o mail#46 - show labels, not values, for custom fields with option values.
5794 if (!empty($messageToken)) {
5795 foreach ($result['values'][$id] as $fieldName => $fieldValue) {
5796 if (strpos($fieldName, 'custom_') === 0 && array_search($fieldName, $messageToken['contribution']) !== FALSE) {
5797 $result['values'][$id][$fieldName] = CRM_Core_BAO_CustomField
::displayValue($result['values'][$id][$fieldName], $fieldName);
5805 * Get invoice_number for contribution.
5807 * @param int $contributionID
5811 public static function getInvoiceNumber($contributionID) {
5812 if ($invoicePrefix = self
::checkContributeSettings('invoice_prefix')) {
5813 return $invoicePrefix . $contributionID;
5820 * Load the values needed for the event message.
5822 * @param int $eventID
5823 * @param int $participantID
5824 * @param int|null $contributionID
5827 * @throws \CRM_Core_Exception
5829 protected function loadEventMessageTemplateParams(int $eventID, int $participantID, $contributionID): array {
5834 $values = ['event' => []];
5836 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
5837 // add custom fields for event
5838 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', NULL, $eventID);
5840 $eventCustomGroup = [];
5841 foreach ($eventGroupTree as $key => $group) {
5842 if ($key === 'info') {
5846 foreach ($group['fields'] as $k => $customField) {
5847 $groupLabel = $group['title'];
5848 if (!empty($customField['customValue'])) {
5849 foreach ($customField['customValue'] as $customFieldValues) {
5850 $eventCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5855 $values['event']['customGroup'] = $eventCustomGroup;
5857 //get participant details
5858 $participantParams = [
5859 'id' => $participantID,
5862 $values['participant'] = [];
5864 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
5865 // add custom fields for event
5866 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', NULL, $participantID);
5867 $participantCustomGroup = [];
5868 foreach ($participantGroupTree as $key => $group) {
5869 if ($key === 'info') {
5873 foreach ($group['fields'] as $k => $customField) {
5874 $groupLabel = $group['title'];
5875 if (!empty($customField['customValue'])) {
5876 foreach ($customField['customValue'] as $customFieldValues) {
5877 $participantCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5882 $values['participant']['customGroup'] = $participantCustomGroup;
5884 //get location details
5886 'entity_id' => $eventID,
5887 'entity_table' => 'civicrm_event',
5889 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
5892 'entity_table' => 'civicrm_event',
5893 'entity_id' => $eventID,
5894 'module' => 'CiviEvent',
5897 list($custom_pre_id,
5899 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
5901 $values['custom_pre_id'] = $custom_pre_id;
5902 $values['custom_post_id'] = $custom_post_ids;
5904 // set lineItem for event contribution
5905 if ($contributionID) {
5906 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($contributionID);
5907 if (!empty($participantIds)) {
5908 foreach ($participantIds as $pIDs) {
5909 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
5910 if (!CRM_Utils_System
::isNull($lineItem)) {
5911 $values['lineItem'][] = $lineItem;