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' => "<i class='crm-i fa-pencil'></i>",
1294 'url' => 'civicrm/payment/edit',
1295 'class' => 'medium-popup',
1296 'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
1297 'title' => ts('Edit Payment'),
1300 $paymentEditLink = CRM_Core_Action
::formLink(
1302 CRM_Core_Action
::mask([CRM_Core_Permission
::EDIT
]),
1304 'id' => $resultDAO->id
,
1305 'contribution_id' => $contributionId,
1309 'Payment.edit.action',
1316 'id' => $resultDAO->id
,
1317 'total_amount' => $resultDAO->total_amount
,
1318 'financial_type' => $resultDAO->financial_account
,
1319 'payment_instrument' => $paidByLabel,
1320 'receive_date' => $resultDAO->trxn_date
,
1321 'trxn_id' => $resultDAO->trxn_id
,
1322 'status' => $statuses[$resultDAO->status_id
],
1323 'currency' => $resultDAO->currency
,
1324 'action' => $paymentEditLink,
1326 if ($paidByName == 'Check') {
1327 $val['check_number'] = $resultDAO->check_number
;
1337 public function addSelectWhereClause() {
1338 $whereClauses = parent
::addSelectWhereClause();
1339 if ($whereClauses !== []) {
1340 // In this case permisssions have been applied & we assume the
1341 // financialaclreport is applying these
1342 // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
1343 return $whereClauses;
1346 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1347 return $whereClauses;
1349 $types = CRM_Financial_BAO_FinancialType
::getAllEnabledAvailableFinancialTypes();
1350 if (empty($types)) {
1351 $whereClauses['financial_type_id'] = 'IN (0)';
1354 $whereClauses['financial_type_id'] = [
1355 'IN (' . implode(',', array_keys($types)) . ')',
1358 return $whereClauses;
1362 * @param null $status
1363 * @param null $startDate
1364 * @param null $endDate
1366 * @return array|null
1368 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1372 $where[] = 'contribution_status_id = 1';
1376 $where[] = 'contribution_status_id = 3';
1381 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
1384 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
1386 $financialTypeACLJoin = '';
1387 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1388 $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1389 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1390 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1391 if ($financialTypes) {
1392 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1393 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1396 $where[] = "c.financial_type_id IN (0)";
1400 $whereCond = implode(' AND ', $where);
1403 SELECT sum( total_amount ) as total_amount,
1404 count( c.id ) as total_count,
1406 FROM civicrm_contribution c
1407 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
1408 $financialTypeACLJoin
1410 AND ( is_test = 0 OR is_test IS NULL )
1411 AND contact.is_deleted = 0
1415 $dao = CRM_Core_DAO
::executeQuery($query);
1418 while ($dao->fetch()) {
1419 $count +
= $dao->total_count
;
1420 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
1424 'amount' => implode(', ', $amount),
1432 * Delete the indirect records associated with this contribution first.
1436 * @return mixed|null
1437 * $results no of deleted Contribution on success, false otherwise
1439 public static function deleteContribution($id) {
1440 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
1442 $transaction = new CRM_Core_Transaction();
1445 //delete activity record
1447 'source_record_id' => $id,
1448 // activity type id for contribution
1449 'activity_type_id' => 6,
1452 CRM_Activity_BAO_Activity
::deleteActivity($params);
1454 //delete billing address if exists for this contribution.
1455 self
::deleteAddress($id);
1457 //update pledge and pledge payment, CRM-3961
1458 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
1460 // remove entry from civicrm_price_set_entity, CRM-5095
1461 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
1462 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
1464 // cleanup line items.
1465 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1467 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1468 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1470 if ($participantId) {
1471 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1474 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1478 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1479 $noteId = key($note);
1481 CRM_Core_BAO_Note
::del($noteId, FALSE);
1484 $dao = new CRM_Contribute_DAO_Contribution();
1487 $results = $dao->delete();
1489 $transaction->commit();
1491 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1493 // delete the recently created Contribution
1494 $contributionRecent = [
1496 'type' => 'Contribution',
1498 CRM_Utils_Recent
::del($contributionRecent);
1504 * React to a financial transaction (payment) failure.
1506 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1507 * payments is important for forensic and outreach reasons.
1509 * @param int $contributionID
1510 * @param int $contactID
1511 * @param string $message
1513 * @throws \CiviCRM_API3_Exception
1515 public static function failPayment($contributionID, $contactID, $message) {
1516 civicrm_api3('activity', 'create', [
1517 'activity_type_id' => 'Failed Payment',
1518 'details' => $message,
1519 'subject' => ts('Payment failed at payment processor'),
1520 'source_record_id' => $contributionID,
1521 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() : $contactID,
1524 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1525 civicrm_api3('contribution', 'create', [
1526 'id' => $contributionID,
1527 'contribution_status_id' => 'Failed',
1532 * Check if there is a contribution with the same trxn_id or invoice_id.
1534 * @param array $input
1535 * An assoc array of name/value pairs.
1536 * @param array $duplicates
1537 * (reference) store ids of duplicate contribs.
1541 * true if duplicate, false otherwise
1543 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1545 $id = $input['id'] ??
NULL;
1547 $trxn_id = $input['trxn_id'] ??
NULL;
1548 $invoice_id = $input['invoice_id'] ??
NULL;
1554 $clause[] = "trxn_id = %1";
1555 $input[1] = [$trxn_id, 'String'];
1559 $clause[] = "invoice_id = %2";
1560 $input[2] = [$invoice_id, 'String'];
1563 if (empty($clause)) {
1567 $clause = implode(' OR ', $clause);
1569 $clause = "( $clause ) AND id != %3";
1570 $input[3] = [$id, 'Integer'];
1573 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1574 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1576 while ($dao->fetch()) {
1577 $duplicates[] = $dao->id
;
1584 * Takes an associative array and creates a contribution_product object.
1586 * the function extract all the params it needs to initialize the create a
1587 * contribution_product object. the params array could contain additional unused name/value
1590 * @param array $params
1591 * (reference) an assoc array of name/value pairs.
1593 * @return CRM_Contribute_DAO_ContributionProduct
1595 public static function addPremium(&$params) {
1596 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1597 $contributionProduct->copyValues($params);
1598 return $contributionProduct->save();
1602 * Get list of contribution fields for profile.
1603 * For now we only allow custom contribution fields to be in
1606 * @param bool $addExtraFields
1607 * True if special fields needs to be added.
1610 * the list of contribution fields
1612 public static function getContributionFields($addExtraFields = TRUE) {
1613 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1614 // @todo remove this - this line was added because payment_instrument_id was not
1615 // set to exportable - but now it is.
1616 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1618 if ($addExtraFields) {
1619 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1622 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1624 foreach ($contributionFields as $key => $var) {
1625 if ($key == 'contribution_contact_id') {
1628 elseif ($key == 'contribution_campaign_id') {
1629 $var['title'] = ts('Campaign');
1631 $fields[$key] = $var;
1634 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1639 * Add extra fields specific to contribution.
1641 public static function getSpecialContributionFields() {
1643 'contribution_soft_credit_name' => [
1644 'name' => 'contribution_soft_credit_name',
1645 'title' => ts('Soft Credit Name'),
1646 'headerPattern' => '/^soft_credit_name$/i',
1647 'where' => 'civicrm_contact_d.display_name',
1649 'contribution_soft_credit_email' => [
1650 'name' => 'contribution_soft_credit_email',
1651 'title' => ts('Soft Credit Email'),
1652 'headerPattern' => '/^soft_credit_email$/i',
1653 'where' => 'soft_email.email',
1655 'contribution_soft_credit_phone' => [
1656 'name' => 'contribution_soft_credit_phone',
1657 'title' => ts('Soft Credit Phone'),
1658 'headerPattern' => '/^soft_credit_phone$/i',
1659 'where' => 'soft_phone.phone',
1661 'contribution_soft_credit_contact_id' => [
1662 'name' => 'contribution_soft_credit_contact_id',
1663 'title' => ts('Soft Credit Contact ID'),
1664 'headerPattern' => '/^soft_credit_contact_id$/i',
1665 'where' => 'civicrm_contribution_soft.contact_id',
1667 'contribution_pcp_title' => [
1668 'name' => 'contribution_pcp_title',
1669 'title' => ts('Personal Campaign Page Title'),
1670 'headerPattern' => '/^contribution_pcp_title$/i',
1671 'where' => 'contribution_pcp.title',
1675 return $extraFields;
1679 * @param int $pageID
1683 public static function getCurrentandGoalAmount($pageID) {
1685 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1686 FROM civicrm_contribution_page p,
1687 civicrm_contribution c
1688 WHERE p.id = c.contribution_page_id
1690 AND c.cancel_date is null
1694 $config = CRM_Core_Config
::singleton();
1695 $params = [1 => [$pageID, 'Integer']];
1696 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1698 if ($dao->fetch()) {
1699 return [$dao->goal
, $dao->total
];
1702 return [NULL, NULL];
1707 * Get list of contributions which credit the passed in contact ID.
1709 * The returned array provides details about the original contribution & donor.
1711 * @param int $honorId
1712 * In Honor of Contact ID.
1715 * list of contribution fields
1716 * @todo - this is a confusing function called from one place. It has a test. It would be
1717 * nice to deprecate it.
1720 public static function getHonorContacts($honorId) {
1722 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1723 $honorDAO->contact_id
= $honorId;
1726 $type = CRM_Contribute_PseudoConstant
::financialType();
1728 while ($honorDAO->fetch()) {
1729 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1730 $contributionDAO->id
= $honorDAO->contribution_id
;
1732 if ($contributionDAO->find(TRUE)) {
1733 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1734 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1735 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1736 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1737 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1738 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1739 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1740 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1741 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
, 'label');
1749 * Get the sort name of a contact for a particular contribution.
1752 * Id of the contribution.
1754 * @return null|string
1755 * sort name of the contact if found
1757 public static function sortName($id) {
1758 $id = CRM_Utils_Type
::escape($id, 'Integer');
1761 SELECT civicrm_contact.sort_name
1762 FROM civicrm_contribution, civicrm_contact
1763 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1764 AND civicrm_contribution.id = {$id}
1766 return CRM_Core_DAO
::singleValueQuery($query);
1770 * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1772 * @param int|array $contactIDs
1776 public static function annual($contactIDs) {
1777 if (!is_array($contactIDs)) {
1778 // In practice I can't fine any evidence that this function is ever called with
1779 // anything other than a single contact id, but left like this due to .... fear.
1780 $contactIDs = explode(',', $contactIDs);
1783 $query = self
::getAnnualQuery($contactIDs);
1784 $dao = CRM_Core_DAO
::executeQuery($query);
1786 $amount = $average = [];
1787 while ($dao->fetch()) {
1788 if ($dao->count
> 0 && $dao->amount
> 0) {
1789 $count +
= $dao->count
;
1790 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1791 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1797 implode(', ', $amount),
1798 implode(', ', $average),
1805 * Check if there is a contribution with the params passed in.
1807 * Used for trxn_id,invoice_id and contribution_id
1809 * @param array $params
1810 * An assoc array of name/value pairs.
1813 * contribution id if success else NULL
1815 public static function checkDuplicateIds($params) {
1816 $dao = new CRM_Contribute_DAO_Contribution();
1820 foreach ($params as $k => $v) {
1822 $clause[] = "$k = '$v'";
1825 $clause = implode(' AND ', $clause);
1826 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1827 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1829 while ($dao->fetch()) {
1837 * Get the contribution details for component export.
1839 * @param int $exportMode
1841 * @param array $componentIds
1847 public static function getContributionDetails($exportMode, $componentIds) {
1848 $paymentDetails = [];
1849 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1851 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1852 $componentSelect = " civicrm_participant_payment.participant_id id";
1853 $additionalClause = "
1854 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1855 AND civicrm_participant_payment.participant_id {$componentClause} )
1858 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1859 $componentSelect = " civicrm_membership_payment.membership_id id";
1860 $additionalClause = "
1861 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1862 AND civicrm_membership_payment.membership_id {$componentClause} )
1865 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1866 $componentSelect = " civicrm_pledge_payment.id id";
1867 $additionalClause = "
1868 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1869 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1873 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1874 trxn_id, {$componentSelect}
1875 FROM civicrm_contribution
1876 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1877 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1878 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1879 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1880 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1881 AND option_group_contribution_status.id = contribution_status.option_group_id )
1885 $dao = CRM_Core_DAO
::executeQuery($query);
1887 while ($dao->fetch()) {
1888 $paymentDetails[$dao->id
] = [
1889 'total_amount' => $dao->total_amount
,
1890 'contribution_status' => $dao->status
,
1891 'receive_date' => $dao->receive_date
,
1892 'pay_instru' => $dao->payment_instrument
,
1893 'trxn_id' => $dao->trxn_id
,
1897 return $paymentDetails;
1901 * Create address associated with contribution record.
1903 * As long as there is one or more billing field in the parameters we will create the address.
1905 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1908 * @param array $params
1909 * @param int $billingLocationTypeID
1914 public static function createAddress($params, $billingLocationTypeID) {
1915 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1916 if ($hasBillingField) {
1917 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1918 return $address->id
;
1925 * Delete billing address record related contribution.
1927 * @param int $contributionId
1928 * @param int $contactId
1930 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1932 $contactJoin = NULL;
1934 if ($contributionId) {
1935 $clauses[] = "cc.id = {$contributionId}";
1939 $clauses[] = "cco.id = {$contactId}";
1940 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1943 if (empty($clauses)) {
1944 CRM_Core_Error
::fatal();
1947 $condition = implode(' OR ', $clauses);
1951 FROM civicrm_address ca
1952 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1956 $dao = CRM_Core_DAO
::executeQuery($query);
1958 while ($dao->fetch()) {
1959 $params = ['id' => $dao->id
];
1960 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1965 * This function check online pending contribution associated w/
1966 * Online Event Registration or Online Membership signup.
1968 * @param int $componentId
1969 * Participant/membership id.
1970 * @param string $componentName
1974 * pending contribution id.
1976 public static function checkOnlinePendingContribution($componentId, $componentName) {
1977 $contributionId = NULL;
1978 if (!$componentId ||
1979 !in_array($componentName, ['Event', 'Membership'])
1981 return $contributionId;
1984 if ($componentName == 'Event') {
1985 $idName = 'participant_id';
1986 $componentTable = 'civicrm_participant';
1987 $paymentTable = 'civicrm_participant_payment';
1988 $source = ts('Online Event Registration');
1991 if ($componentName == 'Membership') {
1992 $idName = 'membership_id';
1993 $componentTable = 'civicrm_membership';
1994 $paymentTable = 'civicrm_membership_payment';
1995 $source = ts('Online Contribution');
1998 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
2001 SELECT component.id as {$idName},
2002 componentPayment.contribution_id as contribution_id,
2003 contribution.source source,
2004 contribution.contribution_status_id as contribution_status_id,
2005 contribution.is_pay_later as is_pay_later
2006 FROM $componentTable component
2007 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
2008 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
2009 WHERE component.id = {$componentId}";
2011 $dao = CRM_Core_DAO
::executeQuery($query);
2013 while ($dao->fetch()) {
2014 if ($dao->contribution_id
&&
2015 $dao->is_pay_later
&&
2016 $dao->contribution_status_id
== $pendingStatusId &&
2017 strpos($dao->source
, $source) !== FALSE
2019 $contributionId = $dao->contribution_id
;
2023 return $contributionId;
2027 * Update contribution as well as related objects.
2029 * This function by-passes hooks - to address this - don't use this function.
2031 * @param array $params
2032 * @param bool $processContributionObject
2036 * @throws CRM_Core_Exception
2037 * @throws \CiviCRM_API3_Exception
2040 * Use api contribute.completetransaction
2041 * For failures use failPayment (preferably exposing by api in the process).
2044 public static function transitionComponents($params, $processContributionObject = FALSE) {
2045 // get minimum required values.
2046 $contactId = $params['contact_id'] ??
NULL;
2047 $componentId = $params['component_id'] ??
NULL;
2048 $componentName = $params['componentName'] ??
NULL;
2049 $contributionId = $params['contribution_id'] ??
NULL;
2050 $contributionStatusId = $params['contribution_status_id'] ??
NULL;
2052 // if we already processed contribution object pass previous status id.
2053 $previousContriStatusId = $params['previous_contribution_status_id'] ??
NULL;
2057 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
2059 // we process only ( Completed, Cancelled, or Failed ) contributions.
2060 if (!$contributionId ||
2061 !in_array($contributionStatusId, [
2062 array_search('Completed', $contributionStatuses),
2063 array_search('Cancelled', $contributionStatuses),
2064 array_search('Failed', $contributionStatuses),
2067 return $updateResult;
2070 if (!$componentName ||
!$componentId) {
2071 // get the related component details.
2072 $componentDetails = self
::getComponentDetails($contributionId);
2075 $componentDetails['contact_id'] = $contactId;
2076 $componentDetails['component'] = $componentName;
2078 if ($componentName == 'event') {
2079 $componentDetails['participant'] = $componentId;
2082 $componentDetails['membership'] = $componentId;
2086 if (!empty($componentDetails['contact_id'])) {
2087 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2093 // do check for required ids.
2094 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
2095 return $updateResult;
2098 //now we are ready w/ required ids, start processing.
2100 $baseIPN = new CRM_Core_Payment_BaseIPN();
2102 $input = $ids = $objects = [];
2104 $input['component'] = $componentDetails['component'] ??
NULL;
2105 $ids['contribution'] = $contributionId;
2106 $ids['contact'] = $componentDetails['contact_id'] ??
NULL;
2107 $ids['membership'] = $componentDetails['membership'] ??
NULL;
2108 $ids['participant'] = $componentDetails['participant'] ??
NULL;
2109 $ids['event'] = $componentDetails['event'] ??
NULL;
2110 $ids['pledge_payment'] = $componentDetails['pledge_payment'] ??
NULL;
2111 $ids['contributionRecur'] = NULL;
2112 $ids['contributionPage'] = NULL;
2114 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
2115 CRM_Core_Error
::fatal();
2118 $memberships = &$objects['membership'];
2119 $participant = &$objects['participant'];
2120 $pledgePayment = &$objects['pledge_payment'];
2121 $contribution = &$objects['contribution'];
2122 $pledgeID = $oldStatus = NULL;
2123 $pledgePaymentIDs = [];
2124 if ($pledgePayment) {
2125 foreach ($pledgePayment as $key => $object) {
2126 $pledgePaymentIDs[] = $object->id
;
2128 $pledgeID = $pledgePayment[0]->pledge_id
;
2131 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
2134 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
2135 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
2140 // we might want to process contribution object.
2141 $processContribution = FALSE;
2142 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
2143 // Call interim cancel function - with a goal to cleaning up the signature on it and switching to a tested api Contribution.cancel function.
2144 list($updateResult, $processContribution) = self
::cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId);
2146 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
2147 if (is_array($memberships)) {
2148 foreach ($memberships as $membership) {
2150 //Update Membership status if there is no other completed contribution associated with the membership.
2151 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
2152 foreach ($relatedContributions as $contriId) {
2153 if ($contriId == $contributionId) {
2156 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
2157 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
2161 if ($membership && $update) {
2162 $membership->status_id
= array_search('Expired', $membershipStatuses);
2163 $membership->is_override
= TRUE;
2164 $membership->status_override_end_date
= 'null';
2165 $membership->save();
2167 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2168 if ($processContributionObject) {
2169 $processContribution = TRUE;
2175 $updatedStatusId = array_search('Cancelled', $participantStatuses);
2176 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2178 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2179 if ($processContributionObject) {
2180 $processContribution = TRUE;
2184 if ($pledgePayment) {
2185 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2187 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2188 if ($processContributionObject) {
2189 $processContribution = TRUE;
2193 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
2195 // only pending contribution related object processed.
2196 if ($previousContriStatusId &&
2197 !in_array($contributionStatuses[$previousContriStatusId], [
2202 // this is case when we already processed contribution object.
2203 return $updateResult;
2205 elseif (!$previousContriStatusId &&
2206 !in_array($contributionStatuses[$contribution->contribution_status_id
], [
2211 // this is case when we are going to process contribution object later.
2212 return $updateResult;
2215 if (is_array($memberships)) {
2216 foreach ($memberships as $membership) {
2221 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
2222 $membership->membership_type_id
,
2223 $membership->is_test
, $membership->id
2226 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
2227 // this picks up membership type changes during renewals
2229 SELECT membership_type_id
2230 FROM civicrm_membership_log
2231 WHERE membership_id=$membership->id
2234 $dao = new CRM_Core_DAO();
2236 if ($dao->fetch()) {
2237 if (!empty($dao->membership_type_id
)) {
2238 $membership->membership_type_id
= $dao->membership_type_id
;
2239 $membership->save();
2242 // else fall back to using current membership type
2243 // Figure out number of terms
2245 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
2246 foreach ($lineitems as $lineitem) {
2247 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
2248 $numterms = $lineitem['membership_num_terms'] ??
NULL;
2250 // in case membership_num_terms comes through as null or zero
2251 $numterms = $numterms >= 1 ?
$numterms : 1;
2256 // CRM-15735-to update the membership status as per the contribution receive date
2258 $oldStatus = $membership->status_id
;
2259 if (!empty($params['receive_date'])) {
2260 $joinDate = $params['receive_date'];
2261 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
2262 $membership->end_date
,
2263 $membership->join_date
,
2264 $params['receive_date'],
2266 $membership->membership_type_id
,
2269 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
2270 $membership->save();
2273 if ($currentMembership) {
2274 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
2275 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
2276 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
2279 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
2282 //get the status for membership.
2283 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
2285 $dates['join_date'],
2288 $membership->membership_type_id
,
2292 $formattedParams = [
2293 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
2294 array_search('Current', $membershipStatuses)
2296 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
2297 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
2298 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
2301 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
2303 $membership->copyValues($formattedParams);
2304 $membership->save();
2306 //updating the membership log
2307 $membershipLog = [];
2308 $membershipLog = $formattedParams;
2309 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
2310 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
2312 $membershipLog['start_date'] = $logStartDate;
2313 $membershipLog['membership_id'] = $membership->id
;
2314 $membershipLog['modified_id'] = $membership->contact_id
;
2315 $membershipLog['modified_date'] = date('Ymd');
2316 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
2318 CRM_Member_BAO_MembershipLog
::add($membershipLog);
2320 //update related Memberships.
2321 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
2323 foreach (['Membership Signup', 'Membership Renewal'] as $activityType) {
2324 $scheduledActivityID = CRM_Utils_Array
::value('id',
2325 civicrm_api3('Activity', 'Get',
2327 'source_record_id' => $membership->id
,
2328 'activity_type_id' => $activityType,
2329 'status_id' => 'Scheduled',
2332 'sort' => 'id DESC',
2337 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2338 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2339 if ($scheduledActivityID) {
2340 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, ['id' => $scheduledActivityID]);
2345 // track membership status change if any
2346 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
2347 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
2348 CRM_Activity_BAO_Activity
::addActivity($membership,
2349 'Change Membership Status',
2352 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2353 'source_contact_id' => $membershipLog['modified_id'],
2354 'priority_id' => 'Normal',
2359 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2360 if ($processContributionObject) {
2361 $processContribution = TRUE;
2364 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2370 $updatedStatusId = array_search('Registered', $participantStatuses);
2371 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2373 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2374 if ($processContributionObject) {
2375 $processContribution = TRUE;
2379 if ($pledgePayment) {
2380 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2382 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2383 if ($processContributionObject) {
2384 $processContribution = TRUE;
2389 // process contribution object.
2390 if ($processContribution) {
2391 $contributionParams = [];
2398 'payment_instrument_id',
2401 'financial_type_id',
2402 'contribution_status_id',
2403 'non_deductible_amount',
2407 foreach ($fields as $field) {
2408 if (empty($params[$field])) {
2411 $contributionParams[$field] = $params[$field];
2414 $contributionParams['id'] = $contributionId;
2415 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams);
2418 return $updateResult;
2422 * Returns all contribution related object ids.
2424 * @param $contributionId
2428 public static function getComponentDetails($contributionId) {
2429 $componentDetails = $pledgePayment = [];
2430 if (!$contributionId) {
2431 return $componentDetails;
2435 SELECT c.id as contribution_id,
2436 c.contact_id as contact_id,
2437 c.contribution_recur_id,
2438 mp.membership_id as membership_id,
2439 m.membership_type_id as membership_type_id,
2440 pp.participant_id as participant_id,
2441 p.event_id as event_id,
2442 pgp.id as pledge_payment_id
2443 FROM civicrm_contribution c
2444 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2445 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2446 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2447 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2448 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2449 WHERE c.id = $contributionId";
2451 $dao = CRM_Core_DAO
::executeQuery($query);
2452 $componentDetails = [];
2454 while ($dao->fetch()) {
2455 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2456 $componentDetails['contact_id'] = $dao->contact_id
;
2457 if ($dao->event_id
) {
2458 $componentDetails['event'] = $dao->event_id
;
2460 if ($dao->participant_id
) {
2461 $componentDetails['participant'] = $dao->participant_id
;
2463 if ($dao->membership_id
) {
2464 if (!isset($componentDetails['membership'])) {
2465 $componentDetails['membership'] = $componentDetails['membership_type'] = [];
2467 $componentDetails['membership'][] = $dao->membership_id
;
2468 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2470 if ($dao->pledge_payment_id
) {
2471 $pledgePayment[] = $dao->pledge_payment_id
;
2473 if ($dao->contribution_recur_id
) {
2474 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2478 if ($pledgePayment) {
2479 $componentDetails['pledge_payment'] = $pledgePayment;
2482 return $componentDetails;
2486 * @param int $contactId
2487 * @param bool $includeSoftCredit
2489 * @return null|string
2491 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2495 $financialTypes = CRM_Financial_BAO_FinancialType
::getAllAvailableFinancialTypes();
2496 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2497 $liWhere = " AND i.financial_type_id IN (0)";
2498 if (!empty($financialTypes)) {
2499 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2500 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2502 $contactContributionsSQL = "
2503 SELECT contribution.id AS id
2504 FROM civicrm_contribution contribution
2505 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2506 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2510 $contactSoftCreditContributionsSQL = "
2511 SELECT contribution.id
2512 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2513 ON ( contribution.id = softContribution.contribution_id )
2514 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2515 $query = "SELECT count( x.id ) count FROM ( ";
2516 $query .= $contactContributionsSQL;
2518 if ($includeSoftCredit) {
2519 $query .= " UNION ";
2520 $query .= $contactSoftCreditContributionsSQL;
2525 return CRM_Core_DAO
::singleValueQuery($query);
2529 * Repeat a transaction as part of a recurring series.
2532 * 1) Processor calls contribution.repeattransaction with contribution_status_id = Pending
2533 * 2) The repeattransaction loads the 'template contribution' and calls a hook to allow altering of it .
2534 * 3) Repeat transaction calls order.create to create the pending contribution with correct line items
2535 * and associated entities.
2536 * 4) The calling code calls Payment.create which in turn calls CompleteOrder (if completing)
2537 * which updates the various entities and sends appropriate emails.
2539 * Gaps in the above (@todo)
2540 * 1) many processors still call repeattransaction with contribution_status_id = Completed
2541 * 2) repeattransaction code is current munged into completeTransaction code for historical bad coding reasons
2542 * 3) Repeat transaction duplicates rather than calls Order.create
2543 * 4) Use of payment.create still limited - completetransaction is more common.
2544 * 5) the template transaction is tricky - historically we used the first contribution
2545 * linked to a recurring contribution. More recently that was changed to be the most recent.
2546 * Ideally it would be an actual template - not a contribution used as a template which
2547 * would give more appropriate flexibility. Note line_items have an entity so that table
2548 * could be used for the line item template - the difficulty is the custom fields...
2549 * 6) the determination of the membership to be linked is tricksy. The prioritised method is
2550 * to load the membership(s) referred to via line items in the template transactions. Any other
2551 * method is likely to lead to incorrect line items & related entities being created (as the line_item
2552 * link is a required part of 'correct data'). However there are 3 other methods to determine it
2553 * - membership_payment record
2554 * - civicrm_membership.contribution_recur_id
2556 * Passing in an input override WILL ensure the membership is extended to prevent regressions
2557 * of historical processors since this has been handled 'forever' - specifically for paypal.
2558 * albeit by an even nastier mechanism than the current input override.
2559 * The count is out on how correct related entities wind up in this case.
2561 * @param CRM_Contribute_BAO_Contribution $contribution
2562 * @param array $input
2563 * @param array $contributionParams
2564 * @param int $paymentProcessorID
2567 * @throws CiviCRM_API3_Exception
2569 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2570 if (!empty($contribution->id
)) {
2573 if (empty($contribution->id
)) {
2574 // Unclear why this would only be set for repeats.
2575 if (!empty($input['amount'])) {
2576 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2579 if (!empty($contributionParams['contribution_recur_id'])) {
2580 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', [
2581 'id' => $contributionParams['contribution_recur_id'],
2583 if (!empty($recurringContribution['campaign_id'])) {
2584 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2585 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2587 if (!empty($recurringContribution['financial_type_id'])) {
2588 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2589 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2592 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2593 $contributionParams['contribution_recur_id'],
2594 array_intersect_key($contributionParams, [
2595 'total_amount' => TRUE,
2596 'financial_type_id' => TRUE,
2599 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2601 $contributionParams['status_id'] = 'Pending';
2602 if (isset($contributionParams['financial_type_id'])) {
2603 // Give precedence to passed in type.
2604 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2607 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2609 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2610 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2612 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2613 //do not create CC or BCC emails or profile notifications.
2614 //The if is just to be safe. Not sure if we can ever arrive with this unset
2615 // but per CRM-19478 it seems it can be 'null'
2616 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2617 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2619 if (!empty($contribution->tax_amount
)) {
2620 $contributionParams['tax_amount'] = $contribution->tax_amount
;
2623 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2624 $contribution->id
= $createContribution['id'];
2625 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2626 self
::handleMembershipIDOverride($contribution->id
, $input);
2632 * Get individual id for onbehalf contribution.
2634 * @param int $contributionId
2636 * @param int $contributorId
2640 * containing organization id and individual id
2642 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2646 if (!$contributionId) {
2650 // fetch contributor id if null
2651 if (!$contributorId) {
2652 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2653 $contributionId, 'contact_id'
2657 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2658 $activityTypeId = array_search('Contribution', $activityTypeIds);
2660 if ($activityTypeId && $contributorId) {
2662 SELECT civicrm_activity_contact.contact_id
2663 FROM civicrm_activity_contact
2664 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2665 WHERE civicrm_activity.activity_type_id = %1
2666 AND civicrm_activity.source_record_id = %2
2667 AND civicrm_activity_contact.record_type_id = %3
2670 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2671 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2674 1 => [$activityTypeId, 'Integer'],
2675 2 => [$contributionId, 'Integer'],
2676 3 => [$sourceID, 'Integer'],
2679 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2681 // for on behalf contribution source is individual and contributor is organization
2682 if ($sourceContactId && $sourceContactId != $contributorId) {
2683 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2684 // get rel type id for employee of relation
2685 foreach ($relationshipTypeIds as $id => $typeVals) {
2686 if ($typeVals['name_a_b'] == 'Employee of') {
2687 $relationshipTypeId = $id;
2692 $rel = new CRM_Contact_DAO_Relationship();
2693 $rel->relationship_type_id
= $relationshipTypeId;
2694 $rel->contact_id_a
= $sourceContactId;
2695 $rel->contact_id_b
= $contributorId;
2696 if ($rel->find(TRUE)) {
2697 $ids['individual_id'] = $rel->contact_id_a
;
2698 $ids['organization_id'] = $rel->contact_id_b
;
2709 public static function getContributionDates() {
2710 $config = CRM_Core_Config
::singleton();
2711 $currentMonth = date('m');
2712 $currentDay = date('d');
2713 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2714 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2715 (int ) $config->fiscalYearStart
['d'] > $currentDay
2718 $year = date('Y') - 1;
2723 $year = ['Y' => $year];
2724 $yearDate = $config->fiscalYearStart
;
2725 $yearDate = array_merge($year, $yearDate);
2726 $yearDate = CRM_Utils_Date
::format($yearDate);
2728 $monthDate = date('Ym') . '01';
2734 'yearDate' => $yearDate,
2735 'monthDate' => $monthDate,
2740 * Load objects relations to contribution object.
2741 * Objects are stored in the $_relatedObjects property
2742 * In the first instance we are just moving functionality from BASEIpn -
2744 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2746 * Note that the unit test for the BaseIPN class tests this function
2748 * @param array $input
2749 * Input as delivered from Payment Processor.
2751 * Ids as Loaded by Payment Processor.
2752 * @param bool $loadAll
2753 * Load all related objects - even where id not passed in? (allows API to call this).
2758 public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2759 // @todo deprecate this function - the steps should be
2760 // 1) add additional functions like 'getRelatedMemberships'
2761 // 2) switch all calls that refer to ->_relatedObjects to
2762 // using the helper functions
2763 // 3) make ->_relatedObjects noisy in some way (deprecation won't work for properties - hmm
2764 // 4) make ->_relatedObjects protected
2765 // 5) hone up the individual functions to not use rely on this having been called
2766 // 6) deprecate like mad
2768 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2769 if (empty($ids['contact']) && isset($this->contact_id
)) {
2770 $ids['contact'] = $this->contact_id
;
2773 if (empty($this->_component
)) {
2774 if (!empty($ids['event'])) {
2775 $this->_component
= 'event';
2778 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2782 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2783 // refactoring than anything else, and has unit test coverage.
2784 if (empty($this->financial_type_id
)) {
2788 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2793 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2794 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2795 $this->contribution_page_id
,
2798 if ($paymentProcessorID) {
2799 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2803 $ids['contributionType'] = $this->financial_type_id
;
2804 $ids['financialType'] = $this->financial_type_id
;
2805 if ($this->contribution_page_id
) {
2806 $ids['contributionPage'] = $this->contribution_page_id
;
2809 $this->loadRelatedEntitiesByID($ids);
2811 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2812 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2815 if (!empty($ids['pledge_payment'])) {
2816 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2817 if (empty($paymentID)) {
2820 $payment = new CRM_Pledge_BAO_PledgePayment();
2821 $payment->id
= $paymentID;
2822 if (!$payment->find(TRUE)) {
2823 throw new Exception("Could not find pledge payment record: " . $paymentID);
2825 $this->_relatedObjects
['pledge_payment'][] = $payment;
2829 // These are probably no longer accessed from anywhere
2830 // @todo remove this line, after ensuring not used.
2831 $ids = $this->loadRelatedMembershipObjects($ids);
2833 if ($this->_component
!= 'contribute') {
2834 // we are in event mode
2835 // make sure event exists and is valid
2836 $event = new CRM_Event_BAO_Event();
2837 $event->id
= $ids['event'];
2838 if ($ids['event'] &&
2841 throw new Exception("Could not find event: " . $ids['event']);
2844 $this->_relatedObjects
['event'] = &$event;
2846 $participant = new CRM_Event_BAO_Participant();
2847 $participant->id
= $ids['participant'];
2848 if ($ids['participant'] &&
2849 !$participant->find(TRUE)
2851 throw new Exception("Could not find participant: " . $ids['participant']);
2853 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2855 $this->_relatedObjects
['participant'] = &$participant;
2857 // get the payment processor id from event - this is inaccurate see CRM-16923
2858 // in future we should look at throwing an exception here rather than an dubious guess.
2859 if (!$paymentProcessorID) {
2860 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2861 if ($paymentProcessorID) {
2862 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2867 if ($paymentProcessorID) {
2868 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2869 $this->is_test ?
'test' : 'live'
2871 $ids['paymentProcessor'] = $paymentProcessorID;
2872 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2875 // Add contribution id to $ids. CRM-20401
2876 $ids['contribution'] = $this->id
;
2881 * Create array of message information - ie. return html version, txt version, to field
2883 * @param array $input
2884 * Incoming information.
2885 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2886 * just check presence of recur object but maintaining legacy approach
2889 * IDs of related objects.
2890 * @param array $values
2891 * Any values that may have already been compiled by calling process.
2892 * This is augmented by values 'gathered' by gatherMessageValues
2893 * @param bool $returnMessageText
2894 * Distinguishes between whether to send message or return.
2895 * message text. We are working towards this function ALWAYS returning message text & calling
2896 * function doing emails / pdfs with it
2902 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2903 $this->loadRelatedObjects($input, $ids);
2905 if (empty($this->_component
)) {
2906 $this->_component
= $input['component'] ??
NULL;
2909 //not really sure what params might be passed in but lets merge em into values
2910 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2911 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2912 if (!empty($input['receipt_date'])) {
2913 $values['receipt_date'] = $input['receipt_date'];
2916 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2917 //what does recur 'mean here - to do with payment processor return functionality but
2918 // what is the importance
2919 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2920 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2922 $entityID = $entity = NULL;
2923 if (isset($ids['contribution'])) {
2924 $entity = 'contribution';
2925 $entityID = $ids['contribution'];
2927 if (!empty($ids['membership'])) {
2928 //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
2929 // 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
2930 // line having loaded an array
2931 $ids['membership'] = (array) $ids['membership'];
2932 $entity = 'membership';
2933 $entityID = $ids['membership'][0];
2936 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2937 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2938 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2940 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2941 //direct mode showing billing block, so use directIPN for temporary
2942 $template->assign('contributeMode', 'directIPN');
2945 // todo remove strtolower - check consistency
2946 if (strtolower($this->_component
) == 'event') {
2947 $eventParams = ['id' => $this->_relatedObjects
['participant']->event_id
];
2948 $values['event'] = [];
2950 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2952 //get location details
2954 'entity_id' => $this->_relatedObjects
['participant']->event_id
,
2955 'entity_table' => 'civicrm_event',
2957 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2960 'entity_table' => 'civicrm_event',
2961 'entity_id' => $ids['event'],
2962 'module' => 'CiviEvent',
2965 list($custom_pre_id,
2967 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2969 $values['custom_pre_id'] = $custom_pre_id;
2970 $values['custom_post_id'] = $custom_post_ids;
2971 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2972 //and cases involving status updation through ipn
2973 // whatever that means!
2974 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2975 // perhaps we should throw an e-notice if amount is set & force total_amount?
2976 if (!empty($input['amount'])) {
2977 $values['totalAmount'] = $input['amount'];
2979 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2980 if ($values['event']['is_email_confirm']) {
2981 $values['is_email_receipt'] = 1;
2984 if (!empty($ids['contribution'])) {
2985 $values['contributionId'] = $ids['contribution'];
2988 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
2989 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
2993 $values['contribution_id'] = $this->id
;
2994 if (!empty($ids['related_contact'])) {
2995 $values['related_contact'] = $ids['related_contact'];
2996 if (isset($ids['onbehalf_dupe_alert'])) {
2997 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
3000 'contact_id' => $ids['contact'],
3001 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
3002 'Home', 'id', 'name'
3005 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
3006 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
3009 if ($this->is_test
) {
3012 if (!empty($this->_relatedObjects
['membership'])) {
3013 foreach ($this->_relatedObjects
['membership'] as $membership) {
3014 if ($membership->id
) {
3015 $values['membership_id'] = $membership->id
;
3016 $values['isMembership'] = TRUE;
3017 $values['membership_assign'] = TRUE;
3019 // need to set the membership values here
3020 $template->assign('membership_name',
3021 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
3023 $template->assign('mem_start_date', $membership->start_date
);
3024 $template->assign('mem_join_date', $membership->join_date
);
3025 $template->assign('mem_end_date', $membership->end_date
);
3026 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
3027 $template->assign('mem_status', $membership_status);
3028 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
3029 $values['is_pay_later'] = 1;
3031 // Pass amount to floatval as string '0.00' is considered a
3032 // valid amount and includes Fee section in the mail.
3033 if (isset($values['amount'])) {
3034 $values['amount'] = floatval($values['amount']);
3037 if (!empty($this->contribution_recur_id
) && $paymentObject) {
3038 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
3039 $template->assign('cancelSubscriptionUrl', $url);
3040 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
3041 $template->assign('updateSubscriptionBillingUrl', $url);
3042 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
3043 $template->assign('updateSubscriptionUrl', $url);
3046 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3049 // otherwise if its about sending emails, continue sending without return, as we
3050 // don't want to exit the loop.
3055 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
3061 * Gather values for contribution mail - this function has been created
3062 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
3063 * Values related to the contribution in question are gathered
3065 * @param array $input
3066 * Input into function (probably from payment processor).
3067 * @param array $values
3069 * The set of ids related to the input.
3072 * @throws \CRM_Core_Exception
3074 public function _gatherMessageValues($input, &$values, $ids = []) {
3075 // set display address of contributor
3076 $values['billingName'] = '';
3077 if ($this->address_id
) {
3078 $addressDetails = CRM_Core_BAO_Address
::getValues(['id' => $this->address_id
], FALSE, 'id');
3079 $addressDetails = reset($addressDetails);
3080 $values['billingName'] = $addressDetails['name'] ??
'';
3082 // Else we assign the billing address of the contribution contact.
3084 $addressDetails = (array) CRM_Core_BAO_Address
::getValues(['contact_id' => $this->contact_id
, 'is_billing' => 1]);
3085 $addressDetails = reset($addressDetails);
3087 $values['address'] = $addressDetails['display'] ??
'';
3089 if ($this->_component
=== 'contribute') {
3090 //get soft contributions
3091 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
3092 if (!empty($softContributions)) {
3093 $values['softContributions'] = $softContributions['soft_credit'];
3095 if (isset($this->contribution_page_id
)) {
3096 // This is a call we want to use less, in favour of loading related objects.
3097 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
3098 if ($this->contribution_page_id
) {
3099 // This is precautionary as there are some legacy flows, but it should really be
3101 if (!isset($this->_relatedObjects
['contributionPage'])) {
3102 $this->loadRelatedEntitiesByID(['contributionPage' => $this->contribution_page_id
]);
3104 CRM_Contribute_BAO_Contribution_Utils
::overrideDefaultCurrency($values);
3107 // no contribution page -probably back office
3109 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
3110 $values['title'] = 'Contribution';
3112 // set lineItem for contribution
3114 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
3115 if (!empty($lineItems)) {
3116 $firstLineItem = reset($lineItems);
3118 if (!empty($firstLineItem['price_set_id'])) {
3119 $priceSet = civicrm_api3('PriceSet', 'getsingle', [
3120 'id' => $firstLineItem['price_set_id'],
3121 'return' => 'is_quick_config, id',
3123 $values['priceSetID'] = $priceSet['id'];
3125 foreach ($lineItems as &$eachItem) {
3126 if (isset($this->_relatedObjects
['membership'])
3127 && is_array($this->_relatedObjects
['membership'])
3128 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
3129 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
3130 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
3131 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
3133 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
3134 // However, that does create upgrade pain so would be better to be phased in.
3135 $values['useForMember'] = empty($priceSet['is_quick_config']);
3137 $values['lineItem'][0] = $lineItems;
3141 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
3145 // if this is onbehalf of contribution then set related contact
3146 if (!empty($relatedContact['individual_id'])) {
3147 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
3151 $values = array_merge($values, $this->loadEventMessageTemplateParams((int) $ids['event'], (int) $this->_relatedObjects
['participant']->id
, $this->id
));
3154 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', NULL, $this->id
);
3157 foreach ($groupTree as $key => $group) {
3158 if ($key === 'info') {
3162 foreach ($group['fields'] as $k => $customField) {
3163 $groupLabel = $group['title'];
3164 if (!empty($customField['customValue'])) {
3165 foreach ($customField['customValue'] as $customFieldValues) {
3166 $customGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
3171 $values['customGroup'] = $customGroup;
3173 $values['is_pay_later'] = $this->is_pay_later
;
3179 * Assign message variables to template but try to break the habit.
3181 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
3182 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
3183 * multiple recurring payments for processors like IATS that use tokens.
3185 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
3186 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
3187 * Note we send directly from this function in some cases because it is only partly refactored.
3189 * Don't call this function directly as the signature will change.
3193 * @param bool $returnMessageText
3197 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
3198 // @todo - this should have a better separation of concerns - ie.
3199 // gatherMessageValues should build an array of values to be assigned to the template
3200 // and this function should assign them (assigning null if not set).
3201 // the way the pcpParams & honor Params section works is a baby-step towards this.
3202 $template = CRM_Core_Smarty
::singleton();
3203 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
3204 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
3205 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
3206 $template->assign('billingName', $values['billingName']);
3208 // For some unit tests contribution cannot contain paymentProcessor information
3209 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
3210 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
3212 //assign honor information to receipt message
3213 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
3216 'soft_credit_type' => NULL,
3217 'honor_block_is_active' => NULL,
3219 if (isset($softRecord['soft_credit'])) {
3220 //if id of contribution page is present
3221 if (!empty($values['id'])) {
3222 $values['honor'] = [
3223 'honor_profile_values' => [],
3224 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
3225 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
3228 $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
3229 $honorParams['honor_block_is_active'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
3232 //offline contribution
3233 $softCreditTypes = $softCredits = [];
3234 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
3235 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
3236 $softCredits[$key] = [
3237 'Name' => $softCredit['contact_name'],
3238 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
3241 $template->assign('softCreditTypes', $softCreditTypes);
3242 $template->assign('softCredits', $softCredits);
3246 $dao = new CRM_Contribute_DAO_ContributionProduct();
3247 $dao->contribution_id
= $this->id
;
3248 if ($dao->find(TRUE)) {
3249 $premiumId = $dao->product_id
;
3250 $template->assign('option', $dao->product_option
);
3252 $productDAO = new CRM_Contribute_DAO_Product();
3253 $productDAO->id
= $premiumId;
3254 $productDAO->find(TRUE);
3255 $template->assign('selectPremium', TRUE);
3256 $template->assign('product_name', $productDAO->name
);
3257 $template->assign('price', $productDAO->price
);
3258 $template->assign('sku', $productDAO->sku
);
3260 $template->assign('title', CRM_Utils_Array
::value('title', $values));
3261 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
3262 if (!$values['amount'] && isset($this->total_amount
)) {
3263 $values['amount'] = $this->total_amount
;
3268 'pcp_display_in_roll' => NULL,
3269 'pcp_roll_nickname' => NULL,
3270 'pcp_personal_note' => NULL,
3274 if (strtolower($this->_component
) == 'contribute') {
3276 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3277 $softDAO->contribution_id
= $this->id
;
3278 if ($softDAO->find(TRUE)) {
3279 $pcpParams['pcpBlock'] = TRUE;
3280 $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll
;
3281 $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname
;
3282 $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note
;
3284 //assign the pcp page title for email subject
3285 $pcpDAO = new CRM_PCP_DAO_PCP();
3286 $pcpDAO->id
= $softDAO->pcp_id
;
3287 if ($pcpDAO->find(TRUE)) {
3288 $pcpParams['title'] = $pcpDAO->title
;
3292 foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3293 $template->assign($templateKey, $templateValue);
3296 if ($this->financial_type_id
) {
3297 $values['financial_type_id'] = $this->financial_type_id
;
3300 $template->assign('trxn_id', $this->trxn_id
);
3301 $template->assign('receive_date',
3302 CRM_Utils_Date
::processDate($this->receive_date
)
3304 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
3305 $template->assign('action', $this->is_test ?
1024 : 1);
3306 $template->assign('receipt_text',
3307 CRM_Utils_Array
::value('receipt_text',
3311 $template->assign('is_monetary', 1);
3312 $template->assign('is_recur', !empty($this->contribution_recur_id
));
3313 $template->assign('currency', $this->currency
);
3314 $template->assign('address', CRM_Utils_Address
::format($input));
3315 if (!empty($values['customGroup'])) {
3316 $template->assign('customGroup', $values['customGroup']);
3318 if (!empty($values['softContributions'])) {
3319 $template->assign('softContributions', $values['softContributions']);
3321 if ($this->_component
== 'event') {
3322 $template->assign('title', $values['event']['title']);
3323 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
3325 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
3326 $viewRoles[] = $participantRoles[$v];
3328 $values['event']['participant_role'] = implode(', ', $viewRoles);
3329 $template->assign('event', $values['event']);
3330 $template->assign('participant', $values['participant']);
3331 $template->assign('location', $values['location']);
3332 $template->assign('customPre', $values['custom_pre_id']);
3333 $template->assign('customPost', $values['custom_post_id']);
3336 if ($this->_relatedObjects
['participant']->is_test
) {
3340 $values['params'] = [];
3341 //to get email of primary participant.
3342 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
3343 $primaryAmount[] = [
3344 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3345 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3347 //build an array of cId/pId of participants
3348 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3349 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3350 //send receipt to additional participant if exists
3351 if (count($additionalIDs)) {
3352 $template->assign('isPrimary', 0);
3353 $template->assign('customProfile', NULL);
3354 //set additionalParticipant true
3355 $values['params']['additionalParticipant'] = TRUE;
3356 foreach ($additionalIDs as $pId => $cId) {
3358 //to change the status pending to completed
3359 $additional = new CRM_Event_DAO_Participant();
3360 $additional->id
= $pId;
3361 $additional->contact_id
= $cId;
3362 $additional->find(TRUE);
3363 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3364 $additional->status_id
= 1;
3365 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3366 //if additional participant dont have email
3368 if (!$additionalParticipantInfo) {
3369 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3372 'label' => $additional->fee_level
,
3373 'amount' => $additional->fee_amount
,
3375 $primaryAmount[] = [
3376 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3377 'amount' => $additional->fee_amount
,
3379 $additional->save();
3380 $template->assign('amount', $amount);
3381 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3385 //build an array of custom profile and assigning it to template
3386 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3388 if (count($customProfile)) {
3389 $template->assign('customProfile', $customProfile);
3392 // for primary contact
3393 $values['params']['additionalParticipant'] = FALSE;
3394 $template->assign('isPrimary', 1);
3395 $template->assign('amount', $primaryAmount);
3396 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3397 if ($this->payment_instrument_id
) {
3398 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3399 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3401 // carry paylater, since we did not created billing,
3402 // so need to pull email from primary location, CRM-4395
3403 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3409 * Check whether payment processor supports
3410 * cancellation of contribution subscription
3412 * @param int $contributionId
3415 * @param bool $isNotCancelled
3419 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3420 $cacheKeyString = "$contributionId";
3421 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3423 static $supportsCancel = [];
3425 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3426 $supportsCancel[$cacheKeyString] = FALSE;
3427 $isCancelled = FALSE;
3429 if ($isNotCancelled) {
3430 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3433 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3434 if (!empty($paymentObject)) {
3435 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3438 return $supportsCancel[$cacheKeyString];
3442 * Check whether subscription is already cancelled.
3444 * @param int $contributionId
3448 * contribution status
3450 public static function isSubscriptionCancelled($contributionId) {
3452 SELECT cr.contribution_status_id
3453 FROM civicrm_contribution_recur cr
3454 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3455 WHERE con.id = %1 LIMIT 1";
3456 $params = [1 => [$contributionId, 'Integer']];
3457 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3458 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId, 'name');
3459 if ($status == 'Cancelled') {
3466 * Create all financial accounts entry.
3468 * @param array $params
3469 * Contribution object, line item array and params for trxn.
3472 * @param array $financialTrxnValues
3474 * @return null|\CRM_Core_BAO_FinancialTrxn
3476 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3477 $skipRecords = $update = $return = $isRelatedId = FALSE;
3478 $isUpdate = !empty($params['prevContribution']);
3480 $additionalParticipantId = [];
3481 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3482 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3484 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3485 $entityId = $params['participant_id'];
3486 $entityTable = 'civicrm_participant';
3487 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3489 elseif (!empty($params['membership_id'])) {
3490 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3491 // are created off one contribution should be handled elsewhere
3492 $entityId = $params['membership_id'];
3493 $entityTable = 'civicrm_membership';
3496 $entityId = $params['contribution']->id
;
3497 $entityTable = 'civicrm_contribution';
3500 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3501 $isRelatedId = TRUE;
3504 $entityID[] = $entityId;
3505 if (!empty($additionalParticipantId)) {
3506 $entityID +
= $additionalParticipantId;
3508 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3509 if (empty($params['prevContribution'])) {
3513 $statusId = $params['contribution']->contribution_status_id
;
3514 // CRM-13964 partial payment
3515 if ($contributionStatus == 'Partially paid'
3516 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3518 CRM_Core_Error
::deprecatedFunctionWarning('partial_amount params are deprecated from Contribution.create - use Payment.create');
3519 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_to_pay']);
3520 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3522 $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3523 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3524 $params['total_amount'] = $partialAmtPay;
3526 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3527 if (empty($balanceTrxnInfo['trxn_id'])) {
3528 // create new balance transaction record
3529 $toFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3531 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3532 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3533 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3534 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3535 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
3536 $balanceTrxnParams['net_amount'] = $params['net_amount'] ??
NULL;
3537 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3538 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3539 $balanceTrxnParams['status_id'] = $statusId;
3540 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3541 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
3542 $balanceTrxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3543 $balanceTrxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3544 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3545 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3547 $balanceTrxnParams['is_payment'] = 1;
3549 if (!empty($params['payment_processor'])) {
3550 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3552 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3556 // build line item array if its not set in $params
3557 if (empty($params['line_item']) ||
$additionalParticipantId) {
3558 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3561 if ($contributionStatus != 'Failed' &&
3562 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3564 $skipRecords = TRUE;
3569 if (in_array($contributionStatus, $pendingStatus)) {
3570 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3571 $params['financial_type_id'],
3572 'Accounts Receivable Account is'
3575 elseif (!empty($params['payment_processor'])) {
3576 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3577 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', [
3578 'id' => $params['payment_processor'],
3579 'return' => 'payment_instrument_id',
3582 elseif (!empty($params['payment_instrument_id'])) {
3583 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3586 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3587 $queryParams = [1 => [$relationTypeId, 'Integer']];
3588 $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);
3591 $totalAmount = $params['total_amount'] ??
NULL;
3592 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3593 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3595 //build financial transaction params
3597 'contribution_id' => $params['contribution']->id
,
3598 'to_financial_account_id' => $params['to_financial_account_id'],
3599 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3600 'total_amount' => $totalAmount,
3601 'fee_amount' => $params['fee_amount'] ??
NULL,
3602 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3603 'currency' => $params['contribution']->currency
,
3604 'trxn_id' => $params['contribution']->trxn_id
,
3605 // @todo - this is getting the status id from the contribution - that is BAD - ie the contribution could be partially
3606 // paid but each payment is completed. The work around is to pass in the status_id in the trxn_params but
3607 // this should really default to completed (after discussion).
3608 'status_id' => $statusId,
3609 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3610 'check_number' => $params['check_number'] ??
NULL,
3611 'pan_truncation' => $params['pan_truncation'] ??
NULL,
3612 'card_type_id' => $params['card_type_id'] ??
NULL,
3614 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3615 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3616 if (isset($params['refund_trxn_id'])) {
3617 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3618 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3621 //CRM-16259, set is_payment flag for non pending status
3622 if (!in_array($contributionStatus, $pendingStatus)) {
3623 $trxnParams['is_payment'] = 1;
3625 if (!empty($params['payment_processor'])) {
3626 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3629 if (isset($fromFinancialAccountId)) {
3630 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3633 // consider external values passed for recording transaction entry
3634 if (!empty($financialTrxnValues)) {
3635 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3637 if (empty($trxnParams['payment_processor_id'])) {
3638 unset($trxnParams['payment_processor_id']);
3641 $params['trxnParams'] = $trxnParams;
3645 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3646 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3647 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3648 if (!isset($params['trxnParams']['trxn_id'])) {
3649 // Actually I have no idea why we are overwriting any values from the previous contribution.
3650 // (filling makes sense to me). However, only protecting this value as I really really know we
3651 // don't want this one overwritten.
3653 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3655 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3657 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3658 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3659 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3661 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3662 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3665 //if financial type is changed
3666 if (!empty($params['financial_type_id']) &&
3667 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3669 $accountRelationship = 'Income Account is';
3670 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3671 $accountRelationship = 'Deferred Revenue Account is';
3673 $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id
, $accountRelationship);
3674 $newFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3675 if ($oldFinancialAccount != $newFinancialAccount) {
3676 $params['total_amount'] = 0;
3677 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3678 $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3679 $params['prevContribution']->financial_type_id
, $accountRelationship);
3682 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3683 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3684 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3687 self
::updateFinancialAccounts($params, 'changeFinancialType');
3688 $params['skipLineItem'] = FALSE;
3689 foreach ($params['line_item'] as &$lineItems) {
3690 foreach ($lineItems as &$line) {
3691 $line['financial_type_id'] = $params['financial_type_id'];
3694 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changeFinancialType');
3695 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3696 $params['financial_account_id'] = $newFinancialAccount;
3697 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3698 self
::updateFinancialAccounts($params);
3699 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE);
3700 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3702 $params['deferred_financial_account_id'] = $newFinancialAccount;
3706 //Update contribution status
3707 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3708 if (!isset($params['refund_trxn_id'])) {
3709 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3710 // gets preference over another so I am only 'protecting' a very specific tested flow
3711 // and letting natural justice take care of the rest.
3712 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3714 if (!empty($params['contribution_status_id']) &&
3715 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3717 //Update Financial Records
3718 $callUpdateFinancialAccounts = self
::updateFinancialAccountsOnContributionStatusChange($params);
3719 if ($callUpdateFinancialAccounts) {
3720 self
::updateFinancialAccounts($params, 'changedStatus');
3721 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedStatus');
3726 // change Payment Instrument for a Completed contribution
3727 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3728 // instrument is null and now new payment instrument is added along with the payment
3729 if (!$params['contribution']->payment_instrument_id
) {
3730 $params['contribution']->find(TRUE);
3732 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3733 $params['trxnParams']['check_number'] = $params['check_number'] ??
NULL;
3735 if (self
::isPaymentInstrumentChange($params, $pendingStatus)) {
3736 $updated = CRM_Core_BAO_FinancialTrxn
::updateFinancialAccountsOnPaymentInstrumentChange($params);
3739 //if Change contribution amount
3740 $params['trxnParams']['fee_amount'] = $params['fee_amount'] ??
NULL;
3741 $params['trxnParams']['net_amount'] = $params['net_amount'] ??
NULL;
3742 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3743 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3744 if (isset($totalAmount) &&
3745 $totalAmount != $params['prevContribution']->total_amount
3747 //Update Financial Records
3748 $params['trxnParams']['from_financial_account_id'] = NULL;
3749 self
::updateFinancialAccounts($params, 'changedAmount');
3750 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, 'changedAmount');
3755 // Looks like we might have a data correction update.
3756 // This would be a case where a transaction id has been entered but it is incorrect &
3757 // the person goes back in & fixes it, as opposed to a new transaction.
3758 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3759 // the data fix scenario.
3761 if (isset($params['refund_trxn_id'])) {
3762 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3763 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3764 civicrm_api3('FinancialTrxn', 'create', [
3765 'id' => $refundIDs['financialTrxnId'],
3766 'trxn_id' => $params['refund_trxn_id'],
3770 $cardType = $params['card_type_id'] ??
NULL;
3771 $panTruncation = $params['pan_truncation'] ??
NULL;
3772 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3777 // records finanical trxn and entity financial trxn
3778 // also make it available as return value
3779 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3780 $trxnParams['pan_truncation'] = $params['pan_truncation'] ??
NULL;
3781 $trxnParams['card_type_id'] = $params['card_type_id'] ??
NULL;
3782 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3783 $params['entity_id'] = $financialTxn->id
;
3784 if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3785 self
::$_trxnIDs[] = $financialTxn->id
;
3789 // record line items and financial items
3790 if (empty($params['skipLineItem'])) {
3791 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $isUpdate);
3794 // create batch entry if batch_id is passed and
3795 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3796 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3798 'batch_id' => $params['batch_id'],
3799 'entity_table' => 'civicrm_financial_trxn',
3800 'entity_id' => $financialTxn->id
,
3802 CRM_Batch_BAO_EntityBatch
::create($entityParams);
3805 // when a fee is charged
3806 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3807 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3810 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3811 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3813 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3814 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3815 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3817 unset($params['line_item']);
3818 self
::$_trxnIDs = NULL;
3823 * Update all financial accounts entry.
3825 * @param array $params
3826 * Contribution object, line item array and params for trxn.
3828 * @param string $context
3831 * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3832 * adds unpredictability.
3835 public static function updateFinancialAccounts(&$params, $context = NULL) {
3837 $inputParams = $params;
3838 $isARefund = self
::isContributionUpdateARefund($params['prevContribution']->contribution_status_id
, $params['contribution']->contribution_status_id
);
3840 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3841 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3842 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3845 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3846 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3847 $params['entity_id'] = $trxn->id
;
3849 $itemParams['entity_table'] = 'civicrm_line_item';
3850 $trxnIds['id'] = $params['entity_id'];
3851 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution']->id
);
3852 foreach ($params['line_item'] as $fieldId => $fields) {
3853 $params = self
::createFinancialItemsForLine($params, $context, $fields, $previousLineItems, $inputParams, $isARefund, $trxnIds, $fieldId);
3858 * Is this contribution status a reversal.
3860 * If so we would expect to record a negative value in the financial_trxn table.
3862 * @param int $status_id
3866 public static function isContributionStatusNegative($status_id) {
3867 $reversalStatuses = ['Cancelled', 'Chargeback', 'Refunded'];
3868 return in_array(CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $status_id), $reversalStatuses, TRUE);
3872 * Check status validation on update of a contribution.
3874 * @param array $values
3875 * Previous form values before submit.
3877 * @param array $fields
3878 * The input form values.
3880 * @param array $errors
3885 public static function checkStatusValidation($values, &$fields, &$errors) {
3886 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3887 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3888 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3892 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3894 'Cancelled' => ['Completed', 'Refunded'],
3895 'Completed' => ['Cancelled', 'Refunded', 'Chargeback'],
3896 'Pending' => ['Cancelled', 'Completed', 'Failed', 'Partially paid'],
3897 'In Progress' => ['Cancelled', 'Completed', 'Failed'],
3898 'Refunded' => ['Cancelled', 'Completed'],
3899 'Partially paid' => ['Completed'],
3900 'Pending refund' => ['Completed', 'Refunded'],
3903 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3904 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, []))
3906 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", [
3907 1 => $contributionStatuses[$values['contribution_status_id']],
3908 2 => $contributionStatuses[$fields['contribution_status_id']],
3914 * Delete contribution of contact.
3918 * @param int $contactId
3922 public static function deleteContactContribution($contactId) {
3923 $contribution = new CRM_Contribute_DAO_Contribution();
3924 $contribution->contact_id
= $contactId;
3925 $contribution->find();
3926 while ($contribution->fetch()) {
3927 self
::deleteContribution($contribution->id
);
3932 * Get options for a given contribution field.
3934 * @param string $fieldName
3935 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3936 * @param array $props whatever is known about this dao object.
3938 * @return array|bool
3939 * @see CRM_Core_DAO::buildOptions
3942 public static function buildOptions($fieldName, $context = NULL, $props = []) {
3943 $className = __CLASS__
;
3945 if (isset($props['orderColumn'])) {
3946 $params['orderColumn'] = $props['orderColumn'];
3948 switch ($fieldName) {
3949 // This field is not part of this object but the api supports it
3950 case 'payment_processor':
3951 $className = 'CRM_Contribute_BAO_ContributionPage';
3952 // Filter results by contribution page
3953 if (!empty($props['contribution_page_id'])) {
3954 $page = civicrm_api('contribution_page', 'getsingle', [
3956 'id' => ($props['contribution_page_id']),
3958 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3959 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3963 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3964 case 'honor_type_id':
3965 $className = 'CRM_Contribute_BAO_ContributionSoft';
3966 $fieldName = 'soft_credit_type_id';
3967 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3970 case 'contribution_status_id':
3971 if ($context !== 'validate') {
3972 $params['condition'] = "v.name <> 'Template'";
3975 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3979 * Validate financial type.
3983 * @param int $financialTypeId
3984 * Financial Type id.
3986 * @param string $relationName
3988 * @return array|bool
3990 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3991 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
3993 if (!$financialAccount) {
3994 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
4000 * @param int $targetCid
4001 * @param $activityType
4002 * @param string $title
4003 * @param int $contributionId
4004 * @param string $totalAmount
4005 * @param string $currency
4006 * @param string $trxn_date
4008 * @throws \CRM_Core_Exception
4009 * @throws \CiviCRM_API3_Exception
4011 public static function addActivityForPayment($targetCid, $activityType, $title, $contributionId, $totalAmount, $currency, $trxn_date) {
4012 $paymentAmount = CRM_Utils_Money
::format($totalAmount, $currency);
4013 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
4014 $date = CRM_Utils_Date
::isoToMysql($trxn_date);
4015 // source record id would be the contribution id
4016 $srcRecId = $contributionId;
4020 'source_contact_id' => $targetCid,
4021 'source_record_id' => $srcRecId,
4022 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
4023 'subject' => $subject,
4024 'activity_date_time' => $date,
4025 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
4026 'skipRecentView' => TRUE,
4029 // create activity with target contacts
4030 $session = CRM_Core_Session
::singleton();
4031 $id = $session->get('userID');
4033 $activityParams['source_contact_id'] = $id;
4034 $activityParams['target_contact_id'][] = $targetCid;
4036 civicrm_api3('Activity', 'create', $activityParams);
4040 * Get list of payments displayed by Contribute_Page_PaymentInfo.
4043 * @param string $component
4044 * @param bool $getTrxnInfo
4048 * @throws \CRM_Core_Exception
4049 * @throws \CiviCRM_API3_Exception
4051 public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE) {
4052 // @todo deprecate passing in component - always call with contribution.
4053 if ($component == 'event') {
4054 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
4056 if (!$contributionId) {
4057 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
4058 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
4059 $id = $primaryParticipantId;
4061 if (!$contributionId) {
4066 elseif ($component == 'membership') {
4067 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
4070 $contributionId = $id;
4073 // The balance used to be calculated this way - we really want to remove this 'oldCalculation'
4074 // but need to unpick the whole trxn_id it's returning first.
4075 $oldCalculation = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
4076 $baseTrxnId = !empty($oldCalculation['trxn_id']) ?
$oldCalculation['trxn_id'] : NULL;
4078 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
4079 $baseTrxnId = $baseTrxnId['financialTrxnId'];
4081 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4083 $paymentBalance = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $total);
4085 $contribution = civicrm_api3('Contribution', 'getsingle', [
4086 'id' => $contributionId,
4090 'contribution_status_id',
4091 'financial_type_id',
4095 $info['payLater'] = $contribution['is_pay_later'];
4096 $info['contribution_status'] = $contribution['contribution_status'];
4097 $info['currency'] = $contribution['currency'];
4099 $info['total'] = $total;
4100 $info['paid'] = $total - $paymentBalance;
4101 $info['balance'] = $paymentBalance;
4103 $info['component'] = $component;
4104 if ($getTrxnInfo && $baseTrxnId) {
4105 $info['transaction'] = self
::getContributionTransactionInformation($contributionId, $contribution['financial_type_id']);
4108 $info['payment_links'] = self
::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4113 * Get the outstanding balance on a contribution.
4115 * @param int $contributionId
4116 * @param float $contributionTotal
4117 * Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4121 public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4122 if ($contributionTotal === NULL) {
4123 $contributionTotal = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4126 return (float) CRM_Utils_Money
::subtractCurrencies(
4128 CRM_Core_BAO_FinancialTrxn
::getTotalPayments($contributionId, TRUE),
4129 CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4134 * Get the tax amount (misnamed function).
4136 * @param array $params
4137 * @param bool $isLineItem
4141 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4142 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4144 // Update contribution.
4145 if (!empty($params['id'])) {
4146 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4147 // there are no tax implications - early return.
4148 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4151 if (empty($params['prevContribution'])) {
4152 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4155 foreach (['total_amount', 'financial_type_id', 'fee_amount'] as $field) {
4156 if (!isset($params[$field])) {
4157 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4158 // Tax amount gets added back on later....
4159 $params['total_amount'] = $params['prevContribution']->total_amount
-
4160 $params['prevContribution']->tax_amount
;
4163 $params[$field] = $params['prevContribution']->$field;
4164 if ($params[$field] != $params['prevContribution']->$field) {
4170 self
::calculateMissingAmountParams($params, $params['id']);
4171 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4172 // Assign tax Amount on update of contribution
4173 if (!empty($params['prevContribution']->tax_amount
)) {
4174 $params['tax_amount'] = 'null';
4175 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4176 foreach ($params['line_item'] as $setID => $priceField) {
4177 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4178 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4185 // New Contribution and update of contribution with tax rate financial type
4186 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4187 empty($params['skipLineItem']) && !$isLineItem
4189 $taxRateParams = $taxRates[$params['financial_type_id']];
4190 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams);
4191 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4193 // Get Line Item on update of contribution
4194 if (isset($params['id'])) {
4195 CRM_Price_BAO_LineItem
::getLineItemArray($params, [$params['id']]);
4198 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4200 foreach ($params['line_item'] as $setID => $priceField) {
4201 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4202 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4205 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4207 elseif (isset($params['api.line_item.create'])) {
4208 // Update total amount of contribution using lineItem
4209 $taxAmountArray = [];
4210 foreach ($params['api.line_item.create'] as $key => $value) {
4211 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4212 $taxRate = $taxRates[$value['financial_type_id']];
4213 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4214 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4217 $params['tax_amount'] = array_sum($taxAmountArray);
4218 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4221 // update line item of contrbution
4222 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4223 $taxRate = $taxRates[$params['financial_type_id']];
4224 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate);
4225 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4232 * Check financial type validation on update of a contribution.
4234 * @param int $financialTypeId
4235 * Value of latest Financial Type.
4237 * @param int $contributionId
4240 * @param array $errors
4245 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4246 if (!empty($financialTypeId)) {
4247 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4248 if ($oldFinancialTypeId == $financialTypeId) {
4252 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4254 '1' => [$contributionId, 'Integer'],
4256 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4257 if ($result->N
> 1) {
4258 $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.');
4263 * Update related pledge payment payments.
4265 * This function has been refactored out of the back office contribution form and may
4266 * still overlap with other functions.
4268 * @param string $action
4269 * @param int $pledgePaymentID
4270 * @param int $contributionID
4271 * @param bool $adjustTotalAmount
4272 * @param float $total_amount
4273 * @param float $original_total_amount
4274 * @param int $contribution_status_id
4275 * @param int $original_contribution_status_id
4277 public static function updateRelatedPledge(
4283 $original_total_amount,
4284 $contribution_status_id,
4285 $original_contribution_status_id
4287 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4291 if ($pledgePaymentID) {
4292 //store contribution id in payment record.
4293 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4296 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4303 if (!$pledgePaymentID) {
4306 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4312 $updatePledgePaymentStatus = FALSE;
4314 // If either the status or the amount has changed we update the pledge status.
4315 if ($action & CRM_Core_Action
::ADD
) {
4316 $updatePledgePaymentStatus = TRUE;
4318 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4319 ($original_total_amount != $total_amount))
4321 $updatePledgePaymentStatus = TRUE;
4324 if ($updatePledgePaymentStatus) {
4325 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4327 $contribution_status_id,
4336 * Compute the stats values
4338 * @param string $stat either 'mode' or 'median'
4339 * @param string $sql
4340 * @param string $alias of civicrm_contribution
4342 * @return array|null
4346 public static function computeStats($stat, $sql, $alias = NULL) {
4347 CRM_Core_Error
::deprecatedFunctionWarning('computeStats is now deprecated');
4352 * Is there only one line item attached to the contribution.
4358 * @throws \CiviCRM_API3_Exception
4360 public static function isSingleLineItem($id) {
4361 $lineItemCount = civicrm_api3('LineItem', 'getcount', ['contribution_id' => $id]);
4362 return ($lineItemCount == 1);
4366 * Complete an order.
4368 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4370 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4372 * Moving it out of the BaseIPN class is just the first step.
4374 * @param array $input
4376 * @param array $objects
4377 * @param CRM_Core_Transaction $transaction
4378 * It is not recommended to pass this in. The calling function handle it's own roll back if it wants it.
4379 * @param bool $isPostPaymentCreate
4380 * Is this being called from the payment.create api. If so the api has taken care of financial entities.
4381 * Note that our goal is that this would only ever be called from payment.create and never handle financials (only
4382 * transitioning related elements).
4385 * @throws \CRM_Core_Exception
4386 * @throws \CiviCRM_API3_Exception
4388 public static function completeOrder($input, &$ids, $objects, $transaction = NULL, $isPostPaymentCreate = FALSE) {
4389 if (!$transaction) {
4390 $transaction = new CRM_Core_Transaction();
4392 $contribution = $objects['contribution'];
4393 $primaryContributionID = $contribution->id ??
$objects['first_contribution']->id
;
4394 // The previous details are used when calculating line items so keep it before any code that 'does something'
4395 if (!empty($contribution->id
)) {
4396 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(['id' => $contribution->id
]);
4398 $inputContributionWhiteList = [
4403 'payment_instrument_id',
4408 'contribution_status_id',
4412 if (self
::isSingleLineItem($primaryContributionID)) {
4413 $inputContributionWhiteList[] = 'financial_type_id';
4416 $participant = $objects['participant'] ??
NULL;
4417 $recurContrib = $objects['contributionRecur'] ??
NULL;
4418 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4419 $event = $objects['event'] ??
NULL;
4421 $paymentProcessorId = '';
4422 if (isset($objects['paymentProcessor'])) {
4423 if (is_array($objects['paymentProcessor'])) {
4424 $paymentProcessorId = $objects['paymentProcessor']['id'];
4427 $paymentProcessorId = $objects['paymentProcessor']->id
;
4431 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4433 $contributionParams = array_merge([
4434 'contribution_status_id' => $completedContributionStatusID,
4435 'source' => self
::getRecurringContributionDescription($contribution, $event),
4436 ], array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4439 // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4440 if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency
)) {
4441 $contributionParams['currency'] = $objects['first_contribution']->currency
;
4444 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4446 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4447 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4448 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4449 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4452 if ($recurringContributionID) {
4453 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4455 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4457 if (empty($contributionParams['receive_date']) && $changeDate) {
4458 $contributionParams['receive_date'] = $changeDate;
4461 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4462 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4465 if (isset($input['is_email_receipt'])) {
4466 $values['is_email_receipt'] = $input['is_email_receipt'];
4469 if ($input['component'] == 'contribute') {
4470 if ($contribution->contribution_page_id
) {
4471 // Figure out what we gain from this.
4472 // Note that we may have overwritten the is_email_receipt input, fix that below.
4473 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4475 elseif ($recurContrib && $recurringContributionID) {
4476 $values['amount'] = $recurContrib->amount
;
4477 $values['financial_type_id'] = $objects['contributionType']->id
;
4478 $values['title'] = $source = ts('Offline Recurring Contribution');
4481 if (isset($input['is_email_receipt'])) {
4482 // CRM-19601 - we may have overwritten this above.
4483 $values['is_email_receipt'] = $input['is_email_receipt'];
4485 elseif ($recurContrib && $recurringContributionID) {
4486 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4487 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4488 // 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
4489 // Instance that had the table added via an upgrade in 4.1
4490 // see also https://github.com/civicrm/civicrm-svn/commit/7f39befd60bc735408d7866b02b3ac7fff1d4eea#diff-9ad8e290180451a2d6eacbd3d1ca7966R354
4491 // https://lab.civicrm.org/dev/core/issues/1245
4492 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4495 if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4496 self
::updateMembershipBasedOnCompletionOfContribution(
4498 $primaryContributionID,
4504 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4505 if ($event->is_email_confirm
) {
4506 // @todo this should be set by the function that sends the mail after sending.
4507 $contributionParams['receipt_date'] = $changeDate;
4509 $participantParams['id'] = $participant->id
;
4510 $participantParams['status_id'] = 'Registered';
4511 civicrm_api3('Participant', 'create', $participantParams);
4515 $contributionParams['id'] = $contribution->id
;
4516 $contributionParams['is_post_payment_create'] = $isPostPaymentCreate;
4518 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4519 // unsetting it here does NOT cause any other contribution test to fail!
4520 unset($contributionParams['financial_type_id']);
4521 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4523 // Add new soft credit against current $contribution.
4524 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
4525 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4528 if (empty($contribution->_relatedObjects
['participant']) && !empty($contribution->_relatedObjects
['membership'])) {
4529 // @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.
4530 // @todo - use getRelatedMemberships instead
4531 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4532 $contribution->trxn_id
= $input['trxn_id'] ??
NULL;
4533 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4536 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4537 $transaction->commit();
4539 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4540 $contributionParams['contribution_status_id'], $input['amount']);
4542 // create an activity record
4543 if ($input['component'] == 'contribute') {
4545 $targetContactID = NULL;
4546 if (!empty($ids['related_contact'])) {
4547 $targetContactID = $contribution->contact_id
;
4548 $contribution->contact_id
= $ids['related_contact'];
4550 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4553 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4554 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4555 if (!array_key_exists('is_email_receipt', $values) ||
4556 $values['is_email_receipt'] == 1
4558 civicrm_api3('Contribution', 'sendconfirmation', [
4559 'id' => $contribution->id
,
4560 'payment_processor_id' => $paymentProcessorId,
4562 CRM_Core_Error
::debug_log_message("Receipt sent");
4565 CRM_Core_Error
::debug_log_message("Success: Database updated");
4566 return $contributionResult;
4570 * Send receipt from contribution.
4572 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4574 * Note that the compose message part has been moved to contribution
4575 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4577 * @param array $input
4578 * Incoming data from Payment processor.
4580 * Related object IDs.
4581 * @param int $contributionID
4582 * @param array $values
4583 * Values related to objects that have already been loaded.
4584 * @param bool $returnMessageText
4585 * Should text be returned instead of sent. This.
4586 * is because the function is also used to generate pdfs
4589 * @throws \CRM_Core_Exception
4590 * @throws \CiviCRM_API3_Exception
4591 * @throws \Exception
4593 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4594 $returnMessageText = FALSE) {
4596 $contribution = new CRM_Contribute_BAO_Contribution();
4597 $contribution->id
= $contributionID;
4598 if (!$contribution->find(TRUE)) {
4599 throw new CRM_Core_Exception('Contribution does not exist');
4601 $contribution->loadRelatedObjects($input, $ids, TRUE);
4602 // set receipt from e-mail and name in value
4603 if (!$returnMessageText) {
4604 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4606 $values['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id
);
4607 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4608 if ((!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4609 civicrm_api3('Contribution', 'create', [
4610 'receipt_date' => 'now',
4611 'id' => $contribution->id
,
4618 * Generate From email and from name in an array values
4620 * @param array $input
4621 * @param \CRM_Contribute_BAO_Contribution $contribution
4625 public static function generateFromEmailAndName($input, $contribution) {
4626 // Use input value if supplied.
4627 if (!empty($input['receipt_from_email'])) {
4629 CRM_Utils_Array
::value('receipt_from_name', $input, ''),
4630 $input['receipt_from_email'],
4633 // if we are still empty see if we can use anything from a contribution page.
4635 if (!empty($contribution->contribution_page_id
)) {
4636 $pageValues = civicrm_api3('ContributionPage', 'getsingle', ['id' => $contribution->contribution_page_id
]);
4638 // if we are still empty see if we can use anything from a contribution page.
4639 if (!empty($pageValues['receipt_from_email'])) {
4641 CRM_Utils_Array
::value('receipt_from_name', $pageValues),
4642 $pageValues['receipt_from_email'],
4645 // If we are still empty fall back to the domain or logged in user information.
4646 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4650 * Load related memberships.
4654 * @return array $ids
4659 * Note that in theory it should be possible to retrieve these from the line_item table
4660 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4661 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4662 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4663 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4665 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4668 public function loadRelatedMembershipObjects($ids = []) {
4670 SELECT membership_id
4671 FROM civicrm_membership_payment
4672 WHERE contribution_id = %1 ";
4673 $params = [1 => [$this->id
, 'Integer']];
4674 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, []);
4676 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4677 while ($dao->fetch()) {
4678 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4679 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4683 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4684 foreach ($ids['membership'] as $id) {
4686 $membership = new CRM_Member_BAO_Membership();
4687 $membership->id
= $id;
4688 if (!$membership->find(TRUE)) {
4689 throw new Exception("Could not find membership record: $id");
4691 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4692 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4693 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4694 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4702 * This function is used to record partial payments for contribution
4704 * @param array $contribution
4706 * @param array $params
4708 * @return CRM_Financial_DAO_FinancialTrxn
4710 public static function recordPartialPayment($contribution, $params) {
4711 CRM_Core_Error
::deprecatedFunctionWarning('use payment create api');
4712 $balanceTrxnParams['to_financial_account_id'] = self
::getToFinancialAccount($contribution, $params);
4713 $balanceTrxnParams['from_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($contribution['financial_type_id'], 'Accounts Receivable Account is');
4714 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4715 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4716 $balanceTrxnParams['trxn_date'] = CRM_Utils_Array
::value('trxn_date', $params, CRM_Utils_Array
::value('contribution_receive_date', $params, date('YmdHis')));
4717 $balanceTrxnParams['fee_amount'] = $params['fee_amount'] ??
NULL;
4718 $balanceTrxnParams['net_amount'] = $params['total_amount'] ??
NULL;
4719 $balanceTrxnParams['currency'] = $contribution['currency'];
4720 $balanceTrxnParams['trxn_id'] = $params['contribution_trxn_id'] ??
NULL;
4721 $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4722 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4723 $balanceTrxnParams['check_number'] = $params['check_number'] ??
NULL;
4724 $balanceTrxnParams['is_payment'] = 1;
4726 if (!empty($params['payment_processor'])) {
4727 // I can't find evidence this is passed in - I was gonna just remove it but decided to deprecate as I see self::getToFinancialAccount
4728 // also anticipates it.
4729 CRM_Core_Error
::deprecatedFunctionWarning('passing payment_processor is deprecated - use payment_processor_id');
4730 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4732 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4736 * Get the description (source field) for the recurring contribution.
4738 * @param CRM_Contribute_BAO_Contribution $contribution
4739 * @param CRM_Event_DAO_Event|null $event
4742 * @throws \CiviCRM_API3_Exception
4744 protected static function getRecurringContributionDescription($contribution, $event) {
4745 if (!empty($contribution->source
)) {
4746 return $contribution->source
;
4748 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4749 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', [
4750 'id' => $contribution->contribution_page_id
,
4751 'return' => 'title',
4753 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4756 return ts('Online Event Registration') . ': ' . $event->title
;
4758 elseif (!empty($contribution->contribution_recur_id
)) {
4759 return 'recurring contribution';
4765 * Function use to store line item proportionally in in entity financial trxn table
4767 * @param array $trxnParams
4769 * @param int $trxnId
4771 * @param float $contributionTotalAmount
4773 * @throws \CiviCRM_API3_Exception
4775 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4776 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
4777 if (!empty($lineItems)) {
4778 // get financial item
4779 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
4781 'contribution_total_amount' => $contributionTotalAmount,
4782 'trxn_total_amount' => $trxnParams['total_amount'],
4783 'trxn_id' => $trxnId,
4785 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4790 * Checks if line items total amounts
4791 * match the contribution total amount.
4793 * @param array $params
4794 * array of order params.
4796 * @throws \API_Exception
4798 public static function checkLineItems(&$params) {
4799 $totalAmount = $params['total_amount'] ??
NULL;
4800 $lineItemAmount = 0;
4802 foreach ($params['line_items'] as &$lineItems) {
4803 foreach ($lineItems['line_item'] as &$item) {
4804 if (empty($item['financial_type_id'])) {
4805 $item['financial_type_id'] = $params['financial_type_id'];
4807 $lineItemAmount +
= $item['line_total'] + CRM_Utils_Array
::value('tax_amount', $item, 0.00);
4811 if (!isset($totalAmount)) {
4812 $params['total_amount'] = $lineItemAmount;
4815 $currency = CRM_Utils_Array
::value('currency', $params, '');
4817 if (empty($currency)) {
4818 $currency = CRM_Core_Config
::singleton()->defaultCurrency
;
4821 if (!CRM_Utils_Money
::equals($totalAmount, $lineItemAmount, $currency)) {
4822 throw new CRM_Contribute_Exception_CheckLineItemsException();
4828 * Get the financial account for the item associated with the new transaction.
4830 * @param array $params
4831 * @param int $default
4835 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4837 if (!empty($params['financial_account_id'])) {
4838 return $params['financial_account_id'];
4841 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
4842 $preferredAccountsRelationships = [
4843 'Refunded' => 'Credit/Contra Revenue Account is',
4844 'Chargeback' => 'Chargeback Account is',
4847 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4848 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
4849 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
4851 $preferredAccountsRelationships[$contributionStatus]
4859 * ContributionPage values were being imposed onto values.
4861 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4862 * REALLY didn't want superimposed. The rest are left there in their overkill out
4865 * The rationale for making this explicit is that it was a case of carefully set values being
4866 * seemingly randonly overwritten without much care. In general I think array randomly setting
4867 * variables en mass is risky.
4869 * @param array $values
4873 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4874 $contributionPageValues = [];
4875 CRM_Contribute_BAO_ContributionPage
::setValues(
4876 $this->contribution_page_id
,
4877 $contributionPageValues
4880 // These are the values that I believe to be useful.
4883 'pay_later_receipt',
4885 'receipt_from_email',
4886 'receipt_from_name',
4890 'honoree_profile_id',
4891 'onbehalf_profile_id',
4892 'honor_block_is_active',
4893 // Kinda might be - but would be on the contribution...
4896 // Included for 'fear of regression' but can't justify any use for these....
4898 'payment_processor',
4899 'financial_type_id',
4900 'amount_block_is_active',
4905 'default_amount_id',
4909 'initial_amount_help_text',
4910 'initial_amount_label',
4912 'is_allow_other_amount',
4913 'is_billing_required',
4914 'is_confirm_enabled',
4915 'is_credit_card_only',
4917 'is_partial_payment',
4918 'is_recur_installments',
4919 'is_recur_interval',
4923 'min_initial_amount',
4924 'recur_frequency_unit',
4931 foreach ($valuesToCopy as $valueToCopy) {
4932 if (isset($contributionPageValues[$valueToCopy])) {
4933 if ($valueToCopy === 'title') {
4934 $values[$valueToCopy] = CRM_Contribute_BAO_Contribution_Utils
::getContributionPageTitle($this->contribution_page_id
);
4937 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4945 * Get values of CiviContribute Settings
4946 * and check if its enabled or not.
4947 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4948 * in serialized form. Usually this should be stored as flat settings for each form fields
4949 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4950 * settings we will live with an inconsistency because it's too hard to change for now.
4951 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
4954 * @param string $name
4959 public static function checkContributeSettings($name) {
4960 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
4961 return $contributeSettings[$name] ??
NULL;
4965 * This function process contribution related objects.
4967 * @param int $contributionId
4968 * @param int $statusId
4969 * @param int|null $previousStatusId
4971 * @param string $receiveDate
4973 * @return null|string
4975 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
4977 if (!$contributionId ||
!$statusId) {
4982 'contribution_id' => $contributionId,
4983 'contribution_status_id' => $statusId,
4984 'previous_contribution_status_id' => $previousStatusId,
4985 'receive_date' => $receiveDate,
4988 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
4990 if (!is_array($updateResult) ||
4991 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
4992 !is_array($updatedComponents) ||
4993 empty($updatedComponents)
4998 // get the user display name.
5000 SELECT display_name as displayName
5001 FROM civicrm_contact
5002 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5003 WHERE civicrm_contribution.id = {$contributionId}";
5004 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5006 // get the status message for user.
5007 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5009 if ($componentName == 'CiviMember') {
5010 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5011 CRM_Member_PseudoConstant
::membershipStatus()
5014 $statusNameMsgPart = 'updated';
5015 switch ($updatedStatusName) {
5018 $statusNameMsgPart = $updatedStatusName;
5022 $statusMsg .= "<br />" . ts("Membership for %1 has been %2.", [
5023 1 => $userDisplayName,
5024 2 => $statusNameMsgPart,
5028 if ($componentName == 'CiviEvent') {
5029 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5030 CRM_Event_PseudoConstant
::participantStatus()
5032 if ($updatedStatusName == 'Cancelled') {
5033 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", [1 => $userDisplayName]);
5035 elseif ($updatedStatusName == 'Registered') {
5036 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", [1 => $userDisplayName]);
5040 if ($componentName == 'CiviPledge') {
5041 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5042 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5044 if ($updatedStatusName == 'Cancelled') {
5045 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", [1 => $userDisplayName]);
5047 elseif ($updatedStatusName == 'Failed') {
5048 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", [1 => $userDisplayName]);
5050 elseif ($updatedStatusName == 'Completed') {
5051 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", [1 => $userDisplayName]);
5060 * Get the contribution as it is in the database before being updated.
5062 * @param int $contributionID
5064 * @return \CRM_Contribute_BAO_Contribution|null
5066 private static function getOriginalContribution($contributionID) {
5067 return self
::getValues(['id' => $contributionID]);
5071 * Get the amount for the financial item row.
5073 * Helper function to start to break down recordFinancialTransactions for readability.
5075 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5077 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5078 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5081 * @param array $params
5082 * Params as passed to contribution.create
5084 * @param string $context
5085 * changeFinancialType| changedAmount
5086 * @param array $lineItemDetails
5088 * @param bool $isARefund
5089 * Is this a refund / negative transaction.
5090 * @param int $previousLineItemTotal
5093 * @todo move recordFinancialAccounts & helper functions to their own class?
5096 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5097 if ($context == 'changedAmount') {
5098 $lineTotal = $lineItemDetails['line_total'];
5099 if ($lineTotal != $previousLineItemTotal) {
5100 $lineTotal -= $previousLineItemTotal;
5104 elseif ($context == 'changeFinancialType') {
5105 return -$lineItemDetails['line_total'];
5107 elseif ($context == 'changedStatus') {
5108 $cancelledTaxAmount = 0;
5110 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $lineItemDetails, '0.00');
5112 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total'] +
(float) $cancelledTaxAmount);
5114 elseif ($context === NULL) {
5115 // erm, yes because? but, hey, it's tested.
5116 return $lineItemDetails['line_total'];
5118 elseif (empty($lineItemDetails['line_total'])) {
5119 // follow legacy code path
5121 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', ['civi.tag' => 'deprecated']);
5122 return $params['total_amount'];
5125 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total']);
5130 * Get the multiplier for adjusting rows.
5132 * If we are dealing with a refund or cancellation then it will be a negative
5133 * amount to reflect the negative transaction.
5135 * If we are changing Financial Type it will be a negative amount to
5136 * adjust down the old type.
5138 * @param int $contribution_status_id
5139 * @param string $context
5143 protected static function getMultiplier($contribution_status_id, $context) {
5144 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5151 * Does this transaction reflect a payment instrument change.
5153 * @param array $params
5154 * @param array $pendingStatuses
5158 protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5159 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
5161 if (array_key_exists('payment_instrument_id', $params)) {
5162 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
5163 !CRM_Utils_System
::isNull($params['payment_instrument_id'])
5165 //check if status is changed from Pending to Completed
5166 // do not update payment instrument changes for Pending to Completed
5167 if (!($contributionStatus == 'Completed' &&
5168 in_array($params['prevContribution']->contribution_status_id
, $pendingStatuses))
5173 elseif ((!CRM_Utils_System
::isNull($params['payment_instrument_id']) &&
5174 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
5175 $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5179 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
5180 $params['contribution']->check_number
!= $params['prevContribution']->check_number
5182 // another special case when check number is changed, create new financial records
5183 // create financial trxn with negative amount
5191 * Update the memberships associated with a contribution if it has been completed.
5193 * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5194 * load them in this function. Code clean up would compensate for any minor performance implication.
5196 * @param \CRM_Contribute_BAO_Contribution $contribution
5197 * @param int $primaryContributionID
5198 * @param string $changeDate
5200 * @throws \CRM_Core_Exception
5201 * @throws \CiviCRM_API3_Exception
5203 public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5204 $memberships = self
::getRelatedMemberships($contribution->id
);
5205 foreach ($memberships as $membership) {
5206 $membershipParams = [
5207 'id' => $membership['id'],
5208 'contact_id' => $membership['contact_id'],
5209 'is_test' => $membership['is_test'],
5210 'membership_type_id' => $membership['membership_type_id'],
5211 'membership_activity_status' => 'Completed',
5214 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
5215 $membershipParams['membership_type_id'],
5216 $membershipParams['is_test'],
5217 $membershipParams['id']
5220 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5221 // this picks up membership type changes during renewals
5222 // @todo this is almost certainly an obsolete sql call, the pre-change
5223 // membership is accessible via $this->_relatedObjects
5225 SELECT membership_type_id
5226 FROM civicrm_membership_log
5227 WHERE membership_id={$membershipParams['id']}
5230 $dao = CRM_Core_DAO
::executeQuery($sql);
5231 if ($dao->fetch()) {
5232 if (!empty($dao->membership_type_id
)) {
5233 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
5236 if (empty($membership['end_date']) ||
(int) $membership['status_id'] !== CRM_Core_PseudoConstant
::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending')) {
5237 // Passing num_terms to the api triggers date calculations, but for pending memberships these may be already calculated.
5238 // sigh - they should be consistent but removing the end date check causes test failures & maybe UI too?
5239 // 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.
5240 // @todo once apiv4 ships with core switch to that & find sanity.
5241 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5242 $membershipParams['membership_type_id'],
5243 $primaryContributionID
5246 // @todo remove all this stuff in favour of letting the api call further down handle in
5247 // (it is a duplication of what the api does).
5248 $dates = array_fill_keys([
5253 if ($currentMembership) {
5255 * Fixed FOR CRM-4433
5256 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5257 * when Contribution mode is notify and membership is for renewal )
5259 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5261 // @todo - we should pass membership_type_id instead of null here but not
5262 // adding as not sure of testing
5263 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
5264 $changeDate, NULL, $membershipParams['num_terms']
5266 $dates['join_date'] = $currentMembership['join_date'];
5269 //get the status for membership.
5270 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
5272 $dates['join_date'],
5275 $membershipParams['membership_type_id'],
5279 unset($dates['end_date']);
5280 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
5281 //we might be renewing membership,
5282 //so make status override false.
5283 $membershipParams['is_override'] = FALSE;
5284 $membershipParams['status_override_end_date'] = 'null';
5286 //CRM-17723 - reset static $relatedContactIds array()
5287 // @todo move it to Civi Statics.
5289 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
5290 civicrm_api3('Membership', 'create', $membershipParams);
5295 * Get payment links as they relate to a contribution.
5297 * If a payment can be made then include a payment link & if a refund is appropriate
5298 * then a refund link.
5301 * @param float $balance
5302 * @param string $contributionStatus
5305 * $actionLinks Links array containing:
5309 protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5310 if ($contributionStatus === 'Failed' ||
!CRM_Core_Permission
::check('edit contributions')) {
5311 // In general the balance is the best way to determine if a payment can be added or not,
5312 // but not for Failed contributions, where we don't accept additional payments at the moment.
5313 // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5314 // do accept more payments agains them.
5319 'url' => CRM_Utils_System
::url('civicrm/payment', [
5325 'title' => ts('Record Payment'),
5328 if ((int) $balance > 0) {
5329 // @todo - this should be possible even if not > 0 - test & remove this if.
5330 // it is possible to 'overpay' in the real world & we honor that.
5331 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
5333 'url' => CRM_Utils_System
::url('civicrm/payment', [
5340 'title' => ts('Submit Credit Card payment'),
5344 elseif ((int) $balance < 0) {
5345 // @todo - in the future remove this IF - OK to refund money even when not due since
5348 'url' => CRM_Utils_System
::url('civicrm/payment', [
5354 'title' => ts('Record Refund'),
5357 return $actionLinks;
5361 * Get a query to determine the amount donated by the contact/s in the current financial year.
5363 * @param array $contactIDs
5367 public static function getAnnualQuery($contactIDs) {
5368 $contactIDs = implode(',', $contactIDs);
5369 $config = CRM_Core_Config
::singleton();
5370 $currentMonth = date('m');
5371 $currentDay = date('d');
5373 (int) $config->fiscalYearStart
['M'] > $currentMonth ||
5375 (int) $config->fiscalYearStart
['M'] == $currentMonth &&
5376 (int) $config->fiscalYearStart
['d'] > $currentDay
5379 $year = date('Y') - 1;
5384 $nextYear = $year +
1;
5386 if ($config->fiscalYearStart
) {
5387 $newFiscalYearStart = $config->fiscalYearStart
;
5388 if ($newFiscalYearStart['M'] < 10) {
5389 // This is just a clumsy way of adding padding.
5390 // @todo next round look for a nicer way.
5391 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5393 if ($newFiscalYearStart['d'] < 10) {
5394 // This is just a clumsy way of adding padding.
5395 // @todo next round look for a nicer way.
5396 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5398 $config->fiscalYearStart
= $newFiscalYearStart;
5399 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
5402 // First of January.
5405 $startDate = "$year$monthDay";
5406 $endDate = "$nextYear$monthDay";
5409 'contact_id' => 'IN (' . $contactIDs . ')',
5410 'is_test' => ' = 0',
5411 'receive_date' => ['>=' . $startDate, '< ' . $endDate],
5413 $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5414 CRM_Financial_BAO_FinancialType
::addACLClausesToWhereClauses($whereClauses);
5417 foreach ($whereClauses as $key => $clause) {
5418 $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5420 $whereClauseString = implode(' AND ', $clauses);
5422 // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5423 // this group by + having on contribution_status_id improves performance
5425 SELECT COUNT(*) as count,
5426 SUM(total_amount) as amount,
5427 AVG(total_amount) as average,
5429 FROM civicrm_contribution b
5430 WHERE " . $whereClauseString . "
5431 GROUP BY currency, contribution_status_id
5432 HAVING $havingClause
5438 * Assign Test Value.
5440 * @param string $fieldName
5441 * @param array $fieldDef
5442 * @param int $counter
5444 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5445 if ($fieldName == 'tax_amount') {
5446 $this->{$fieldName} = "0.00";
5448 elseif ($fieldName == 'net_amount') {
5449 $this->{$fieldName} = "2.00";
5451 elseif ($fieldName == 'total_amount') {
5452 $this->{$fieldName} = "3.00";
5454 elseif ($fieldName == 'fee_amount') {
5455 $this->{$fieldName} = "1.00";
5458 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5463 * Check if contribution has participant/membership payment.
5465 * @param int $contributionId
5470 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5471 // get line item for contribution
5472 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5473 // check if line item is for membership or participant
5474 foreach ($lineItems as $items) {
5475 if ($items['entity_table'] == 'civicrm_participant') {
5479 elseif ($items['entity_table'] == 'civicrm_membership') {
5491 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5493 * @param array $trxnParams
5494 * Financial trxn params
5495 * @param array $contributionParams
5496 * Contribution Params
5500 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5501 if (!Civi
::settings()->get('always_post_to_accounts_receivable')) {
5504 $statusId = $contributionParams['contribution']->contribution_status_id
;
5505 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5506 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5507 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5508 // Return if contribution status is not completed.
5509 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5510 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5511 && $contributionParams['prevContribution']->is_pay_later
== 0
5517 $params = $trxnParams;
5518 $financialTypeID = !empty($contributionParams['financial_type_id']) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5519 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5520 $params['to_financial_account_id'] = $arAccountId;
5521 $params['status_id'] = array_search('Pending', $contributionStatuses);
5522 $params['is_payment'] = FALSE;
5523 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5524 self
::$_trxnIDs[] = $trxn->id
;
5525 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5529 * Calculate financial item amount when contribution is updated.
5531 * @param array $params
5532 * contribution params
5533 * @param array $amountParams
5535 * @param string $context
5539 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5540 if (!empty($params['is_quick_config'])) {
5541 $amount = $amountParams['item_amount'];
5543 $amount = $params['total_amount'];
5544 if ($context === NULL) {
5545 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5550 $amount = $amountParams['line_total'];
5551 if ($context == 'changedAmount') {
5552 $amount -= $amountParams['previous_line_total'];
5554 $amount *= $amountParams['diff'];
5560 * Retrieve Sales Tax Financial Accounts.
5566 public static function getSalesTaxFinancialAccounts() {
5567 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5568 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5569 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5570 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5571 $queryParams = [1 => [$accountRel, 'Integer']];
5572 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5573 $financialAccount = [];
5574 while ($dao->fetch()) {
5575 $financialAccount[$dao->id
] = $dao->id
;
5577 return $financialAccount;
5581 * Create tax entry in civicrm_entity_financial_trxn table.
5583 * @param array $entityParams
5585 * @param array $eftParams
5587 * @throws \CiviCRM_API3_Exception
5589 public static function createProportionalEntry($entityParams, $eftParams) {
5591 if ($entityParams['contribution_total_amount'] != 0) {
5592 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5594 // Record Entity Financial Trxn; CRM-20145
5595 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5596 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5600 * Create array of last financial item id's.
5602 * @param int $contributionId
5606 public static function getLastFinancialItemIds($contributionId) {
5607 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5608 FROM civicrm_financial_item fi
5609 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5610 WHERE li.contribution_id = %1";
5611 $dao = CRM_Core_DAO
::executeQuery($sql, [
5617 $ftIds = $taxItems = [];
5618 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5619 while ($dao->fetch()) {
5620 /* if sales tax item*/
5621 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5622 $taxItems[$dao->price_field_value_id
] = [
5623 'financial_item_id' => $dao->id
,
5624 'amount' => $dao->tax_amount
,
5628 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5631 return [$ftIds, $taxItems];
5635 * Create proportional entries in civicrm_entity_financial_trxn.
5637 * @param array $entityParams
5639 * @param array $lineItems
5641 * @param array $ftIds
5643 * @param array $taxItems
5645 * @throws \CiviCRM_API3_Exception
5647 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5649 'entity_table' => 'civicrm_financial_item',
5650 'financial_trxn_id' => $entityParams['trxn_id'],
5652 foreach ($lineItems as $key => $value) {
5653 if ($value['qty'] == 0) {
5656 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5657 $entityParams['line_item_amount'] = $value['line_total'];
5658 self
::createProportionalEntry($entityParams, $eftParams);
5659 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5660 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5661 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5662 self
::createProportionalEntry($entityParams, $eftParams);
5668 * Load entities related to the contribution into $this->_relatedObjects.
5672 * @throws \CRM_Core_Exception
5674 protected function loadRelatedEntitiesByID($ids) {
5676 'contact' => 'CRM_Contact_BAO_Contact',
5677 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5678 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5679 'financialType' => 'CRM_Financial_BAO_FinancialType',
5680 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5682 foreach ($entities as $entity => $bao) {
5683 if (!empty($ids[$entity])) {
5684 $this->_relatedObjects
[$entity] = new $bao();
5685 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5686 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5687 throw new CRM_Core_Exception($entity . ' could not be loaded');
5694 * Should an email receipt be sent for this contribution when complete.
5696 * @param array $input
5700 protected function isEmailReceipt($input) {
5701 if (isset($input['is_email_receipt'])) {
5702 return $input['is_email_receipt'];
5704 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5705 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5711 * Function to replace contribution tokens.
5713 * @param array $contributionIds
5715 * @param string $subject
5717 * @param array $subjectToken
5719 * @param string $text
5721 * @param string $html
5723 * @param array $messageToken
5725 * @param bool $escapeSmarty
5728 * @throws \CiviCRM_API3_Exception
5730 public static function replaceContributionTokens(
5739 if (empty($contributionIds)) {
5742 $contributionDetails = [];
5743 foreach ($contributionIds as $id) {
5744 $result = self
::getContributionTokenValues($id, $messageToken);
5745 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5746 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5747 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5749 return $contributionDetails;
5753 * Get the contribution fields for $id and display labels where
5754 * appropriate (if the token is present).
5757 * @param array $messageToken
5760 public static function getContributionTokenValues($id, $messageToken) {
5764 $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
5765 // lab.c.o mail#46 - show labels, not values, for custom fields with option values.
5766 if (!empty($messageToken)) {
5767 foreach ($result['values'][$id] as $fieldName => $fieldValue) {
5768 if (strpos($fieldName, 'custom_') === 0 && array_search($fieldName, $messageToken['contribution']) !== FALSE) {
5769 $result['values'][$id][$fieldName] = CRM_Core_BAO_CustomField
::displayValue($result['values'][$id][$fieldName], $fieldName);
5777 * Get invoice_number for contribution.
5779 * @param int $contributionID
5783 public static function getInvoiceNumber($contributionID) {
5784 if ($invoicePrefix = self
::checkContributeSettings('invoice_prefix')) {
5785 return $invoicePrefix . $contributionID;
5792 * Load the values needed for the event message.
5794 * @param int $eventID
5795 * @param int $participantID
5796 * @param int|null $contributionID
5799 * @throws \CRM_Core_Exception
5801 protected function loadEventMessageTemplateParams(int $eventID, int $participantID, $contributionID): array {
5806 $values = ['event' => []];
5808 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
5809 // add custom fields for event
5810 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', NULL, $eventID);
5812 $eventCustomGroup = [];
5813 foreach ($eventGroupTree as $key => $group) {
5814 if ($key === 'info') {
5818 foreach ($group['fields'] as $k => $customField) {
5819 $groupLabel = $group['title'];
5820 if (!empty($customField['customValue'])) {
5821 foreach ($customField['customValue'] as $customFieldValues) {
5822 $eventCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5827 $values['event']['customGroup'] = $eventCustomGroup;
5829 //get participant details
5830 $participantParams = [
5831 'id' => $participantID,
5834 $values['participant'] = [];
5836 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
5837 // add custom fields for event
5838 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', NULL, $participantID);
5839 $participantCustomGroup = [];
5840 foreach ($participantGroupTree as $key => $group) {
5841 if ($key === 'info') {
5845 foreach ($group['fields'] as $k => $customField) {
5846 $groupLabel = $group['title'];
5847 if (!empty($customField['customValue'])) {
5848 foreach ($customField['customValue'] as $customFieldValues) {
5849 $participantCustomGroup[$groupLabel][$customField['label']] = $customFieldValues['data'] ??
NULL;
5854 $values['participant']['customGroup'] = $participantCustomGroup;
5856 //get location details
5858 'entity_id' => $eventID,
5859 'entity_table' => 'civicrm_event',
5861 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
5864 'entity_table' => 'civicrm_event',
5865 'entity_id' => $eventID,
5866 'module' => 'CiviEvent',
5869 list($custom_pre_id,
5871 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
5873 $values['custom_pre_id'] = $custom_pre_id;
5874 $values['custom_post_id'] = $custom_post_ids;
5876 // set lineItem for event contribution
5877 if ($contributionID) {
5878 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($contributionID);
5879 if (!empty($participantIds)) {
5880 foreach ($participantIds as $pIDs) {
5881 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
5882 if (!CRM_Utils_System
::isNull($lineItem)) {
5883 $values['lineItem'][] = $lineItem;