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 && !empty($params['membership_id'])
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 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
513 $transaction->commit();
515 $activity = civicrm_api3('Activity', 'get', [
516 'source_record_id' => $contribution->id
,
517 'options' => ['limit' => 1],
519 'activity_type_id' => 'Contribution',
520 'return' => ['id', 'campaign'],
523 //CRM-18406: Update activity when edit contribution.
524 if ($activity['count']) {
525 // CRM-13237 : if activity record found, update it with campaign id of contribution
526 // @todo compare campaign ids first.
527 CRM_Core_DAO
::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id
);
528 $contribution->activity_id
= $activity['id'];
531 if (empty($contribution->contact_id
)) {
532 $contribution->find(TRUE);
534 CRM_Activity_BAO_Activity
::addActivity($contribution, 'Contribution');
536 // do not add to recent items for import, CRM-4399
537 if (empty($params['skipRecentView'])) {
538 $url = CRM_Utils_System
::url('civicrm/contact/view/contribution',
539 "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
541 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
548 $retrieveRequired = 0;
549 foreach ($titleFields as $titleField) {
550 if (!isset($contribution->$titleField)) {
551 $retrieveRequired = 1;
555 if ($retrieveRequired == 1) {
556 $contribution->find(TRUE);
558 $financialType = CRM_Contribute_PseudoConstant
::financialType($contribution->financial_type_id
);
559 $title = CRM_Contact_BAO_Contact
::displayName($contribution->contact_id
) . ' - (' . CRM_Utils_Money
::format($contribution->total_amount
, $contribution->currency
) . ' ' . ' - ' . $financialType . ')';
562 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::UPDATE
)) {
563 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
564 "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
568 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::DELETE
)) {
569 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
570 "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
574 // add the recently created Contribution
575 CRM_Utils_Recent
::add($title,
579 $contribution->contact_id
,
585 return $contribution;
589 * Get the values for pseudoconstants for name->value and reverse.
591 * @param array $defaults
592 * (reference) the default values, some of which need to be resolved.
593 * @param bool $reverse
594 * True if we want to resolve the values in the reverse direction (value -> name).
596 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
597 self
::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant
::financialType(), $reverse);
598 self
::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant
::paymentInstrument(), $reverse);
599 self
::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'label'), $reverse);
600 self
::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant
::pcPage(), $reverse);
604 * Convert associative array names to values and vice-versa.
606 * This function is used by both the web form layer and the api. Note that
607 * the api needs the name => value conversion, also the view layer typically
608 * requires value => name conversion
610 * @param array $defaults
611 * @param string $property
612 * @param array $lookup
613 * @param bool $reverse
617 public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
618 $id = $property . '_id';
620 $src = $reverse ?
$property : $id;
621 $dst = $reverse ?
$id : $property;
623 if (!array_key_exists($src, $defaults)) {
627 $look = $reverse ?
array_flip($lookup) : $lookup;
629 if (is_array($look)) {
630 if (!array_key_exists($defaults[$src], $look)) {
634 $defaults[$dst] = $look[$defaults[$src]];
639 * Retrieve DB object based on input parameters.
641 * It also stores all the retrieved values in the default array.
643 * @param array $params
644 * (reference ) an assoc array of name/value pairs.
645 * @param array $defaults
646 * (reference ) an assoc array to hold the name / value pairs.
647 * in a hierarchical manner
649 * (reference) the array that holds all the db ids.
651 * @return CRM_Contribute_BAO_Contribution
653 public static function retrieve(&$params, &$defaults = [], &$ids = []) {
654 $contribution = CRM_Contribute_BAO_Contribution
::getValues($params, $defaults, $ids);
655 return $contribution;
659 * Combine all the importable fields from the lower levels object.
661 * The ordering is important, since currently we do not have a weight
662 * scheme. Adding weight is super important and should be done in the
663 * next week or so, before this can be called complete.
665 * @param string $contactType
666 * @param bool $status
669 * array of importable Fields
671 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
672 if (!self
::$_importableFields) {
673 if (!self
::$_importableFields) {
674 self
::$_importableFields = [];
678 $fields = ['' => ['title' => ts('- do not import -')]];
681 $fields = ['' => ['title' => ts('- Contribution Fields -')]];
684 $note = CRM_Core_DAO_Note
::import();
685 $tmpFields = CRM_Contribute_DAO_Contribution
::import();
686 unset($tmpFields['option_value']);
687 $optionFields = CRM_Core_OptionValue
::getFields($mode = 'contribute');
688 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
690 // Using new Dedupe rule.
692 'contact_type' => $contactType,
693 'used' => 'Unsupervised',
695 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
696 $tmpContactField = [];
697 if (is_array($fieldsArray)) {
698 foreach ($fieldsArray as $value) {
699 //skip if there is no dupe rule
700 if ($value == 'none') {
703 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
708 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
709 $tmpContactField[trim($value)] = $contactFields[trim($value)];
711 $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
714 $title = $tmpContactField[trim($value)]['title'];
716 $tmpContactField[trim($value)]['title'] = $title;
720 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
721 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
722 $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
723 $fields = array_merge($fields, $tmpContactField);
724 $fields = array_merge($fields, $tmpFields);
725 $fields = array_merge($fields, $note);
726 $fields = array_merge($fields, $optionFields);
727 $fields = array_merge($fields, CRM_Financial_DAO_FinancialType
::export());
728 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
729 self
::$_importableFields = $fields;
731 return self
::$_importableFields;
735 * Combine all the exportable fields from the lower level objects.
737 * @param bool $checkPermission
740 * array of exportable Fields
742 public static function &exportableFields($checkPermission = TRUE) {
743 if (!self
::$_exportableFields) {
744 if (!self
::$_exportableFields) {
745 self
::$_exportableFields = [];
748 $fields = CRM_Contribute_DAO_Contribution
::export();
749 if (CRM_Contribute_BAO_Query
::isSiteHasProducts()) {
750 $fields = array_merge(
752 CRM_Contribute_DAO_Product
::export(),
753 CRM_Contribute_DAO_ContributionProduct
::export(),
754 // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
756 'contribution_product_id' => [
757 'title' => ts('Premium'),
758 'name' => 'contribution_product_id',
759 'where' => 'civicrm_product.id',
760 'data_type' => CRM_Utils_Type
::T_INT
,
766 $financialAccount = CRM_Financial_DAO_FinancialAccount
::export();
768 $contributionPage = [
769 'contribution_page' => [
770 'title' => ts('Contribution Page'),
771 'name' => 'contribution_page',
772 'where' => 'civicrm_contribution_page.title',
773 'data_type' => CRM_Utils_Type
::T_STRING
,
777 $contributionNote = [
778 'contribution_note' => [
779 'title' => ts('Contribution Note'),
780 'name' => 'contribution_note',
781 'data_type' => CRM_Utils_Type
::T_TEXT
,
786 'contribution_batch' => [
787 'title' => ts('Batch Name'),
793 'contribution_campaign_title' => [
794 'title' => ts('Campaign Title'),
795 'name' => 'campaign_title',
796 'where' => 'civicrm_campaign.title',
797 'data_type' => CRM_Utils_Type
::T_STRING
,
800 $softCreditFields = [
801 'contribution_soft_credit_name' => [
802 'name' => 'contribution_soft_credit_name',
803 'title' => ts('Soft Credit For'),
804 'where' => 'civicrm_contact_d.display_name',
805 'data_type' => CRM_Utils_Type
::T_STRING
,
807 'contribution_soft_credit_amount' => [
808 'name' => 'contribution_soft_credit_amount',
809 'title' => ts('Soft Credit Amount'),
810 'where' => 'civicrm_contribution_soft.amount',
811 'data_type' => CRM_Utils_Type
::T_MONEY
,
813 'contribution_soft_credit_type' => [
814 'name' => 'contribution_soft_credit_type',
815 'title' => ts('Soft Credit Type'),
816 'where' => 'contribution_softcredit_type.label',
817 'data_type' => CRM_Utils_Type
::T_STRING
,
819 'contribution_soft_credit_contribution_id' => [
820 'name' => 'contribution_soft_credit_contribution_id',
821 'title' => ts('Soft Credit For Contribution ID'),
822 'where' => 'civicrm_contribution_soft.contribution_id',
823 'data_type' => CRM_Utils_Type
::T_INT
,
825 'contribution_soft_credit_contact_id' => [
826 'name' => 'contribution_soft_credit_contact_id',
827 'title' => ts('Soft Credit For Contact ID'),
828 'where' => 'civicrm_contact_d.id',
829 'data_type' => CRM_Utils_Type
::T_INT
,
833 $fields = array_merge($fields, $contributionPage,
834 $contributionNote, $extraFields, $softCreditFields, $financialAccount, $campaignTitle,
835 CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
838 self
::$_exportableFields = $fields;
841 return self
::$_exportableFields;
845 * Record an activity when a payment is received.
847 * @todo this is intended to be moved to payment BAO class as a protected function
848 * on that class. Currently being cleaned up. The addActivityForPayment doesn't really
849 * merit it's own function as it makes the code less rather than more readable.
851 * @param int $contributionId
852 * @param int $participantId
853 * @param string $totalAmount
854 * @param string $currency
855 * @param string $trxnDate
857 * @throws \CRM_Core_Exception
858 * @throws \CiviCRM_API3_Exception
860 public static function recordPaymentActivity($contributionId, $participantId, $totalAmount, $currency, $trxnDate) {
861 $activityType = ($totalAmount < 0) ?
'Refund' : 'Payment';
863 if ($participantId) {
864 $inputParams['id'] = $participantId;
867 $entityObj = CRM_Event_BAO_Participant
::getValues($inputParams, $values, $ids);
868 $entityObj = $entityObj[$participantId];
869 $title = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id
, 'title');
872 $entityObj = new CRM_Contribute_BAO_Contribution();
873 $entityObj->id
= $contributionId;
874 $entityObj->find(TRUE);
875 $title = ts('Contribution');
877 // @todo per block above this is not a logical splitting off of functionality.
878 self
::addActivityForPayment($entityObj->contact_id
, $activityType, $title, $contributionId, $totalAmount, $currency, $trxnDate);
882 * Get the value for the To Financial Account.
884 * @param $contribution
889 public static function getToFinancialAccount($contribution, $params) {
890 if (!empty($params['payment_processor_id'])) {
891 return CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor_id'], NULL, 'civicrm_payment_processor');
893 if (!empty($params['payment_instrument_id'])) {
894 return CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
897 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
898 $queryParams = [1 => [$relationTypeId, 'Integer']];
899 return CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
904 * Get memberships related to the contribution.
906 * @param int $contributionID
910 protected static function getRelatedMemberships($contributionID) {
911 $membershipPayments = civicrm_api3('MembershipPayment', 'get', [
912 'return' => 'membership_id',
913 'contribution_id' => (int) $contributionID,
916 foreach ($membershipPayments as $membershipPayment) {
917 $membershipIDs[] = $membershipPayment['membership_id'];
919 if (empty($membershipIDs)) {
922 // We could combine this with the MembershipPayment.get - we'd
923 // need to re-wrangle the params (here or in the calling function)
924 // as they would then me membership.contact_id, membership.is_test etc
925 return civicrm_api3('Membership', 'get', [
926 'id' => ['IN' => $membershipIDs],
927 'return' => ['id', 'contact_id', 'membership_type_id', 'is_test', 'status_id', 'end_date'],
932 * Cancel contribution.
934 * This function should only be called from transitioncomponents - it is an interim step in refactoring.
936 * @param $processContributionObject
937 * @param $memberships
938 * @param $contributionId
939 * @param $membershipStatuses
940 * @param $updateResult
941 * @param $participant
943 * @param $pledgePayment
945 * @param $pledgePaymentIDs
946 * @param $contributionStatusId
950 protected static function cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId) {
951 // @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
952 $processContribution = FALSE;
953 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
954 if (is_array($memberships)) {
955 foreach ($memberships as $membership) {
957 //Update Membership status if there is no other completed contribution associated with the membership.
958 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
959 foreach ($relatedContributions as $contriId) {
960 if ($contriId == $contributionId) {
963 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
964 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
968 if ($membership && $update) {
969 $newStatus = array_search('Cancelled', $membershipStatuses);
972 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
974 'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
975 'source_contact_id' => CRM_Core_Session
::singleton()->get('userID'),
976 'target_contact_id' => $membership->contact_id
,
977 'source_record_id' => $membership->id
,
978 'activity_type_id' => 'Change Membership Status',
979 'status_id' => 'Completed',
980 'priority_id' => 'Normal',
981 'activity_date_time' => 'now',
984 $membership->status_id
= $newStatus;
985 $membership->is_override
= TRUE;
986 $membership->status_override_end_date
= 'null';
988 civicrm_api3('activity', 'create', $activityParam);
990 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
991 if ($processContributionObject) {
992 $processContribution = TRUE;
999 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1000 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1002 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1003 if ($processContributionObject) {
1004 $processContribution = TRUE;
1008 if ($pledgePayment) {
1009 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1011 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1012 if ($processContributionObject) {
1013 $processContribution = TRUE;
1016 return [$updateResult, $processContribution];
1020 * Do any accounting updates required as a result of a contribution status change.
1022 * Currently we have a bit of a roundabout where adding a payment results in this being called &
1023 * this may attempt to add a payment. We need to resolve that....
1025 * The 'right' way to add payments or refunds is through the Payment.create api. That api
1026 * then updates the contribution but this process should not also record another financial trxn.
1027 * Currently we have weak detection fot that scenario & where it is detected the first returned
1028 * value is FALSE - meaning 'do not continue'.
1030 * We should also look at the fact that the calling function - updateFinancialAccounts
1031 * bunches together some disparate processes rather than having separate appropriate
1034 * @param array $params
1037 * Return indicates whether the updateFinancialAccounts function should continue.
1039 private static function updateFinancialAccountsOnContributionStatusChange(&$params) {
1040 $previousContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['prevContribution']->contribution_status_id
, 'name');
1041 $currentContributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
1043 if ((($previousContributionStatus == 'Partially paid' && $currentContributionStatus == 'Completed')
1044 ||
($previousContributionStatus == 'Pending refund' && $currentContributionStatus == 'Completed')
1045 // This concept of pay_later as different to any other sort of pending is deprecated & it's unclear
1046 // why it is here or where it is handled instead.
1047 ||
($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later
== TRUE
1048 && $currentContributionStatus == 'Partially paid'))
1053 if (self
::isContributionUpdateARefund($params['prevContribution']->contribution_status_id
, $params['contribution']->contribution_status_id
)) {
1054 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1055 $params['trxnParams']['total_amount'] = -$params['total_amount'];
1057 elseif (($previousContributionStatus == 'Pending'
1058 && $params['prevContribution']->is_pay_later
) ||
$previousContributionStatus == 'In Progress'
1060 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
1061 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
1063 if ($currentContributionStatus == 'Cancelled') {
1064 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1065 $params['trxnParams']['to_financial_account_id'] = $arAccountId;
1066 $params['trxnParams']['total_amount'] = -$params['total_amount'];
1069 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1070 $params['trxnParams']['from_financial_account_id'] = $arAccountId;
1074 if (($previousContributionStatus == 'Pending'
1075 ||
$previousContributionStatus == 'In Progress')
1076 && ($currentContributionStatus == 'Completed')
1078 if (empty($params['line_item'])) {
1080 //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
1081 // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
1082 // & this can be removed
1085 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1086 // This is an update so original currency if none passed in.
1087 $params['trxnParams']['currency'] = CRM_Utils_Array
::value('currency', $params, $params['prevContribution']->currency
);
1089 self
::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
1090 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
1091 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1092 $params['entity_id'] = self
::$_trxnIDs[] = $trxn->id
;
1094 $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
1097 'entity_table' => 'civicrm_financial_item',
1099 foreach ($params['line_item'] as $fieldId => $fields) {
1100 foreach ($fields as $fieldValueId => $lineItemDetails) {
1101 self
::updateFinancialItemForLineItemToPaid($lineItemDetails['id']);
1103 1 => [$lineItemDetails['id'], 'Integer'],
1105 $financialItem = CRM_Core_DAO
::executeQuery($sql, $fparams);
1106 while ($financialItem->fetch()) {
1107 $entityParams['entity_id'] = $financialItem->id
;
1108 $entityParams['amount'] = $financialItem->amount
;
1109 foreach (self
::$_trxnIDs as $tID) {
1110 $entityParams['financial_trxn_id'] = $tID;
1111 CRM_Financial_BAO_FinancialItem
::createEntityTrxn($entityParams);
1122 * It is possible to override the membership id that is updated from the payment processor.
1124 * Historically Paypal does this & it still does if it determines data is messed up - see
1125 * https://lab.civicrm.org/dev/membership/issues/13
1127 * Read the comment block on repeattransaction for more information
1128 * about how things should work.
1130 * @param int $contributionID
1131 * @param array $input
1133 * @throws \CiviCRM_API3_Exception
1135 protected static function handleMembershipIDOverride($contributionID, $input) {
1136 if (!empty($input['membership_id'])) {
1137 Civi
::log()->debug('The related membership id has been overridden - this may impact data - see https://github.com/civicrm/civicrm-core/pull/15053');
1138 civicrm_api3('MembershipPayment', 'create', ['contribution_id' => $contributionID, 'membership_id' => $input['membership_id']]);
1143 * Update all financial items related to the line item tto have a status of paid.
1145 * @param int $lineItemID
1147 private static function updateFinancialItemForLineItemToPaid($lineItemID) {
1150 CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
1153 2 => [$lineItemID, 'Integer'],
1155 $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
1156 CRM_Core_DAO
::executeQuery($query, $fparams);
1160 * Create the financial items for the line.
1162 * @param array $params
1163 * @param string $context
1164 * @param array $fields
1165 * @param array $previousLineItems
1166 * @param array $inputParams
1167 * @param bool $isARefund
1168 * @param array $trxnIds
1169 * @param int $fieldId
1173 private static function createFinancialItemsForLine($params, $context, $fields, array $previousLineItems, array $inputParams, bool $isARefund, $trxnIds, $fieldId): array {
1174 foreach ($fields as $fieldValueId => $lineItemDetails) {
1175 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($lineItemDetails['id']);
1176 $receiveDate = CRM_Utils_Date
::isoToMysql($params['prevContribution']->receive_date
);
1177 if ($params['contribution']->receive_date
) {
1178 $receiveDate = CRM_Utils_Date
::isoToMysql($params['contribution']->receive_date
);
1181 $financialAccount = self
::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array
::value('financial_account_id', $prevFinancialItem));
1183 $currency = $params['prevContribution']->currency
;
1184 if ($params['contribution']->currency
) {
1185 $currency = $params['contribution']->currency
;
1187 $previousLineItemTotal = CRM_Utils_Array
::value('line_total', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1189 'transaction_date' => $receiveDate,
1190 'contact_id' => $params['prevContribution']->contact_id
,
1191 'currency' => $currency,
1192 'amount' => self
::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
1193 'description' => $prevFinancialItem['description'] ??
NULL,
1194 'status_id' => $prevFinancialItem['status_id'],
1195 'financial_account_id' => $financialAccount,
1196 'entity_table' => 'civicrm_line_item',
1197 'entity_id' => $lineItemDetails['id'],
1199 $financialItem = CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
1200 $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
1201 $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id
;
1203 if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') ||
($context == 'changeFinancialType')) {
1204 $taxAmount = (float) $lineItemDetails['tax_amount'];
1205 if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
1206 // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
1207 $taxAmount = CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1209 elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
1210 $taxAmount -= CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
1212 if ($taxAmount != 0) {
1213 $itemParams['amount'] = self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $taxAmount;
1214 $itemParams['description'] = CRM_Invoicing_Utils
::getTaxTerm();
1215 if ($lineItemDetails['financial_type_id']) {
1216 $itemParams['financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getSalesTaxFinancialAccount($lineItemDetails['financial_type_id']);
1218 CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
1226 * Does this contributtion status update represent a refund.
1228 * @param int $previousContributionStatusID
1229 * @param int $currentContributionStatusID
1233 private static function isContributionUpdateARefund($previousContributionStatusID, $currentContributionStatusID): bool {
1234 if ('Completed' !== CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $previousContributionStatusID)) {
1237 return self
::isContributionStatusNegative($currentContributionStatusID);
1241 * Get transaction information about the contribution.
1243 * @param int $contributionId
1244 * @param int $financialTypeID
1248 protected static function getContributionTransactionInformation($contributionId, int $financialTypeID) {
1250 $feeFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Expense Account is');
1252 // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
1254 SELECT GROUP_CONCAT(fa.`name`) as financial_account,
1256 ft.payment_instrument_id,
1257 ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
1259 FROM civicrm_contribution con
1260 LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
1261 INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
1262 AND ft.to_financial_account_id != %2
1263 LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
1264 LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
1265 LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
1267 WHERE con.id = %1 AND ft.is_payment = 1
1270 1 => [$contributionId, 'Integer'],
1271 2 => [$feeFinancialAccount, 'Integer'],
1273 $resultDAO = CRM_Core_DAO
::executeQuery($sql, $queryParams);
1274 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'label');
1276 while ($resultDAO->fetch()) {
1277 $paidByLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
1278 $paidByName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
1279 if ($resultDAO->card_type_id
) {
1280 $creditCardType = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id
);
1281 $pantruncation = '';
1282 if ($resultDAO->pan_truncation
) {
1283 $pantruncation = ": {$resultDAO->pan_truncation}";
1285 $paidByLabel .= " ({$creditCardType}{$pantruncation})";
1288 // show payment edit link only for payments done via backoffice form
1289 $paymentEditLink = '';
1290 if (empty($resultDAO->payment_processor_id
) && CRM_Core_Permission
::check('edit contributions')) {
1292 CRM_Core_Action
::UPDATE
=> [
1293 'name' => ts('Edit Payment'),
1294 'icon' => 'fa-pencil',
1295 'url' => 'civicrm/payment/edit',
1296 'class' => 'medium-popup',
1297 'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
1298 'title' => ts('Edit Payment'),
1301 $paymentEditLink = CRM_Core_Action
::formLink(
1303 CRM_Core_Action
::mask([CRM_Core_Permission
::EDIT
]),
1305 'id' => $resultDAO->id
,
1306 'contribution_id' => $contributionId,
1310 'Payment.edit.action',
1317 'id' => $resultDAO->id
,
1318 'total_amount' => $resultDAO->total_amount
,
1319 'financial_type' => $resultDAO->financial_account
,
1320 'payment_instrument' => $paidByLabel,
1321 'receive_date' => $resultDAO->trxn_date
,
1322 'trxn_id' => $resultDAO->trxn_id
,
1323 'status' => $statuses[$resultDAO->status_id
],
1324 'currency' => $resultDAO->currency
,
1325 'action' => $paymentEditLink,
1327 if ($paidByName == 'Check') {
1328 $val['check_number'] = $resultDAO->check_number
;
1338 public function addSelectWhereClause() {
1339 $whereClauses = parent
::addSelectWhereClause();
1340 if ($whereClauses !== []) {
1341 // In this case permisssions have been applied & we assume the
1342 // financialaclreport is applying these
1343 // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
1344 return $whereClauses;
1347 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1348 return $whereClauses;
1350 $types = CRM_Financial_BAO_FinancialType
::getAllEnabledAvailableFinancialTypes();
1351 if (empty($types)) {
1352 $whereClauses['financial_type_id'] = 'IN (0)';
1355 $whereClauses['financial_type_id'] = [
1356 'IN (' . implode(',', array_keys($types)) . ')',
1359 return $whereClauses;
1363 * @param null $status
1364 * @param null $startDate
1365 * @param null $endDate
1367 * @return array|null
1369 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1373 $where[] = 'contribution_status_id = 1';
1377 $where[] = 'contribution_status_id = 3';
1382 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
1385 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
1387 $financialTypeACLJoin = '';
1388 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1389 $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1390 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1391 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1392 if ($financialTypes) {
1393 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1394 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1397 $where[] = "c.financial_type_id IN (0)";
1401 $whereCond = implode(' AND ', $where);
1404 SELECT sum( total_amount ) as total_amount,
1405 count( c.id ) as total_count,
1407 FROM civicrm_contribution c
1408 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
1409 $financialTypeACLJoin
1411 AND ( is_test = 0 OR is_test IS NULL )
1412 AND contact.is_deleted = 0
1416 $dao = CRM_Core_DAO
::executeQuery($query);
1419 while ($dao->fetch()) {
1420 $count +
= $dao->total_count
;
1421 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
1425 'amount' => implode(', ', $amount),
1433 * Delete the indirect records associated with this contribution first.
1437 * @return mixed|null
1438 * $results no of deleted Contribution on success, false otherwise
1440 public static function deleteContribution($id) {
1441 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
1443 $transaction = new CRM_Core_Transaction();
1446 //delete activity record
1448 'source_record_id' => $id,
1449 // activity type id for contribution
1450 'activity_type_id' => 6,
1453 CRM_Activity_BAO_Activity
::deleteActivity($params);
1455 //delete billing address if exists for this contribution.
1456 self
::deleteAddress($id);
1458 //update pledge and pledge payment, CRM-3961
1459 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
1461 // remove entry from civicrm_price_set_entity, CRM-5095
1462 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
1463 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
1465 // cleanup line items.
1466 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1468 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1469 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1471 if ($participantId) {
1472 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1475 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1479 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1480 $noteId = key($note);
1482 CRM_Core_BAO_Note
::del($noteId, FALSE);
1485 $dao = new CRM_Contribute_DAO_Contribution();
1488 $results = $dao->delete();
1490 $transaction->commit();
1492 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1494 // delete the recently created Contribution
1495 $contributionRecent = [
1497 'type' => 'Contribution',
1499 CRM_Utils_Recent
::del($contributionRecent);
1505 * React to a financial transaction (payment) failure.
1507 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1508 * payments is important for forensic and outreach reasons.
1510 * @param int $contributionID
1511 * @param int $contactID
1512 * @param string $message
1514 * @throws \CiviCRM_API3_Exception
1516 public static function failPayment($contributionID, $contactID, $message) {
1517 civicrm_api3('activity', 'create', [
1518 'activity_type_id' => 'Failed Payment',
1519 'details' => $message,
1520 'subject' => ts('Payment failed at payment processor'),
1521 'source_record_id' => $contributionID,
1522 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() : $contactID,
1525 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1526 civicrm_api3('contribution', 'create', [
1527 'id' => $contributionID,
1528 'contribution_status_id' => 'Failed',
1533 * Check if there is a contribution with the same trxn_id or invoice_id.
1535 * @param array $input
1536 * An assoc array of name/value pairs.
1537 * @param array $duplicates
1538 * (reference) store ids of duplicate contribs.
1542 * true if duplicate, false otherwise
1544 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1546 $id = $input['id'] ??
NULL;
1548 $trxn_id = $input['trxn_id'] ??
NULL;
1549 $invoice_id = $input['invoice_id'] ??
NULL;
1555 $clause[] = "trxn_id = %1";
1556 $input[1] = [$trxn_id, 'String'];
1560 $clause[] = "invoice_id = %2";
1561 $input[2] = [$invoice_id, 'String'];
1564 if (empty($clause)) {
1568 $clause = implode(' OR ', $clause);
1570 $clause = "( $clause ) AND id != %3";
1571 $input[3] = [$id, 'Integer'];
1574 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1575 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1577 while ($dao->fetch()) {
1578 $duplicates[] = $dao->id
;
1585 * Takes an associative array and creates a contribution_product object.
1587 * the function extract all the params it needs to initialize the create a
1588 * contribution_product object. the params array could contain additional unused name/value
1591 * @param array $params
1592 * (reference) an assoc array of name/value pairs.
1594 * @return CRM_Contribute_DAO_ContributionProduct
1596 public static function addPremium(&$params) {
1597 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1598 $contributionProduct->copyValues($params);
1599 return $contributionProduct->save();
1603 * Get list of contribution fields for profile.
1604 * For now we only allow custom contribution fields to be in
1607 * @param bool $addExtraFields
1608 * True if special fields needs to be added.
1611 * the list of contribution fields
1613 public static function getContributionFields($addExtraFields = TRUE) {
1614 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1615 // @todo remove this - this line was added because payment_instrument_id was not
1616 // set to exportable - but now it is.
1617 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1619 if ($addExtraFields) {
1620 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1623 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1625 foreach ($contributionFields as $key => $var) {
1626 if ($key == 'contribution_contact_id') {
1629 elseif ($key == 'contribution_campaign_id') {
1630 $var['title'] = ts('Campaign');
1632 $fields[$key] = $var;
1635 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1640 * Add extra fields specific to contribution.
1642 public static function getSpecialContributionFields() {
1644 'contribution_soft_credit_name' => [
1645 'name' => 'contribution_soft_credit_name',
1646 'title' => ts('Soft Credit Name'),
1647 'headerPattern' => '/^soft_credit_name$/i',
1648 'where' => 'civicrm_contact_d.display_name',
1650 'contribution_soft_credit_email' => [
1651 'name' => 'contribution_soft_credit_email',
1652 'title' => ts('Soft Credit Email'),
1653 'headerPattern' => '/^soft_credit_email$/i',
1654 'where' => 'soft_email.email',
1656 'contribution_soft_credit_phone' => [
1657 'name' => 'contribution_soft_credit_phone',
1658 'title' => ts('Soft Credit Phone'),
1659 'headerPattern' => '/^soft_credit_phone$/i',
1660 'where' => 'soft_phone.phone',
1662 'contribution_soft_credit_contact_id' => [
1663 'name' => 'contribution_soft_credit_contact_id',
1664 'title' => ts('Soft Credit Contact ID'),
1665 'headerPattern' => '/^soft_credit_contact_id$/i',
1666 'where' => 'civicrm_contribution_soft.contact_id',
1668 'contribution_pcp_title' => [
1669 'name' => 'contribution_pcp_title',
1670 'title' => ts('Personal Campaign Page Title'),
1671 'headerPattern' => '/^contribution_pcp_title$/i',
1672 'where' => 'contribution_pcp.title',
1676 return $extraFields;
1680 * @param int $pageID
1684 public static function getCurrentandGoalAmount($pageID) {
1686 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1687 FROM civicrm_contribution_page p,
1688 civicrm_contribution c
1689 WHERE p.id = c.contribution_page_id
1691 AND c.cancel_date is null
1695 $config = CRM_Core_Config
::singleton();
1696 $params = [1 => [$pageID, 'Integer']];
1697 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1699 if ($dao->fetch()) {
1700 return [$dao->goal
, $dao->total
];
1703 return [NULL, NULL];
1708 * Get list of contributions which credit the passed in contact ID.
1710 * The returned array provides details about the original contribution & donor.
1712 * @param int $honorId
1713 * In Honor of Contact ID.
1716 * list of contribution fields
1717 * @todo - this is a confusing function called from one place. It has a test. It would be
1718 * nice to deprecate it.
1721 public static function getHonorContacts($honorId) {
1723 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1724 $honorDAO->contact_id
= $honorId;
1727 $type = CRM_Contribute_PseudoConstant
::financialType();
1729 while ($honorDAO->fetch()) {
1730 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1731 $contributionDAO->id
= $honorDAO->contribution_id
;
1733 if ($contributionDAO->find(TRUE)) {
1734 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1735 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1736 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1737 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1738 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1739 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1740 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1741 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1742 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
, 'label');
1750 * Get the sort name of a contact for a particular contribution.
1753 * Id of the contribution.
1755 * @return null|string
1756 * sort name of the contact if found
1758 public static function sortName($id) {
1759 $id = CRM_Utils_Type
::escape($id, 'Integer');
1762 SELECT civicrm_contact.sort_name
1763 FROM civicrm_contribution, civicrm_contact
1764 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1765 AND civicrm_contribution.id = {$id}
1767 return CRM_Core_DAO
::singleValueQuery($query);
1771 * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1773 * @param int|array $contactIDs
1777 public static function annual($contactIDs) {
1778 if (!is_array($contactIDs)) {
1779 // In practice I can't fine any evidence that this function is ever called with
1780 // anything other than a single contact id, but left like this due to .... fear.
1781 $contactIDs = explode(',', $contactIDs);
1784 $query = self
::getAnnualQuery($contactIDs);
1785 $dao = CRM_Core_DAO
::executeQuery($query);
1787 $amount = $average = [];
1788 while ($dao->fetch()) {
1789 if ($dao->count
> 0 && $dao->amount
> 0) {
1790 $count +
= $dao->count
;
1791 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1792 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1798 implode(', ', $amount),
1799 implode(', ', $average),
1806 * Check if there is a contribution with the params passed in.
1808 * Used for trxn_id,invoice_id and contribution_id
1810 * @param array $params
1811 * An assoc array of name/value pairs.
1814 * contribution id if success else NULL
1816 public static function checkDuplicateIds($params) {
1817 $dao = new CRM_Contribute_DAO_Contribution();
1821 foreach ($params as $k => $v) {
1823 $clause[] = "$k = '$v'";
1826 $clause = implode(' AND ', $clause);
1827 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1828 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1830 while ($dao->fetch()) {
1838 * Get the contribution details for component export.
1840 * @param int $exportMode
1842 * @param array $componentIds
1848 public static function getContributionDetails($exportMode, $componentIds) {
1849 $paymentDetails = [];
1850 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1852 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1853 $componentSelect = " civicrm_participant_payment.participant_id id";
1854 $additionalClause = "
1855 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1856 AND civicrm_participant_payment.participant_id {$componentClause} )
1859 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1860 $componentSelect = " civicrm_membership_payment.membership_id id";
1861 $additionalClause = "
1862 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1863 AND civicrm_membership_payment.membership_id {$componentClause} )
1866 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1867 $componentSelect = " civicrm_pledge_payment.id id";
1868 $additionalClause = "
1869 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1870 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1874 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1875 trxn_id, {$componentSelect}
1876 FROM civicrm_contribution
1877 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1878 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1879 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1880 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1881 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1882 AND option_group_contribution_status.id = contribution_status.option_group_id )
1886 $dao = CRM_Core_DAO
::executeQuery($query);
1888 while ($dao->fetch()) {
1889 $paymentDetails[$dao->id
] = [
1890 'total_amount' => $dao->total_amount
,
1891 'contribution_status' => $dao->status
,
1892 'receive_date' => $dao->receive_date
,
1893 'pay_instru' => $dao->payment_instrument
,
1894 'trxn_id' => $dao->trxn_id
,
1898 return $paymentDetails;
1902 * Create address associated with contribution record.
1904 * As long as there is one or more billing field in the parameters we will create the address.
1906 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1909 * @param array $params
1910 * @param int $billingLocationTypeID
1915 public static function createAddress($params, $billingLocationTypeID) {
1916 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1917 if ($hasBillingField) {
1918 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1919 return $address->id
;
1926 * Delete billing address record related contribution.
1928 * @param int $contributionId
1929 * @param int $contactId
1931 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1933 $contactJoin = NULL;
1935 if ($contributionId) {
1936 $clauses[] = "cc.id = {$contributionId}";
1940 $clauses[] = "cco.id = {$contactId}";
1941 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1944 if (empty($clauses)) {
1945 CRM_Core_Error
::fatal();
1948 $condition = implode(' OR ', $clauses);
1952 FROM civicrm_address ca
1953 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1957 $dao = CRM_Core_DAO
::executeQuery($query);
1959 while ($dao->fetch()) {
1960 $params = ['id' => $dao->id
];
1961 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1966 * This function check online pending contribution associated w/
1967 * Online Event Registration or Online Membership signup.
1969 * @param int $componentId
1970 * Participant/membership id.
1971 * @param string $componentName
1975 * pending contribution id.
1977 public static function checkOnlinePendingContribution($componentId, $componentName) {
1978 $contributionId = NULL;
1979 if (!$componentId ||
1980 !in_array($componentName, ['Event', 'Membership'])
1982 return $contributionId;
1985 if ($componentName == 'Event') {
1986 $idName = 'participant_id';
1987 $componentTable = 'civicrm_participant';
1988 $paymentTable = 'civicrm_participant_payment';
1989 $source = ts('Online Event Registration');
1992 if ($componentName == 'Membership') {
1993 $idName = 'membership_id';
1994 $componentTable = 'civicrm_membership';
1995 $paymentTable = 'civicrm_membership_payment';
1996 $source = ts('Online Contribution');
1999 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
2002 SELECT component.id as {$idName},
2003 componentPayment.contribution_id as contribution_id,
2004 contribution.source source,
2005 contribution.contribution_status_id as contribution_status_id,
2006 contribution.is_pay_later as is_pay_later
2007 FROM $componentTable component
2008 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
2009 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
2010 WHERE component.id = {$componentId}";
2012 $dao = CRM_Core_DAO
::executeQuery($query);
2014 while ($dao->fetch()) {
2015 if ($dao->contribution_id
&&
2016 $dao->is_pay_later
&&
2017 $dao->contribution_status_id
== $pendingStatusId &&
2018 strpos($dao->source
, $source) !== FALSE
2020 $contributionId = $dao->contribution_id
;
2024 return $contributionId;
2028 * Update contribution as well as related objects.
2030 * This function by-passes hooks - to address this - don't use this function.
2032 * @param array $params
2033 * @param bool $processContributionObject
2037 * @throws CRM_Core_Exception
2038 * @throws \CiviCRM_API3_Exception
2041 * Use api contribute.completetransaction
2042 * For failures use failPayment (preferably exposing by api in the process).
2045 public static function transitionComponents($params, $processContributionObject = FALSE) {
2046 // get minimum required values.
2047 $contactId = $params['contact_id'] ??
NULL;
2048 $componentId = $params['component_id'] ??
NULL;
2049 $componentName = $params['componentName'] ??
NULL;
2050 $contributionId = $params['contribution_id'] ??
NULL;
2051 $contributionStatusId = $params['contribution_status_id'] ??
NULL;
2053 // if we already processed contribution object pass previous status id.
2054 $previousContriStatusId = $params['previous_contribution_status_id'] ??
NULL;
2058 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2060 // we process only ( Completed, Cancelled, or Failed ) contributions.
2061 if (!$contributionId ||
2062 !in_array($contributionStatusId, [
2063 array_search('Completed', $contributionStatuses),
2064 array_search('Cancelled', $contributionStatuses),
2065 array_search('Failed', $contributionStatuses),
2068 return $updateResult;
2071 if (!$componentName ||
!$componentId) {
2072 // get the related component details.
2073 $componentDetails = self
::getComponentDetails($contributionId);
2076 $componentDetails['contact_id'] = $contactId;
2077 $componentDetails['component'] = $componentName;
2079 if ($componentName == 'event') {
2080 $componentDetails['participant'] = $componentId;
2083 $componentDetails['membership'] = $componentId;
2087 if (!empty($componentDetails['contact_id'])) {
2088 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2094 // do check for required ids.
2095 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
2096 return $updateResult;
2099 //now we are ready w/ required ids, start processing.
2101 $baseIPN = new CRM_Core_Payment_BaseIPN();
2103 $input = $ids = $objects = [];
2105 $input['component'] = $componentDetails['component'] ??
NULL;
2106 $ids['contribution'] = $contributionId;
2107 $ids['contact'] = $componentDetails['contact_id'] ??
NULL;
2108 $ids['membership'] = $componentDetails['membership'] ??
NULL;
2109 $ids['participant'] = $componentDetails['participant'] ??
NULL;
2110 $ids['event'] = $componentDetails['event'] ??
NULL;
2111 $ids['pledge_payment'] = $componentDetails['pledge_payment'] ??
NULL;
2112 $ids['contributionRecur'] = NULL;
2113 $ids['contributionPage'] = NULL;
2115 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
2116 CRM_Core_Error
::fatal();
2119 $memberships = &$objects['membership'];
2120 $participant = &$objects['participant'];
2121 $pledgePayment = &$objects['pledge_payment'];
2122 $contribution = &$objects['contribution'];
2123 $pledgeID = $oldStatus = NULL;
2124 $pledgePaymentIDs = [];
2125 if ($pledgePayment) {
2126 foreach ($pledgePayment as $key => $object) {
2127 $pledgePaymentIDs[] = $object->id
;
2129 $pledgeID = $pledgePayment[0]->pledge_id
;
2132 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
2135 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
2136 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
2141 // we might want to process contribution object.
2142 $processContribution = FALSE;
2143 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
2144 // Call interim cancel function - with a goal to cleaning up the signature on it and switching to a tested api Contribution.cancel function.
2145 list($updateResult, $processContribution) = self
::cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId);
2147 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
2148 if (is_array($memberships)) {
2149 foreach ($memberships as $membership) {
2151 //Update Membership status if there is no other completed contribution associated with the membership.
2152 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
2153 foreach ($relatedContributions as $contriId) {
2154 if ($contriId == $contributionId) {
2157 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
2158 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
2162 if ($membership && $update) {
2163 $membership->status_id
= array_search('Expired', $membershipStatuses);
2164 $membership->is_override
= TRUE;
2165 $membership->status_override_end_date
= 'null';
2166 $membership->save();
2168 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2169 if ($processContributionObject) {
2170 $processContribution = TRUE;
2176 $updatedStatusId = array_search('Cancelled', $participantStatuses);
2177 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2179 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2180 if ($processContributionObject) {
2181 $processContribution = TRUE;
2185 if ($pledgePayment) {
2186 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2188 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2189 if ($processContributionObject) {
2190 $processContribution = TRUE;
2194 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
2196 // only pending contribution related object processed.
2197 if ($previousContriStatusId &&
2198 !in_array($contributionStatuses[$previousContriStatusId], [
2203 // this is case when we already processed contribution object.
2204 return $updateResult;
2206 elseif (!$previousContriStatusId &&
2207 !in_array($contributionStatuses[$contribution->contribution_status_id
], [
2212 // this is case when we are going to process contribution object later.
2213 return $updateResult;
2216 if (is_array($memberships)) {
2217 foreach ($memberships as $membership) {
2222 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
2223 $membership->membership_type_id
,
2224 $membership->is_test
, $membership->id
2227 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
2228 // this picks up membership type changes during renewals
2230 SELECT membership_type_id
2231 FROM civicrm_membership_log
2232 WHERE membership_id=$membership->id
2235 $dao = new CRM_Core_DAO();
2237 if ($dao->fetch()) {
2238 if (!empty($dao->membership_type_id
)) {
2239 $membership->membership_type_id
= $dao->membership_type_id
;
2240 $membership->save();
2243 // else fall back to using current membership type
2244 // Figure out number of terms
2246 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
2247 foreach ($lineitems as $lineitem) {
2248 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
2249 $numterms = $lineitem['membership_num_terms'] ??
NULL;
2251 // in case membership_num_terms comes through as null or zero
2252 $numterms = $numterms >= 1 ?
$numterms : 1;
2257 // CRM-15735-to update the membership status as per the contribution receive date
2259 $oldStatus = $membership->status_id
;
2260 if (!empty($params['receive_date'])) {
2261 $joinDate = $params['receive_date'];
2262 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
2263 $membership->end_date
,
2264 $membership->join_date
,
2265 $params['receive_date'],
2267 $membership->membership_type_id
,
2270 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
2271 $membership->save();
2274 if ($currentMembership) {
2275 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
2276 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
2277 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
2280 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
2283 //get the status for membership.
2284 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
2286 $dates['join_date'],
2289 $membership->membership_type_id
,
2293 $formattedParams = [
2294 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
2295 array_search('Current', $membershipStatuses)
2297 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
2298 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
2299 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
2302 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
2304 $membership->copyValues($formattedParams);
2305 $membership->save();
2307 //updating the membership log
2308 $membershipLog = [];
2309 $membershipLog = $formattedParams;
2310 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
2311 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
2313 $membershipLog['start_date'] = $logStartDate;
2314 $membershipLog['membership_id'] = $membership->id
;
2315 $membershipLog['modified_id'] = $membership->contact_id
;
2316 $membershipLog['modified_date'] = date('Ymd');
2317 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
2319 CRM_Member_BAO_MembershipLog
::add($membershipLog);
2321 //update related Memberships.
2322 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
2324 foreach (['Membership Signup', 'Membership Renewal'] as $activityType) {
2325 $scheduledActivityID = CRM_Utils_Array
::value('id',
2326 civicrm_api3('Activity', 'Get',
2328 'source_record_id' => $membership->id
,
2329 'activity_type_id' => $activityType,
2330 'status_id' => 'Scheduled',
2333 'sort' => 'id DESC',
2338 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2339 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2340 if ($scheduledActivityID) {
2341 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, ['id' => $scheduledActivityID]);
2346 // track membership status change if any
2347 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
2348 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
2349 CRM_Activity_BAO_Activity
::addActivity($membership,
2350 'Change Membership Status',
2353 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2354 'source_contact_id' => $membershipLog['modified_id'],
2355 'priority_id' => 'Normal',
2360 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2361 if ($processContributionObject) {
2362 $processContribution = TRUE;
2365 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2371 $updatedStatusId = array_search('Registered', $participantStatuses);
2372 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2374 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2375 if ($processContributionObject) {
2376 $processContribution = TRUE;
2380 if ($pledgePayment) {
2381 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2383 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2384 if ($processContributionObject) {
2385 $processContribution = TRUE;
2390 // process contribution object.
2391 if ($processContribution) {
2392 $contributionParams = [];
2399 'payment_instrument_id',
2402 'financial_type_id',
2403 'contribution_status_id',
2404 'non_deductible_amount',
2408 foreach ($fields as $field) {
2409 if (empty($params[$field])) {
2412 $contributionParams[$field] = $params[$field];
2415 $contributionParams['id'] = $contributionId;
2416 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams);
2419 return $updateResult;
2423 * Returns all contribution related object ids.
2425 * @param $contributionId
2429 public static function getComponentDetails($contributionId) {
2430 $componentDetails = $pledgePayment = [];
2431 if (!$contributionId) {
2432 return $componentDetails;
2436 SELECT c.id as contribution_id,
2437 c.contact_id as contact_id,
2438 c.contribution_recur_id,
2439 mp.membership_id as membership_id,
2440 m.membership_type_id as membership_type_id,
2441 pp.participant_id as participant_id,
2442 p.event_id as event_id,
2443 pgp.id as pledge_payment_id
2444 FROM civicrm_contribution c
2445 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2446 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2447 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2448 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2449 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2450 WHERE c.id = $contributionId";
2452 $dao = CRM_Core_DAO
::executeQuery($query);
2453 $componentDetails = [];
2455 while ($dao->fetch()) {
2456 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2457 $componentDetails['contact_id'] = $dao->contact_id
;
2458 if ($dao->event_id
) {
2459 $componentDetails['event'] = $dao->event_id
;
2461 if ($dao->participant_id
) {
2462 $componentDetails['participant'] = $dao->participant_id
;
2464 if ($dao->membership_id
) {
2465 if (!isset($componentDetails['membership'])) {
2466 $componentDetails['membership'] = $componentDetails['membership_type'] = [];
2468 $componentDetails['membership'][] = $dao->membership_id
;
2469 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2471 if ($dao->pledge_payment_id
) {
2472 $pledgePayment[] = $dao->pledge_payment_id
;
2474 if ($dao->contribution_recur_id
) {
2475 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2479 if ($pledgePayment) {
2480 $componentDetails['pledge_payment'] = $pledgePayment;
2483 return $componentDetails;
2487 * @param int $contactId
2488 * @param bool $includeSoftCredit
2490 * @return null|string
2492 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2496 $financialTypes = CRM_Financial_BAO_FinancialType
::getAllAvailableFinancialTypes();
2497 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2498 $liWhere = " AND i.financial_type_id IN (0)";
2499 if (!empty($financialTypes)) {
2500 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2501 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2503 $contactContributionsSQL = "
2504 SELECT contribution.id AS id
2505 FROM civicrm_contribution contribution
2506 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2507 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2511 $contactSoftCreditContributionsSQL = "
2512 SELECT contribution.id
2513 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2514 ON ( contribution.id = softContribution.contribution_id )
2515 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2516 $query = "SELECT count( x.id ) count FROM ( ";
2517 $query .= $contactContributionsSQL;
2519 if ($includeSoftCredit) {
2520 $query .= " UNION ";
2521 $query .= $contactSoftCreditContributionsSQL;
2526 return CRM_Core_DAO
::singleValueQuery($query);
2530 * Repeat a transaction as part of a recurring series.
2533 * 1) Processor calls contribution.repeattransaction with contribution_status_id = Pending
2534 * 2) The repeattransaction loads the 'template contribution' and calls a hook to allow altering of it .
2535 * 3) Repeat transaction calls order.create to create the pending contribution with correct line items
2536 * and associated entities.
2537 * 4) The calling code calls Payment.create which in turn calls CompleteOrder (if completing)
2538 * which updates the various entities and sends appropriate emails.
2540 * Gaps in the above (@todo)
2541 * 1) many processors still call repeattransaction with contribution_status_id = Completed
2542 * 2) repeattransaction code is current munged into completeTransaction code for historical bad coding reasons
2543 * 3) Repeat transaction duplicates rather than calls Order.create
2544 * 4) Use of payment.create still limited - completetransaction is more common.
2545 * 5) the template transaction is tricky - historically we used the first contribution
2546 * linked to a recurring contribution. More recently that was changed to be the most recent.
2547 * Ideally it would be an actual template - not a contribution used as a template which
2548 * would give more appropriate flexibility. Note line_items have an entity so that table
2549 * could be used for the line item template - the difficulty is the custom fields...
2550 * 6) the determination of the membership to be linked is tricksy. The prioritised method is
2551 * to load the membership(s) referred to via line items in the template transactions. Any other
2552 * method is likely to lead to incorrect line items & related entities being created (as the line_item
2553 * link is a required part of 'correct data'). However there are 3 other methods to determine it
2554 * - membership_payment record
2555 * - civicrm_membership.contribution_recur_id
2557 * Passing in an input override WILL ensure the membership is extended to prevent regressions
2558 * of historical processors since this has been handled 'forever' - specifically for paypal.
2559 * albeit by an even nastier mechanism than the current input override.
2560 * The count is out on how correct related entities wind up in this case.
2562 * @param CRM_Contribute_BAO_Contribution $contribution
2563 * @param array $input
2564 * @param array $contributionParams
2565 * @param int $paymentProcessorID
2568 * @throws CiviCRM_API3_Exception
2570 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2571 if (!empty($contribution->id
)) {
2574 if (empty($contribution->id
)) {
2575 // Unclear why this would only be set for repeats.
2576 if (!empty($input['amount'])) {
2577 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2580 if (!empty($contributionParams['contribution_recur_id'])) {
2581 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', [
2582 'id' => $contributionParams['contribution_recur_id'],
2584 if (!empty($recurringContribution['campaign_id'])) {
2585 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2586 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2588 if (!empty($recurringContribution['financial_type_id'])) {
2589 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2590 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2593 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2594 $contributionParams['contribution_recur_id'],
2595 array_intersect_key($contributionParams, [
2596 'total_amount' => TRUE,
2597 'financial_type_id' => TRUE,
2600 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2602 $contributionParams['status_id'] = 'Pending';
2603 if (isset($contributionParams['financial_type_id'])) {
2604 // Give precedence to passed in type.
2605 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2608 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2610 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2611 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2613 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2614 //do not create CC or BCC emails or profile notifications.
2615 //The if is just to be safe. Not sure if we can ever arrive with this unset
2616 // but per CRM-19478 it seems it can be 'null'
2617 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2618 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2620 if (!empty($contribution->tax_amount
)) {
2621 $contributionParams['tax_amount'] = $contribution->tax_amount
;
2624 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2625 $contribution->id
= $createContribution['id'];
2626 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2627 self
::handleMembershipIDOverride($contribution->id
, $input);
2633 * Get individual id for onbehalf contribution.
2635 * @param int $contributionId
2637 * @param int $contributorId
2641 * containing organization id and individual id
2643 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2647 if (!$contributionId) {
2651 // fetch contributor id if null
2652 if (!$contributorId) {
2653 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2654 $contributionId, 'contact_id'
2658 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2659 $activityTypeId = array_search('Contribution', $activityTypeIds);
2661 if ($activityTypeId && $contributorId) {
2663 SELECT civicrm_activity_contact.contact_id
2664 FROM civicrm_activity_contact
2665 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2666 WHERE civicrm_activity.activity_type_id = %1
2667 AND civicrm_activity.source_record_id = %2
2668 AND civicrm_activity_contact.record_type_id = %3
2671 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2672 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2675 1 => [$activityTypeId, 'Integer'],
2676 2 => [$contributionId, 'Integer'],
2677 3 => [$sourceID, 'Integer'],
2680 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2682 // for on behalf contribution source is individual and contributor is organization
2683 if ($sourceContactId && $sourceContactId != $contributorId) {
2684 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2685 // get rel type id for employee of relation
2686 foreach ($relationshipTypeIds as $id => $typeVals) {
2687 if ($typeVals['name_a_b'] == 'Employee of') {
2688 $relationshipTypeId = $id;
2693 $rel = new CRM_Contact_DAO_Relationship();
2694 $rel->relationship_type_id
= $relationshipTypeId;
2695 $rel->contact_id_a
= $sourceContactId;
2696 $rel->contact_id_b
= $contributorId;
2697 if ($rel->find(TRUE)) {
2698 $ids['individual_id'] = $rel->contact_id_a
;
2699 $ids['organization_id'] = $rel->contact_id_b
;
2710 public static function getContributionDates() {
2711 $config = CRM_Core_Config
::singleton();
2712 $currentMonth = date('m');
2713 $currentDay = date('d');
2714 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2715 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2716 (int ) $config->fiscalYearStart
['d'] > $currentDay
2719 $year = date('Y') - 1;
2724 $year = ['Y' => $year];
2725 $yearDate = $config->fiscalYearStart
;
2726 $yearDate = array_merge($year, $yearDate);
2727 $yearDate = CRM_Utils_Date
::format($yearDate);
2729 $monthDate = date('Ym') . '01';
2735 'yearDate' => $yearDate,
2736 'monthDate' => $monthDate,
2741 * Load objects relations to contribution object.
2742 * Objects are stored in the $_relatedObjects property
2743 * In the first instance we are just moving functionality from BASEIpn -
2745 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2747 * Note that the unit test for the BaseIPN class tests this function
2749 * @param array $input
2750 * Input as delivered from Payment Processor.
2752 * Ids as Loaded by Payment Processor.
2753 * @param bool $loadAll
2754 * Load all related objects - even where id not passed in? (allows API to call this).
2759 public function loadRelatedObjects($input, &$ids, $loadAll = FALSE) {
2760 // @todo deprecate this function - the steps should be
2761 // 1) add additional functions like 'getRelatedMemberships'
2762 // 2) switch all calls that refer to ->_relatedObjects to
2763 // using the helper functions
2764 // 3) make ->_relatedObjects noisy in some way (deprecation won't work for properties - hmm
2765 // 4) make ->_relatedObjects protected
2766 // 5) hone up the individual functions to not use rely on this having been called
2767 // 6) deprecate like mad
2769 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2770 if (empty($ids['contact']) && isset($this->contact_id
)) {
2771 $ids['contact'] = $this->contact_id
;
2774 if (empty($this->_component
)) {
2775 if (!empty($ids['event'])) {
2776 $this->_component
= 'event';
2779 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2783 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2784 // refactoring than anything else, and has unit test coverage.
2785 if (empty($this->financial_type_id
)) {
2789 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2794 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2795 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2796 $this->contribution_page_id
,
2799 if ($paymentProcessorID) {
2800 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2804 $ids['contributionType'] = $this->financial_type_id
;
2805 $ids['financialType'] = $this->financial_type_id
;
2806 if ($this->contribution_page_id
) {
2807 $ids['contributionPage'] = $this->contribution_page_id
;
2810 $this->loadRelatedEntitiesByID($ids);
2812 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2813 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2816 if (!empty($ids['pledge_payment'])) {
2817 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2818 if (empty($paymentID)) {
2821 $payment = new CRM_Pledge_BAO_PledgePayment();
2822 $payment->id
= $paymentID;
2823 if (!$payment->find(TRUE)) {
2824 throw new Exception("Could not find pledge payment record: " . $paymentID);
2826 $this->_relatedObjects
['pledge_payment'][] = $payment;
2830 // These are probably no longer accessed from anywhere
2831 // @todo remove this line, after ensuring not used.
2832 $ids = $this->loadRelatedMembershipObjects($ids);
2834 if ($this->_component
!= 'contribute') {
2835 // we are in event mode
2836 // make sure event exists and is valid
2837 $event = new CRM_Event_BAO_Event();
2838 $event->id
= $ids['event'];
2839 if ($ids['event'] &&
2842 throw new Exception("Could not find event: " . $ids['event']);
2845 $this->_relatedObjects
['event'] = &$event;
2847 $participant = new CRM_Event_BAO_Participant();
2848 $participant->id
= $ids['participant'];
2849 if ($ids['participant'] &&
2850 !$participant->find(TRUE)
2852 throw new Exception("Could not find participant: " . $ids['participant']);
2854 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2856 $this->_relatedObjects
['participant'] = &$participant;
2858 // get the payment processor id from event - this is inaccurate see CRM-16923
2859 // in future we should look at throwing an exception here rather than an dubious guess.
2860 if (!$paymentProcessorID) {
2861 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2862 if ($paymentProcessorID) {
2863 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2868 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds($this->id
);
2869 if (!empty($relatedContact['individual_id'])) {
2870 $ids['related_contact'] = $relatedContact['individual_id'];
2873 if ($paymentProcessorID) {
2874 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2875 $this->is_test ?
'test' : 'live'
2877 $ids['paymentProcessor'] = $paymentProcessorID;
2878 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2881 // Add contribution id to $ids. CRM-20401
2882 $ids['contribution'] = $this->id
;
2887 * Create array of message information - ie. return html version, txt version, to field
2889 * @param array $input
2890 * Incoming information.
2891 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2892 * just check presence of recur object but maintaining legacy approach
2895 * IDs of related objects.
2896 * @param array $values
2897 * Any values that may have already been compiled by calling process.
2898 * This is augmented by values 'gathered' by gatherMessageValues
2899 * @param bool $returnMessageText
2900 * Distinguishes between whether to send message or return.
2901 * message text. We are working towards this function ALWAYS returning message text & calling
2902 * function doing emails / pdfs with it
2908 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2909 $this->loadRelatedObjects($input, $ids);
2911 if (empty($this->_component
)) {
2912 $this->_component
= $input['component'] ??
NULL;
2915 //not really sure what params might be passed in but lets merge em into values
2916 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2917 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2918 if (!empty($input['receipt_date'])) {
2919 $values['receipt_date'] = $input['receipt_date'];
2922 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2923 //what does recur 'mean here - to do with payment processor return functionality but
2924 // what is the importance
2925 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2926 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2928 $entityID = $entity = NULL;
2929 if (isset($ids['contribution'])) {
2930 $entity = 'contribution';
2931 $entityID = $ids['contribution'];
2933 if (!empty($ids['membership'])) {
2934 //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
2935 // 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
2936 // line having loaded an array
2937 $ids['membership'] = (array) $ids['membership'];
2938 $entity = 'membership';
2939 $entityID = $ids['membership'][0];
2942 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2943 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2944 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2946 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2947 //direct mode showing billing block, so use directIPN for temporary
2948 $template->assign('contributeMode', 'directIPN');
2951 // todo remove strtolower - check consistency
2952 if (strtolower($this->_component
) == 'event') {
2953 $eventParams = ['id' => $this->_relatedObjects
['participant']->event_id
];
2954 $values['event'] = [];
2956 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2958 //get location details
2960 'entity_id' => $this->_relatedObjects
['participant']->event_id
,
2961 'entity_table' => 'civicrm_event',
2963 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2966 'entity_table' => 'civicrm_event',
2967 'entity_id' => $ids['event'],
2968 'module' => 'CiviEvent',
2971 list($custom_pre_id,
2973 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2975 $values['custom_pre_id'] = $custom_pre_id;
2976 $values['custom_post_id'] = $custom_post_ids;
2977 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2978 //and cases involving status updation through ipn
2979 // whatever that means!
2980 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2981 // perhaps we should throw an e-notice if amount is set & force total_amount?
2982 if (!empty($input['amount'])) {
2983 $values['totalAmount'] = $input['amount'];
2985 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2986 if ($values['event']['is_email_confirm']) {
2987 $values['is_email_receipt'] = 1;
2990 if (!empty($ids['contribution'])) {
2991 $values['contributionId'] = $ids['contribution'];
2994 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
2995 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
2999 $values['contribution_id'] = $this->id
;
3000 if (!empty($ids['related_contact'])) {
3001 $values['related_contact'] = $ids['related_contact'];
3002 if (isset($ids['onbehalf_dupe_alert'])) {
3003 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
3006 'contact_id' => $ids['contact'],
3007 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
3008 'Home', 'id', 'name'
3011 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
3012 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
3015 if ($this->is_test
) {
3018 if (!empty($this->_relatedObjects
['membership'])) {
3019 foreach ($this->_relatedObjects
['membership'] as $membership) {
3020 if ($membership->id
) {
3021 $values['membership_id'] = $membership->id
;
3022 $values['isMembership'] = TRUE;
3023 $values['membership_assign'] = TRUE;
3025 // need to set the membership values here
3026 $template->assign('membership_name',
3027 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
3029 $template->assign('mem_start_date', $membership->start_date
);
3030 $template->assign('mem_join_date', $membership->join_date
);
3031 $template->assign('mem_end_date', $membership->end_date
);
3032 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
3033 $template->assign('mem_status', $membership_status);
3034 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
3035 $values['is_pay_later'] = 1;
3037 // Pass amount to floatval as string '0.00' is considered a
3038 // valid amount and includes Fee section in the mail.
3039 if (isset($values['amount'])) {
3040 $values['amount'] = floatval($values['amount']);
3043 if (!empty($this->contribution_recur_id
) && $paymentObject) {
3044 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
3045 $template->assign('cancelSubscriptionUrl', $url);
3046 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
3047 $template->assign('updateSubscriptionBillingUrl', $url);
3048 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
3049 $template->assign('updateSubscriptionUrl', $url);
3052 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3055 // otherwise if its about sending emails, continue sending without return, as we
3056 // don't want to exit the loop.
3061 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3067 * Gather values for contribution mail - this function has been created
3068 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
3069 * Values related to the contribution in question are gathered
3071 * @param array $input
3072 * Input into function (probably from payment processor).
3073 * @param array $values
3075 * The set of ids related to the input.
3078 * @throws \CRM_Core_Exception
3080 public function _gatherMessageValues($input, &$values, $ids = []) {
3081 // set display address of contributor
3082 $values['billingName'] = '';
3083 if ($this->address_id
) {
3084 $addressDetails = CRM_Core_BAO_Address
::getValues(['id' => $this->address_id
], FALSE, 'id');
3085 $addressDetails = reset($addressDetails);
3086 $values['billingName'] = $addressDetails['name'] ??
'';
3088 // Else we assign the billing address of the contribution contact.
3090 $addressDetails = (array) CRM_Core_BAO_Address
::getValues(['contact_id' => $this->contact_id
, 'is_billing' => 1]);
3091 $addressDetails = reset($addressDetails);
3093 $values['address'] = $addressDetails['display'] ??
'';
3095 if ($this->_component
=== 'contribute') {
3096 //get soft contributions
3097 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
3098 if (!empty($softContributions)) {
3099 $values['softContributions'] = $softContributions['soft_credit'];
3101 if (isset($this->contribution_page_id
)) {
3102 // This is a call we want to use less, in favour of loading related objects.
3103 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
3104 if ($this->contribution_page_id
) {
3105 // This is precautionary as there are some legacy flows, but it should really be
3107 if (!isset($this->_relatedObjects
['contributionPage'])) {
3108 $this->loadRelatedEntitiesByID(['contributionPage' => $this->contribution_page_id
]);
3110 CRM_Contribute_BAO_Contribution_Utils
::overrideDefaultCurrency($values);
3113 // no contribution page -probably back office
3115 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
3116 $values['title'] = 'Contribution';
3118 // set lineItem for contribution
3120 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
3121 if (!empty($lineItems)) {
3122 $firstLineItem = reset($lineItems);
3124 if (!empty($firstLineItem['price_set_id'])) {
3125 $priceSet = civicrm_api3('PriceSet', 'getsingle', [
3126 'id' => $firstLineItem['price_set_id'],
3127 'return' => 'is_quick_config, id',
3129 $values['priceSetID'] = $priceSet['id'];
3131 foreach ($lineItems as &$eachItem) {
3132 if (isset($this->_relatedObjects
['membership'])
3133 && is_array($this->_relatedObjects
['membership'])
3134 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
3135 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
3136 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
3137 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
3139 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
3140 // However, that does create upgrade pain so would be better to be phased in.
3141 $values['useForMember'] = empty($priceSet['is_quick_config']);
3143 $values['lineItem'][0] = $lineItems;
3147 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
3151 // if this is onbehalf of contribution then set related contact
3152 if (!empty($relatedContact['individual_id'])) {
3153 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
3157 $values = array_merge($values, $this->loadEventMessageTemplateParams((int) $ids['event'], (int) $this->_relatedObjects
['participant']->id
, $this->id
));
3160 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', NULL, $this->id
);
3163 foreach ($groupTree as $key => $group) {
3164 if ($key === 'info') {
3168 foreach ($group['fields'] as $k => $customField) {
3169 $groupLabel = $group['title'];
3170 if (!empty($customField['customValue'])) {
3171 foreach ($customField['customValue'] as $customFieldValues) {
3172 $customGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
3177 $values['customGroup'] = $customGroup;
3179 $values['is_pay_later'] = $this->is_pay_later
;
3185 * Assign message variables to template but try to break the habit.
3187 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
3188 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
3189 * multiple recurring payments for processors like IATS that use tokens.
3191 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
3192 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
3193 * Note we send directly from this function in some cases because it is only partly refactored.
3195 * Don't call this function directly as the signature will change.
3199 * @param bool $returnMessageText
3203 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
3204 // @todo - this should have a better separation of concerns - ie.
3205 // gatherMessageValues should build an array of values to be assigned to the template
3206 // and this function should assign them (assigning null if not set).
3207 // the way the pcpParams & honor Params section works is a baby-step towards this.
3208 $template = CRM_Core_Smarty
::singleton();
3209 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
3210 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
3211 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
3212 $template->assign('billingName', $values['billingName']);
3214 // For some unit tests contribution cannot contain paymentProcessor information
3215 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
3216 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
3218 //assign honor information to receipt message
3219 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
3222 'soft_credit_type' => NULL,
3223 'honor_block_is_active' => NULL,
3225 if (isset($softRecord['soft_credit'])) {
3226 //if id of contribution page is present
3227 if (!empty($values['id'])) {
3228 $values['honor'] = [
3229 'honor_profile_values' => [],
3230 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
3231 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
3234 $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
3235 $honorParams['honor_block_is_active'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
3238 //offline contribution
3239 $softCreditTypes = $softCredits = [];
3240 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
3241 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
3242 $softCredits[$key] = [
3243 'Name' => $softCredit['contact_name'],
3244 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
3247 $template->assign('softCreditTypes', $softCreditTypes);
3248 $template->assign('softCredits', $softCredits);
3252 $dao = new CRM_Contribute_DAO_ContributionProduct();
3253 $dao->contribution_id
= $this->id
;
3254 if ($dao->find(TRUE)) {
3255 $premiumId = $dao->product_id
;
3256 $template->assign('option', $dao->product_option
);
3258 $productDAO = new CRM_Contribute_DAO_Product();
3259 $productDAO->id
= $premiumId;
3260 $productDAO->find(TRUE);
3261 $template->assign('selectPremium', TRUE);
3262 $template->assign('product_name', $productDAO->name
);
3263 $template->assign('price', $productDAO->price
);
3264 $template->assign('sku', $productDAO->sku
);
3266 $template->assign('title', CRM_Utils_Array
::value('title', $values));
3267 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
3268 if (!$values['amount'] && isset($this->total_amount
)) {
3269 $values['amount'] = $this->total_amount
;
3274 'pcp_display_in_roll' => NULL,
3275 'pcp_roll_nickname' => NULL,
3276 'pcp_personal_note' => NULL,
3280 if (strtolower($this->_component
) == 'contribute') {
3282 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3283 $softDAO->contribution_id
= $this->id
;
3284 if ($softDAO->find(TRUE)) {
3285 $pcpParams['pcpBlock'] = TRUE;
3286 $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll
;
3287 $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname
;
3288 $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note
;
3290 //assign the pcp page title for email subject
3291 $pcpDAO = new CRM_PCP_DAO_PCP();
3292 $pcpDAO->id
= $softDAO->pcp_id
;
3293 if ($pcpDAO->find(TRUE)) {
3294 $pcpParams['title'] = $pcpDAO->title
;
3298 foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3299 $template->assign($templateKey, $templateValue);
3302 if ($this->financial_type_id
) {
3303 $values['financial_type_id'] = $this->financial_type_id
;
3306 $template->assign('trxn_id', $this->trxn_id
);
3307 $template->assign('receive_date',
3308 CRM_Utils_Date
::processDate($this->receive_date
)
3310 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
3311 $template->assign('action', $this->is_test ?
1024 : 1);
3312 $template->assign('receipt_text',
3313 CRM_Utils_Array
::value('receipt_text',
3317 $template->assign('is_monetary', 1);
3318 $template->assign('is_recur', !empty($this->contribution_recur_id
));
3319 $template->assign('currency', $this->currency
);
3320 $template->assign('address', CRM_Utils_Address
::format($input));
3321 if (!empty($values['customGroup'])) {
3322 $template->assign('customGroup', $values['customGroup']);
3324 if (!empty($values['softContributions'])) {
3325 $template->assign('softContributions', $values['softContributions']);
3327 if ($this->_component
== 'event') {
3328 $template->assign('title', $values['event']['title']);
3329 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
3331 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
3332 $viewRoles[] = $participantRoles[$v];
3334 $values['event']['participant_role'] = implode(', ', $viewRoles);
3335 $template->assign('event', $values['event']);
3336 $template->assign('participant', $values['participant']);
3337 $template->assign('location', $values['location']);
3338 $template->assign('customPre', $values['custom_pre_id']);
3339 $template->assign('customPost', $values['custom_post_id']);
3342 if ($this->_relatedObjects
['participant']->is_test
) {
3346 $values['params'] = [];
3347 //to get email of primary participant.
3348 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
3349 $primaryAmount[] = [
3350 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3351 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3353 //build an array of cId/pId of participants
3354 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3355 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3356 //send receipt to additional participant if exists
3357 if (count($additionalIDs)) {
3358 $template->assign('isPrimary', 0);
3359 $template->assign('customProfile', NULL);
3360 //set additionalParticipant true
3361 $values['params']['additionalParticipant'] = TRUE;
3362 foreach ($additionalIDs as $pId => $cId) {
3364 //to change the status pending to completed
3365 $additional = new CRM_Event_DAO_Participant();
3366 $additional->id
= $pId;
3367 $additional->contact_id
= $cId;
3368 $additional->find(TRUE);
3369 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3370 $additional->status_id
= 1;
3371 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3372 //if additional participant dont have email
3374 if (!$additionalParticipantInfo) {
3375 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3378 'label' => $additional->fee_level
,
3379 'amount' => $additional->fee_amount
,
3381 $primaryAmount[] = [
3382 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3383 'amount' => $additional->fee_amount
,
3385 $additional->save();
3386 $template->assign('amount', $amount);
3387 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3391 //build an array of custom profile and assigning it to template
3392 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3394 if (count($customProfile)) {
3395 $template->assign('customProfile', $customProfile);
3398 // for primary contact
3399 $values['params']['additionalParticipant'] = FALSE;
3400 $template->assign('isPrimary', 1);
3401 $template->assign('amount', $primaryAmount);
3402 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3403 if ($this->payment_instrument_id
) {
3404 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3405 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3407 // carry paylater, since we did not created billing,
3408 // so need to pull email from primary location, CRM-4395
3409 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3415 * Check whether payment processor supports
3416 * cancellation of contribution subscription
3418 * @param int $contributionId
3421 * @param bool $isNotCancelled
3425 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3426 $cacheKeyString = "$contributionId";
3427 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3429 static $supportsCancel = [];
3431 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3432 $supportsCancel[$cacheKeyString] = FALSE;
3433 $isCancelled = FALSE;
3435 if ($isNotCancelled) {
3436 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3439 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3440 if (!empty($paymentObject)) {
3441 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3444 return $supportsCancel[$cacheKeyString];
3448 * Check whether subscription is already cancelled.
3450 * @param int $contributionId
3454 * contribution status
3456 public static function isSubscriptionCancelled($contributionId) {
3458 SELECT cr.contribution_status_id
3459 FROM civicrm_contribution_recur cr
3460 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3461 WHERE con.id = %1 LIMIT 1";
3462 $params = [1 => [$contributionId, 'Integer']];
3463 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3464 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name');
3465 if ($status == 'Cancelled') {
3472 * Create all financial accounts entry.
3474 * @param array $params
3475 * Contribution object, line item array and params for trxn.
3478 * @param array $financialTrxnValues
3480 * @return null|\CRM_Core_BAO_FinancialTrxn
3482 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3483 $skipRecords = $update = $return = $isRelatedId = FALSE;
3484 $isUpdate = !empty($params['prevContribution']);
3486 $additionalParticipantId = [];
3487 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3488 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3490 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3491 $entityId = $params['participant_id'];
3492 $entityTable = 'civicrm_participant';
3493 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3495 elseif (!empty($params['membership_id'])) {
3496 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3497 // are created off one contribution should be handled elsewhere
3498 $entityId = $params['membership_id'];
3499 $entityTable = 'civicrm_membership';
3502 $entityId = $params['contribution']->id
;
3503 $entityTable = 'civicrm_contribution';
3506 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3507 $isRelatedId = TRUE;
3510 $entityID[] = $entityId;
3511 if (!empty($additionalParticipantId)) {
3512 $entityID +
= $additionalParticipantId;
3514 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3515 if (empty($params['prevContribution'])) {
3519 $statusId = $params['contribution']->contribution_status_id
;
3520 // CRM-13964 partial payment
3521 if ($contributionStatus == 'Partially paid'
3522 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3524 CRM_Core_Error
::deprecatedFunctionWarning('partial_amount params are deprecated from Contribution.create - use Payment.create');
3525 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_to_pay']);
3526 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3528 $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3529 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3530 $params['total_amount'] = $partialAmtPay;
3532 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3533 if (empty($balanceTrxnInfo['trxn_id'])) {
3534 // create new balance transaction record
3535 $toFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3537 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3538 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3539 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3540 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3541 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
3542 $balanceTrxnParams['net_amount'] = $params['net_amount'] ??
NULL;
3543 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3544 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3545 $balanceTrxnParams['status_id'] = $statusId;
3546 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3547 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
3548 $balanceTrxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3549 $balanceTrxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3550 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3551 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3553 $balanceTrxnParams['is_payment'] = 1;
3555 if (!empty($params['payment_processor'])) {
3556 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3558 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3562 // build line item array if its not set in $params
3563 if (empty($params['line_item']) ||
$additionalParticipantId) {
3564 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3567 if ($contributionStatus != 'Failed' &&
3568 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3570 $skipRecords = TRUE;
3575 if (in_array($contributionStatus, $pendingStatus)) {
3576 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3577 $params['financial_type_id'],
3578 'Accounts Receivable Account is'
3581 elseif (!empty($params['payment_processor'])) {
3582 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3583 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', [
3584 'id' => $params['payment_processor'],
3585 'return' => 'payment_instrument_id',
3588 elseif (!empty($params['payment_instrument_id'])) {
3589 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3592 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3593 $queryParams = [1 => [$relationTypeId, 'Integer']];
3594 $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);
3597 $totalAmount = $params['total_amount'] ??
NULL;
3598 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3599 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3601 //build financial transaction params
3603 'contribution_id' => $params['contribution']->id
,
3604 'to_financial_account_id' => $params['to_financial_account_id'],
3605 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3606 'total_amount' => $totalAmount,
3607 'fee_amount' => $params['fee_amount'] ??
NULL,
3608 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3609 'currency' => $params['contribution']->currency
,
3610 'trxn_id' => $params['contribution']->trxn_id
,
3611 // @todo - this is getting the status id from the contribution - that is BAD - ie the contribution could be partially
3612 // paid but each payment is completed. The work around is to pass in the status_id in the trxn_params but
3613 // this should really default to completed (after discussion).
3614 'status_id' => $statusId,
3615 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3616 'check_number' => $params['check_number'] ??
NULL,
3617 'pan_truncation' => $params['pan_truncation'] ??
NULL,
3618 'card_type_id' => $params['card_type_id'] ??
NULL,
3620 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3621 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3622 if (isset($params['refund_trxn_id'])) {
3623 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3624 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3627 //CRM-16259, set is_payment flag for non pending status
3628 if (!in_array($contributionStatus, $pendingStatus)) {
3629 $trxnParams['is_payment'] = 1;
3631 if (!empty($params['payment_processor'])) {
3632 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3635 if (isset($fromFinancialAccountId)) {
3636 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3639 // consider external values passed for recording transaction entry
3640 if (!empty($financialTrxnValues)) {
3641 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3643 if (empty($trxnParams['payment_processor_id'])) {
3644 unset($trxnParams['payment_processor_id']);
3647 $params['trxnParams'] = $trxnParams;
3651 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3652 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3653 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3654 if (!isset($params['trxnParams']['trxn_id'])) {
3655 // Actually I have no idea why we are overwriting any values from the previous contribution.
3656 // (filling makes sense to me). However, only protecting this value as I really really know we
3657 // don't want this one overwritten.
3659 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3661 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3663 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3664 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3665 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3667 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3668 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3671 //if financial type is changed
3672 if (!empty($params['financial_type_id']) &&
3673 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3675 $accountRelationship = 'Income Account is';
3676 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3677 $accountRelationship = 'Deferred Revenue Account is';
3679 $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id
, $accountRelationship);
3680 $newFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3681 if ($oldFinancialAccount != $newFinancialAccount) {
3682 $params['total_amount'] = 0;
3683 // If we have a fee amount set reverse this as well.
3684 if (isset($params['fee_amount'])) {
3685 $params['trxnParams']['fee_amount'] = 0 - $params['fee_amount'];
3687 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3688 $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3689 $params['prevContribution']->financial_type_id
, $accountRelationship);
3692 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3693 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3694 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3697 self
::updateFinancialAccounts($params, 'changeFinancialType');
3698 $params['skipLineItem'] = FALSE;
3699 foreach ($params['line_item'] as &$lineItems) {
3700 foreach ($lineItems as &$line) {
3701 $line['financial_type_id'] = $params['financial_type_id'];
3704 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changeFinancialType');
3705 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3706 $params['financial_account_id'] = $newFinancialAccount;
3707 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3708 // Set the transaction fee amount back to the original value for creating the new positive financial trxn.
3709 if (isset($params['fee_amount'])) {
3710 $params['trxnParams']['fee_amount'] = $params['fee_amount'];
3712 self
::updateFinancialAccounts($params);
3713 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE);
3714 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3716 $params['deferred_financial_account_id'] = $newFinancialAccount;
3720 //Update contribution status
3721 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3722 if (!isset($params['refund_trxn_id'])) {
3723 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3724 // gets preference over another so I am only 'protecting' a very specific tested flow
3725 // and letting natural justice take care of the rest.
3726 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3728 if (!empty($params['contribution_status_id']) &&
3729 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3731 //Update Financial Records
3732 $callUpdateFinancialAccounts = self
::updateFinancialAccountsOnContributionStatusChange($params);
3733 if ($callUpdateFinancialAccounts) {
3734 self
::updateFinancialAccounts($params, 'changedStatus');
3735 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedStatus');
3740 // change Payment Instrument for a Completed contribution
3741 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3742 // instrument is null and now new payment instrument is added along with the payment
3743 if (!$params['contribution']->payment_instrument_id
) {
3744 $params['contribution']->find(TRUE);
3746 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3747 $params['trxnParams']['check_number'] = $params['check_number'] ??
NULL;
3749 if (self
::isPaymentInstrumentChange($params, $pendingStatus)) {
3750 $updated = CRM_Core_BAO_FinancialTrxn
::updateFinancialAccountsOnPaymentInstrumentChange($params);
3753 //if Change contribution amount
3754 $params['trxnParams']['fee_amount'] = $params['fee_amount'] ??
NULL;
3755 $params['trxnParams']['net_amount'] = $params['net_amount'] ??
NULL;
3756 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3757 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3758 if (isset($totalAmount) &&
3759 $totalAmount != $params['prevContribution']->total_amount
3761 //Update Financial Records
3762 $params['trxnParams']['from_financial_account_id'] = NULL;
3763 self
::updateFinancialAccounts($params, 'changedAmount');
3764 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedAmount');
3769 // Looks like we might have a data correction update.
3770 // This would be a case where a transaction id has been entered but it is incorrect &
3771 // the person goes back in & fixes it, as opposed to a new transaction.
3772 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3773 // the data fix scenario.
3775 if (isset($params['refund_trxn_id'])) {
3776 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3777 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3778 civicrm_api3('FinancialTrxn', 'create', [
3779 'id' => $refundIDs['financialTrxnId'],
3780 'trxn_id' => $params['refund_trxn_id'],
3784 $cardType = $params['card_type_id'] ??
NULL;
3785 $panTruncation = $params['pan_truncation'] ??
NULL;
3786 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3791 // records finanical trxn and entity financial trxn
3792 // also make it available as return value
3793 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3794 $trxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3795 $trxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3796 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3797 $params['entity_id'] = $financialTxn->id
;
3798 if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3799 self
::$_trxnIDs[] = $financialTxn->id
;
3803 // record line items and financial items
3804 if (empty($params['skipLineItem'])) {
3805 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $isUpdate);
3808 // create batch entry if batch_id is passed and
3809 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3810 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3812 'batch_id' => $params['batch_id'],
3813 'entity_table' => 'civicrm_financial_trxn',
3814 'entity_id' => $financialTxn->id
,
3816 CRM_Batch_BAO_EntityBatch
::create($entityParams);
3819 // when a fee is charged
3820 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3821 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3824 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3825 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3827 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3828 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3829 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3831 unset($params['line_item']);
3832 self
::$_trxnIDs = NULL;
3837 * Update all financial accounts entry.
3839 * @param array $params
3840 * Contribution object, line item array and params for trxn.
3842 * @param string $context
3845 * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3846 * adds unpredictability.
3849 public static function updateFinancialAccounts(&$params, $context = NULL) {
3851 $inputParams = $params;
3852 $isARefund = self
::isContributionUpdateARefund($params['prevContribution']->contribution_status_id
, $params['contribution']->contribution_status_id
);
3854 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3855 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3856 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3859 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3860 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3861 $params['entity_id'] = $trxn->id
;
3863 $itemParams['entity_table'] = 'civicrm_line_item';
3864 $trxnIds['id'] = $params['entity_id'];
3865 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution']->id
);
3866 foreach ($params['line_item'] as $fieldId => $fields) {
3867 $params = self
::createFinancialItemsForLine($params, $context, $fields, $previousLineItems, $inputParams, $isARefund, $trxnIds, $fieldId);
3872 * Is this contribution status a reversal.
3874 * If so we would expect to record a negative value in the financial_trxn table.
3876 * @param int $status_id
3880 public static function isContributionStatusNegative($status_id) {
3881 $reversalStatuses = ['Cancelled', 'Chargeback', 'Refunded'];
3882 return in_array(CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $status_id), $reversalStatuses, TRUE);
3886 * Check status validation on update of a contribution.
3888 * @param array $values
3889 * Previous form values before submit.
3891 * @param array $fields
3892 * The input form values.
3894 * @param array $errors
3899 public static function checkStatusValidation($values, &$fields, &$errors) {
3900 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3901 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3902 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3906 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3908 'Cancelled' => ['Completed', 'Refunded'],
3909 'Completed' => ['Cancelled', 'Refunded', 'Chargeback'],
3910 'Pending' => ['Cancelled', 'Completed', 'Failed', 'Partially paid'],
3911 'In Progress' => ['Cancelled', 'Completed', 'Failed'],
3912 'Refunded' => ['Cancelled', 'Completed'],
3913 'Partially paid' => ['Completed'],
3914 'Pending refund' => ['Completed', 'Refunded'],
3917 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3918 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, []))
3920 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", [
3921 1 => $contributionStatuses[$values['contribution_status_id']],
3922 2 => $contributionStatuses[$fields['contribution_status_id']],
3928 * Delete contribution of contact.
3932 * @param int $contactId
3936 public static function deleteContactContribution($contactId) {
3937 $contribution = new CRM_Contribute_DAO_Contribution();
3938 $contribution->contact_id
= $contactId;
3939 $contribution->find();
3940 while ($contribution->fetch()) {
3941 self
::deleteContribution($contribution->id
);
3946 * Get options for a given contribution field.
3948 * @param string $fieldName
3949 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3950 * @param array $props whatever is known about this dao object.
3952 * @return array|bool
3953 * @see CRM_Core_DAO::buildOptions
3956 public static function buildOptions($fieldName, $context = NULL, $props = []) {
3957 $className = __CLASS__
;
3959 if (isset($props['orderColumn'])) {
3960 $params['orderColumn'] = $props['orderColumn'];
3962 switch ($fieldName) {
3963 // This field is not part of this object but the api supports it
3964 case 'payment_processor':
3965 $className = 'CRM_Contribute_BAO_ContributionPage';
3966 // Filter results by contribution page
3967 if (!empty($props['contribution_page_id'])) {
3968 $page = civicrm_api('contribution_page', 'getsingle', [
3970 'id' => ($props['contribution_page_id']),
3972 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3973 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3977 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3978 case 'honor_type_id':
3979 $className = 'CRM_Contribute_BAO_ContributionSoft';
3980 $fieldName = 'soft_credit_type_id';
3981 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3984 case 'contribution_status_id':
3985 if ($context !== 'validate') {
3986 $params['condition'] = "v.name <> 'Template'";
3989 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3993 * Validate financial type.
3997 * @param int $financialTypeId
3998 * Financial Type id.
4000 * @param string $relationName
4002 * @return array|bool
4004 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
4005 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
4007 if (!$financialAccount) {
4008 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
4014 * @param int $targetCid
4015 * @param $activityType
4016 * @param string $title
4017 * @param int $contributionId
4018 * @param string $totalAmount
4019 * @param string $currency
4020 * @param string $trxn_date
4022 * @throws \CRM_Core_Exception
4023 * @throws \CiviCRM_API3_Exception
4025 public static function addActivityForPayment($targetCid, $activityType, $title, $contributionId, $totalAmount, $currency, $trxn_date) {
4026 $paymentAmount = CRM_Utils_Money
::format($totalAmount, $currency);
4027 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
4028 $date = CRM_Utils_Date
::isoToMysql($trxn_date);
4029 // source record id would be the contribution id
4030 $srcRecId = $contributionId;
4034 'source_contact_id' => $targetCid,
4035 'source_record_id' => $srcRecId,
4036 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
4037 'subject' => $subject,
4038 'activity_date_time' => $date,
4039 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
4040 'skipRecentView' => TRUE,
4043 // create activity with target contacts
4044 $session = CRM_Core_Session
::singleton();
4045 $id = $session->get('userID');
4047 $activityParams['source_contact_id'] = $id;
4048 $activityParams['target_contact_id'][] = $targetCid;
4050 civicrm_api3('Activity', 'create', $activityParams);
4054 * Get list of payments displayed by Contribute_Page_PaymentInfo.
4057 * @param string $component
4058 * @param bool $getTrxnInfo
4062 * @throws \CRM_Core_Exception
4063 * @throws \CiviCRM_API3_Exception
4065 public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE) {
4066 // @todo deprecate passing in component - always call with contribution.
4067 if ($component == 'event') {
4068 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
4070 if (!$contributionId) {
4071 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
4072 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
4073 $id = $primaryParticipantId;
4075 if (!$contributionId) {
4080 elseif ($component == 'membership') {
4081 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
4084 $contributionId = $id;
4087 // The balance used to be calculated this way - we really want to remove this 'oldCalculation'
4088 // but need to unpick the whole trxn_id it's returning first.
4089 $oldCalculation = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
4090 $baseTrxnId = !empty($oldCalculation['trxn_id']) ?
$oldCalculation['trxn_id'] : NULL;
4092 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
4093 $baseTrxnId = $baseTrxnId['financialTrxnId'];
4095 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4097 $paymentBalance = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $total);
4099 $contribution = civicrm_api3('Contribution', 'getsingle', [
4100 'id' => $contributionId,
4104 'contribution_status_id',
4105 'financial_type_id',
4109 $info['payLater'] = $contribution['is_pay_later'];
4110 $info['contribution_status'] = $contribution['contribution_status'];
4111 $info['currency'] = $contribution['currency'];
4113 $info['total'] = $total;
4114 $info['paid'] = $total - $paymentBalance;
4115 $info['balance'] = $paymentBalance;
4117 $info['component'] = $component;
4118 if ($getTrxnInfo && $baseTrxnId) {
4119 $info['transaction'] = self
::getContributionTransactionInformation($contributionId, $contribution['financial_type_id']);
4122 $info['payment_links'] = self
::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4127 * Get the outstanding balance on a contribution.
4129 * @param int $contributionId
4130 * @param float $contributionTotal
4131 * Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4135 public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4136 if ($contributionTotal === NULL) {
4137 $contributionTotal = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4140 return (float) CRM_Utils_Money
::subtractCurrencies(
4142 CRM_Core_BAO_FinancialTrxn
::getTotalPayments($contributionId, TRUE),
4143 CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4148 * Get the tax amount (misnamed function).
4150 * @param array $params
4151 * @param bool $isLineItem
4155 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4156 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4158 // Update contribution.
4159 if (!empty($params['id'])) {
4160 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4161 // there are no tax implications - early return.
4162 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4165 if (empty($params['prevContribution'])) {
4166 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4169 foreach (['total_amount', 'financial_type_id', 'fee_amount'] as $field) {
4170 if (!isset($params[$field])) {
4171 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4172 // Tax amount gets added back on later....
4173 $params['total_amount'] = $params['prevContribution']->total_amount
-
4174 $params['prevContribution']->tax_amount
;
4177 $params[$field] = $params['prevContribution']->$field;
4178 if ($params[$field] != $params['prevContribution']->$field) {
4184 self
::calculateMissingAmountParams($params, $params['id']);
4185 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4186 // Assign tax Amount on update of contribution
4187 if (!empty($params['prevContribution']->tax_amount
)) {
4188 $params['tax_amount'] = 'null';
4189 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4190 foreach ($params['line_item'] as $setID => $priceField) {
4191 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4192 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4199 // New Contribution and update of contribution with tax rate financial type
4200 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4201 empty($params['skipLineItem']) && !$isLineItem
4203 $taxRateParams = $taxRates[$params['financial_type_id']];
4204 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams);
4205 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4207 // Get Line Item on update of contribution
4208 if (isset($params['id'])) {
4209 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4212 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4214 foreach ($params['line_item'] as $setID => $priceField) {
4215 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4216 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4219 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4221 elseif (isset($params['api.line_item.create'])) {
4222 // Update total amount of contribution using lineItem
4223 $taxAmountArray = [];
4224 foreach ($params['api.line_item.create'] as $key => $value) {
4225 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4226 $taxRate = $taxRates[$value['financial_type_id']];
4227 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4228 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4231 $params['tax_amount'] = array_sum($taxAmountArray);
4232 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4235 // update line item of contrbution
4236 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4237 $taxRate = $taxRates[$params['financial_type_id']];
4238 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate);
4239 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4246 * Check financial type validation on update of a contribution.
4248 * @param int $financialTypeId
4249 * Value of latest Financial Type.
4251 * @param int $contributionId
4254 * @param array $errors
4259 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4260 if (!empty($financialTypeId)) {
4261 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4262 if ($oldFinancialTypeId == $financialTypeId) {
4266 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4268 '1' => [$contributionId, 'Integer'],
4270 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4271 if ($result->N
> 1) {
4272 $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.');
4277 * Update related pledge payment payments.
4279 * This function has been refactored out of the back office contribution form and may
4280 * still overlap with other functions.
4282 * @param string $action
4283 * @param int $pledgePaymentID
4284 * @param int $contributionID
4285 * @param bool $adjustTotalAmount
4286 * @param float $total_amount
4287 * @param float $original_total_amount
4288 * @param int $contribution_status_id
4289 * @param int $original_contribution_status_id
4291 public static function updateRelatedPledge(
4297 $original_total_amount,
4298 $contribution_status_id,
4299 $original_contribution_status_id
4301 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4305 if ($pledgePaymentID) {
4306 //store contribution id in payment record.
4307 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4310 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4317 if (!$pledgePaymentID) {
4320 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4326 $updatePledgePaymentStatus = FALSE;
4328 // If either the status or the amount has changed we update the pledge status.
4329 if ($action & CRM_Core_Action
::ADD
) {
4330 $updatePledgePaymentStatus = TRUE;
4332 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4333 ($original_total_amount != $total_amount))
4335 $updatePledgePaymentStatus = TRUE;
4338 if ($updatePledgePaymentStatus) {
4339 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4341 $contribution_status_id,
4350 * Compute the stats values
4352 * @param string $stat either 'mode' or 'median'
4353 * @param string $sql
4354 * @param string $alias of civicrm_contribution
4356 * @return array|null
4360 public static function computeStats($stat, $sql, $alias = NULL) {
4361 CRM_Core_Error
::deprecatedFunctionWarning('computeStats is now deprecated');
4366 * Is there only one line item attached to the contribution.
4372 * @throws \CiviCRM_API3_Exception
4374 public static function isSingleLineItem($id) {
4375 $lineItemCount = civicrm_api3('LineItem', 'getcount', ['contribution_id' => $id]);
4376 return ($lineItemCount == 1);
4380 * Complete an order.
4382 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4384 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4386 * Moving it out of the BaseIPN class is just the first step.
4388 * @param array $input
4390 * @param array $objects
4391 * @param CRM_Core_Transaction $transaction
4392 * It is not recommended to pass this in. The calling function handle it's own roll back if it wants it.
4393 * @param bool $isPostPaymentCreate
4394 * Is this being called from the payment.create api. If so the api has taken care of financial entities.
4395 * Note that our goal is that this would only ever be called from payment.create and never handle financials (only
4396 * transitioning related elements).
4399 * @throws \CRM_Core_Exception
4400 * @throws \CiviCRM_API3_Exception
4402 public static function completeOrder($input, &$ids, $objects, $transaction = NULL, $isPostPaymentCreate = FALSE) {
4403 if (!$transaction) {
4404 $transaction = new CRM_Core_Transaction();
4406 $contribution = $objects['contribution'];
4407 $primaryContributionID = $contribution->id ??
$objects['first_contribution']->id
;
4408 // The previous details are used when calculating line items so keep it before any code that 'does something'
4409 if (!empty($contribution->id
)) {
4410 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(['id' => $contribution->id
]);
4412 $inputContributionWhiteList = [
4417 'payment_instrument_id',
4422 'contribution_status_id',
4426 if (self
::isSingleLineItem($primaryContributionID)) {
4427 $inputContributionWhiteList[] = 'financial_type_id';
4430 $participant = $objects['participant'] ??
NULL;
4431 $recurContrib = $objects['contributionRecur'] ??
NULL;
4432 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4433 $event = $objects['event'] ??
NULL;
4435 $paymentProcessorId = '';
4436 if (isset($objects['paymentProcessor'])) {
4437 if (is_array($objects['paymentProcessor'])) {
4438 $paymentProcessorId = $objects['paymentProcessor']['id'];
4441 $paymentProcessorId = $objects['paymentProcessor']->id
;
4445 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4447 $contributionParams = array_merge([
4448 'contribution_status_id' => $completedContributionStatusID,
4449 'source' => self
::getRecurringContributionDescription($contribution, $event),
4450 ], array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4453 // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4454 if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency
)) {
4455 $contributionParams['currency'] = $objects['first_contribution']->currency
;
4458 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4460 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4461 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4462 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4463 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4466 if ($recurringContributionID) {
4467 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4469 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4471 if (empty($contributionParams['receive_date']) && $changeDate) {
4472 $contributionParams['receive_date'] = $changeDate;
4475 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4476 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4479 if (isset($input['is_email_receipt'])) {
4480 $values['is_email_receipt'] = $input['is_email_receipt'];
4483 if ($input['component'] == 'contribute') {
4484 if ($contribution->contribution_page_id
) {
4485 // Figure out what we gain from this.
4486 // Note that we may have overwritten the is_email_receipt input, fix that below.
4487 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4489 elseif ($recurContrib && $recurringContributionID) {
4490 $values['amount'] = $recurContrib->amount
;
4491 $values['financial_type_id'] = $objects['contributionType']->id
;
4492 $values['title'] = $source = ts('Offline Recurring Contribution');
4495 if (isset($input['is_email_receipt'])) {
4496 // CRM-19601 - we may have overwritten this above.
4497 $values['is_email_receipt'] = $input['is_email_receipt'];
4499 elseif ($recurContrib && $recurringContributionID) {
4500 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4501 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4502 // 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
4503 // Instance that had the table added via an upgrade in 4.1
4504 // see also https://github.com/civicrm/civicrm-svn/commit/7f39befd60bc735408d7866b02b3ac7fff1d4eea#diff-9ad8e290180451a2d6eacbd3d1ca7966R354
4505 // https://lab.civicrm.org/dev/core/issues/1245
4506 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4509 if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4510 self
::updateMembershipBasedOnCompletionOfContribution(
4512 $primaryContributionID,
4518 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4519 if ($event->is_email_confirm
) {
4520 // @todo this should be set by the function that sends the mail after sending.
4521 $contributionParams['receipt_date'] = $changeDate;
4523 $participantParams['id'] = $participant->id
;
4524 $participantParams['status_id'] = 'Registered';
4525 civicrm_api3('Participant', 'create', $participantParams);
4529 $contributionParams['id'] = $contribution->id
;
4530 $contributionParams['is_post_payment_create'] = $isPostPaymentCreate;
4532 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4533 // unsetting it here does NOT cause any other contribution test to fail!
4534 unset($contributionParams['financial_type_id']);
4535 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4537 // Add new soft credit against current $contribution.
4538 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
4539 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4542 if (empty($contribution->_relatedObjects
['participant']) && !empty($contribution->_relatedObjects
['membership'])) {
4543 // @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.
4544 // @todo - use getRelatedMemberships instead
4545 $contribution->trxn_id
= $input['trxn_id'] ??
NULL;
4546 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4548 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4550 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4551 $transaction->commit();
4553 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4554 $contributionParams['contribution_status_id'], $input['amount']);
4556 // create an activity record
4557 if ($input['component'] == 'contribute') {
4559 $targetContactID = NULL;
4560 if (!empty($ids['related_contact'])) {
4561 $targetContactID = $contribution->contact_id
;
4562 $contribution->contact_id
= $ids['related_contact'];
4564 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4567 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4568 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4569 if (!array_key_exists('is_email_receipt', $values) ||
4570 $values['is_email_receipt'] == 1
4572 civicrm_api3('Contribution', 'sendconfirmation', [
4573 'id' => $contribution->id
,
4574 'payment_processor_id' => $paymentProcessorId,
4576 CRM_Core_Error
::debug_log_message("Receipt sent");
4579 CRM_Core_Error
::debug_log_message("Success: Database updated");
4580 return $contributionResult;
4584 * Send receipt from contribution.
4586 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4588 * Note that the compose message part has been moved to contribution
4589 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4591 * @param array $input
4592 * Incoming data from Payment processor.
4594 * Related object IDs.
4595 * @param int $contributionID
4596 * @param array $values
4597 * Values related to objects that have already been loaded.
4598 * @param bool $returnMessageText
4599 * Should text be returned instead of sent. This.
4600 * is because the function is also used to generate pdfs
4603 * @throws \CRM_Core_Exception
4604 * @throws \CiviCRM_API3_Exception
4605 * @throws \Exception
4607 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4608 $returnMessageText = FALSE) {
4610 $contribution = new CRM_Contribute_BAO_Contribution();
4611 $contribution->id
= $contributionID;
4612 if (!$contribution->find(TRUE)) {
4613 throw new CRM_Core_Exception('Contribution does not exist');
4615 $contribution->loadRelatedObjects($input, $ids, TRUE);
4616 // set receipt from e-mail and name in value
4617 if (!$returnMessageText) {
4618 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4620 $values['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id
);
4621 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4622 if ((!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4623 civicrm_api3('Contribution', 'create', [
4624 'receipt_date' => 'now',
4625 'id' => $contribution->id
,
4632 * Generate From email and from name in an array values
4634 * @param array $input
4635 * @param \CRM_Contribute_BAO_Contribution $contribution
4639 public static function generateFromEmailAndName($input, $contribution) {
4640 // Use input value if supplied.
4641 if (!empty($input['receipt_from_email'])) {
4643 CRM_Utils_Array
::value('receipt_from_name', $input, ''),
4644 $input['receipt_from_email'],
4647 // if we are still empty see if we can use anything from a contribution page.
4649 if (!empty($contribution->contribution_page_id
)) {
4650 $pageValues = civicrm_api3('ContributionPage', 'getsingle', ['id' => $contribution->contribution_page_id
]);
4652 // if we are still empty see if we can use anything from a contribution page.
4653 if (!empty($pageValues['receipt_from_email'])) {
4655 CRM_Utils_Array
::value('receipt_from_name', $pageValues),
4656 $pageValues['receipt_from_email'],
4659 // If we are still empty fall back to the domain or logged in user information.
4660 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4664 * Load related memberships.
4668 * @return array $ids
4673 * Note that in theory it should be possible to retrieve these from the line_item table
4674 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4675 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4676 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4677 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4679 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4682 public function loadRelatedMembershipObjects($ids = []) {
4684 SELECT membership_id
4685 FROM civicrm_membership_payment
4686 WHERE contribution_id = %1 ";
4687 $params = [1 => [$this->id
, 'Integer']];
4688 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, []);
4690 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4691 while ($dao->fetch()) {
4692 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4693 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4697 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4698 foreach ($ids['membership'] as $id) {
4700 $membership = new CRM_Member_BAO_Membership();
4701 $membership->id
= $id;
4702 if (!$membership->find(TRUE)) {
4703 throw new Exception("Could not find membership record: $id");
4705 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4706 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4707 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4708 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4716 * This function is used to record partial payments for contribution
4718 * @param array $contribution
4720 * @param array $params
4722 * @return CRM_Financial_DAO_FinancialTrxn
4724 public static function recordPartialPayment($contribution, $params) {
4725 CRM_Core_Error
::deprecatedFunctionWarning('use payment create api');
4726 $balanceTrxnParams['to_financial_account_id'] = self
::getToFinancialAccount($contribution, $params);
4727 $balanceTrxnParams['from_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($contribution['financial_type_id'], 'Accounts Receivable Account is');
4728 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4729 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4730 $balanceTrxnParams['trxn_date'] = CRM_Utils_Array
::value('trxn_date', $params, CRM_Utils_Array
::value('contribution_receive_date', $params, date('YmdHis')));
4731 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
4732 $balanceTrxnParams['net_amount'] = $params['total_amount'] ??
NULL;
4733 $balanceTrxnParams['currency'] = $contribution['currency'];
4734 $balanceTrxnParams['trxn_id'] = $params['contribution_trxn_id'] ??
NULL;
4735 $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4736 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4737 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
4738 $balanceTrxnParams['is_payment'] = 1;
4740 if (!empty($params['payment_processor'])) {
4741 // I can't find evidence this is passed in - I was gonna just remove it but decided to deprecate as I see self::getToFinancialAccount
4742 // also anticipates it.
4743 CRM_Core_Error
::deprecatedFunctionWarning('passing payment_processor is deprecated - use payment_processor_id');
4744 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4746 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4750 * Get the description (source field) for the recurring contribution.
4752 * @param CRM_Contribute_BAO_Contribution $contribution
4753 * @param CRM_Event_DAO_Event|null $event
4756 * @throws \CiviCRM_API3_Exception
4758 protected static function getRecurringContributionDescription($contribution, $event) {
4759 if (!empty($contribution->source
)) {
4760 return $contribution->source
;
4762 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4763 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', [
4764 'id' => $contribution->contribution_page_id
,
4765 'return' => 'title',
4767 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4770 return ts('Online Event Registration') . ': ' . $event->title
;
4772 elseif (!empty($contribution->contribution_recur_id
)) {
4773 return 'recurring contribution';
4779 * Function use to store line item proportionally in in entity financial trxn table
4781 * @param array $trxnParams
4783 * @param int $trxnId
4785 * @param float $contributionTotalAmount
4787 * @throws \CiviCRM_API3_Exception
4789 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4790 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
4791 if (!empty($lineItems)) {
4792 // get financial item
4793 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
4795 'contribution_total_amount' => $contributionTotalAmount,
4796 'trxn_total_amount' => $trxnParams['total_amount'],
4797 'trxn_id' => $trxnId,
4799 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4804 * Checks if line items total amounts
4805 * match the contribution total amount.
4807 * @param array $params
4808 * array of order params.
4810 * @throws \API_Exception
4812 public static function checkLineItems(&$params) {
4813 $totalAmount = $params['total_amount'] ??
NULL;
4814 $lineItemAmount = 0;
4816 foreach ($params['line_items'] as &$lineItems) {
4817 foreach ($lineItems['line_item'] as &$item) {
4818 if (empty($item['financial_type_id'])) {
4819 $item['financial_type_id'] = $params['financial_type_id'];
4821 $lineItemAmount +
= $item['line_total'] + CRM_Utils_Array
::value('tax_amount', $item, 0.00);
4825 if (!isset($totalAmount)) {
4826 $params['total_amount'] = $lineItemAmount;
4829 $currency = CRM_Utils_Array
::value('currency', $params, '');
4831 if (empty($currency)) {
4832 $currency = CRM_Core_Config
::singleton()->defaultCurrency
;
4835 if (!CRM_Utils_Money
::equals($totalAmount, $lineItemAmount, $currency)) {
4836 throw new CRM_Contribute_Exception_CheckLineItemsException();
4842 * Get the financial account for the item associated with the new transaction.
4844 * @param array $params
4845 * @param int $default
4849 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4851 if (!empty($params['financial_account_id'])) {
4852 return $params['financial_account_id'];
4855 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
4856 $preferredAccountsRelationships = [
4857 'Refunded' => 'Credit/Contra Revenue Account is',
4858 'Chargeback' => 'Chargeback Account is',
4861 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4862 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
4863 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
4865 $preferredAccountsRelationships[$contributionStatus]
4873 * ContributionPage values were being imposed onto values.
4875 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4876 * REALLY didn't want superimposed. The rest are left there in their overkill out
4879 * The rationale for making this explicit is that it was a case of carefully set values being
4880 * seemingly randonly overwritten without much care. In general I think array randomly setting
4881 * variables en mass is risky.
4883 * @param array $values
4887 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4888 $contributionPageValues = [];
4889 CRM_Contribute_BAO_ContributionPage
::setValues(
4890 $this->contribution_page_id
,
4891 $contributionPageValues
4894 // These are the values that I believe to be useful.
4897 'pay_later_receipt',
4899 'receipt_from_email',
4900 'receipt_from_name',
4904 'honoree_profile_id',
4905 'onbehalf_profile_id',
4906 'honor_block_is_active',
4907 // Kinda might be - but would be on the contribution...
4910 // Included for 'fear of regression' but can't justify any use for these....
4912 'payment_processor',
4913 'financial_type_id',
4914 'amount_block_is_active',
4919 'default_amount_id',
4923 'initial_amount_help_text',
4924 'initial_amount_label',
4926 'is_allow_other_amount',
4927 'is_billing_required',
4928 'is_confirm_enabled',
4929 'is_credit_card_only',
4931 'is_partial_payment',
4932 'is_recur_installments',
4933 'is_recur_interval',
4937 'min_initial_amount',
4938 'recur_frequency_unit',
4945 foreach ($valuesToCopy as $valueToCopy) {
4946 if (isset($contributionPageValues[$valueToCopy])) {
4947 if ($valueToCopy === 'title') {
4948 $values[$valueToCopy] = CRM_Contribute_BAO_Contribution_Utils
::getContributionPageTitle($this->contribution_page_id
);
4951 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4959 * Get values of CiviContribute Settings
4960 * and check if its enabled or not.
4961 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4962 * in serialized form. Usually this should be stored as flat settings for each form fields
4963 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4964 * settings we will live with an inconsistency because it's too hard to change for now.
4965 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
4968 * @param string $name
4973 public static function checkContributeSettings($name) {
4974 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
4975 return $contributeSettings[$name] ??
NULL;
4979 * This function process contribution related objects.
4981 * @param int $contributionId
4982 * @param int $statusId
4983 * @param int|null $previousStatusId
4985 * @param string $receiveDate
4987 * @return null|string
4989 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
4991 if (!$contributionId ||
!$statusId) {
4996 'contribution_id' => $contributionId,
4997 'contribution_status_id' => $statusId,
4998 'previous_contribution_status_id' => $previousStatusId,
4999 'receive_date' => $receiveDate,
5002 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
5004 if (!is_array($updateResult) ||
5005 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
5006 !is_array($updatedComponents) ||
5007 empty($updatedComponents)
5012 // get the user display name.
5014 SELECT display_name as displayName
5015 FROM civicrm_contact
5016 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5017 WHERE civicrm_contribution.id = {$contributionId}";
5018 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5020 // get the status message for user.
5021 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5023 if ($componentName == 'CiviMember') {
5024 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5025 CRM_Member_PseudoConstant
::membershipStatus()
5028 $statusNameMsgPart = 'updated';
5029 switch ($updatedStatusName) {
5032 $statusNameMsgPart = $updatedStatusName;
5036 $statusMsg .= "<br />" . ts("Membership for %1 has been %2.", [
5037 1 => $userDisplayName,
5038 2 => $statusNameMsgPart,
5042 if ($componentName == 'CiviEvent') {
5043 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5044 CRM_Event_PseudoConstant
::participantStatus()
5046 if ($updatedStatusName == 'Cancelled') {
5047 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", [1 => $userDisplayName]);
5049 elseif ($updatedStatusName == 'Registered') {
5050 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", [1 => $userDisplayName]);
5054 if ($componentName == 'CiviPledge') {
5055 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5056 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5058 if ($updatedStatusName == 'Cancelled') {
5059 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", [1 => $userDisplayName]);
5061 elseif ($updatedStatusName == 'Failed') {
5062 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", [1 => $userDisplayName]);
5064 elseif ($updatedStatusName == 'Completed') {
5065 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", [1 => $userDisplayName]);
5074 * Get the contribution as it is in the database before being updated.
5076 * @param int $contributionID
5078 * @return \CRM_Contribute_BAO_Contribution|null
5080 private static function getOriginalContribution($contributionID) {
5081 return self
::getValues(['id' => $contributionID]);
5085 * Get the amount for the financial item row.
5087 * Helper function to start to break down recordFinancialTransactions for readability.
5089 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5091 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5092 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5095 * @param array $params
5096 * Params as passed to contribution.create
5098 * @param string $context
5099 * changeFinancialType| changedAmount
5100 * @param array $lineItemDetails
5102 * @param bool $isARefund
5103 * Is this a refund / negative transaction.
5104 * @param int $previousLineItemTotal
5107 * @todo move recordFinancialAccounts & helper functions to their own class?
5110 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5111 if ($context == 'changedAmount') {
5112 $lineTotal = $lineItemDetails['line_total'];
5113 if ($lineTotal != $previousLineItemTotal) {
5114 $lineTotal -= $previousLineItemTotal;
5118 elseif ($context == 'changeFinancialType') {
5119 return -$lineItemDetails['line_total'];
5121 elseif ($context == 'changedStatus') {
5122 $cancelledTaxAmount = 0;
5124 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $lineItemDetails, '0.00');
5126 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total'] +
(float) $cancelledTaxAmount);
5128 elseif ($context === NULL) {
5129 // erm, yes because? but, hey, it's tested.
5130 return $lineItemDetails['line_total'];
5132 elseif (empty($lineItemDetails['line_total'])) {
5133 // follow legacy code path
5135 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', ['civi.tag' => 'deprecated']);
5136 return $params['total_amount'];
5139 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total']);
5144 * Get the multiplier for adjusting rows.
5146 * If we are dealing with a refund or cancellation then it will be a negative
5147 * amount to reflect the negative transaction.
5149 * If we are changing Financial Type it will be a negative amount to
5150 * adjust down the old type.
5152 * @param int $contribution_status_id
5153 * @param string $context
5157 protected static function getMultiplier($contribution_status_id, $context) {
5158 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5165 * Does this transaction reflect a payment instrument change.
5167 * @param array $params
5168 * @param array $pendingStatuses
5172 protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5173 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
5175 if (array_key_exists('payment_instrument_id', $params)) {
5176 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
5177 !CRM_Utils_System
::isNull($params['payment_instrument_id'])
5179 //check if status is changed from Pending to Completed
5180 // do not update payment instrument changes for Pending to Completed
5181 if (!($contributionStatus == 'Completed' &&
5182 in_array($params['prevContribution']->contribution_status_id
, $pendingStatuses))
5187 elseif ((!CRM_Utils_System
::isNull($params['payment_instrument_id']) &&
5188 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
5189 $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5193 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
5194 $params['contribution']->check_number
!= $params['prevContribution']->check_number
5196 // another special case when check number is changed, create new financial records
5197 // create financial trxn with negative amount
5205 * Update the memberships associated with a contribution if it has been completed.
5207 * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5208 * load them in this function. Code clean up would compensate for any minor performance implication.
5210 * @param \CRM_Contribute_BAO_Contribution $contribution
5211 * @param int $primaryContributionID
5212 * @param string $changeDate
5214 * @throws \CRM_Core_Exception
5215 * @throws \CiviCRM_API3_Exception
5217 public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5218 $memberships = self
::getRelatedMemberships($contribution->id
);
5219 foreach ($memberships as $membership) {
5220 $membershipParams = [
5221 'id' => $membership['id'],
5222 'contact_id' => $membership['contact_id'],
5223 'is_test' => $membership['is_test'],
5224 'membership_type_id' => $membership['membership_type_id'],
5225 'membership_activity_status' => 'Completed',
5228 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
5229 $membershipParams['membership_type_id'],
5230 $membershipParams['is_test'],
5231 $membershipParams['id']
5234 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5235 // this picks up membership type changes during renewals
5236 // @todo this is almost certainly an obsolete sql call, the pre-change
5237 // membership is accessible via $this->_relatedObjects
5239 SELECT membership_type_id
5240 FROM civicrm_membership_log
5241 WHERE membership_id={$membershipParams['id']}
5244 $dao = CRM_Core_DAO
::executeQuery($sql);
5245 if ($dao->fetch()) {
5246 if (!empty($dao->membership_type_id
)) {
5247 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
5250 if (empty($membership['end_date']) ||
(int) $membership['status_id'] !== CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending')) {
5251 // Passing num_terms to the api triggers date calculations, but for pending memberships these may be already calculated.
5252 // sigh - they should be consistent but removing the end date check causes test failures & maybe UI too?
5253 // 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.
5254 // @todo once apiv4 ships with core switch to that & find sanity.
5255 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5256 $membershipParams['membership_type_id'],
5257 $primaryContributionID
5260 // @todo remove all this stuff in favour of letting the api call further down handle in
5261 // (it is a duplication of what the api does).
5262 $dates = array_fill_keys([
5267 if ($currentMembership) {
5269 * Fixed FOR CRM-4433
5270 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5271 * when Contribution mode is notify and membership is for renewal )
5273 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5275 // @todo - we should pass membership_type_id instead of null here but not
5276 // adding as not sure of testing
5277 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
5278 $changeDate, NULL, $membershipParams['num_terms']
5280 $dates['join_date'] = $currentMembership['join_date'];
5283 //get the status for membership.
5284 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
5286 $dates['join_date'],
5289 $membershipParams['membership_type_id'],
5293 unset($dates['end_date']);
5294 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
5295 //we might be renewing membership,
5296 //so make status override false.
5297 $membershipParams['is_override'] = FALSE;
5298 $membershipParams['status_override_end_date'] = 'null';
5300 //CRM-17723 - reset static $relatedContactIds array()
5301 // @todo move it to Civi Statics.
5303 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
5304 civicrm_api3('Membership', 'create', $membershipParams);
5309 * Get payment links as they relate to a contribution.
5311 * If a payment can be made then include a payment link & if a refund is appropriate
5312 * then a refund link.
5315 * @param float $balance
5316 * @param string $contributionStatus
5319 * $actionLinks Links array containing:
5323 protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5324 if ($contributionStatus === 'Failed' ||
!CRM_Core_Permission
::check('edit contributions')) {
5325 // In general the balance is the best way to determine if a payment can be added or not,
5326 // but not for Failed contributions, where we don't accept additional payments at the moment.
5327 // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5328 // do accept more payments agains them.
5333 'url' => CRM_Utils_System
::url('civicrm/payment', [
5339 'title' => ts('Record Payment'),
5342 if ((int) $balance > 0) {
5343 // @todo - this should be possible even if not > 0 - test & remove this if.
5344 // it is possible to 'overpay' in the real world & we honor that.
5345 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
5347 'url' => CRM_Utils_System
::url('civicrm/payment', [
5354 'title' => ts('Submit Credit Card payment'),
5358 elseif ((int) $balance < 0) {
5359 // @todo - in the future remove this IF - OK to refund money even when not due since
5362 'url' => CRM_Utils_System
::url('civicrm/payment', [
5368 'title' => ts('Record Refund'),
5371 return $actionLinks;
5375 * Get a query to determine the amount donated by the contact/s in the current financial year.
5377 * @param array $contactIDs
5381 public static function getAnnualQuery($contactIDs) {
5382 $contactIDs = implode(',', $contactIDs);
5383 $config = CRM_Core_Config
::singleton();
5384 $currentMonth = date('m');
5385 $currentDay = date('d');
5387 (int) $config->fiscalYearStart
['M'] > $currentMonth ||
5389 (int) $config->fiscalYearStart
['M'] == $currentMonth &&
5390 (int) $config->fiscalYearStart
['d'] > $currentDay
5393 $year = date('Y') - 1;
5398 $nextYear = $year +
1;
5400 if ($config->fiscalYearStart
) {
5401 $newFiscalYearStart = $config->fiscalYearStart
;
5402 if ($newFiscalYearStart['M'] < 10) {
5403 // This is just a clumsy way of adding padding.
5404 // @todo next round look for a nicer way.
5405 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5407 if ($newFiscalYearStart['d'] < 10) {
5408 // This is just a clumsy way of adding padding.
5409 // @todo next round look for a nicer way.
5410 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5412 $config->fiscalYearStart
= $newFiscalYearStart;
5413 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
5416 // First of January.
5419 $startDate = "$year$monthDay";
5420 $endDate = "$nextYear$monthDay";
5423 'contact_id' => 'IN (' . $contactIDs . ')',
5424 'is_test' => ' = 0',
5425 'receive_date' => ['>=' . $startDate, '< ' . $endDate],
5427 $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5428 CRM_Financial_BAO_FinancialType
::addACLClausesToWhereClauses($whereClauses);
5431 foreach ($whereClauses as $key => $clause) {
5432 $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5434 $whereClauseString = implode(' AND ', $clauses);
5436 // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5437 // this group by + having on contribution_status_id improves performance
5439 SELECT COUNT(*) as count,
5440 SUM(total_amount) as amount,
5441 AVG(total_amount) as average,
5443 FROM civicrm_contribution b
5444 WHERE " . $whereClauseString . "
5445 GROUP BY currency, contribution_status_id
5446 HAVING $havingClause
5452 * Assign Test Value.
5454 * @param string $fieldName
5455 * @param array $fieldDef
5456 * @param int $counter
5458 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5459 if ($fieldName == 'tax_amount') {
5460 $this->{$fieldName} = "0.00";
5462 elseif ($fieldName == 'net_amount') {
5463 $this->{$fieldName} = "2.00";
5465 elseif ($fieldName == 'total_amount') {
5466 $this->{$fieldName} = "3.00";
5468 elseif ($fieldName == 'fee_amount') {
5469 $this->{$fieldName} = "1.00";
5472 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5477 * Check if contribution has participant/membership payment.
5479 * @param int $contributionId
5484 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5485 // get line item for contribution
5486 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5487 // check if line item is for membership or participant
5488 foreach ($lineItems as $items) {
5489 if ($items['entity_table'] == 'civicrm_participant') {
5493 elseif ($items['entity_table'] == 'civicrm_membership') {
5505 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5507 * @param array $trxnParams
5508 * Financial trxn params
5509 * @param array $contributionParams
5510 * Contribution Params
5514 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5515 if (!Civi
::settings()->get('always_post_to_accounts_receivable')) {
5518 $statusId = $contributionParams['contribution']->contribution_status_id
;
5519 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5520 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5521 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5522 // Return if contribution status is not completed.
5523 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5524 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5525 && $contributionParams['prevContribution']->is_pay_later
== 0
5531 $params = $trxnParams;
5532 $financialTypeID = !empty($contributionParams['financial_type_id']) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5533 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5534 $params['to_financial_account_id'] = $arAccountId;
5535 $params['status_id'] = array_search('Pending', $contributionStatuses);
5536 $params['is_payment'] = FALSE;
5537 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5538 self
::$_trxnIDs[] = $trxn->id
;
5539 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5543 * Calculate financial item amount when contribution is updated.
5545 * @param array $params
5546 * contribution params
5547 * @param array $amountParams
5549 * @param string $context
5553 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5554 if (!empty($params['is_quick_config'])) {
5555 $amount = $amountParams['item_amount'];
5557 $amount = $params['total_amount'];
5558 if ($context === NULL) {
5559 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5564 $amount = $amountParams['line_total'];
5565 if ($context == 'changedAmount') {
5566 $amount -= $amountParams['previous_line_total'];
5568 $amount *= $amountParams['diff'];
5574 * Retrieve Sales Tax Financial Accounts.
5580 public static function getSalesTaxFinancialAccounts() {
5581 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5582 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5583 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5584 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5585 $queryParams = [1 => [$accountRel, 'Integer']];
5586 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5587 $financialAccount = [];
5588 while ($dao->fetch()) {
5589 $financialAccount[$dao->id
] = $dao->id
;
5591 return $financialAccount;
5595 * Create tax entry in civicrm_entity_financial_trxn table.
5597 * @param array $entityParams
5599 * @param array $eftParams
5601 * @throws \CiviCRM_API3_Exception
5603 public static function createProportionalEntry($entityParams, $eftParams) {
5605 if ($entityParams['contribution_total_amount'] != 0) {
5606 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5608 // Record Entity Financial Trxn; CRM-20145
5609 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5610 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5614 * Create array of last financial item id's.
5616 * @param int $contributionId
5620 public static function getLastFinancialItemIds($contributionId) {
5621 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5622 FROM civicrm_financial_item fi
5623 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5624 WHERE li.contribution_id = %1";
5625 $dao = CRM_Core_DAO
::executeQuery($sql, [
5631 $ftIds = $taxItems = [];
5632 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5633 while ($dao->fetch()) {
5634 /* if sales tax item*/
5635 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5636 $taxItems[$dao->price_field_value_id
] = [
5637 'financial_item_id' => $dao->id
,
5638 'amount' => $dao->tax_amount
,
5642 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5645 return [$ftIds, $taxItems];
5649 * Create proportional entries in civicrm_entity_financial_trxn.
5651 * @param array $entityParams
5653 * @param array $lineItems
5655 * @param array $ftIds
5657 * @param array $taxItems
5659 * @throws \CiviCRM_API3_Exception
5661 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5663 'entity_table' => 'civicrm_financial_item',
5664 'financial_trxn_id' => $entityParams['trxn_id'],
5666 foreach ($lineItems as $key => $value) {
5667 if ($value['qty'] == 0) {
5670 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5671 $entityParams['line_item_amount'] = $value['line_total'];
5672 self
::createProportionalEntry($entityParams, $eftParams);
5673 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5674 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5675 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5676 self
::createProportionalEntry($entityParams, $eftParams);
5682 * Load entities related to the contribution into $this->_relatedObjects.
5686 * @throws \CRM_Core_Exception
5688 protected function loadRelatedEntitiesByID($ids) {
5690 'contact' => 'CRM_Contact_BAO_Contact',
5691 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5692 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5693 'financialType' => 'CRM_Financial_BAO_FinancialType',
5694 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5696 foreach ($entities as $entity => $bao) {
5697 if (!empty($ids[$entity])) {
5698 $this->_relatedObjects
[$entity] = new $bao();
5699 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5700 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5701 throw new CRM_Core_Exception($entity . ' could not be loaded');
5708 * Should an email receipt be sent for this contribution when complete.
5710 * @param array $input
5714 protected function isEmailReceipt($input) {
5715 if (isset($input['is_email_receipt'])) {
5716 return $input['is_email_receipt'];
5718 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5719 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5725 * Function to replace contribution tokens.
5727 * @param array $contributionIds
5729 * @param string $subject
5731 * @param array $subjectToken
5733 * @param string $text
5735 * @param string $html
5737 * @param array $messageToken
5739 * @param bool $escapeSmarty
5742 * @throws \CiviCRM_API3_Exception
5744 public static function replaceContributionTokens(
5753 if (empty($contributionIds)) {
5756 $contributionDetails = [];
5757 foreach ($contributionIds as $id) {
5758 $result = self
::getContributionTokenValues($id, $messageToken);
5759 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5760 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5761 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5763 return $contributionDetails;
5767 * Get the contribution fields for $id and display labels where
5768 * appropriate (if the token is present).
5771 * @param array $messageToken
5774 public static function getContributionTokenValues($id, $messageToken) {
5778 $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
5779 // lab.c.o mail#46 - show labels, not values, for custom fields with option values.
5780 if (!empty($messageToken)) {
5781 foreach ($result['values'][$id] as $fieldName => $fieldValue) {
5782 if (strpos($fieldName, 'custom_') === 0 && array_search($fieldName, $messageToken['contribution']) !== FALSE) {
5783 $result['values'][$id][$fieldName] = CRM_Core_BAO_CustomField
::displayValue($result['values'][$id][$fieldName], $fieldName);
5791 * Get invoice_number for contribution.
5793 * @param int $contributionID
5797 public static function getInvoiceNumber($contributionID) {
5798 if ($invoicePrefix = self
::checkContributeSettings('invoice_prefix')) {
5799 return $invoicePrefix . $contributionID;
5806 * Load the values needed for the event message.
5808 * @param int $eventID
5809 * @param int $participantID
5810 * @param int|null $contributionID
5813 * @throws \CRM_Core_Exception
5815 protected function loadEventMessageTemplateParams(int $eventID, int $participantID, $contributionID): array {
5820 $values = ['event' => []];
5822 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
5823 // add custom fields for event
5824 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', NULL, $eventID);
5826 $eventCustomGroup = [];
5827 foreach ($eventGroupTree as $key => $group) {
5828 if ($key === 'info') {
5832 foreach ($group['fields'] as $k => $customField) {
5833 $groupLabel = $group['title'];
5834 if (!empty($customField['customValue'])) {
5835 foreach ($customField['customValue'] as $customFieldValues) {
5836 $eventCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5841 $values['event']['customGroup'] = $eventCustomGroup;
5843 //get participant details
5844 $participantParams = [
5845 'id' => $participantID,
5848 $values['participant'] = [];
5850 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
5851 // add custom fields for event
5852 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', NULL, $participantID);
5853 $participantCustomGroup = [];
5854 foreach ($participantGroupTree as $key => $group) {
5855 if ($key === 'info') {
5859 foreach ($group['fields'] as $k => $customField) {
5860 $groupLabel = $group['title'];
5861 if (!empty($customField['customValue'])) {
5862 foreach ($customField['customValue'] as $customFieldValues) {
5863 $participantCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5868 $values['participant']['customGroup'] = $participantCustomGroup;
5870 //get location details
5872 'entity_id' => $eventID,
5873 'entity_table' => 'civicrm_event',
5875 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
5878 'entity_table' => 'civicrm_event',
5879 'entity_id' => $eventID,
5880 'module' => 'CiviEvent',
5883 list($custom_pre_id,
5885 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
5887 $values['custom_pre_id'] = $custom_pre_id;
5888 $values['custom_post_id'] = $custom_post_ids;
5890 // set lineItem for event contribution
5891 if ($contributionID) {
5892 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($contributionID);
5893 if (!empty($participantIds)) {
5894 foreach ($participantIds as $pIDs) {
5895 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
5896 if (!CRM_Utils_System
::isNull($lineItem)) {
5897 $values['lineItem'][] = $lineItem;