3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
33 class CRM_Contribute_BAO_Contribution
extends CRM_Contribute_DAO_Contribution
{
36 * Static field for all the contribution information that we can potentially import
40 static $_importableFields = NULL;
43 * Static field for all the contribution information that we can potentially export
47 static $_exportableFields = NULL;
50 * Static field to hold financial trxn id's.
54 static $_trxnIDs = NULL;
57 * Field for all the objects related to this contribution
58 * @var array of objects (e.g membership object, participant object)
60 public $_relatedObjects = array();
63 * Field for the component - either 'event' (participant) or 'contribute'
64 * (any item related to a contribution page e.g. membership, pledge, contribution)
65 * This is used for composing messages because they have dependency on the
66 * contribution_page or event page - although over time we may eliminate that
68 * @var string component or event
70 public $_component = NULL;
73 * Possibly obsolete variable.
75 * If you use it please explain why it is set in the create function here.
79 public $trxn_result_code;
84 public function __construct() {
85 parent
::__construct();
89 * Takes an associative array and creates a contribution object.
91 * the function extract all the params it needs to initialize the create a
92 * contribution object. the params array could contain additional unused name/value
95 * @param array $params
96 * (reference ) an assoc array of name/value pairs.
98 * The array that holds all the db ids.
100 * @return \CRM_Contribute_BAO_Contribution
101 * @throws \CRM_Core_Exception
103 public static function add(&$params, $ids = array()) {
104 if (empty($params)) {
107 //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
108 $contributionID = CRM_Utils_Array
::value('contribution', $ids, CRM_Utils_Array
::value('id', $params));
109 $duplicates = array();
110 if (self
::checkDuplicate($params, $duplicates, $contributionID)) {
111 $message = ts("Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: " . implode(', ', $duplicates));
112 throw new CRM_Core_Exception($message);
115 // first clean up all the money fields
116 $moneyFields = array(
120 'non_deductible_amount',
123 //if priceset is used, no need to cleanup money
124 if (!empty($params['skipCleanMoney'])) {
128 // @todo put a deprecated here - this should be done in the form layer.
129 $params['skipCleanMoney'] = FALSE;
130 Civi
::log()->warning('Deprecated code path. Money should always be clean before it hits the BAO.', array('civi.tag' => 'deprecated'));
133 foreach ($moneyFields as $field) {
134 if (isset($params[$field])) {
135 $params[$field] = CRM_Utils_Rule
::cleanMoney($params[$field]);
139 //set defaults in create mode
140 if (!$contributionID) {
141 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
143 if (empty($params['invoice_number'])) {
144 $nextContributionID = CRM_Core_DAO
::singleValueQuery("SELECT COALESCE(MAX(id) + 1, 1) FROM civicrm_contribution");
145 $params['invoice_number'] = self
::getInvoiceNumber($nextContributionID);
149 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
150 //if contribution is created with cancelled or refunded status, add credit note id
151 if (!empty($params['contribution_status_id'])) {
152 // @todo - should we include Chargeback? If so use self::isContributionStatusNegative($params['contribution_status_id'])
153 if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
154 ||
$params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
156 if (empty($params['creditnote_id']) ||
$params['creditnote_id'] == "null") {
157 $params['creditnote_id'] = self
::createCreditNoteId();
162 // Since the fee amount is expecting this (later on) ensure it is always set.
163 // It would only not be set for an update where it is unchanged.
164 $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', array('id' => $contributionID, 'return' => 'contribution_status_id'));
168 && CRM_Utils_Array
::value('membership_id', $params)
169 && self
::checkContributeSettings('deferred_revenue_enabled')
171 $memberStartDate = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
172 if ($memberStartDate) {
173 $params['revenue_recognition_date'] = date('Ymd', strtotime($memberStartDate));
176 self
::calculateMissingAmountParams($params, $contributionID);
178 if (!empty($params['payment_instrument_id'])) {
179 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument('name');
180 if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
181 $params['check_number'] = 'null';
185 $setPrevContribution = TRUE;
186 // CRM-13964 partial payment
187 if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])) {
188 $partialAmtTotal = $params['partial_payment_total'];
189 $partialAmtPay = $params['partial_amount_to_pay'];
190 $params['total_amount'] = $partialAmtTotal;
191 if ($partialAmtPay < $partialAmtTotal) {
192 $params['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Partially paid');
193 $params['is_pay_later'] = 0;
194 $setPrevContribution = FALSE;
197 if ($contributionID && $setPrevContribution) {
198 $params['prevContribution'] = self
::getOriginalContribution($contributionID);
201 if ($contributionID && !empty($params['revenue_recognition_date']) && !empty($params['prevContribution'])
202 && !($contributionStatus[$params['prevContribution']->contribution_status_id
] == 'Pending')
203 && !self
::allowUpdateRevenueRecognitionDate($contributionID)
205 unset($params['revenue_recognition_date']);
208 if (!isset($params['tax_amount']) && $setPrevContribution && (isset($params['total_amount']) ||
209 isset($params['financial_type_id']))) {
210 $params = CRM_Contribute_BAO_Contribution
::checkTaxAmount($params);
213 if ($contributionID) {
214 CRM_Utils_Hook
::pre('edit', 'Contribution', $contributionID, $params);
217 CRM_Utils_Hook
::pre('create', 'Contribution', NULL, $params);
219 $contribution = new CRM_Contribute_BAO_Contribution();
220 $contribution->copyValues($params);
222 $contribution->id
= $contributionID;
224 if (empty($contribution->id
)) {
225 // (only) on 'create', make sure that a valid currency is set (CRM-16845)
226 if (!CRM_Utils_Rule
::currencyCode($contribution->currency
)) {
227 $contribution->currency
= CRM_Core_Config
::singleton()->defaultCurrency
;
231 $result = $contribution->save();
233 // Add financial_trxn details as part of fix for CRM-4724
234 $contribution->trxn_result_code
= CRM_Utils_Array
::value('trxn_result_code', $params);
235 $contribution->payment_processor
= CRM_Utils_Array
::value('payment_processor', $params);
237 //add Account details
238 $params['contribution'] = $contribution;
239 self
::recordFinancialAccounts($params);
241 if (self
::isUpdateToRecurringContribution($params)) {
242 CRM_Contribute_BAO_ContributionRecur
::updateOnNewPayment(
243 (!empty($params['contribution_recur_id']) ?
$params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id
),
244 $contributionStatus[$params['contribution_status_id']],
245 CRM_Utils_Array
::value('receive_date', $params)
249 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
251 if ($contributionID) {
252 CRM_Utils_Hook
::post('edit', 'Contribution', $contribution->id
, $contribution);
255 CRM_Utils_Hook
::post('create', 'Contribution', $contribution->id
, $contribution);
262 * Is this contribution updating an existing recurring contribution.
264 * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
265 * pending payment is being confirmed (or failing).
267 * @param array $params
271 public static function isUpdateToRecurringContribution($params) {
272 if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
275 if (empty($params['prevContribution']) ||
empty($params['contribution_status_id'])) {
278 if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id
)) {
281 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
282 if ($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatus)) {
289 * Get defaults for new entity.
292 public static function getDefaults() {
294 'payment_instrument_id' => key(CRM_Core_OptionGroup
::values('payment_instrument',
295 FALSE, FALSE, FALSE, 'AND is_default = 1')
297 'contribution_status_id' => CRM_Core_Pseudoconstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
302 * Fetch the object and store the values in the values array.
304 * @param array $params
305 * Input parameters to find object.
306 * @param array $values
307 * Output values of the object.
309 * The array that holds all the db ids.
311 * @return CRM_Contribute_BAO_Contribution|null
312 * The found object or null
314 public static function getValues($params, &$values, &$ids) {
315 if (empty($params)) {
318 $contribution = new CRM_Contribute_BAO_Contribution();
320 $contribution->copyValues($params);
322 if ($contribution->find(TRUE)) {
323 $ids['contribution'] = $contribution->id
;
325 CRM_Core_DAO
::storeValues($contribution, $values);
327 return $contribution;
329 $null = NULL; // return by reference
334 * Get the values and resolve the most common mappings.
336 * Since contribution status is resolved in almost every function that calls getValues it makes
337 * sense to have an extra function to resolve it rather than repeat the code.
339 * Think carefully before adding more mappings to be resolved as there could be performance implications
340 * if this function starts to be called from more iterative functions.
342 * @param array $params
343 * Input parameters to find object.
346 * Array of the found contribution.
347 * @throws CRM_Core_Exception
349 public static function getValuesWithMappings($params) {
350 $values = $ids = array();
351 $contribution = self
::getValues($params, $values, $ids);
352 if (is_null($contribution)) {
353 throw new CRM_Core_Exception('No contribution found');
355 $values['contribution_status'] = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
360 * Calculate net_amount & fee_amount if they are not set.
362 * Net amount should be total - fee.
363 * This should only be called for new contributions.
365 * @param array $params
366 * Params for a new contribution before they are saved.
367 * @param int|null $contributionID
368 * Contribution ID if we are dealing with an update.
370 * @throws \CiviCRM_API3_Exception
372 public static function calculateMissingAmountParams(&$params, $contributionID) {
373 if (!$contributionID && !isset($params['fee_amount'])) {
374 if (isset($params['total_amount']) && isset($params['net_amount'])) {
375 $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
378 $params['fee_amount'] = 0;
381 if (!isset($params['net_amount'])) {
382 if (!$contributionID) {
383 $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
386 if (isset($params['fee_amount']) ||
isset($params['total_amount'])) {
387 // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
388 // net_amount may need adjusting.
389 $contribution = civicrm_api3('Contribution', 'getsingle', array(
390 'id' => $contributionID,
391 'return' => array('total_amount', 'net_amount', 'fee_amount'),
393 $totalAmount = isset($params['total_amount']) ?
$params['total_amount'] : CRM_Utils_Array
::value('total_amount', $contribution);
394 $feeAmount = isset($params['fee_amount']) ?
$params['fee_amount'] : CRM_Utils_Array
::value('fee_amount', $contribution);
395 $params['net_amount'] = $totalAmount - $feeAmount;
403 * @param $billingLocationTypeID
407 protected static function getBillingAddressParams($params, $billingLocationTypeID) {
408 $hasBillingField = FALSE;
409 $billingFields = array(
417 //build address array
418 $addressParams = array();
419 $addressParams['location_type_id'] = $billingLocationTypeID;
420 $addressParams['is_billing'] = 1;
422 $billingFirstName = CRM_Utils_Array
::value('billing_first_name', $params);
423 $billingMiddleName = CRM_Utils_Array
::value('billing_middle_name', $params);
424 $billingLastName = CRM_Utils_Array
::value('billing_last_name', $params);
425 $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingMiddleName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingLastName}";
427 foreach ($billingFields as $value) {
428 $addressParams[$value] = CRM_Utils_Array
::value("billing_{$value}-{$billingLocationTypeID}", $params);
429 if (!empty($addressParams[$value])) {
430 $hasBillingField = TRUE;
433 return array($hasBillingField, $addressParams);
437 * Get address params ready to be passed to the payment processor.
439 * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
440 * To create an address we need state_province_id.
442 * @param array $params
443 * @param int $billingLocationTypeID
447 public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
448 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
449 foreach ($addressParams as $name => $field) {
450 if (substr($name, 0, 8) == 'billing_') {
451 $addressParams[substr($name, 9)] = $addressParams[$field];
454 return array($hasBillingField, $addressParams);
458 * Get the number of terms for this contribution for a given membership type
459 * based on querying the line item table and relevant price field values
460 * Note that any one contribution should only be able to have one line item relating to a particular membership
463 * @param int $membershipTypeID
465 * @param int $contributionID
469 public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
470 $numTerms = CRM_Core_DAO
::singleValueQuery("
471 SELECT membership_num_terms FROM civicrm_line_item li
472 LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
473 WHERE contribution_id = %1 AND membership_type_id = %2",
474 array(1 => array($contributionID, 'Integer'), 2 => array($membershipTypeID, 'Integer'))
476 // default of 1 is precautionary
477 return empty($numTerms) ?
1 : $numTerms;
481 * Takes an associative array and creates a contribution object.
483 * @param array $params
484 * (reference ) an assoc array of name/value pairs.
486 * The array that holds all the db ids.
488 * @return CRM_Contribute_BAO_Contribution
490 public static function create(&$params, $ids = array()) {
491 $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date', 'revenue_recognition_date');
492 foreach ($dateFields as $df) {
493 if (isset($params[$df])) {
494 $params[$df] = CRM_Utils_Date
::isoToMysql($params[$df]);
498 $transaction = new CRM_Core_Transaction();
501 $contribution = self
::add($params, $ids);
503 catch (CRM_Core_Exception
$e) {
504 $transaction->rollback();
508 $params['contribution_id'] = $contribution->id
;
510 if (!empty($params['custom']) &&
511 is_array($params['custom'])
513 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution', $contribution->id
);
516 $session = CRM_Core_Session
::singleton();
518 if (!empty($params['note'])) {
520 'entity_table' => 'civicrm_contribution',
521 'note' => $params['note'],
522 'entity_id' => $contribution->id
,
523 'contact_id' => $session->get('userID'),
524 'modified_date' => date('Ymd'),
526 if (!$noteParams['contact_id']) {
527 $noteParams['contact_id'] = $params['contact_id'];
529 CRM_Core_BAO_Note
::add($noteParams);
532 // make entry in batch entity batch table
533 if (!empty($params['batch_id'])) {
534 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
535 $titleFields = array(
541 $retrieveRequired = 0;
542 foreach ($titleFields as $titleField) {
543 if (!isset($contribution->$titleField)) {
544 $retrieveRequired = 1;
548 if ($retrieveRequired == 1) {
549 $contribution->find(TRUE);
553 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
555 $transaction->commit();
557 $activity = civicrm_api3('Activity', 'get', array(
558 'source_record_id' => $contribution->id
,
559 'options' => array('limit' => 1),
561 'activity_type_id' => 'Contribution',
562 'return' => array('id', 'campaign'),
565 //CRM-18406: Update activity when edit contribution.
566 if ($activity['count']) {
567 // CRM-13237 : if activity record found, update it with campaign id of contribution
568 // @todo compare campaign ids first.
569 CRM_Core_DAO
::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id
);
570 $contribution->activity_id
= $activity['id'];
573 if (empty($contribution->contact_id
)) {
574 $contribution->find(TRUE);
576 CRM_Activity_BAO_Activity
::addActivity($contribution, 'Contribution');
578 // do not add to recent items for import, CRM-4399
579 if (empty($params['skipRecentView'])) {
580 $url = CRM_Utils_System
::url('civicrm/contact/view/contribution',
581 "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
583 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
584 $titleFields = array(
590 $retrieveRequired = 0;
591 foreach ($titleFields as $titleField) {
592 if (!isset($contribution->$titleField)) {
593 $retrieveRequired = 1;
597 if ($retrieveRequired == 1) {
598 $contribution->find(TRUE);
600 $financialType = CRM_Contribute_PseudoConstant
::financialType($contribution->financial_type_id
);
601 $title = CRM_Contact_BAO_Contact
::displayName($contribution->contact_id
) . ' - (' . CRM_Utils_Money
::format($contribution->total_amount
, $contribution->currency
) . ' ' . ' - ' . $financialType . ')';
603 $recentOther = array();
604 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::UPDATE
)) {
605 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
606 "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
610 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::DELETE
)) {
611 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
612 "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
616 // add the recently created Contribution
617 CRM_Utils_Recent
::add($title,
621 $contribution->contact_id
,
627 return $contribution;
631 * Get the values for pseudoconstants for name->value and reverse.
633 * @param array $defaults
634 * (reference) the default values, some of which need to be resolved.
635 * @param bool $reverse
636 * True if we want to resolve the values in the reverse direction (value -> name).
638 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
639 self
::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant
::financialType(), $reverse);
640 self
::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant
::paymentInstrument(), $reverse);
641 self
::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant
::contributionStatus(), $reverse);
642 self
::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant
::pcPage(), $reverse);
646 * Convert associative array names to values and vice-versa.
648 * This function is used by both the web form layer and the api. Note that
649 * the api needs the name => value conversion, also the view layer typically
650 * requires value => name conversion
652 * @param array $defaults
653 * @param string $property
654 * @param array $lookup
655 * @param bool $reverse
659 public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
660 $id = $property . '_id';
662 $src = $reverse ?
$property : $id;
663 $dst = $reverse ?
$id : $property;
665 if (!array_key_exists($src, $defaults)) {
669 $look = $reverse ?
array_flip($lookup) : $lookup;
671 if (is_array($look)) {
672 if (!array_key_exists($defaults[$src], $look)) {
676 $defaults[$dst] = $look[$defaults[$src]];
681 * Retrieve DB object based on input parameters.
683 * It also stores all the retrieved values in the default array.
685 * @param array $params
686 * (reference ) an assoc array of name/value pairs.
687 * @param array $defaults
688 * (reference ) an assoc array to hold the name / value pairs.
689 * in a hierarchical manner
691 * (reference) the array that holds all the db ids.
693 * @return CRM_Contribute_BAO_Contribution
695 public static function retrieve(&$params, &$defaults, &$ids) {
696 $contribution = CRM_Contribute_BAO_Contribution
::getValues($params, $defaults, $ids);
697 return $contribution;
701 * Combine all the importable fields from the lower levels object.
703 * The ordering is important, since currently we do not have a weight
704 * scheme. Adding weight is super important and should be done in the
705 * next week or so, before this can be called complete.
707 * @param string $contactType
708 * @param bool $status
711 * array of importable Fields
713 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
714 if (!self
::$_importableFields) {
715 if (!self
::$_importableFields) {
716 self
::$_importableFields = array();
720 $fields = array('' => array('title' => ts('- do not import -')));
723 $fields = array('' => array('title' => ts('- Contribution Fields -')));
726 $note = CRM_Core_DAO_Note
::import();
727 $tmpFields = CRM_Contribute_DAO_Contribution
::import();
728 unset($tmpFields['option_value']);
729 $optionFields = CRM_Core_OptionValue
::getFields($mode = 'contribute');
730 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
732 // Using new Dedupe rule.
734 'contact_type' => $contactType,
735 'used' => 'Unsupervised',
737 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
738 $tmpContactField = array();
739 if (is_array($fieldsArray)) {
740 foreach ($fieldsArray as $value) {
741 //skip if there is no dupe rule
742 if ($value == 'none') {
745 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
750 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
751 $tmpContactField[trim($value)] = $contactFields[trim($value)];
753 $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
756 $title = $tmpContactField[trim($value)]['title'];
758 $tmpContactField[trim($value)]['title'] = $title;
762 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
763 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
764 $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
765 $fields = array_merge($fields, $tmpContactField);
766 $fields = array_merge($fields, $tmpFields);
767 $fields = array_merge($fields, $note);
768 $fields = array_merge($fields, $optionFields);
769 $fields = array_merge($fields, CRM_Financial_DAO_FinancialType
::export());
770 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
771 self
::$_importableFields = $fields;
773 return self
::$_importableFields;
777 * Combine all the exportable fields from the lower level objects.
779 * @param bool $checkPermission
782 * array of exportable Fields
784 public static function &exportableFields($checkPermission = TRUE) {
785 if (!self
::$_exportableFields) {
786 if (!self
::$_exportableFields) {
787 self
::$_exportableFields = array();
790 $fields = CRM_Contribute_DAO_Contribution
::export();
791 if (CRM_Contribute_BAO_Query
::isSiteHasProducts()) {
792 $fields = array_merge(
794 CRM_Contribute_DAO_Product
::export(),
795 CRM_Contribute_DAO_ContributionProduct
::export(),
796 // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
798 'contribution_product_id' => [
799 'title' => ts('Premium'),
800 'name' => 'contribution_product_id',
801 'where' => 'civicrm_product.id',
802 'data_type' => CRM_Utils_Type
::T_INT
,
808 $financialAccount = CRM_Financial_DAO_FinancialAccount
::export();
810 $contributionPage = array(
811 'contribution_page' => array(
812 'title' => ts('Contribution Page'),
813 'name' => 'contribution_page',
814 'where' => 'civicrm_contribution_page.title',
815 'data_type' => CRM_Utils_Type
::T_STRING
,
819 $contributionNote = array(
820 'contribution_note' => array(
821 'title' => ts('Contribution Note'),
822 'name' => 'contribution_note',
823 'data_type' => CRM_Utils_Type
::T_TEXT
,
827 $extraFields = array(
828 'contribution_batch' => array(
829 'title' => ts('Batch Name'),
834 $campaignTitle = array(
835 'contribution_campaign_title' => array(
836 'title' => ts('Campaign Title'),
837 'name' => 'campaign_title',
838 'where' => 'civicrm_campaign.title',
839 'data_type' => CRM_Utils_Type
::T_STRING
,
842 $softCreditFields = array(
843 'contribution_soft_credit_name' => array(
844 'name' => 'contribution_soft_credit_name',
845 'title' => ts('Soft Credit For'),
846 'where' => 'civicrm_contact_d.display_name',
847 'data_type' => CRM_Utils_Type
::T_STRING
,
849 'contribution_soft_credit_amount' => array(
850 'name' => 'contribution_soft_credit_amount',
851 'title' => ts('Soft Credit Amount'),
852 'where' => 'civicrm_contribution_soft.amount',
853 'data_type' => CRM_Utils_Type
::T_MONEY
,
855 'contribution_soft_credit_type' => array(
856 'name' => 'contribution_soft_credit_type',
857 'title' => ts('Soft Credit Type'),
858 'where' => 'contribution_softcredit_type.label',
859 'data_type' => CRM_Utils_Type
::T_STRING
,
861 'contribution_soft_credit_contribution_id' => array(
862 'name' => 'contribution_soft_credit_contribution_id',
863 'title' => ts('Soft Credit For Contribution ID'),
864 'where' => 'civicrm_contribution_soft.contribution_id',
865 'data_type' => CRM_Utils_Type
::T_INT
,
867 'contribution_soft_credit_contact_id' => array(
868 'name' => 'contribution_soft_credit_contact_id',
869 'title' => ts('Soft Credit For Contact ID'),
870 'where' => 'civicrm_contact_d.id',
871 'data_type' => CRM_Utils_Type
::T_INT
,
875 $fields = array_merge($fields, $contributionPage,
876 $contributionNote, $extraFields, $softCreditFields, $financialAccount, $campaignTitle,
877 CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
880 self
::$_exportableFields = $fields;
883 return self
::$_exportableFields;
887 * @param $contributionId
888 * @param $participantId
889 * @param array $financialTrxn
891 * @param $financialTrxn
893 protected static function recordPaymentActivity($contributionId, $participantId, $financialTrxn) {
894 $activityType = ($financialTrxn->total_amount
< 0) ?
'Refund' : 'Payment';
895 if ($participantId) {
896 $inputParams['id'] = $participantId;
899 $component = 'event';
900 $entityObj = CRM_Event_BAO_Participant
::getValues($inputParams, $values, $ids);
901 $entityObj = $entityObj[$participantId];
904 $entityObj = new CRM_Contribute_BAO_Contribution();
905 $entityObj->id
= $contributionId;
906 $entityObj->find(TRUE);
907 $component = 'contribution';
910 self
::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
914 * Get the value for the To Financial Account.
916 * @param $contribution
921 protected static function getToFinancialAccount($contribution, $params) {
922 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
923 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
925 array_search('Pending', $contributionStatuses),
926 array_search('In Progress', $contributionStatuses),
928 if (in_array(CRM_Utils_Array
::value('contribution_status_id', $contribution), $pendingStatus)) {
929 return CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
931 elseif (!empty($params['payment_processor'])) {
932 return CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['payment_processor'], NULL, 'civicrm_payment_processor');
934 elseif (!empty($params['payment_instrument_id'])) {
935 return CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
938 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
939 $queryParams = [1 => [$relationTypeId, 'Integer']];
940 return CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
945 * Get memberships realted to the contribution.
947 * @param int $contributionID
951 protected static function getRelatedMemberships($contributionID) {
952 $contribution = new CRM_Contribute_BAO_Contribution();
953 $contribution->id
= $contributionID;
954 $contribution->fetch(TRUE);
955 $contribution->loadRelatedMembershipObjects();
956 $result = CRM_Utils_Array
::value('membership', $contribution->_relatedObjects
, []);
958 foreach ($result as $membership) {
959 if (empty($membership)) {
962 // @todo - remove this again & just call api in the first place.
963 _civicrm_api3_object_to_array($membership, $memberships[$membership->id
]);
971 public function addSelectWhereClause() {
972 $whereClauses = parent
::addSelectWhereClause();
973 if ($whereClauses !== []) {
974 // In this case permisssions have been applied & we assume the
975 // financialaclreport is applying these
976 // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
977 return $whereClauses;
980 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
981 return $whereClauses;
983 $types = CRM_Financial_BAO_FinancialType
::getAllEnabledAvailableFinancialTypes();
985 $whereClauses['financial_type_id'] = 'IN (0)';
988 $whereClauses['financial_type_id'] = [
989 'IN (' . implode(',', array_keys($types)) . ')'
992 return $whereClauses;
996 * @param null $status
997 * @param null $startDate
998 * @param null $endDate
1000 * @return array|null
1002 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1006 $where[] = 'contribution_status_id = 1';
1010 $where[] = 'contribution_status_id = 3';
1015 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
1018 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
1020 $financialTypeACLJoin = '';
1021 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1022 $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1023 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1024 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1025 if ($financialTypes) {
1026 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1027 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1030 $where[] = "c.financial_type_id IN (0)";
1034 $whereCond = implode(' AND ', $where);
1037 SELECT sum( total_amount ) as total_amount,
1038 count( c.id ) as total_count,
1040 FROM civicrm_contribution c
1041 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
1042 $financialTypeACLJoin
1044 AND ( is_test = 0 OR is_test IS NULL )
1045 AND contact.is_deleted = 0
1049 $dao = CRM_Core_DAO
::executeQuery($query);
1052 while ($dao->fetch()) {
1053 $count +
= $dao->total_count
;
1054 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
1058 'amount' => implode(', ', $amount),
1066 * Delete the indirect records associated with this contribution first.
1070 * @return mixed|null
1071 * $results no of deleted Contribution on success, false otherwise
1073 public static function deleteContribution($id) {
1074 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
1076 $transaction = new CRM_Core_Transaction();
1079 //delete activity record
1081 'source_record_id' => $id,
1082 // activity type id for contribution
1083 'activity_type_id' => 6,
1086 CRM_Activity_BAO_Activity
::deleteActivity($params);
1088 //delete billing address if exists for this contribution.
1089 self
::deleteAddress($id);
1091 //update pledge and pledge payment, CRM-3961
1092 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
1094 // remove entry from civicrm_price_set_entity, CRM-5095
1095 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
1096 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
1098 // cleanup line items.
1099 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1101 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1102 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1104 if ($participantId) {
1105 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1108 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1112 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1113 $noteId = key($note);
1115 CRM_Core_BAO_Note
::del($noteId, FALSE);
1118 $dao = new CRM_Contribute_DAO_Contribution();
1121 $results = $dao->delete();
1123 $transaction->commit();
1125 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1127 // delete the recently created Contribution
1128 $contributionRecent = array(
1130 'type' => 'Contribution',
1132 CRM_Utils_Recent
::del($contributionRecent);
1138 * React to a financial transaction (payment) failure.
1140 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1141 * payments is important for forensic and outreach reasons.
1143 * @param int $contributionID
1144 * @param int $contactID
1145 * @param string $message
1147 * @throws \CiviCRM_API3_Exception
1149 public static function failPayment($contributionID, $contactID, $message) {
1150 civicrm_api3('activity', 'create', array(
1151 'activity_type_id' => 'Failed Payment',
1152 'details' => $message,
1153 'subject' => ts('Payment failed at payment processor'),
1154 'source_record_id' => $contributionID,
1155 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() :
1159 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1160 civicrm_api3('contribution', 'create', array(
1161 'id' => $contributionID,
1162 'contribution_status_id' => 'Failed',
1167 * Check if there is a contribution with the same trxn_id or invoice_id.
1169 * @param array $input
1170 * An assoc array of name/value pairs.
1171 * @param array $duplicates
1172 * (reference) store ids of duplicate contribs.
1176 * true if duplicate, false otherwise
1178 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1180 $id = CRM_Utils_Array
::value('id', $input);
1182 $trxn_id = CRM_Utils_Array
::value('trxn_id', $input);
1183 $invoice_id = CRM_Utils_Array
::value('invoice_id', $input);
1189 $clause[] = "trxn_id = %1";
1190 $input[1] = array($trxn_id, 'String');
1194 $clause[] = "invoice_id = %2";
1195 $input[2] = array($invoice_id, 'String');
1198 if (empty($clause)) {
1202 $clause = implode(' OR ', $clause);
1204 $clause = "( $clause ) AND id != %3";
1205 $input[3] = array($id, 'Integer');
1208 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1209 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1211 while ($dao->fetch()) {
1212 $duplicates[] = $dao->id
;
1219 * Takes an associative array and creates a contribution_product object.
1221 * the function extract all the params it needs to initialize the create a
1222 * contribution_product object. the params array could contain additional unused name/value
1225 * @param array $params
1226 * (reference) an assoc array of name/value pairs.
1228 * @return CRM_Contribute_DAO_ContributionProduct
1230 public static function addPremium(&$params) {
1231 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1232 $contributionProduct->copyValues($params);
1233 return $contributionProduct->save();
1237 * Get list of contribution fields for profile.
1238 * For now we only allow custom contribution fields to be in
1241 * @param bool $addExtraFields
1242 * True if special fields needs to be added.
1245 * the list of contribution fields
1247 public static function getContributionFields($addExtraFields = TRUE) {
1248 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1249 // @todo remove this - this line was added because payment_instrument_id was not
1250 // set to exportable - but now it is.
1251 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1253 if ($addExtraFields) {
1254 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1257 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1259 foreach ($contributionFields as $key => $var) {
1260 if ($key == 'contribution_contact_id') {
1263 elseif ($key == 'contribution_campaign_id') {
1264 $var['title'] = ts('Campaign');
1266 $fields[$key] = $var;
1269 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1274 * Add extra fields specific to contribution.
1276 public static function getSpecialContributionFields() {
1277 $extraFields = array(
1278 'contribution_soft_credit_name' => array(
1279 'name' => 'contribution_soft_credit_name',
1280 'title' => ts('Soft Credit Name'),
1281 'headerPattern' => '/^soft_credit_name$/i',
1282 'where' => 'civicrm_contact_d.display_name',
1284 'contribution_soft_credit_email' => array(
1285 'name' => 'contribution_soft_credit_email',
1286 'title' => ts('Soft Credit Email'),
1287 'headerPattern' => '/^soft_credit_email$/i',
1288 'where' => 'soft_email.email',
1290 'contribution_soft_credit_phone' => array(
1291 'name' => 'contribution_soft_credit_phone',
1292 'title' => ts('Soft Credit Phone'),
1293 'headerPattern' => '/^soft_credit_phone$/i',
1294 'where' => 'soft_phone.phone',
1296 'contribution_soft_credit_contact_id' => array(
1297 'name' => 'contribution_soft_credit_contact_id',
1298 'title' => ts('Soft Credit Contact ID'),
1299 'headerPattern' => '/^soft_credit_contact_id$/i',
1300 'where' => 'civicrm_contribution_soft.contact_id',
1302 'contribution_pcp_title' => array(
1303 'name' => 'contribution_pcp_title',
1304 'title' => ts('Personal Campaign Page Title'),
1305 'headerPattern' => '/^contribution_pcp_title$/i',
1306 'where' => 'contribution_pcp.title',
1310 return $extraFields;
1314 * @param int $pageID
1318 public static function getCurrentandGoalAmount($pageID) {
1320 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1321 FROM civicrm_contribution_page p,
1322 civicrm_contribution c
1323 WHERE p.id = c.contribution_page_id
1325 AND c.cancel_date is null
1329 $config = CRM_Core_Config
::singleton();
1330 $params = array(1 => array($pageID, 'Integer'));
1331 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1333 if ($dao->fetch()) {
1334 return array($dao->goal
, $dao->total
);
1337 return array(NULL, NULL);
1342 * Get list of contributions which credit the passed in contact ID.
1344 * The returned array provides details about the original contribution & donor.
1346 * @todo - this is a confusing function called from one place. It has a test. It would be
1347 * nice to deprecate it.
1349 * @param int $honorId
1350 * In Honor of Contact ID.
1353 * list of contribution fields
1355 public static function getHonorContacts($honorId) {
1357 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1358 $honorDAO->contact_id
= $honorId;
1361 $type = CRM_Contribute_PseudoConstant
::financialType();
1363 while ($honorDAO->fetch()) {
1364 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1365 $contributionDAO->id
= $honorDAO->contribution_id
;
1367 if ($contributionDAO->find(TRUE)) {
1368 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1369 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1370 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1371 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1372 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1373 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1374 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1375 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1376 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
);
1384 * Get the sort name of a contact for a particular contribution.
1387 * Id of the contribution.
1389 * @return null|string
1390 * sort name of the contact if found
1392 public static function sortName($id) {
1393 $id = CRM_Utils_Type
::escape($id, 'Integer');
1396 SELECT civicrm_contact.sort_name
1397 FROM civicrm_contribution, civicrm_contact
1398 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1399 AND civicrm_contribution.id = {$id}
1401 return CRM_Core_DAO
::singleValueQuery($query);
1405 * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1407 * @param int|array $contactIDs
1411 public static function annual($contactIDs) {
1412 if (!is_array($contactIDs)) {
1413 // In practice I can't fine any evidence that this function is ever called with
1414 // anything other than a single contact id, but left like this due to .... fear.
1415 $contactIDs = explode(',', $contactIDs);
1418 $query = self
::getAnnualQuery($contactIDs);
1419 $dao = CRM_Core_DAO
::executeQuery($query);
1421 $amount = $average = array();
1422 while ($dao->fetch()) {
1423 if ($dao->count
> 0 && $dao->amount
> 0) {
1424 $count +
= $dao->count
;
1425 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1426 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1432 implode(', ', $amount),
1433 implode(', ', $average),
1436 return array(0, 0, 0);
1440 * Check if there is a contribution with the params passed in.
1442 * Used for trxn_id,invoice_id and contribution_id
1444 * @param array $params
1445 * An assoc array of name/value pairs.
1448 * contribution id if success else NULL
1450 public static function checkDuplicateIds($params) {
1451 $dao = new CRM_Contribute_DAO_Contribution();
1455 foreach ($params as $k => $v) {
1457 $clause[] = "$k = '$v'";
1460 $clause = implode(' AND ', $clause);
1461 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1462 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1464 while ($dao->fetch()) {
1472 * Get the contribution details for component export.
1474 * @param int $exportMode
1476 * @param array $componentIds
1482 public static function getContributionDetails($exportMode, $componentIds) {
1483 $paymentDetails = array();
1484 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1486 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1487 $componentSelect = " civicrm_participant_payment.participant_id id";
1488 $additionalClause = "
1489 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1490 AND civicrm_participant_payment.participant_id {$componentClause} )
1493 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1494 $componentSelect = " civicrm_membership_payment.membership_id id";
1495 $additionalClause = "
1496 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1497 AND civicrm_membership_payment.membership_id {$componentClause} )
1500 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1501 $componentSelect = " civicrm_pledge_payment.id id";
1502 $additionalClause = "
1503 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1504 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1508 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1509 trxn_id, {$componentSelect}
1510 FROM civicrm_contribution
1511 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1512 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1513 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1514 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1515 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1516 AND option_group_contribution_status.id = contribution_status.option_group_id )
1520 $dao = CRM_Core_DAO
::executeQuery($query);
1522 while ($dao->fetch()) {
1523 $paymentDetails[$dao->id
] = array(
1524 'total_amount' => $dao->total_amount
,
1525 'contribution_status' => $dao->status
,
1526 'receive_date' => $dao->receive_date
,
1527 'pay_instru' => $dao->payment_instrument
,
1528 'trxn_id' => $dao->trxn_id
,
1532 return $paymentDetails;
1536 * Create address associated with contribution record.
1538 * As long as there is one or more billing field in the parameters we will create the address.
1540 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1543 * @param array $params
1544 * @param int $billingLocationTypeID
1549 public static function createAddress($params, $billingLocationTypeID) {
1550 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1551 if ($hasBillingField) {
1552 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1553 return $address->id
;
1560 * Delete billing address record related contribution.
1562 * @param int $contributionId
1563 * @param int $contactId
1565 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1567 $contactJoin = NULL;
1569 if ($contributionId) {
1570 $clauses[] = "cc.id = {$contributionId}";
1574 $clauses[] = "cco.id = {$contactId}";
1575 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1578 if (empty($clauses)) {
1579 CRM_Core_Error
::fatal();
1582 $condition = implode(' OR ', $clauses);
1586 FROM civicrm_address ca
1587 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1591 $dao = CRM_Core_DAO
::executeQuery($query);
1593 while ($dao->fetch()) {
1594 $params = array('id' => $dao->id
);
1595 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1600 * This function check online pending contribution associated w/
1601 * Online Event Registration or Online Membership signup.
1603 * @param int $componentId
1604 * Participant/membership id.
1605 * @param string $componentName
1609 * pending contribution id.
1611 public static function checkOnlinePendingContribution($componentId, $componentName) {
1612 $contributionId = NULL;
1613 if (!$componentId ||
1614 !in_array($componentName, array('Event', 'Membership'))
1616 return $contributionId;
1619 if ($componentName == 'Event') {
1620 $idName = 'participant_id';
1621 $componentTable = 'civicrm_participant';
1622 $paymentTable = 'civicrm_participant_payment';
1623 $source = ts('Online Event Registration');
1626 if ($componentName == 'Membership') {
1627 $idName = 'membership_id';
1628 $componentTable = 'civicrm_membership';
1629 $paymentTable = 'civicrm_membership_payment';
1630 $source = ts('Online Contribution');
1633 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
1636 SELECT component.id as {$idName},
1637 componentPayment.contribution_id as contribution_id,
1638 contribution.source source,
1639 contribution.contribution_status_id as contribution_status_id,
1640 contribution.is_pay_later as is_pay_later
1641 FROM $componentTable component
1642 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
1643 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1644 WHERE component.id = {$componentId}";
1646 $dao = CRM_Core_DAO
::executeQuery($query);
1648 while ($dao->fetch()) {
1649 if ($dao->contribution_id
&&
1650 $dao->is_pay_later
&&
1651 $dao->contribution_status_id
== $pendingStatusId &&
1652 strpos($dao->source
, $source) !== FALSE
1654 $contributionId = $dao->contribution_id
;
1658 return $contributionId;
1662 * Update contribution as well as related objects.
1664 * This function by-passes hooks - to address this - don't use this function.
1668 * Use api contribute.completetransaction
1669 * For failures use failPayment (preferably exposing by api in the process).
1671 * @param array $params
1672 * @param bool $processContributionObject
1675 * @throws \Exception
1677 public static function transitionComponents($params, $processContributionObject = FALSE) {
1678 // get minimum required values.
1679 $contactId = CRM_Utils_Array
::value('contact_id', $params);
1680 $componentId = CRM_Utils_Array
::value('component_id', $params);
1681 $componentName = CRM_Utils_Array
::value('componentName', $params);
1682 $contributionId = CRM_Utils_Array
::value('contribution_id', $params);
1683 $contributionStatusId = CRM_Utils_Array
::value('contribution_status_id', $params);
1685 // if we already processed contribution object pass previous status id.
1686 $previousContriStatusId = CRM_Utils_Array
::value('previous_contribution_status_id', $params);
1688 $updateResult = array();
1690 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1692 // we process only ( Completed, Cancelled, or Failed ) contributions.
1693 if (!$contributionId ||
1694 !in_array($contributionStatusId, array(
1695 array_search('Completed', $contributionStatuses),
1696 array_search('Cancelled', $contributionStatuses),
1697 array_search('Failed', $contributionStatuses),
1700 return $updateResult;
1703 if (!$componentName ||
!$componentId) {
1704 // get the related component details.
1705 $componentDetails = self
::getComponentDetails($contributionId);
1708 $componentDetails['contact_id'] = $contactId;
1709 $componentDetails['component'] = $componentName;
1711 if ($componentName == 'event') {
1712 $componentDetails['participant'] = $componentId;
1715 $componentDetails['membership'] = $componentId;
1719 if (!empty($componentDetails['contact_id'])) {
1720 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
1726 // do check for required ids.
1727 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
1728 return $updateResult;
1731 //now we are ready w/ required ids, start processing.
1733 $baseIPN = new CRM_Core_Payment_BaseIPN();
1735 $input = $ids = $objects = array();
1737 $input['component'] = CRM_Utils_Array
::value('component', $componentDetails);
1738 $ids['contribution'] = $contributionId;
1739 $ids['contact'] = CRM_Utils_Array
::value('contact_id', $componentDetails);
1740 $ids['membership'] = CRM_Utils_Array
::value('membership', $componentDetails);
1741 $ids['participant'] = CRM_Utils_Array
::value('participant', $componentDetails);
1742 $ids['event'] = CRM_Utils_Array
::value('event', $componentDetails);
1743 $ids['pledge_payment'] = CRM_Utils_Array
::value('pledge_payment', $componentDetails);
1744 $ids['contributionRecur'] = NULL;
1745 $ids['contributionPage'] = NULL;
1747 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1748 CRM_Core_Error
::fatal();
1751 $memberships = &$objects['membership'];
1752 $participant = &$objects['participant'];
1753 $pledgePayment = &$objects['pledge_payment'];
1754 $contribution = &$objects['contribution'];
1756 if ($pledgePayment) {
1757 $pledgePaymentIDs = array();
1758 foreach ($pledgePayment as $key => $object) {
1759 $pledgePaymentIDs[] = $object->id
;
1761 $pledgeID = $pledgePayment[0]->pledge_id
;
1764 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
1767 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
1768 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1773 // we might want to process contribution object.
1774 $processContribution = FALSE;
1775 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1776 if (is_array($memberships)) {
1777 foreach ($memberships as $membership) {
1779 //Update Membership status if there is no other completed contribution associated with the membership.
1780 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1781 foreach ($relatedContributions as $contriId) {
1782 if ($contriId == $contributionId) {
1785 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1786 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1790 if ($membership && $update) {
1791 $newStatus = array_search('Cancelled', $membershipStatuses);
1794 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
1795 $activityParam = array(
1796 'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
1797 'source_contact_id' => CRM_Core_Session
::singleton()->get('userID'),
1798 'target_contact_id' => $membership->contact_id
,
1799 'source_record_id' => $membership->id
,
1800 'activity_type_id' => 'Change Membership Status',
1801 'status_id' => 'Completed',
1802 'priority_id' => 'Normal',
1803 'activity_date_time' => 'now',
1806 $membership->status_id
= $newStatus;
1807 $membership->is_override
= TRUE;
1808 $membership->status_override_end_date
= 'null';
1809 $membership->save();
1810 civicrm_api3('activity', 'create', $activityParam);
1812 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1813 if ($processContributionObject) {
1814 $processContribution = TRUE;
1821 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1822 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1824 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1825 if ($processContributionObject) {
1826 $processContribution = TRUE;
1830 if ($pledgePayment) {
1831 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1833 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1834 if ($processContributionObject) {
1835 $processContribution = TRUE;
1839 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1840 if (is_array($memberships)) {
1841 foreach ($memberships as $membership) {
1843 //Update Membership status if there is no other completed contribution associated with the membership.
1844 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1845 foreach ($relatedContributions as $contriId) {
1846 if ($contriId == $contributionId) {
1849 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1850 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1854 if ($membership && $update) {
1855 $membership->status_id
= array_search('Expired', $membershipStatuses);
1856 $membership->is_override
= TRUE;
1857 $membership->status_override_end_date
= 'null';
1858 $membership->save();
1860 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1861 if ($processContributionObject) {
1862 $processContribution = TRUE;
1868 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1869 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1871 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1872 if ($processContributionObject) {
1873 $processContribution = TRUE;
1877 if ($pledgePayment) {
1878 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1880 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1881 if ($processContributionObject) {
1882 $processContribution = TRUE;
1886 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1888 // only pending contribution related object processed.
1889 if ($previousContriStatusId &&
1890 !in_array($contributionStatuses[$previousContriStatusId], array('Pending', 'Partially paid'))
1892 // this is case when we already processed contribution object.
1893 return $updateResult;
1895 elseif (!$previousContriStatusId &&
1896 !in_array($contributionStatuses[$contribution->contribution_status_id
], array('Pending', 'Partially paid'))
1898 // this is case when we are going to process contribution object later.
1899 return $updateResult;
1902 if (is_array($memberships)) {
1903 foreach ($memberships as $membership) {
1908 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
1909 $membership->membership_type_id
,
1910 $membership->is_test
, $membership->id
1913 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1914 // this picks up membership type changes during renewals
1916 SELECT membership_type_id
1917 FROM civicrm_membership_log
1918 WHERE membership_id=$membership->id
1921 $dao = new CRM_Core_DAO();
1923 if ($dao->fetch()) {
1924 if (!empty($dao->membership_type_id
)) {
1925 $membership->membership_type_id
= $dao->membership_type_id
;
1926 $membership->save();
1929 // else fall back to using current membership type
1930 // Figure out number of terms
1932 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
1933 foreach ($lineitems as $lineitem) {
1934 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
1935 $numterms = CRM_Utils_Array
::value('membership_num_terms', $lineitem);
1937 // in case membership_num_terms comes through as null or zero
1938 $numterms = $numterms >= 1 ?
$numterms : 1;
1943 // CRM-15735-to update the membership status as per the contribution receive date
1945 $oldStatus = $membership->status_id
;
1946 if (!empty($params['receive_date'])) {
1947 $joinDate = $params['receive_date'];
1948 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
1949 $membership->end_date
,
1950 $membership->join_date
,
1951 $params['receive_date'],
1953 $membership->membership_type_id
,
1956 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
1957 $membership->save();
1960 if ($currentMembership) {
1961 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1962 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
1963 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1966 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
1969 //get the status for membership.
1970 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
1972 $dates['join_date'],
1975 $membership->membership_type_id
,
1979 $formattedParams = array(
1980 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
1981 array_search('Current', $membershipStatuses)
1983 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
1984 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
1985 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
1988 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
1990 $membership->copyValues($formattedParams);
1991 $membership->save();
1993 //updating the membership log
1994 $membershipLog = array();
1995 $membershipLog = $formattedParams;
1996 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
1997 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
1999 $membershipLog['start_date'] = $logStartDate;
2000 $membershipLog['membership_id'] = $membership->id
;
2001 $membershipLog['modified_id'] = $membership->contact_id
;
2002 $membershipLog['modified_date'] = date('Ymd');
2003 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
2005 CRM_Member_BAO_MembershipLog
::add($membershipLog);
2007 //update related Memberships.
2008 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
2010 foreach (array('Membership Signup', 'Membership Renewal') as $activityType) {
2011 $scheduledActivityID = CRM_Utils_Array
::value('id',
2012 civicrm_api3('Activity', 'Get',
2014 'source_record_id' => $membership->id
,
2015 'activity_type_id' => $activityType,
2016 'status_id' => 'Scheduled',
2019 'sort' => 'id DESC',
2024 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2025 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2026 if ($scheduledActivityID) {
2027 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, array('id' => $scheduledActivityID));
2032 // track membership status change if any
2033 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
2034 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
2035 CRM_Activity_BAO_Activity
::addActivity($membership,
2036 'Change Membership Status',
2039 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2040 'source_contact_id' => $membershipLog['modified_id'],
2041 'priority_id' => 'Normal',
2046 $updateResult['membership_end_date'] = CRM_Utils_Date
::customFormat($dates['end_date'],
2049 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2050 if ($processContributionObject) {
2051 $processContribution = TRUE;
2054 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2060 $updatedStatusId = array_search('Registered', $participantStatuses);
2061 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2063 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2064 if ($processContributionObject) {
2065 $processContribution = TRUE;
2069 if ($pledgePayment) {
2070 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2072 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2073 if ($processContributionObject) {
2074 $processContribution = TRUE;
2079 // process contribution object.
2080 if ($processContribution) {
2081 $contributionParams = array();
2088 'payment_instrument_id',
2091 'financial_type_id',
2092 'contribution_status_id',
2093 'non_deductible_amount',
2097 foreach ($fields as $field) {
2098 if (empty($params[$field])) {
2101 $contributionParams[$field] = $params[$field];
2104 $ids = array('contribution' => $contributionId);
2105 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2108 return $updateResult;
2112 * Returns all contribution related object ids.
2114 * @param $contributionId
2118 public static function getComponentDetails($contributionId) {
2119 $componentDetails = $pledgePayment = array();
2120 if (!$contributionId) {
2121 return $componentDetails;
2125 SELECT c.id as contribution_id,
2126 c.contact_id as contact_id,
2127 c.contribution_recur_id,
2128 mp.membership_id as membership_id,
2129 m.membership_type_id as membership_type_id,
2130 pp.participant_id as participant_id,
2131 p.event_id as event_id,
2132 pgp.id as pledge_payment_id
2133 FROM civicrm_contribution c
2134 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2135 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2136 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2137 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2138 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2139 WHERE c.id = $contributionId";
2141 $dao = CRM_Core_DAO
::executeQuery($query);
2142 $componentDetails = array();
2144 while ($dao->fetch()) {
2145 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2146 $componentDetails['contact_id'] = $dao->contact_id
;
2147 if ($dao->event_id
) {
2148 $componentDetails['event'] = $dao->event_id
;
2150 if ($dao->participant_id
) {
2151 $componentDetails['participant'] = $dao->participant_id
;
2153 if ($dao->membership_id
) {
2154 if (!isset($componentDetails['membership'])) {
2155 $componentDetails['membership'] = $componentDetails['membership_type'] = array();
2157 $componentDetails['membership'][] = $dao->membership_id
;
2158 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2160 if ($dao->pledge_payment_id
) {
2161 $pledgePayment[] = $dao->pledge_payment_id
;
2163 if ($dao->contribution_recur_id
) {
2164 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2168 if ($pledgePayment) {
2169 $componentDetails['pledge_payment'] = $pledgePayment;
2172 return $componentDetails;
2176 * @param int $contactId
2177 * @param bool $includeSoftCredit
2179 * @return null|string
2181 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2185 $financialTypes = CRM_Financial_BAO_FinancialType
::getAllAvailableFinancialTypes();
2186 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2187 $liWhere = " AND i.financial_type_id IN (0)";
2188 if (!empty($financialTypes)) {
2189 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2190 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2192 $contactContributionsSQL = "
2193 SELECT contribution.id AS id
2194 FROM civicrm_contribution contribution
2195 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2196 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2200 $contactSoftCreditContributionsSQL = "
2201 SELECT contribution.id
2202 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2203 ON ( contribution.id = softContribution.contribution_id )
2204 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2205 $query = "SELECT count( x.id ) count FROM ( ";
2206 $query .= $contactContributionsSQL;
2208 if ($includeSoftCredit) {
2209 $query .= " UNION ";
2210 $query .= $contactSoftCreditContributionsSQL;
2215 return CRM_Core_DAO
::singleValueQuery($query);
2219 * Repeat a transaction as part of a recurring series.
2221 * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2222 * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2223 * subsequent call to the contribution.completetransaction api.
2225 * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2227 * @param CRM_Contribute_BAO_Contribution $contribution
2228 * @param array $input
2229 * @param array $contributionParams
2230 * @param int $paymentProcessorID
2233 * @throws CiviCRM_API3_Exception
2235 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2236 if (!empty($contribution->id
)) {
2239 if (empty($contribution->id
)) {
2240 // Unclear why this would only be set for repeats.
2241 if (!empty($input['amount'])) {
2242 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2245 if (!empty($contributionParams['contribution_recur_id'])) {
2246 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2247 'id' => $contributionParams['contribution_recur_id'],
2249 if (!empty($recurringContribution['campaign_id'])) {
2250 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2251 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2253 if (!empty($recurringContribution['financial_type_id'])) {
2254 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2255 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2258 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2259 $contributionParams['contribution_recur_id'],
2260 array_intersect_key($contributionParams, array('total_amount' => TRUE, 'financial_type_id' => TRUE))
2262 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2264 $contributionParams['status_id'] = 'Pending';
2265 if (isset($contributionParams['financial_type_id'])) {
2266 // Give precedence to passed in type.
2267 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2270 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2272 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2273 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2275 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2276 //do not create CC or BCC emails or profile notifications.
2277 //The if is just to be safe. Not sure if we can ever arrive with this unset
2278 // but per CRM-19478 it seems it can be 'null'
2279 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2280 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2283 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2284 $contribution->id
= $createContribution['id'];
2285 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2291 * Get individual id for onbehalf contribution.
2293 * @param int $contributionId
2295 * @param int $contributorId
2299 * containing organization id and individual id
2301 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2305 if (!$contributionId) {
2309 // fetch contributor id if null
2310 if (!$contributorId) {
2311 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2312 $contributionId, 'contact_id'
2316 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2317 $activityTypeId = array_search('Contribution', $activityTypeIds);
2319 if ($activityTypeId && $contributorId) {
2321 SELECT civicrm_activity_contact.contact_id
2322 FROM civicrm_activity_contact
2323 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2324 WHERE civicrm_activity.activity_type_id = %1
2325 AND civicrm_activity.source_record_id = %2
2326 AND civicrm_activity_contact.record_type_id = %3
2329 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2330 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2333 1 => array($activityTypeId, 'Integer'),
2334 2 => array($contributionId, 'Integer'),
2335 3 => array($sourceID, 'Integer'),
2338 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2340 // for on behalf contribution source is individual and contributor is organization
2341 if ($sourceContactId && $sourceContactId != $contributorId) {
2342 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2343 // get rel type id for employee of relation
2344 foreach ($relationshipTypeIds as $id => $typeVals) {
2345 if ($typeVals['name_a_b'] == 'Employee of') {
2346 $relationshipTypeId = $id;
2351 $rel = new CRM_Contact_DAO_Relationship();
2352 $rel->relationship_type_id
= $relationshipTypeId;
2353 $rel->contact_id_a
= $sourceContactId;
2354 $rel->contact_id_b
= $contributorId;
2355 if ($rel->find(TRUE)) {
2356 $ids['individual_id'] = $rel->contact_id_a
;
2357 $ids['organization_id'] = $rel->contact_id_b
;
2368 public static function getContributionDates() {
2369 $config = CRM_Core_Config
::singleton();
2370 $currentMonth = date('m');
2371 $currentDay = date('d');
2372 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2373 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2374 (int ) $config->fiscalYearStart
['d'] > $currentDay
2377 $year = date('Y') - 1;
2382 $year = array('Y' => $year);
2383 $yearDate = $config->fiscalYearStart
;
2384 $yearDate = array_merge($year, $yearDate);
2385 $yearDate = CRM_Utils_Date
::format($yearDate);
2387 $monthDate = date('Ym') . '01';
2393 'yearDate' => $yearDate,
2394 'monthDate' => $monthDate,
2399 * Load objects relations to contribution object.
2400 * Objects are stored in the $_relatedObjects property
2401 * In the first instance we are just moving functionality from BASEIpn -
2402 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2404 * Note that the unit test for the BaseIPN class tests this function
2406 * @param array $input
2407 * Input as delivered from Payment Processor.
2409 * Ids as Loaded by Payment Processor.
2410 * @param bool $loadAll
2411 * Load all related objects - even where id not passed in? (allows API to call this).
2416 public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2418 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2419 if (empty($ids['contact']) && isset($this->contact_id
)) {
2420 $ids['contact'] = $this->contact_id
;
2423 if (empty($this->_component
)) {
2424 if (!empty($ids['event'])) {
2425 $this->_component
= 'event';
2428 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2432 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2433 // refactoring than anything else, and has unit test coverage.
2434 if (empty($this->financial_type_id
)) {
2438 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2443 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2444 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2445 $this->contribution_page_id
,
2448 if ($paymentProcessorID) {
2449 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2453 $ids['contributionType'] = $this->financial_type_id
;
2454 $ids['financialType'] = $this->financial_type_id
;
2455 if ($this->contribution_page_id
) {
2456 $ids['contributionPage'] = $this->contribution_page_id
;
2459 $this->loadRelatedEntitiesByID($ids);
2461 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2462 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2465 if (!empty($ids['pledge_payment'])) {
2466 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2467 if (empty($paymentID)) {
2470 $payment = new CRM_Pledge_BAO_PledgePayment();
2471 $payment->id
= $paymentID;
2472 if (!$payment->find(TRUE)) {
2473 throw new Exception("Could not find pledge payment record: " . $paymentID);
2475 $this->_relatedObjects
['pledge_payment'][] = $payment;
2479 $ids = $this->loadRelatedMembershipObjects($ids);
2481 if ($this->_component
!= 'contribute') {
2482 // we are in event mode
2483 // make sure event exists and is valid
2484 $event = new CRM_Event_BAO_Event();
2485 $event->id
= $ids['event'];
2486 if ($ids['event'] &&
2489 throw new Exception("Could not find event: " . $ids['event']);
2492 $this->_relatedObjects
['event'] = &$event;
2494 $participant = new CRM_Event_BAO_Participant();
2495 $participant->id
= $ids['participant'];
2496 if ($ids['participant'] &&
2497 !$participant->find(TRUE)
2499 throw new Exception("Could not find participant: " . $ids['participant']);
2501 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2503 $this->_relatedObjects
['participant'] = &$participant;
2505 // get the payment processor id from event - this is inaccurate see CRM-16923
2506 // in future we should look at throwing an exception here rather than an dubious guess.
2507 if (!$paymentProcessorID) {
2508 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2509 if ($paymentProcessorID) {
2510 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2515 if ($paymentProcessorID) {
2516 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2517 $this->is_test ?
'test' : 'live'
2519 $ids['paymentProcessor'] = $paymentProcessorID;
2520 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2523 // Add contribution id to $ids. CRM-20401
2524 $ids['contribution'] = $this->id
;
2529 * Create array of message information - ie. return html version, txt version, to field
2531 * @param array $input
2532 * Incoming information.
2533 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2534 * just check presence of recur object but maintaining legacy approach
2537 * IDs of related objects.
2538 * @param array $values
2539 * Any values that may have already been compiled by calling process.
2540 * This is augmented by values 'gathered' by gatherMessageValues
2541 * @param bool $returnMessageText
2542 * Distinguishes between whether to send message or return.
2543 * message text. We are working towards this function ALWAYS returning message text & calling
2544 * function doing emails / pdfs with it
2550 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2551 $this->loadRelatedObjects($input, $ids);
2553 if (empty($this->_component
)) {
2554 $this->_component
= CRM_Utils_Array
::value('component', $input);
2557 //not really sure what params might be passed in but lets merge em into values
2558 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2559 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2560 if (!empty($input['receipt_date'])) {
2561 $values['receipt_date'] = $input['receipt_date'];
2564 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2565 //what does recur 'mean here - to do with payment processor return functionality but
2566 // what is the importance
2567 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2568 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2570 $entityID = $entity = NULL;
2571 if (isset($ids['contribution'])) {
2572 $entity = 'contribution';
2573 $entityID = $ids['contribution'];
2575 if (!empty($ids['membership'])) {
2576 //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
2577 // 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
2578 // line having loaded an array
2579 $ids['membership'] = (array) $ids['membership'];
2580 $entity = 'membership';
2581 $entityID = $ids['membership'][0];
2584 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2585 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2586 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2588 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2589 //direct mode showing billing block, so use directIPN for temporary
2590 $template->assign('contributeMode', 'directIPN');
2593 // todo remove strtolower - check consistency
2594 if (strtolower($this->_component
) == 'event') {
2595 $eventParams = array('id' => $this->_relatedObjects
['participant']->event_id
);
2596 $values['event'] = array();
2598 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2600 //get location details
2601 $locationParams = array('entity_id' => $this->_relatedObjects
['participant']->event_id
, 'entity_table' => 'civicrm_event');
2602 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2604 $ufJoinParams = array(
2605 'entity_table' => 'civicrm_event',
2606 'entity_id' => $ids['event'],
2607 'module' => 'CiviEvent',
2610 list($custom_pre_id,
2612 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2614 $values['custom_pre_id'] = $custom_pre_id;
2615 $values['custom_post_id'] = $custom_post_ids;
2616 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2617 //and cases involving status updation through ipn
2618 // whatever that means!
2619 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2620 // perhaps we should throw an e-notice if amount is set & force total_amount?
2621 if (!empty($input['amount'])) {
2622 $values['totalAmount'] = $input['amount'];
2624 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2625 if ($values['event']['is_email_confirm']) {
2626 $values['is_email_receipt'] = 1;
2629 if (!empty($ids['contribution'])) {
2630 $values['contributionId'] = $ids['contribution'];
2633 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
2634 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
2638 $values['contribution_id'] = $this->id
;
2639 if (!empty($ids['related_contact'])) {
2640 $values['related_contact'] = $ids['related_contact'];
2641 if (isset($ids['onbehalf_dupe_alert'])) {
2642 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2644 $entityBlock = array(
2645 'contact_id' => $ids['contact'],
2646 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
2647 'Home', 'id', 'name'
2650 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
2651 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2654 if ($this->is_test
) {
2657 if (!empty($this->_relatedObjects
['membership'])) {
2658 foreach ($this->_relatedObjects
['membership'] as $membership) {
2659 if ($membership->id
) {
2660 $values['membership_id'] = $membership->id
;
2661 $values['isMembership'] = TRUE;
2662 $values['membership_assign'] = TRUE;
2664 // need to set the membership values here
2665 $template->assign('membership_name',
2666 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
2668 $template->assign('mem_start_date', $membership->start_date
);
2669 $template->assign('mem_join_date', $membership->join_date
);
2670 $template->assign('mem_end_date', $membership->end_date
);
2671 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
2672 $template->assign('mem_status', $membership_status);
2673 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
2674 $values['is_pay_later'] = 1;
2676 // Pass amount to floatval as string '0.00' is considered a
2677 // valid amount and includes Fee section in the mail.
2678 if (isset($values['amount'])) {
2679 $values['amount'] = floatval($values['amount']);
2682 if (!empty($this->contribution_recur_id
) && $paymentObject) {
2683 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
2684 $template->assign('cancelSubscriptionUrl', $url);
2685 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
2686 $template->assign('updateSubscriptionBillingUrl', $url);
2687 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2688 $template->assign('updateSubscriptionUrl', $url);
2691 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2694 // otherwise if its about sending emails, continue sending without return, as we
2695 // don't want to exit the loop.
2700 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2706 * Gather values for contribution mail - this function has been created
2707 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2708 * Values related to the contribution in question are gathered
2710 * @param array $input
2711 * Input into function (probably from payment processor).
2712 * @param array $values
2714 * The set of ids related to the input.
2718 public function _gatherMessageValues($input, &$values, $ids = array()) {
2719 // set display address of contributor
2720 if ($this->address_id
) {
2721 $addressParams = array('id' => $this->address_id
);
2722 $addressDetails = CRM_Core_BAO_Address
::getValues($addressParams, FALSE, 'id');
2723 $addressDetails = array_values($addressDetails);
2725 // Else we assign the billing address of the contribution contact.
2727 $addressParams = array('contact_id' => $this->contact_id
, 'is_billing' => 1);
2728 $addressDetails = (array) CRM_Core_BAO_Address
::getValues($addressParams);
2729 $addressDetails = array_values($addressDetails);
2732 if (!empty($addressDetails[0]['display'])) {
2733 $values['address'] = $addressDetails[0]['display'];
2736 if ($this->_component
== 'contribute') {
2737 //get soft contributions
2738 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
2739 if (!empty($softContributions)) {
2740 $values['softContributions'] = $softContributions['soft_credit'];
2742 if (isset($this->contribution_page_id
)) {
2743 // This is a call we want to use less, in favour of loading related objects.
2744 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
2745 if ($this->contribution_page_id
) {
2746 // This is precautionary as there are some legacy flows, but it should really be
2748 if (!isset($this->_relatedObjects
['contributionPage'])) {
2749 $this->loadRelatedEntitiesByID(array('contributionPage' => $this->contribution_page_id
));
2751 // CRM-8254 - override default currency if applicable
2752 $config = CRM_Core_Config
::singleton();
2753 $config->defaultCurrency
= CRM_Utils_Array
::value(
2756 $config->defaultCurrency
2760 // no contribution page -probably back office
2762 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2763 $values['title'] = 'Contribution';
2765 // set lineItem for contribution
2767 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
2768 if (!empty($lineItems)) {
2769 $firstLineItem = reset($lineItems);
2770 $priceSet = array();
2771 if (CRM_Utils_Array
::value('price_set_id', $firstLineItem)) {
2772 $priceSet = civicrm_api3('PriceSet', 'getsingle', array('id' => $firstLineItem['price_set_id'], 'return' => 'is_quick_config, id'));
2773 $values['priceSetID'] = $priceSet['id'];
2775 foreach ($lineItems as &$eachItem) {
2776 if (isset($this->_relatedObjects
['membership'])
2777 && is_array($this->_relatedObjects
['membership'])
2778 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
2779 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
2780 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
2781 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
2783 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
2784 // However, that does create upgrade pain so would be better to be phased in.
2785 $values['useForMember'] = empty($priceSet['is_quick_config']);
2787 $values['lineItem'][0] = $lineItems;
2791 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
2795 // if this is onbehalf of contribution then set related contact
2796 if (!empty($relatedContact['individual_id'])) {
2797 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2802 $eventParams = array(
2803 'id' => $this->_relatedObjects
['event']->id
,
2805 $values['event'] = array();
2807 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2808 // add custom fields for event
2809 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', NULL, $this->_relatedObjects
['event']->id
);
2811 $eventCustomGroup = array();
2812 foreach ($eventGroupTree as $key => $group) {
2813 if ($key === 'info') {
2817 foreach ($group['fields'] as $k => $customField) {
2818 $groupLabel = $group['title'];
2819 if (!empty($customField['customValue'])) {
2820 foreach ($customField['customValue'] as $customFieldValues) {
2821 $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2826 $values['event']['customGroup'] = $eventCustomGroup;
2828 //get participant details
2829 $participantParams = array(
2830 'id' => $this->_relatedObjects
['participant']->id
,
2833 $values['participant'] = array();
2835 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
2836 // add custom fields for event
2837 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', NULL, $this->_relatedObjects
['participant']->id
);
2838 $participantCustomGroup = array();
2839 foreach ($participantGroupTree as $key => $group) {
2840 if ($key === 'info') {
2844 foreach ($group['fields'] as $k => $customField) {
2845 $groupLabel = $group['title'];
2846 if (!empty($customField['customValue'])) {
2847 foreach ($customField['customValue'] as $customFieldValues) {
2848 $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2853 $values['participant']['customGroup'] = $participantCustomGroup;
2855 //get location details
2856 $locationParams = array(
2857 'entity_id' => $this->_relatedObjects
['event']->id
,
2858 'entity_table' => 'civicrm_event',
2860 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2862 $ufJoinParams = array(
2863 'entity_table' => 'civicrm_event',
2864 'entity_id' => $ids['event'],
2865 'module' => 'CiviEvent',
2868 list($custom_pre_id,
2870 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2872 $values['custom_pre_id'] = $custom_pre_id;
2873 $values['custom_post_id'] = $custom_post_ids;
2875 // set lineItem for event contribution
2877 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($this->id
);
2878 if (!empty($participantIds)) {
2879 foreach ($participantIds as $pIDs) {
2880 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
2881 if (!CRM_Utils_System
::isNull($lineItem)) {
2882 $values['lineItem'][] = $lineItem;
2889 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', NULL, $this->id
);
2891 $customGroup = array();
2892 foreach ($groupTree as $key => $group) {
2893 if ($key === 'info') {
2897 foreach ($group['fields'] as $k => $customField) {
2898 $groupLabel = $group['title'];
2899 if (!empty($customField['customValue'])) {
2900 foreach ($customField['customValue'] as $customFieldValues) {
2901 $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2906 $values['customGroup'] = $customGroup;
2908 $values['is_pay_later'] = $this->is_pay_later
;
2914 * Assign message variables to template but try to break the habit.
2916 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2917 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2918 * multiple recurring payments for processors like IATS that use tokens.
2920 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2921 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2922 * Note we send directly from this function in some cases because it is only partly refactored.
2924 * Don't call this function directly as the signature will change.
2928 * @param bool $returnMessageText
2932 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
2933 // @todo - this should have a better separation of concerns - ie.
2934 // gatherMessageValues should build an array of values to be assigned to the template
2935 // and this function should assign them (assigning null if not set).
2936 // the way the pcpParams & honor Params section works is a baby-step towards this.
2937 $template = CRM_Core_Smarty
::singleton();
2938 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
2939 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
2940 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
2942 // For some unit tests contribution cannot contain paymentProcessor information
2943 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
2944 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
2946 //assign honor information to receipt message
2947 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
2949 $honorParams = ['soft_credit_type' => NULL, 'honor_block_is_active' => NULL];
2950 if (isset($softRecord['soft_credit'])) {
2951 //if id of contribution page is present
2952 if (!empty($values['id'])) {
2953 $values['honor'] = array(
2954 'honor_profile_values' => array(),
2955 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2956 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2959 $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
2960 $honorParams['honor_block_is_active'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
2963 //offline contribution
2964 $softCreditTypes = $softCredits = array();
2965 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2966 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2967 $softCredits[$key] = array(
2968 'Name' => $softCredit['contact_name'],
2969 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
2972 $template->assign('softCreditTypes', $softCreditTypes);
2973 $template->assign('softCredits', $softCredits);
2977 $dao = new CRM_Contribute_DAO_ContributionProduct();
2978 $dao->contribution_id
= $this->id
;
2979 if ($dao->find(TRUE)) {
2980 $premiumId = $dao->product_id
;
2981 $template->assign('option', $dao->product_option
);
2983 $productDAO = new CRM_Contribute_DAO_Product();
2984 $productDAO->id
= $premiumId;
2985 $productDAO->find(TRUE);
2986 $template->assign('selectPremium', TRUE);
2987 $template->assign('product_name', $productDAO->name
);
2988 $template->assign('price', $productDAO->price
);
2989 $template->assign('sku', $productDAO->sku
);
2991 $template->assign('title', CRM_Utils_Array
::value('title', $values));
2992 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
2993 if (!$values['amount'] && isset($this->total_amount
)) {
2994 $values['amount'] = $this->total_amount
;
2997 $pcpParams = ['pcpBlock' => NULL, 'pcp_display_in_roll' => NULL, 'pcp_roll_nickname' => NULL, 'pcp_personal_note' => NULL, 'title' => NULL];
2999 if (strtolower($this->_component
) == 'contribute') {
3001 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3002 $softDAO->contribution_id
= $this->id
;
3003 if ($softDAO->find(TRUE)) {
3004 $pcpParams['pcpBlock'] = TRUE;
3005 $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll
;
3006 $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname
;
3007 $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note
;
3009 //assign the pcp page title for email subject
3010 $pcpDAO = new CRM_PCP_DAO_PCP();
3011 $pcpDAO->id
= $softDAO->pcp_id
;
3012 if ($pcpDAO->find(TRUE)) {
3013 $pcpParams['title'] = $pcpDAO->title
;
3017 foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3018 $template->assign($templateKey, $templateValue);
3021 if ($this->financial_type_id
) {
3022 $values['financial_type_id'] = $this->financial_type_id
;
3025 $template->assign('trxn_id', $this->trxn_id
);
3026 $template->assign('receive_date',
3027 CRM_Utils_Date
::processDate($this->receive_date
)
3029 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
3030 $template->assign('action', $this->is_test ?
1024 : 1);
3031 $template->assign('receipt_text',
3032 CRM_Utils_Array
::value('receipt_text',
3036 $template->assign('is_monetary', 1);
3037 $template->assign('is_recur', !empty($this->contribution_recur_id
));
3038 $template->assign('currency', $this->currency
);
3039 $template->assign('address', CRM_Utils_Address
::format($input));
3040 if (!empty($values['customGroup'])) {
3041 $template->assign('customGroup', $values['customGroup']);
3043 if (!empty($values['softContributions'])) {
3044 $template->assign('softContributions', $values['softContributions']);
3046 if ($this->_component
== 'event') {
3047 $template->assign('title', $values['event']['title']);
3048 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
3049 $viewRoles = array();
3050 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
3051 $viewRoles[] = $participantRoles[$v];
3053 $values['event']['participant_role'] = implode(', ', $viewRoles);
3054 $template->assign('event', $values['event']);
3055 $template->assign('participant', $values['participant']);
3056 $template->assign('location', $values['location']);
3057 $template->assign('customPre', $values['custom_pre_id']);
3058 $template->assign('customPost', $values['custom_post_id']);
3061 if ($this->_relatedObjects
['participant']->is_test
) {
3065 $values['params'] = array();
3066 //to get email of primary participant.
3067 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
3068 $primaryAmount[] = array(
3069 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3070 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3072 //build an array of cId/pId of participants
3073 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3074 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3075 //send receipt to additional participant if exists
3076 if (count($additionalIDs)) {
3077 $template->assign('isPrimary', 0);
3078 $template->assign('customProfile', NULL);
3079 //set additionalParticipant true
3080 $values['params']['additionalParticipant'] = TRUE;
3081 foreach ($additionalIDs as $pId => $cId) {
3083 //to change the status pending to completed
3084 $additional = new CRM_Event_DAO_Participant();
3085 $additional->id
= $pId;
3086 $additional->contact_id
= $cId;
3087 $additional->find(TRUE);
3088 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3089 $additional->status_id
= 1;
3090 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3091 //if additional participant dont have email
3093 if (!$additionalParticipantInfo) {
3094 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3096 $amount[0] = array('label' => $additional->fee_level
, 'amount' => $additional->fee_amount
);
3097 $primaryAmount[] = array(
3098 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3099 'amount' => $additional->fee_amount
,
3101 $additional->save();
3102 $template->assign('amount', $amount);
3103 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3107 //build an array of custom profile and assigning it to template
3108 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3110 if (count($customProfile)) {
3111 $template->assign('customProfile', $customProfile);
3114 // for primary contact
3115 $values['params']['additionalParticipant'] = FALSE;
3116 $template->assign('isPrimary', 1);
3117 $template->assign('amount', $primaryAmount);
3118 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3119 if ($this->payment_instrument_id
) {
3120 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3121 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3123 // carry paylater, since we did not created billing,
3124 // so need to pull email from primary location, CRM-4395
3125 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3131 * Check whether payment processor supports
3132 * cancellation of contribution subscription
3134 * @param int $contributionId
3137 * @param bool $isNotCancelled
3141 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3142 $cacheKeyString = "$contributionId";
3143 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3145 static $supportsCancel = array();
3147 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3148 $supportsCancel[$cacheKeyString] = FALSE;
3149 $isCancelled = FALSE;
3151 if ($isNotCancelled) {
3152 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3155 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3156 if (!empty($paymentObject)) {
3157 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3160 return $supportsCancel[$cacheKeyString];
3164 * Check whether subscription is already cancelled.
3166 * @param int $contributionId
3170 * contribution status
3172 public static function isSubscriptionCancelled($contributionId) {
3174 SELECT cr.contribution_status_id
3175 FROM civicrm_contribution_recur cr
3176 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3177 WHERE con.id = %1 LIMIT 1";
3178 $params = array(1 => array($contributionId, 'Integer'));
3179 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3180 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId);
3181 if ($status == 'Cancelled') {
3188 * Create all financial accounts entry.
3190 * @param array $params
3191 * Contribution object, line item array and params for trxn.
3194 * @param array $financialTrxnValues
3196 * @return null|\CRM_Core_BAO_FinancialTrxn
3198 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3199 $skipRecords = $update = $return = $isRelatedId = FALSE;
3201 $additionalParticipantId = array();
3202 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3203 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3205 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3206 $entityId = $params['participant_id'];
3207 $entityTable = 'civicrm_participant';
3208 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3210 elseif (!empty($params['membership_id'])) {
3211 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3212 // are created off one contribution should be handled elsewhere
3213 $entityId = $params['membership_id'];
3214 $entityTable = 'civicrm_membership';
3217 $entityId = $params['contribution']->id
;
3218 $entityTable = 'civicrm_contribution';
3221 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3222 $isRelatedId = TRUE;
3225 $entityID[] = $entityId;
3226 if (!empty($additionalParticipantId)) {
3227 $entityID +
= $additionalParticipantId;
3229 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3230 if (empty($params['prevContribution'])) {
3237 $statusId = $params['contribution']->contribution_status_id
;
3238 // CRM-13964 partial payment
3239 if ($contributionStatus == 'Partially paid'
3240 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3242 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_to_pay']);
3243 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3245 $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3246 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3247 $params['total_amount'] = $partialAmtPay;
3249 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3250 if (empty($balanceTrxnInfo['trxn_id'])) {
3251 // create new balance transaction record
3252 $toFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3254 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3255 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3256 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3257 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3258 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3259 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3260 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3261 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3262 $balanceTrxnParams['status_id'] = $statusId;
3263 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3264 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3265 $balanceTrxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3266 $balanceTrxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3267 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3268 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3270 $balanceTrxnParams['is_payment'] = 1;
3272 if (!empty($params['payment_processor'])) {
3273 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3275 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3279 // build line item array if its not set in $params
3280 if (empty($params['line_item']) ||
$additionalParticipantId) {
3281 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3284 if ($contributionStatus != 'Failed' &&
3285 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3287 $skipRecords = TRUE;
3288 $pendingStatus = array(
3292 if (in_array($contributionStatus, $pendingStatus)) {
3293 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3294 $params['financial_type_id'],
3295 'Accounts Receivable Account is'
3298 elseif (!empty($params['payment_processor'])) {
3299 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3300 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', array(
3301 'id' => $params['payment_processor'],
3302 'return' => 'payment_instrument_id',
3305 elseif (!empty($params['payment_instrument_id'])) {
3306 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3309 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3310 $queryParams = array(1 => array($relationTypeId, 'Integer'));
3311 $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);
3314 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
3315 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3316 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3318 //build financial transaction params
3319 $trxnParams = array(
3320 'contribution_id' => $params['contribution']->id
,
3321 'to_financial_account_id' => $params['to_financial_account_id'],
3322 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3323 'total_amount' => $totalAmount,
3324 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $params),
3325 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3326 'currency' => $params['contribution']->currency
,
3327 'trxn_id' => $params['contribution']->trxn_id
,
3328 'status_id' => $statusId,
3329 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3330 'check_number' => CRM_Utils_Array
::value('check_number', $params),
3331 'pan_truncation' => CRM_Utils_Array
::value('pan_truncation', $params),
3332 'card_type_id' => CRM_Utils_Array
::value('card_type_id', $params),
3334 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3335 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3336 if (isset($params['refund_trxn_id'])) {
3337 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3338 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3341 //CRM-16259, set is_payment flag for non pending status
3342 if (!in_array($contributionStatus, $pendingStatus)) {
3343 $trxnParams['is_payment'] = 1;
3345 if (!empty($params['payment_processor'])) {
3346 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3349 if (isset($fromFinancialAccountId)) {
3350 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3353 // consider external values passed for recording transaction entry
3354 if (!empty($financialTrxnValues)) {
3355 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3357 if (empty($trxnParams['payment_processor_id'])) {
3358 unset($trxnParams['payment_processor_id']);
3361 $params['trxnParams'] = $trxnParams;
3363 if (!empty($params['prevContribution'])) {
3365 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3366 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3367 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3368 if (!isset($params['trxnParams']['trxn_id'])) {
3369 // Actually I have no idea why we are overwriting any values from the previous contribution.
3370 // (filling makes sense to me). However, only protecting this value as I really really know we
3371 // don't want this one overwritten.
3373 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3375 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3377 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3378 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3379 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3381 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3382 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3385 //if financial type is changed
3386 if (!empty($params['financial_type_id']) &&
3387 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3389 $accountRelationship = 'Income Account is';
3390 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3391 $accountRelationship = 'Deferred Revenue Account is';
3393 $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id
, $accountRelationship);
3394 $newFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3395 if ($oldFinancialAccount != $newFinancialAccount) {
3396 $params['total_amount'] = 0;
3397 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3398 $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3399 $params['prevContribution']->financial_type_id
, $accountRelationship);
3402 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3403 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3404 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3407 self
::updateFinancialAccounts($params, 'changeFinancialType');
3408 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3409 $params['financial_account_id'] = $newFinancialAccount;
3410 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3411 self
::updateFinancialAccounts($params);
3412 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3414 $params['deferred_financial_account_id'] = $newFinancialAccount;
3418 //Update contribution status
3419 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3420 if (!isset($params['refund_trxn_id'])) {
3421 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3422 // gets preference over another so I am only 'protecting' a very specific tested flow
3423 // and letting natural justice take care of the rest.
3424 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3426 if (!empty($params['contribution_status_id']) &&
3427 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3429 //Update Financial Records
3430 self
::updateFinancialAccounts($params, 'changedStatus');
3434 // change Payment Instrument for a Completed contribution
3435 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3436 // instrument is null and now new payment instrument is added along with the payment
3437 if (!$params['contribution']->payment_instrument_id
) {
3438 $params['contribution']->find(TRUE);
3440 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3441 $params['trxnParams']['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3443 if (self
::isPaymentInstrumentChange($params, $pendingStatus)) {
3444 $updated = CRM_Core_BAO_FinancialTrxn
::updateFinancialAccountsOnPaymentInstrumentChange($params);
3447 //if Change contribution amount
3448 $params['trxnParams']['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3449 $params['trxnParams']['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3450 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3451 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3452 if (isset($totalAmount) &&
3453 $totalAmount != $params['prevContribution']->total_amount
3455 //Update Financial Records
3456 $params['trxnParams']['from_financial_account_id'] = NULL;
3457 self
::updateFinancialAccounts($params, 'changedAmount');
3462 // Looks like we might have a data correction update.
3463 // This would be a case where a transaction id has been entered but it is incorrect &
3464 // the person goes back in & fixes it, as opposed to a new transaction.
3465 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3466 // the data fix scenario.
3468 if (isset($params['refund_trxn_id'])) {
3469 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3470 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3471 civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3474 $cardType = CRM_Utils_Array
::value('card_type_id', $params);
3475 $panTruncation = CRM_Utils_Array
::value('pan_truncation', $params);
3476 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3481 // records finanical trxn and entity financial trxn
3482 // also make it available as return value
3483 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3484 $trxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3485 $trxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3486 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3487 $params['entity_id'] = $financialTxn->id
;
3488 if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3489 self
::$_trxnIDs[] = $financialTxn->id
;
3493 // record line items and financial items
3494 if (empty($params['skipLineItem'])) {
3495 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $update);
3498 // create batch entry if batch_id is passed and
3499 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3500 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3501 $entityParams = array(
3502 'batch_id' => $params['batch_id'],
3503 'entity_table' => 'civicrm_financial_trxn',
3504 'entity_id' => $financialTxn->id
,
3506 CRM_Batch_BAO_EntityBatch
::create($entityParams);
3509 // when a fee is charged
3510 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3511 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3514 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3515 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3517 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3518 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3519 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3521 unset($params['line_item']);
3522 self
::$_trxnIDs = NULL;
3527 * Update all financial accounts entry.
3529 * @param array $params
3530 * Contribution object, line item array and params for trxn.
3532 * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3533 * adds unpredictability.
3535 * @param string $context
3539 public static function updateFinancialAccounts(&$params, $context = NULL) {
3541 $inputParams = $params;
3543 $currentContributionStatus = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
3544 $previousContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['prevContribution']->contribution_status_id
, 'name');
3546 if (($previousContributionStatus == 'Pending'
3547 ||
$previousContributionStatus == 'In Progress')
3548 && $currentContributionStatus == 'Completed'
3549 && $context == 'changePaymentInstrument'
3553 if ((($previousContributionStatus == 'Partially paid'
3554 && $currentContributionStatus == 'Completed')
3555 ||
($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later
== TRUE
3556 && $currentContributionStatus == 'Partially paid'))
3557 && $context == 'changedStatus'
3561 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3562 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3563 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3565 if ($context == 'changedStatus') {
3566 if ($previousContributionStatus == 'Completed'
3567 && (self
::isContributionStatusNegative($params['contribution']->contribution_status_id
))
3570 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3571 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3572 if (empty($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3573 $creditNoteId = self
::createCreditNoteId();
3574 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3577 elseif (($previousContributionStatus == 'Pending'
3578 && $params['prevContribution']->is_pay_later
) ||
$previousContributionStatus == 'In Progress'
3580 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $params) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
3581 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
3583 if ($currentContributionStatus == 'Cancelled') {
3584 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3585 $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3586 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3587 if (is_null($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3588 $creditNoteId = self
::createCreditNoteId();
3589 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3593 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3594 $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3599 if ($context == 'changedStatus') {
3600 if (($previousContributionStatus == 'Pending'
3601 ||
$previousContributionStatus == 'In Progress')
3602 && ($currentContributionStatus == 'Completed')
3604 if (empty($params['line_item'])) {
3606 //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3607 // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3608 // & this can be removed
3611 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3612 // This is an update so original currency if none passed in.
3613 $params['trxnParams']['currency'] = CRM_Utils_Array
::value('currency', $params, $params['prevContribution']->currency
);
3615 self
::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
3616 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3617 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3618 $params['entity_id'] = self
::$_trxnIDs[] = $trxn->id
;
3619 $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3620 $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3622 $entityParams = array(
3623 'entity_table' => 'civicrm_financial_item',
3625 foreach ($params['line_item'] as $fieldId => $fields) {
3626 foreach ($fields as $fieldValueId => $lineItemDetails) {
3628 1 => array(CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'), 'Integer'),
3629 2 => array($lineItemDetails['id'], 'Integer'),
3631 CRM_Core_DAO
::executeQuery($query, $fparams);
3633 1 => array($lineItemDetails['id'], 'Integer'),
3635 $financialItem = CRM_Core_DAO
::executeQuery($sql, $fparams);
3636 while ($financialItem->fetch()) {
3637 $entityParams['entity_id'] = $financialItem->id
;
3638 $entityParams['amount'] = $financialItem->amount
;
3639 foreach (self
::$_trxnIDs as $tID) {
3640 $entityParams['financial_trxn_id'] = $tID;
3641 CRM_Financial_BAO_FinancialItem
::createEntityTrxn($entityParams);
3650 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3651 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3652 $params['entity_id'] = $trxn->id
;
3653 if ($context != 'changePaymentInstrument') {
3654 $itemParams['entity_table'] = 'civicrm_line_item';
3655 $trxnIds['id'] = $params['entity_id'];
3656 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution']->id
);
3657 foreach ($params['line_item'] as $fieldId => $fields) {
3658 foreach ($fields as $fieldValueId => $lineItemDetails) {
3659 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($lineItemDetails['id']);
3660 $receiveDate = CRM_Utils_Date
::isoToMysql($params['prevContribution']->receive_date
);
3661 if ($params['contribution']->receive_date
) {
3662 $receiveDate = CRM_Utils_Date
::isoToMysql($params['contribution']->receive_date
);
3665 $financialAccount = self
::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array
::value('financial_account_id', $prevFinancialItem));
3667 $currency = $params['prevContribution']->currency
;
3668 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3669 if ($params['contribution']->currency
) {
3670 $currency = $params['contribution']->currency
;
3672 $previousLineItemTotal = CRM_Utils_Array
::value('line_total', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3673 $itemParams = array(
3674 'transaction_date' => $receiveDate,
3675 'contact_id' => $params['prevContribution']->contact_id
,
3676 'currency' => $currency,
3677 'amount' => self
::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
3678 'description' => CRM_Utils_Array
::value('description', $prevFinancialItem),
3679 'status_id' => $prevFinancialItem['status_id'],
3680 'financial_account_id' => $financialAccount,
3681 'entity_table' => 'civicrm_line_item',
3682 'entity_id' => $lineItemDetails['id'],
3684 $financialItem = CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3685 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3686 $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
3687 $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id
;
3689 if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') ||
($context == 'changeFinancialType')) {
3690 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
3691 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
3692 $taxAmount = (float) $lineItemDetails['tax_amount'];
3693 if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
3694 // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
3695 $taxAmount = CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3697 elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
3698 $taxAmount -= CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3700 $itemParams['amount'] = self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $taxAmount;
3701 $itemParams['description'] = $taxTerm;
3702 if ($lineItemDetails['financial_type_id']) {
3703 $itemParams['financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount(
3704 $lineItemDetails['financial_type_id'],
3705 'Sales Tax Account is'
3708 CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3713 if ($context == 'changeFinancialType') {
3714 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3715 $params['skipLineItem'] = FALSE;
3716 foreach ($params['line_item'] as &$lineItems) {
3717 foreach ($lineItems as &$line) {
3718 $line['financial_type_id'] = $params['financial_type_id'];
3723 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, $context);
3727 * Is this contribution status a reversal.
3729 * If so we would expect to record a negative value in the financial_trxn table.
3731 * @param int $status_id
3735 public static function isContributionStatusNegative($status_id) {
3736 $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3737 return in_array(CRM_Contribute_PseudoConstant
::contributionStatus($status_id, 'name'), $reversalStatuses);
3741 * Check status validation on update of a contribution.
3743 * @param array $values
3744 * Previous form values before submit.
3746 * @param array $fields
3747 * The input form values.
3749 * @param array $errors
3754 public static function checkStatusValidation($values, &$fields, &$errors) {
3755 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3756 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3757 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3761 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3762 $checkStatus = array(
3763 'Cancelled' => array('Completed', 'Refunded'),
3764 'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3765 'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3766 'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3767 'Refunded' => array('Cancelled', 'Completed'),
3768 'Partially paid' => array('Completed'),
3771 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3772 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3774 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3775 1 => $contributionStatuses[$values['contribution_status_id']],
3776 2 => $contributionStatuses[$fields['contribution_status_id']],
3782 * Delete contribution of contact.
3786 * @param int $contactId
3790 public static function deleteContactContribution($contactId) {
3791 $contribution = new CRM_Contribute_DAO_Contribution();
3792 $contribution->contact_id
= $contactId;
3793 $contribution->find();
3794 while ($contribution->fetch()) {
3795 self
::deleteContribution($contribution->id
);
3800 * Get options for a given contribution field.
3801 * @see CRM_Core_DAO::buildOptions
3803 * @param string $fieldName
3804 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3805 * @param array $props whatever is known about this dao object.
3807 * @return array|bool
3809 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3810 $className = __CLASS__
;
3812 if (isset($props['orderColumn'])) {
3813 $params['orderColumn'] = $props['orderColumn'];
3815 switch ($fieldName) {
3816 // This field is not part of this object but the api supports it
3817 case 'payment_processor':
3818 $className = 'CRM_Contribute_BAO_ContributionPage';
3819 // Filter results by contribution page
3820 if (!empty($props['contribution_page_id'])) {
3821 $page = civicrm_api('contribution_page', 'getsingle', array(
3823 'id' => ($props['contribution_page_id']),
3825 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3826 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3830 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3831 case 'honor_type_id':
3832 $className = 'CRM_Contribute_BAO_ContributionSoft';
3833 $fieldName = 'soft_credit_type_id';
3834 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3837 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3841 * Validate financial type.
3845 * @param int $financialTypeId
3846 * Financial Type id.
3848 * @param string $relationName
3850 * @return array|bool
3852 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3853 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
3855 if (!$financialAccount) {
3856 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
3863 * Function to record additional payment for partial and refund contributions.
3865 * @param int $contributionId
3866 * is the invoice contribution id (got created after processing participant payment).
3867 * @param array $trxnsData
3868 * to take user provided input of transaction details.
3869 * @param string $paymentType
3870 * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3871 * @param int $participantId
3872 * @param bool $updateStatus
3874 * @return null|object
3876 public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3878 if ($paymentType == 'owed') {
3879 $financialTrxn = CRM_Financial_BAO_Payment
::recordPayment($contributionId, $trxnsData, $participantId);
3881 elseif ($paymentType == 'refund') {
3882 $financialTrxn = CRM_Financial_BAO_Payment
::recordRefundPayment($contributionId, $trxnsData, $updateStatus);
3883 if ($participantId) {
3884 // update participant status
3885 // @todo this doesn't make sense...
3886 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
3887 $ids = CRM_Event_BAO_Participant
::getParticipantIds($contributionId);
3888 foreach ($ids as $val) {
3889 $participantUpdate['id'] = $val;
3890 $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3891 CRM_Event_BAO_Participant
::add($participantUpdate);
3896 if (!empty($financialTrxn)) {
3897 self
::recordPaymentActivity($contributionId, $participantId, $financialTrxn);
3898 return $financialTrxn;
3906 * @param $activityType
3908 * @param int $contributionId
3910 * @throws CRM_Core_Exception
3912 public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3913 if ($component == 'event') {
3914 $title = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id
, 'title');
3917 $title = ts('Contribution');
3919 $paymentAmount = CRM_Utils_Money
::format($trxnObj->total_amount
, $trxnObj->currency
);
3920 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
3921 $date = CRM_Utils_Date
::isoToMysql($trxnObj->trxn_date
);
3922 $targetCid = $entityObj->contact_id
;
3923 // source record id would be the contribution id
3924 $srcRecId = $contributionId;
3927 $activityParams = array(
3928 'source_contact_id' => $targetCid,
3929 'source_record_id' => $srcRecId,
3930 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
3931 'subject' => $subject,
3932 'activity_date_time' => $date,
3933 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
3934 'skipRecentView' => TRUE,
3937 // create activity with target contacts
3938 $session = CRM_Core_Session
::singleton();
3939 $id = $session->get('userID');
3941 $activityParams['source_contact_id'] = $id;
3942 $activityParams['target_contact_id'][] = $targetCid;
3945 CRM_Activity_BAO_Activity
::create($activityParams);
3949 * Get list of payments displayed by Contribute_Page_PaymentInfo.
3953 * @param bool $getTrxnInfo
3954 * @param bool $usingLineTotal
3958 public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3959 // @todo deprecate passing in component - always call with contribution.
3960 if ($component == 'event') {
3961 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3963 if (!$contributionId) {
3964 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3965 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3966 $id = $primaryParticipantId;
3968 if (!$contributionId) {
3973 elseif ($component == 'membership') {
3974 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
3977 $contributionId = $id;
3980 $total = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
3981 $baseTrxnId = !empty($total['trxn_id']) ?
$total['trxn_id'] : NULL;
3983 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
3984 $baseTrxnId = $baseTrxnId['financialTrxnId'];
3986 if (!CRM_Utils_Array
::value('total_amount', $total) ||
$usingLineTotal) {
3987 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
3990 $baseTrxnId = $total['trxn_id'];
3991 $total = $total['total_amount'];
3994 $paymentBalance = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $total);
3996 $contribution = civicrm_api3('Contribution', 'getsingle', array('id' => $contributionId, 'return' => array('currency', 'is_pay_later', 'contribution_status_id', 'financial_type_id')));
3998 $info['payLater'] = $contribution['is_pay_later'];
3999 $info['contribution_status'] = $contribution['contribution_status'];
4000 $info['currency'] = $contribution['currency'];
4002 $financialTypeId = $contribution['financial_type_id'];
4003 $feeFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, 'Expense Account is');
4005 if ($paymentBalance == 0 && $info['payLater']) {
4006 // @todo - review - this looks very unlikely to be correct.
4007 // the balance should be correct based on payment transactions not
4009 $paymentBalance = $total;
4012 $info['total'] = $total;
4013 $info['paid'] = $total - $paymentBalance;
4014 $info['balance'] = $paymentBalance;
4016 $info['component'] = $component;
4018 if ($getTrxnInfo && $baseTrxnId) {
4019 // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
4021 SELECT GROUP_CONCAT(fa.`name`) as financial_account,
4023 ft.payment_instrument_id,
4024 ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
4026 FROM civicrm_contribution con
4027 LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4028 INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4029 AND ft.to_financial_account_id != %2
4030 LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4031 LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4032 LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4034 WHERE con.id = %1 AND ft.is_payment = 1
4036 $queryParams = array(
4037 1 => array($contributionId, 'Integer'),
4038 2 => array($feeFinancialAccount, 'Integer'),
4040 $resultDAO = CRM_Core_DAO
::executeQuery($sql, $queryParams);
4041 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
4043 while ($resultDAO->fetch()) {
4044 $paidByLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4045 $paidByName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4046 if ($resultDAO->card_type_id
) {
4047 $creditCardType = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id
);
4048 $pantruncation = '';
4049 if ($resultDAO->pan_truncation
) {
4050 $pantruncation = ": {$resultDAO->pan_truncation}";
4052 $paidByLabel .= " ({$creditCardType}{$pantruncation})";
4055 // show payment edit link only for payments done via backoffice form
4056 $paymentEditLink = '';
4057 if (empty($resultDAO->payment_processor_id
) && CRM_Core_Permission
::check('edit contributions')) {
4059 CRM_Core_Action
::UPDATE
=> array(
4060 'name' => "<i class='crm-i fa-pencil'></i>",
4061 'url' => 'civicrm/payment/edit',
4062 'class' => 'medium-popup',
4063 'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
4064 'title' => ts('Edit Payment'),
4067 $paymentEditLink = CRM_Core_Action
::formLink(
4069 CRM_Core_Action
::mask(array(CRM_Core_Permission
::EDIT
)),
4071 'id' => $resultDAO->id
,
4072 'contribution_id' => $contributionId,
4078 'id' => $resultDAO->id
,
4079 'total_amount' => $resultDAO->total_amount
,
4080 'financial_type' => $resultDAO->financial_account
,
4081 'payment_instrument' => $paidByLabel,
4082 'receive_date' => $resultDAO->trxn_date
,
4083 'trxn_id' => $resultDAO->trxn_id
,
4084 'status' => $statuses[$resultDAO->status_id
],
4085 'currency' => $resultDAO->currency
,
4086 'action' => $paymentEditLink,
4088 if ($paidByName == 'Check') {
4089 $val['check_number'] = $resultDAO->check_number
;
4093 $info['transaction'] = $rows;
4096 $info['payment_links'] = self
::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4101 * Get the outstanding balance on a contribution.
4103 * @param int $contributionId
4104 * @param float $contributionTotal
4105 * Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4109 public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4110 if ($contributionTotal === NULL) {
4111 $contributionTotal = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4114 return CRM_Utils_Money
::subtractCurrencies(
4116 CRM_Core_BAO_FinancialTrxn
::getTotalPayments($contributionId, TRUE) ?
: 0,
4117 CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4122 * Get the tax amount (misnamed function).
4124 * @param array $params
4125 * @param bool $isLineItem
4129 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4130 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4132 // This function should be only called after standardisation (removal of
4133 // thousand separator & using a decimal point for cents separator.
4134 // However, we don't know if that is always true :-(
4135 // There is a deprecation notice tho :-)
4136 $unknownIfMoneyIsClean = empty($params['skipCleanMoney']) && !$isLineItem;
4137 // Update contribution.
4138 if (!empty($params['id'])) {
4139 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4140 // there are no tax implications - early return.
4141 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4144 if (empty($params['prevContribution'])) {
4145 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4148 foreach (array('total_amount', 'financial_type_id', 'fee_amount') as $field) {
4149 if (!isset($params[$field])) {
4150 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4151 // Tax amount gets added back on later....
4152 $params['total_amount'] = $params['prevContribution']->total_amount
-
4153 $params['prevContribution']->tax_amount
;
4156 $params[$field] = $params['prevContribution']->$field;
4157 if ($params[$field] != $params['prevContribution']->$field) {
4163 self
::calculateMissingAmountParams($params, $params['id']);
4164 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4165 // Assign tax Amount on update of contribution
4166 if (!empty($params['prevContribution']->tax_amount
)) {
4167 $params['tax_amount'] = 'null';
4168 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4169 foreach ($params['line_item'] as $setID => $priceField) {
4170 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4171 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4178 // New Contribution and update of contribution with tax rate financial type
4179 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4180 empty($params['skipLineItem']) && !$isLineItem
4182 $taxRateParams = $taxRates[$params['financial_type_id']];
4183 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams, $unknownIfMoneyIsClean);
4184 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4186 // Get Line Item on update of contribution
4187 if (isset($params['id'])) {
4188 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4191 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4193 foreach ($params['line_item'] as $setID => $priceField) {
4194 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4195 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4198 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4200 elseif (isset($params['api.line_item.create'])) {
4201 // Update total amount of contribution using lineItem
4202 $taxAmountArray = array();
4203 foreach ($params['api.line_item.create'] as $key => $value) {
4204 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4205 $taxRate = $taxRates[$value['financial_type_id']];
4206 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4207 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4210 $params['tax_amount'] = array_sum($taxAmountArray);
4211 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4214 // update line item of contrbution
4215 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4216 $taxRate = $taxRates[$params['financial_type_id']];
4217 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate, $unknownIfMoneyIsClean);
4218 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4225 * Check financial type validation on update of a contribution.
4227 * @param Integer $financialTypeId
4228 * Value of latest Financial Type.
4230 * @param Integer $contributionId
4233 * @param array $errors
4238 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4239 if (!empty($financialTypeId)) {
4240 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4241 if ($oldFinancialTypeId == $financialTypeId) {
4245 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4247 '1' => array($contributionId, 'Integer'),
4249 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4250 if ($result->N
> 1) {
4251 $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.');
4256 * Update related pledge payment payments.
4258 * This function has been refactored out of the back office contribution form and may
4259 * still overlap with other functions.
4261 * @param string $action
4262 * @param int $pledgePaymentID
4263 * @param int $contributionID
4264 * @param bool $adjustTotalAmount
4265 * @param float $total_amount
4266 * @param float $original_total_amount
4267 * @param int $contribution_status_id
4268 * @param int $original_contribution_status_id
4270 public static function updateRelatedPledge(
4276 $original_total_amount,
4277 $contribution_status_id,
4278 $original_contribution_status_id
4280 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4284 if ($pledgePaymentID) {
4285 //store contribution id in payment record.
4286 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4289 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4296 if (!$pledgePaymentID) {
4299 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4305 $updatePledgePaymentStatus = FALSE;
4307 // If either the status or the amount has changed we update the pledge status.
4308 if ($action & CRM_Core_Action
::ADD
) {
4309 $updatePledgePaymentStatus = TRUE;
4311 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4312 ($original_total_amount != $total_amount))
4314 $updatePledgePaymentStatus = TRUE;
4317 if ($updatePledgePaymentStatus) {
4318 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4319 array($pledgePaymentID),
4320 $contribution_status_id,
4329 * Compute the stats values
4333 * @param string $stat either 'mode' or 'median'
4334 * @param string $sql
4335 * @param string $alias of civicrm_contribution
4337 * @return array|null
4339 public static function computeStats($stat, $sql, $alias = NULL) {
4340 CRM_Core_Error
::deprecatedFunctionWarning('computeStats is now deprecated');
4345 * Is there only one line item attached to the contribution.
4351 * @throws \CiviCRM_API3_Exception
4353 public static function isSingleLineItem($id) {
4354 $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4355 return ($lineItemCount == 1);
4359 * Complete an order.
4361 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4363 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4365 * Moving it out of the BaseIPN class is just the first step.
4367 * @param array $input
4369 * @param array $objects
4370 * @param CRM_Core_Transaction $transaction
4372 * @param CRM_Contribute_BAO_Contribution $contribution
4376 public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution) {
4377 $primaryContributionID = isset($contribution->id
) ?
$contribution->id
: $objects['first_contribution']->id
;
4378 // The previous details are used when calculating line items so keep it before any code that 'does something'
4379 if (!empty($contribution->id
)) {
4380 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(array('id' => $contribution->id
),
4381 CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
4383 $inputContributionWhiteList = array(
4388 'payment_instrument_id',
4393 'contribution_status_id',
4397 if (self
::isSingleLineItem($primaryContributionID)) {
4398 $inputContributionWhiteList[] = 'financial_type_id';
4401 $participant = CRM_Utils_Array
::value('participant', $objects);
4402 $recurContrib = CRM_Utils_Array
::value('contributionRecur', $objects);
4403 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4404 $event = CRM_Utils_Array
::value('event', $objects);
4406 $paymentProcessorId = '';
4407 if (isset($objects['paymentProcessor'])) {
4408 if (is_array($objects['paymentProcessor'])) {
4409 $paymentProcessorId = $objects['paymentProcessor']['id'];
4412 $paymentProcessorId = $objects['paymentProcessor']->id
;
4416 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4418 $contributionParams = array_merge(array(
4419 'contribution_status_id' => $completedContributionStatusID,
4420 'source' => self
::getRecurringContributionDescription($contribution, $event),
4421 ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4424 // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4425 if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency
)) {
4426 $contributionParams['currency'] = $objects['first_contribution']->currency
;
4429 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4431 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4432 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4433 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4434 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4437 if ($recurringContributionID) {
4438 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4440 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4442 if (empty($contributionParams['receive_date']) && $changeDate) {
4443 $contributionParams['receive_date'] = $changeDate;
4446 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4447 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4450 if (isset($input['is_email_receipt'])) {
4451 $values['is_email_receipt'] = $input['is_email_receipt'];
4454 if ($input['component'] == 'contribute') {
4455 if ($contribution->contribution_page_id
) {
4456 // Figure out what we gain from this.
4457 // Note that we may have overwritten the is_email_receipt input, fix that below.
4458 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4460 elseif ($recurContrib && $recurringContributionID) {
4461 $values['amount'] = $recurContrib->amount
;
4462 $values['financial_type_id'] = $objects['contributionType']->id
;
4463 $values['title'] = $source = ts('Offline Recurring Contribution');
4466 if (isset($input['is_email_receipt'])) {
4467 // CRM-19601 - we may have overwritten this above.
4468 $values['is_email_receipt'] = $input['is_email_receipt'];
4470 elseif ($recurContrib && $recurringContributionID) {
4471 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4472 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4473 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4476 if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4477 self
::updateMembershipBasedOnCompletionOfContribution(
4479 $primaryContributionID,
4485 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4486 if ($event->is_email_confirm
) {
4487 // @todo this should be set by the function that sends the mail after sending.
4488 $contributionParams['receipt_date'] = $changeDate;
4490 $participantParams['id'] = $participant->id
;
4491 $participantParams['status_id'] = 'Registered';
4492 civicrm_api3('Participant', 'create', $participantParams);
4496 $contributionParams['id'] = $contribution->id
;
4498 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4499 // unsetting it here does NOT cause any other contribution test to fail!
4500 unset($contributionParams['financial_type_id']);
4501 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4503 // Add new soft credit against current $contribution.
4504 if (CRM_Utils_Array
::value('contributionRecur', $objects) && $objects['contributionRecur']->id
) {
4505 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4508 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4509 'labelColumn' => 'name',
4512 if (isset($input['prevContribution']) && (!$input['prevContribution']->is_pay_later
&& $input['prevContribution']->contribution_status_id
== $contributionStatuses['Pending'])) {
4513 $input['payment_processor'] = $paymentProcessorId;
4516 if (!empty($contribution->_relatedObjects
['participant'])) {
4517 $input['contribution_mode'] = 'participant';
4518 $input['participant_id'] = $contribution->_relatedObjects
['participant']->id
;
4520 elseif (!empty($contribution->_relatedObjects
['membership'])) {
4521 $input['contribution_mode'] = 'membership';
4522 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4523 $contribution->trxn_id
= CRM_Utils_Array
::value('trxn_id', $input);
4524 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4527 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4528 $transaction->commit();
4530 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4531 $contributionParams['contribution_status_id'], $input['amount']);
4533 // create an activity record
4534 if ($input['component'] == 'contribute') {
4536 $targetContactID = NULL;
4537 if (!empty($ids['related_contact'])) {
4538 $targetContactID = $contribution->contact_id
;
4539 $contribution->contact_id
= $ids['related_contact'];
4541 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4544 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4545 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4546 if (!array_key_exists('is_email_receipt', $values) ||
4547 $values['is_email_receipt'] == 1
4549 civicrm_api3('Contribution', 'sendconfirmation', array(
4550 'id' => $contribution->id
,
4551 'payment_processor_id' => $paymentProcessorId,
4553 CRM_Core_Error
::debug_log_message("Receipt sent");
4556 CRM_Core_Error
::debug_log_message("Success: Database updated");
4557 return $contributionResult;
4561 * Send receipt from contribution.
4563 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4565 * Note that the compose message part has been moved to contribution
4566 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4568 * @param array $input
4569 * Incoming data from Payment processor.
4571 * Related object IDs.
4572 * @param int $contributionID
4573 * @param array $values
4574 * Values related to objects that have already been loaded.
4575 * @param bool $returnMessageText
4576 * Should text be returned instead of sent. This.
4577 * is because the function is also used to generate pdfs
4580 * @throws \CRM_Core_Exception
4581 * @throws \CiviCRM_API3_Exception
4583 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4584 $returnMessageText = FALSE) {
4586 $contribution = new CRM_Contribute_BAO_Contribution();
4587 $contribution->id
= $contributionID;
4588 if (!$contribution->find(TRUE)) {
4589 throw new CRM_Core_Exception('Contribution does not exist');
4591 $contribution->loadRelatedObjects($input, $ids, TRUE);
4592 // set receipt from e-mail and name in value
4593 if (!$returnMessageText) {
4594 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4596 $values['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id
);
4597 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4598 if ((!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4599 civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id
));
4605 * Generate From email and from name in an array values
4606 * @param array $input
4607 * @param \CRM_Contribute_BAO_Contribution $contribution
4610 public static function generateFromEmailAndName($input, $contribution) {
4611 // Use input value if supplied.
4612 if (!empty($input['receipt_from_email'])) {
4613 return array(CRM_Utils_array
::value('receipt_from_name', $input, ''), $input['receipt_from_email']);
4615 // if we are still empty see if we can use anything from a contribution page.
4616 $pageValues = array();
4617 if (!empty($contribution->contribution_page_id
)) {
4618 $pageValues = civicrm_api3('ContributionPage', 'getsingle', array('id' => $contribution->contribution_page_id
));
4620 // if we are still empty see if we can use anything from a contribution page.
4621 if (!empty($pageValues['receipt_from_email'])) {
4622 return array($pageValues['receipt_from_name'], $pageValues['receipt_from_email']);
4624 // If we are still empty fall back to the domain or logged in user information.
4625 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4629 * Generate credit note id with next avaible number
4634 public static function createCreditNoteId() {
4635 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
4637 $creditNoteNum = CRM_Core_DAO
::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution WHERE creditnote_id IS NOT NULL");
4638 $creditNoteId = NULL;
4642 $creditNoteId = CRM_Utils_Array
::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4643 $result = civicrm_api3('Contribution', 'getcount', array(
4645 'creditnote_id' => $creditNoteId,
4647 } while ($result > 0);
4649 return $creditNoteId;
4653 * Load related memberships.
4655 * Note that in theory it should be possible to retrieve these from the line_item table
4656 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4657 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4658 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4659 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4661 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4665 * @return array $ids
4669 public function loadRelatedMembershipObjects($ids = []) {
4671 SELECT membership_id
4672 FROM civicrm_membership_payment
4673 WHERE contribution_id = %1 ";
4674 $params = array(1 => array($this->id
, 'Integer'));
4675 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, array());
4677 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4678 while ($dao->fetch()) {
4679 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4680 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4684 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4685 foreach ($ids['membership'] as $id) {
4687 $membership = new CRM_Member_BAO_Membership();
4688 $membership->id
= $id;
4689 if (!$membership->find(TRUE)) {
4690 throw new Exception("Could not find membership record: $id");
4692 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4693 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4694 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4695 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4703 * This function is used to record partial payments for contribution
4705 * @param array $contribution
4707 * @param array $params
4709 * @return CRM_Financial_DAO_FinancialTrxn
4711 public static function recordPartialPayment($contribution, $params) {
4713 $balanceTrxnParams['to_financial_account_id'] = self
::getToFinancialAccount($contribution, $params);
4714 $fromFinancialAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
4715 $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4716 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4717 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4718 $balanceTrxnParams['trxn_date'] = CRM_Utils_Array
::value('trxn_date', $params, CRM_Utils_Array
::value('contribution_receive_date', $params, date('YmdHis')));
4719 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
4720 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('total_amount', $params);
4721 $balanceTrxnParams['currency'] = $contribution['currency'];
4722 $balanceTrxnParams['trxn_id'] = CRM_Utils_Array
::value('contribution_trxn_id', $params, NULL);
4723 $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4724 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4725 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
4727 // @todo the logic of this section seems very wrong. This code is ONLY reached from the Payment.create
4728 // routine so is_payment should ALWAYS be true
4729 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
4730 $statusId = array_search('Completed', $contributionStatuses);
4731 if ($fromFinancialAccountId != NULL &&
4732 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
4734 $balanceTrxnParams['is_payment'] = 1;
4737 if (!empty($params['payment_processor'])) {
4738 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4740 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4744 * Get the description (source field) for the recurring contribution.
4746 * @param CRM_Contribute_BAO_Contribution $contribution
4747 * @param CRM_Event_DAO_Event|null $event
4750 * @throws \CiviCRM_API3_Exception
4752 protected static function getRecurringContributionDescription($contribution, $event) {
4753 if (!empty($contribution->source
)) {
4754 return $contribution->source
;
4756 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4757 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4758 'id' => $contribution->contribution_page_id
,
4759 'return' => 'title',
4761 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4764 return ts('Online Event Registration') . ': ' . $event->title
;
4766 elseif (!empty($contribution->contribution_recur_id
)) {
4767 return 'recurring contribution';
4773 * Function to add payments for contribution
4774 * for Partially Paid status
4776 * @param array $contributions
4777 * @param string $contributionStatusId
4780 public static function addPayments($contributions, $contributionStatusId = NULL) {
4781 // get financial trxn which is a payment
4782 $ftSql = "SELECT ft.id, ft.total_amount
4783 FROM civicrm_financial_trxn ft
4784 INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4785 WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4786 $contributionStatus = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4787 'labelColumn' => 'name',
4789 foreach ($contributions as $contribution) {
4790 if (!($contributionStatus[$contribution->contribution_status_id
] == 'Partially paid'
4791 || CRM_Utils_Array
::value($contributionStatusId, $contributionStatus) == 'Partially paid')
4795 $ftDao = CRM_Core_DAO
::executeQuery($ftSql, array(1 => array($contribution->id
, 'Integer')));
4798 // store financial item Proportionaly.
4799 $trxnParams = array(
4800 'total_amount' => $ftDao->total_amount
,
4801 'contribution_id' => $contribution->id
,
4803 self
::assignProportionalLineItems($trxnParams, $ftDao->id
, $contribution->total_amount
);
4808 * Function use to store line item proportionaly in
4809 * in entity financial trxn table
4811 * @param array $trxnParams
4813 * @param Integer $trxnId
4815 * @param float $contributionTotalAmount
4818 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4819 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
4820 if (!empty($lineItems)) {
4821 // get financial item
4822 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
4823 $entityParams = array(
4824 'contribution_total_amount' => $contributionTotalAmount,
4825 'trxn_total_amount' => $trxnParams['total_amount'],
4826 'trxn_id' => $trxnId,
4828 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4833 * Checks if line items total amounts
4834 * match the contribution total amount.
4836 * @param array $params
4837 * array of order params.
4839 * @throws \API_Exception
4841 public static function checkLineItems(&$params) {
4842 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
4843 $lineItemAmount = 0;
4845 foreach ($params['line_items'] as &$lineItems) {
4846 foreach ($lineItems['line_item'] as &$item) {
4847 if (empty($item['financial_type_id'])) {
4848 $item['financial_type_id'] = $params['financial_type_id'];
4850 $lineItemAmount +
= $item['line_total'] + CRM_Utils_Array
::value('tax_amount', $item, 0.00);
4854 if (!isset($totalAmount)) {
4855 $params['total_amount'] = $lineItemAmount;
4858 $currency = CRM_Utils_Array
::value('currency', $params, '');
4860 if (empty($currency)) {
4861 $currency = CRM_Core_Config
::singleton()->defaultCurrency
;
4864 if (!CRM_Utils_Money
::equals($totalAmount, $lineItemAmount, $currency)) {
4865 throw new CRM_Contribute_Exception_CheckLineItemsException();
4871 * Get the financial account for the item associated with the new transaction.
4873 * @param array $params
4874 * @param int $default
4878 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4880 if (!empty($params['financial_account_id'])) {
4881 return $params['financial_account_id'];
4884 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
4885 $preferredAccountsRelationships = array(
4886 'Refunded' => 'Credit/Contra Revenue Account is',
4887 'Chargeback' => 'Chargeback Account is',
4890 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4891 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
4892 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
4894 $preferredAccountsRelationships[$contributionStatus]
4902 * ContributionPage values were being imposed onto values.
4904 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4905 * REALLY didn't want superimposed. The rest are left there in their overkill out
4908 * The rationale for making this explicit is that it was a case of carefully set values being
4909 * seemingly randonly overwritten without much care. In general I think array randomly setting
4910 * variables en mass is risky.
4912 * @param array $values
4916 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4917 $contributionPageValues = array();
4918 CRM_Contribute_BAO_ContributionPage
::setValues(
4919 $this->contribution_page_id
,
4920 $contributionPageValues
4922 $valuesToCopy = array(
4923 // These are the values that I believe to be useful.
4926 'pay_later_receipt',
4928 'receipt_from_email',
4929 'receipt_from_name',
4933 'honoree_profile_id',
4934 'onbehalf_profile_id',
4935 'honor_block_is_active',
4936 // Kinda might be - but would be on the contribution...
4939 // Included for 'fear of regression' but can't justify any use for these....
4941 'payment_processor',
4942 'financial_type_id',
4943 'amount_block_is_active',
4948 'default_amount_id',
4952 'initial_amount_help_text',
4953 'initial_amount_label',
4955 'is_allow_other_amount',
4956 'is_billing_required',
4957 'is_confirm_enabled',
4958 'is_credit_card_only',
4960 'is_partial_payment',
4961 'is_recur_installments',
4962 'is_recur_interval',
4966 'min_initial_amount',
4967 'recur_frequency_unit',
4974 foreach ($valuesToCopy as $valueToCopy) {
4975 if (isset($contributionPageValues[$valueToCopy])) {
4976 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4983 * Get values of CiviContribute Settings
4984 * and check if its enabled or not.
4985 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4986 * in serialized form. Usually this should be stored as flat settings for each form fields
4987 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4988 * settings we will live with an inconsistency because it's too hard to change for now.
4989 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
4992 * @param string $name
4993 * @param bool $checkInvoicing
4997 public static function checkContributeSettings($name = NULL, $checkInvoicing = FALSE) {
4998 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
5000 if ($checkInvoicing && !CRM_Utils_Array
::value('invoicing', $contributeSettings)) {
5005 return CRM_Utils_Array
::value($name, $contributeSettings);
5007 return $contributeSettings;
5011 * This function process contribution related objects.
5013 * @param int $contributionId
5014 * @param int $statusId
5015 * @param int|null $previousStatusId
5017 * @param string $receiveDate
5019 * @return null|string
5021 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
5023 if (!$contributionId ||
!$statusId) {
5028 'contribution_id' => $contributionId,
5029 'contribution_status_id' => $statusId,
5030 'previous_contribution_status_id' => $previousStatusId,
5031 'receive_date' => $receiveDate,
5034 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
5036 if (!is_array($updateResult) ||
5037 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
5038 !is_array($updatedComponents) ||
5039 empty($updatedComponents)
5044 // get the user display name.
5046 SELECT display_name as displayName
5047 FROM civicrm_contact
5048 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5049 WHERE civicrm_contribution.id = {$contributionId}";
5050 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5052 // get the status message for user.
5053 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5055 if ($componentName == 'CiviMember') {
5056 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5057 CRM_Member_PseudoConstant
::membershipStatus()
5059 if ($updatedStatusName == 'Cancelled') {
5060 $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
5062 elseif ($updatedStatusName == 'Expired') {
5063 $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
5066 $endDate = CRM_Utils_Array
::value('membership_end_date', $updateResult);
5068 $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
5070 1 => $userDisplayName,
5078 if ($componentName == 'CiviEvent') {
5079 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5080 CRM_Event_PseudoConstant
::participantStatus()
5082 if ($updatedStatusName == 'Cancelled') {
5083 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
5085 elseif ($updatedStatusName == 'Registered') {
5086 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
5090 if ($componentName == 'CiviPledge') {
5091 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5092 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5094 if ($updatedStatusName == 'Cancelled') {
5095 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
5097 elseif ($updatedStatusName == 'Failed') {
5098 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
5100 elseif ($updatedStatusName == 'Completed') {
5101 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
5110 * Get the contribution as it is in the database before being updated.
5112 * @param int $contributionID
5114 * @return \CRM_Contribute_BAO_Contribution|null
5116 private static function getOriginalContribution($contributionID) {
5117 return self
::getValues(array('id' => $contributionID), CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
5121 * Get the amount for the financial item row.
5123 * Helper function to start to break down recordFinancialTransactions for readability.
5125 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5127 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5128 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5131 * @todo move recordFinancialAccounts & helper functions to their own class?
5133 * @param array $params
5134 * Params as passed to contribution.create
5136 * @param string $context
5137 * changeFinancialType| changedAmount
5138 * @param array $lineItemDetails
5140 * @param bool $isARefund
5141 * Is this a refund / negative transaction.
5145 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5146 if ($context == 'changedAmount') {
5147 $lineTotal = $lineItemDetails['line_total'];
5148 if ($lineTotal != $previousLineItemTotal) {
5149 $lineTotal -= $previousLineItemTotal;
5153 elseif ($context == 'changeFinancialType') {
5154 return -$lineItemDetails['line_total'];
5156 elseif ($context == 'changedStatus') {
5157 $cancelledTaxAmount = 0;
5159 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $lineItemDetails, '0.00');
5161 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total'] +
(float) $cancelledTaxAmount);
5163 elseif ($context === NULL) {
5164 // erm, yes because? but, hey, it's tested.
5165 return $lineItemDetails['line_total'];
5167 elseif (empty($lineItemDetails['line_total'])) {
5168 // follow legacy code path
5170 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', array('civi.tag' => 'deprecated'));
5171 return $params['total_amount'];
5174 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total']);
5179 * Get the multiplier for adjusting rows.
5181 * If we are dealing with a refund or cancellation then it will be a negative
5182 * amount to reflect the negative transaction.
5184 * If we are changing Financial Type it will be a negative amount to
5185 * adjust down the old type.
5187 * @param int $contribution_status_id
5188 * @param string $context
5192 protected static function getMultiplier($contribution_status_id, $context) {
5193 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5200 * Does this transaction reflect a payment instrument change.
5202 * @param array $params
5203 * @param array $pendingStatuses
5207 protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5208 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
5210 if (array_key_exists('payment_instrument_id', $params)) {
5211 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
5212 !CRM_Utils_System
::isNull($params['payment_instrument_id'])
5214 //check if status is changed from Pending to Completed
5215 // do not update payment instrument changes for Pending to Completed
5216 if (!($contributionStatus == 'Completed' &&
5217 in_array($params['prevContribution']->contribution_status_id
, $pendingStatuses))
5222 elseif ((!CRM_Utils_System
::isNull($params['payment_instrument_id']) &&
5223 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
5224 $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5228 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
5229 $params['contribution']->check_number
!= $params['prevContribution']->check_number
5231 // another special case when check number is changed, create new financial records
5232 // create financial trxn with negative amount
5240 * Update the memberships associated with a contribution if it has been completed.
5242 * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5243 * load them in this function. Code clean up would compensate for any minor performance implication.
5245 * @param \CRM_Contribute_BAO_Contribution $contribution
5246 * @param int $primaryContributionID
5247 * @param string $changeDate
5249 * @throws \CRM_Core_Exception
5250 * @throws \CiviCRM_API3_Exception
5252 public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5253 $memberships = self
::getRelatedMemberships($contribution->id
);
5254 foreach ($memberships as $membership) {
5255 $membershipParams = array(
5256 'id' => $membership['id'],
5257 'contact_id' => $membership['contact_id'],
5258 'is_test' => $membership['is_test'],
5259 'membership_type_id' => $membership['membership_type_id'],
5260 'membership_activity_status' => 'Completed',
5263 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
5264 $membershipParams['membership_type_id'],
5265 $membershipParams['is_test'],
5266 $membershipParams['id']
5269 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5270 // this picks up membership type changes during renewals
5271 // @todo this is almost certainly an obsolete sql call, the pre-change
5272 // membership is accessible via $this->_relatedObjects
5274 SELECT membership_type_id
5275 FROM civicrm_membership_log
5276 WHERE membership_id={$membershipParams['id']}
5279 $dao = CRM_Core_DAO
::executeQuery($sql);
5280 if ($dao->fetch()) {
5281 if (!empty($dao->membership_type_id
)) {
5282 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
5286 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5287 $membershipParams['membership_type_id'],
5288 $primaryContributionID
5290 // @todo remove all this stuff in favour of letting the api call further down handle in
5291 // (it is a duplication of what the api does).
5292 $dates = array_fill_keys(array(
5297 if ($currentMembership) {
5299 * Fixed FOR CRM-4433
5300 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5301 * when Contribution mode is notify and membership is for renewal )
5303 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5305 // @todo - we should pass membership_type_id instead of null here but not
5306 // adding as not sure of testing
5307 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
5308 $changeDate, NULL, $membershipParams['num_terms']
5310 $dates['join_date'] = $currentMembership['join_date'];
5313 //get the status for membership.
5314 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
5316 $dates['join_date'],
5319 $membershipParams['membership_type_id'],
5323 unset($dates['end_date']);
5324 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
5325 //we might be renewing membership,
5326 //so make status override false.
5327 $membershipParams['is_override'] = FALSE;
5328 $membershipParams['status_override_end_date'] = 'null';
5330 //CRM-17723 - reset static $relatedContactIds array()
5331 // @todo move it to Civi Statics.
5333 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
5334 civicrm_api3('Membership', 'create', $membershipParams);
5339 * Get payment links as they relate to a contribution.
5341 * If a payment can be made then include a payment link & if a refund is appropriate
5342 * then a refund link.
5345 * @param float $balance
5346 * @param string $contributionStatus
5348 * @return array $actionLinks Links array containing:
5352 protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5353 if ($contributionStatus === 'Failed' ||
!CRM_Core_Permission
::check('edit contributions')) {
5354 // In general the balance is the best way to determine if a payment can be added or not,
5355 // but not for Failed contributions, where we don't accept additional payments at the moment.
5356 // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5357 // do accept more payments agains them.
5360 $actionLinks = array();
5361 if ((int) $balance > 0) {
5362 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
5363 $actionLinks[] = array(
5364 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5370 'title' => ts('Submit Credit Card payment'),
5373 $actionLinks[] = array(
5374 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5379 'title' => ts('Record Payment'),
5382 elseif ((int) $balance < 0) {
5383 $actionLinks[] = array(
5384 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5389 'title' => ts('Record Refund'),
5392 return $actionLinks;
5396 * Get a query to determine the amount donated by the contact/s in the current financial year.
5398 * @param array $contactIDs
5402 public static function getAnnualQuery($contactIDs) {
5403 $contactIDs = implode(',', $contactIDs);
5404 $config = CRM_Core_Config
::singleton();
5405 $currentMonth = date('m');
5406 $currentDay = date('d');
5408 (int) $config->fiscalYearStart
['M'] > $currentMonth ||
5410 (int) $config->fiscalYearStart
['M'] == $currentMonth &&
5411 (int) $config->fiscalYearStart
['d'] > $currentDay
5414 $year = date('Y') - 1;
5419 $nextYear = $year +
1;
5421 if ($config->fiscalYearStart
) {
5422 $newFiscalYearStart = $config->fiscalYearStart
;
5423 if ($newFiscalYearStart['M'] < 10) {
5424 // This is just a clumsy way of adding padding.
5425 // @todo next round look for a nicer way.
5426 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5428 if ($newFiscalYearStart['d'] < 10) {
5429 // This is just a clumsy way of adding padding.
5430 // @todo next round look for a nicer way.
5431 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5433 $config->fiscalYearStart
= $newFiscalYearStart;
5434 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
5437 // First of January.
5440 $startDate = "$year$monthDay";
5441 $endDate = "$nextYear$monthDay";
5444 'contact_id' => 'IN (' . $contactIDs . ')',
5445 'is_test' => ' = 0',
5446 'receive_date' => ['>=' . $startDate, '< ' . $endDate],
5448 $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5449 CRM_Financial_BAO_FinancialType
::addACLClausesToWhereClauses($whereClauses);
5452 foreach ($whereClauses as $key => $clause) {
5453 $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5455 $whereClauseString = implode(' AND ', $clauses);
5457 // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5458 // this group by + having on contribution_status_id improves performance
5460 SELECT COUNT(*) as count,
5461 SUM(total_amount) as amount,
5462 AVG(total_amount) as average,
5464 FROM civicrm_contribution b
5465 WHERE " . $whereClauseString . "
5466 GROUP BY currency, contribution_status_id
5467 HAVING $havingClause
5473 * Assign Test Value.
5475 * @param string $fieldName
5476 * @param array $fieldDef
5477 * @param int $counter
5479 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5480 if ($fieldName == 'tax_amount') {
5481 $this->{$fieldName} = "0.00";
5483 elseif ($fieldName == 'net_amount') {
5484 $this->{$fieldName} = "2.00";
5486 elseif ($fieldName == 'total_amount') {
5487 $this->{$fieldName} = "3.00";
5489 elseif ($fieldName == 'fee_amount') {
5490 $this->{$fieldName} = "1.00";
5493 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5498 * Check if contribution has participant/membership payment.
5500 * @param int $contributionId
5505 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5506 // get line item for contribution
5507 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5508 // check if line item is for membership or participant
5509 foreach ($lineItems as $items) {
5510 if ($items['entity_table'] == 'civicrm_participant') {
5514 elseif ($items['entity_table'] == 'civicrm_membership') {
5526 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5528 * @param array $trxnParams
5529 * Financial trxn params
5530 * @param array $contributionParams
5531 * Contribution Params
5535 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5536 if (!self
::checkContributeSettings('always_post_to_accounts_receivable')) {
5539 $statusId = $contributionParams['contribution']->contribution_status_id
;
5540 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5541 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5542 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5543 // Return if contribution status is not completed.
5544 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5545 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5546 && $contributionParams['prevContribution']->is_pay_later
== 0
5552 $params = $trxnParams;
5553 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $contributionParams) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5554 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5555 $params['to_financial_account_id'] = $arAccountId;
5556 $params['status_id'] = array_search('Pending', $contributionStatuses);
5557 $params['is_payment'] = FALSE;
5558 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5559 self
::$_trxnIDs[] = $trxn->id
;
5560 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5564 * Calculate financial item amount when contribution is updated.
5566 * @param array $params
5567 * contribution params
5568 * @param array $amountParams
5570 * @param string $context
5574 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5575 if (!empty($params['is_quick_config'])) {
5576 $amount = $amountParams['item_amount'];
5578 $amount = $params['total_amount'];
5579 if ($context === NULL) {
5580 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5585 $amount = $amountParams['line_total'];
5586 if ($context == 'changedAmount') {
5587 $amount -= $amountParams['previous_line_total'];
5589 $amount *= $amountParams['diff'];
5595 * Retrieve Sales Tax Financial Accounts.
5601 public static function getSalesTaxFinancialAccounts() {
5602 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5603 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5604 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5605 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5606 $queryParams = array(1 => array($accountRel, 'Integer'));
5607 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5608 $financialAccount = array();
5609 while ($dao->fetch()) {
5610 $financialAccount[$dao->id
] = $dao->id
;
5612 return $financialAccount;
5616 * Create tax entry in civicrm_entity_financial_trxn table.
5618 * @param array $entityParams
5620 * @param array $eftParams
5623 public static function createProportionalEntry($entityParams, $eftParams) {
5625 if ($entityParams['contribution_total_amount'] != 0) {
5626 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5628 // Record Entity Financial Trxn; CRM-20145
5629 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5630 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5634 * Create array of last financial item id's.
5636 * @param int $contributionId
5640 public static function getLastFinancialItemIds($contributionId) {
5641 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5642 FROM civicrm_financial_item fi
5643 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5644 WHERE li.contribution_id = %1";
5645 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($contributionId, 'Integer')));
5646 $ftIds = $taxItems = array();
5647 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5648 while ($dao->fetch()) {
5649 /* if sales tax item*/
5650 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5651 $taxItems[$dao->price_field_value_id
] = array(
5652 'financial_item_id' => $dao->id
,
5653 'amount' => $dao->tax_amount
,
5657 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5660 return array($ftIds, $taxItems);
5664 * Create proportional entries in civicrm_entity_financial_trxn.
5666 * @param array $entityParams
5668 * @param array $lineItems
5670 * @param array $ftIds
5672 * @param array $taxItems
5675 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5677 'entity_table' => 'civicrm_financial_item',
5678 'financial_trxn_id' => $entityParams['trxn_id'],
5680 foreach ($lineItems as $key => $value) {
5681 if ($value['qty'] == 0) {
5684 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5685 $entityParams['line_item_amount'] = $value['line_total'];
5686 self
::createProportionalEntry($entityParams, $eftParams);
5687 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5688 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5689 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5690 self
::createProportionalEntry($entityParams, $eftParams);
5696 * Load entities related to the contribution into $this->_relatedObjects.
5700 * @throws \CRM_Core_Exception
5702 protected function loadRelatedEntitiesByID($ids) {
5704 'contact' => 'CRM_Contact_BAO_Contact',
5705 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5706 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5707 'financialType' => 'CRM_Financial_BAO_FinancialType',
5708 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5710 foreach ($entities as $entity => $bao) {
5711 if (!empty($ids[$entity])) {
5712 $this->_relatedObjects
[$entity] = new $bao();
5713 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5714 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5715 throw new CRM_Core_Exception($entity . ' could not be loaded');
5722 * Should an email receipt be sent for this contribution when complete.
5724 * @param array $input
5728 protected function isEmailReceipt($input) {
5729 if (isset($input['is_email_receipt'])) {
5730 return $input['is_email_receipt'];
5732 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5733 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5739 * Function to replace contribution tokens.
5741 * @param array $contributionIds
5743 * @param string $subject
5745 * @param array $subjectToken
5747 * @param string $text
5749 * @param string $html
5751 * @param array $messageToken
5753 * @param bool $escapeSmarty
5757 public static function replaceContributionTokens(
5766 if (empty($contributionIds)) {
5769 $contributionDetails = array();
5770 foreach ($contributionIds as $id) {
5771 $result = civicrm_api3('Contribution', 'get', array('id' => $id));
5772 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5773 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5774 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5776 return $contributionDetails;
5780 * Get invoice_number for contribution.
5782 * @param int $contributionID
5786 public static function getInvoiceNumber($contributionID) {
5787 if ($invoicePrefix = self
::checkContributeSettings('invoice_prefix', TRUE)) {
5788 return $invoicePrefix . $contributionID;