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 $membershipPayments = civicrm_api3('MembershipPayment', 'get', [
953 'return' => 'membership_id',
954 'contribution_id' => (int) $contributionID,
957 foreach ($membershipPayments as $membershipPayment) {
958 $membershipIDs[] = $membershipPayment['membership_id'];
960 if (empty($membershipIDs)) {
963 // We could combine this with the MembershipPayment.get - we'd
964 // need to re-wrangle the params (here or in the calling function)
965 // as they would then me membership.contact_id, membership.is_test etc
966 return civicrm_api3('Membership', 'get', [
967 'id' => ['IN' => $membershipIDs],
968 'return' => ['id', 'contact_id', 'membership_type_id', 'is_test']
975 public function addSelectWhereClause() {
976 $whereClauses = parent
::addSelectWhereClause();
977 if ($whereClauses !== []) {
978 // In this case permisssions have been applied & we assume the
979 // financialaclreport is applying these
980 // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
981 return $whereClauses;
984 if (!CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
985 return $whereClauses;
987 $types = CRM_Financial_BAO_FinancialType
::getAllEnabledAvailableFinancialTypes();
989 $whereClauses['financial_type_id'] = 'IN (0)';
992 $whereClauses['financial_type_id'] = [
993 'IN (' . implode(',', array_keys($types)) . ')'
996 return $whereClauses;
1000 * @param null $status
1001 * @param null $startDate
1002 * @param null $endDate
1004 * @return array|null
1006 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1010 $where[] = 'contribution_status_id = 1';
1014 $where[] = 'contribution_status_id = 3';
1019 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
1022 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
1024 $financialTypeACLJoin = '';
1025 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
1026 $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1027 $financialTypes = CRM_Contribute_PseudoConstant
::financialType();
1028 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1029 if ($financialTypes) {
1030 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1031 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1034 $where[] = "c.financial_type_id IN (0)";
1038 $whereCond = implode(' AND ', $where);
1041 SELECT sum( total_amount ) as total_amount,
1042 count( c.id ) as total_count,
1044 FROM civicrm_contribution c
1045 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
1046 $financialTypeACLJoin
1048 AND ( is_test = 0 OR is_test IS NULL )
1049 AND contact.is_deleted = 0
1053 $dao = CRM_Core_DAO
::executeQuery($query);
1056 while ($dao->fetch()) {
1057 $count +
= $dao->total_count
;
1058 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
1062 'amount' => implode(', ', $amount),
1070 * Delete the indirect records associated with this contribution first.
1074 * @return mixed|null
1075 * $results no of deleted Contribution on success, false otherwise
1077 public static function deleteContribution($id) {
1078 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
1080 $transaction = new CRM_Core_Transaction();
1083 //delete activity record
1085 'source_record_id' => $id,
1086 // activity type id for contribution
1087 'activity_type_id' => 6,
1090 CRM_Activity_BAO_Activity
::deleteActivity($params);
1092 //delete billing address if exists for this contribution.
1093 self
::deleteAddress($id);
1095 //update pledge and pledge payment, CRM-3961
1096 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
1098 // remove entry from civicrm_price_set_entity, CRM-5095
1099 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
1100 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
1102 // cleanup line items.
1103 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1105 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1106 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1108 if ($participantId) {
1109 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1112 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1116 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1117 $noteId = key($note);
1119 CRM_Core_BAO_Note
::del($noteId, FALSE);
1122 $dao = new CRM_Contribute_DAO_Contribution();
1125 $results = $dao->delete();
1127 $transaction->commit();
1129 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1131 // delete the recently created Contribution
1132 $contributionRecent = array(
1134 'type' => 'Contribution',
1136 CRM_Utils_Recent
::del($contributionRecent);
1142 * React to a financial transaction (payment) failure.
1144 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1145 * payments is important for forensic and outreach reasons.
1147 * @param int $contributionID
1148 * @param int $contactID
1149 * @param string $message
1151 * @throws \CiviCRM_API3_Exception
1153 public static function failPayment($contributionID, $contactID, $message) {
1154 civicrm_api3('activity', 'create', array(
1155 'activity_type_id' => 'Failed Payment',
1156 'details' => $message,
1157 'subject' => ts('Payment failed at payment processor'),
1158 'source_record_id' => $contributionID,
1159 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() :
1163 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1164 civicrm_api3('contribution', 'create', array(
1165 'id' => $contributionID,
1166 'contribution_status_id' => 'Failed',
1171 * Check if there is a contribution with the same trxn_id or invoice_id.
1173 * @param array $input
1174 * An assoc array of name/value pairs.
1175 * @param array $duplicates
1176 * (reference) store ids of duplicate contribs.
1180 * true if duplicate, false otherwise
1182 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1184 $id = CRM_Utils_Array
::value('id', $input);
1186 $trxn_id = CRM_Utils_Array
::value('trxn_id', $input);
1187 $invoice_id = CRM_Utils_Array
::value('invoice_id', $input);
1193 $clause[] = "trxn_id = %1";
1194 $input[1] = array($trxn_id, 'String');
1198 $clause[] = "invoice_id = %2";
1199 $input[2] = array($invoice_id, 'String');
1202 if (empty($clause)) {
1206 $clause = implode(' OR ', $clause);
1208 $clause = "( $clause ) AND id != %3";
1209 $input[3] = array($id, 'Integer');
1212 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1213 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1215 while ($dao->fetch()) {
1216 $duplicates[] = $dao->id
;
1223 * Takes an associative array and creates a contribution_product object.
1225 * the function extract all the params it needs to initialize the create a
1226 * contribution_product object. the params array could contain additional unused name/value
1229 * @param array $params
1230 * (reference) an assoc array of name/value pairs.
1232 * @return CRM_Contribute_DAO_ContributionProduct
1234 public static function addPremium(&$params) {
1235 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1236 $contributionProduct->copyValues($params);
1237 return $contributionProduct->save();
1241 * Get list of contribution fields for profile.
1242 * For now we only allow custom contribution fields to be in
1245 * @param bool $addExtraFields
1246 * True if special fields needs to be added.
1249 * the list of contribution fields
1251 public static function getContributionFields($addExtraFields = TRUE) {
1252 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1253 // @todo remove this - this line was added because payment_instrument_id was not
1254 // set to exportable - but now it is.
1255 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1257 if ($addExtraFields) {
1258 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1261 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1263 foreach ($contributionFields as $key => $var) {
1264 if ($key == 'contribution_contact_id') {
1267 elseif ($key == 'contribution_campaign_id') {
1268 $var['title'] = ts('Campaign');
1270 $fields[$key] = $var;
1273 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1278 * Add extra fields specific to contribution.
1280 public static function getSpecialContributionFields() {
1281 $extraFields = array(
1282 'contribution_soft_credit_name' => array(
1283 'name' => 'contribution_soft_credit_name',
1284 'title' => ts('Soft Credit Name'),
1285 'headerPattern' => '/^soft_credit_name$/i',
1286 'where' => 'civicrm_contact_d.display_name',
1288 'contribution_soft_credit_email' => array(
1289 'name' => 'contribution_soft_credit_email',
1290 'title' => ts('Soft Credit Email'),
1291 'headerPattern' => '/^soft_credit_email$/i',
1292 'where' => 'soft_email.email',
1294 'contribution_soft_credit_phone' => array(
1295 'name' => 'contribution_soft_credit_phone',
1296 'title' => ts('Soft Credit Phone'),
1297 'headerPattern' => '/^soft_credit_phone$/i',
1298 'where' => 'soft_phone.phone',
1300 'contribution_soft_credit_contact_id' => array(
1301 'name' => 'contribution_soft_credit_contact_id',
1302 'title' => ts('Soft Credit Contact ID'),
1303 'headerPattern' => '/^soft_credit_contact_id$/i',
1304 'where' => 'civicrm_contribution_soft.contact_id',
1306 'contribution_pcp_title' => array(
1307 'name' => 'contribution_pcp_title',
1308 'title' => ts('Personal Campaign Page Title'),
1309 'headerPattern' => '/^contribution_pcp_title$/i',
1310 'where' => 'contribution_pcp.title',
1314 return $extraFields;
1318 * @param int $pageID
1322 public static function getCurrentandGoalAmount($pageID) {
1324 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1325 FROM civicrm_contribution_page p,
1326 civicrm_contribution c
1327 WHERE p.id = c.contribution_page_id
1329 AND c.cancel_date is null
1333 $config = CRM_Core_Config
::singleton();
1334 $params = array(1 => array($pageID, 'Integer'));
1335 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1337 if ($dao->fetch()) {
1338 return array($dao->goal
, $dao->total
);
1341 return array(NULL, NULL);
1346 * Get list of contributions which credit the passed in contact ID.
1348 * The returned array provides details about the original contribution & donor.
1350 * @todo - this is a confusing function called from one place. It has a test. It would be
1351 * nice to deprecate it.
1353 * @param int $honorId
1354 * In Honor of Contact ID.
1357 * list of contribution fields
1359 public static function getHonorContacts($honorId) {
1361 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1362 $honorDAO->contact_id
= $honorId;
1365 $type = CRM_Contribute_PseudoConstant
::financialType();
1367 while ($honorDAO->fetch()) {
1368 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1369 $contributionDAO->id
= $honorDAO->contribution_id
;
1371 if ($contributionDAO->find(TRUE)) {
1372 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1373 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1374 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1375 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1376 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1377 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1378 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1379 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1380 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
);
1388 * Get the sort name of a contact for a particular contribution.
1391 * Id of the contribution.
1393 * @return null|string
1394 * sort name of the contact if found
1396 public static function sortName($id) {
1397 $id = CRM_Utils_Type
::escape($id, 'Integer');
1400 SELECT civicrm_contact.sort_name
1401 FROM civicrm_contribution, civicrm_contact
1402 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1403 AND civicrm_contribution.id = {$id}
1405 return CRM_Core_DAO
::singleValueQuery($query);
1409 * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1411 * @param int|array $contactIDs
1415 public static function annual($contactIDs) {
1416 if (!is_array($contactIDs)) {
1417 // In practice I can't fine any evidence that this function is ever called with
1418 // anything other than a single contact id, but left like this due to .... fear.
1419 $contactIDs = explode(',', $contactIDs);
1422 $query = self
::getAnnualQuery($contactIDs);
1423 $dao = CRM_Core_DAO
::executeQuery($query);
1425 $amount = $average = array();
1426 while ($dao->fetch()) {
1427 if ($dao->count
> 0 && $dao->amount
> 0) {
1428 $count +
= $dao->count
;
1429 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1430 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1436 implode(', ', $amount),
1437 implode(', ', $average),
1440 return array(0, 0, 0);
1444 * Check if there is a contribution with the params passed in.
1446 * Used for trxn_id,invoice_id and contribution_id
1448 * @param array $params
1449 * An assoc array of name/value pairs.
1452 * contribution id if success else NULL
1454 public static function checkDuplicateIds($params) {
1455 $dao = new CRM_Contribute_DAO_Contribution();
1459 foreach ($params as $k => $v) {
1461 $clause[] = "$k = '$v'";
1464 $clause = implode(' AND ', $clause);
1465 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1466 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1468 while ($dao->fetch()) {
1476 * Get the contribution details for component export.
1478 * @param int $exportMode
1480 * @param array $componentIds
1486 public static function getContributionDetails($exportMode, $componentIds) {
1487 $paymentDetails = array();
1488 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1490 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1491 $componentSelect = " civicrm_participant_payment.participant_id id";
1492 $additionalClause = "
1493 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1494 AND civicrm_participant_payment.participant_id {$componentClause} )
1497 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1498 $componentSelect = " civicrm_membership_payment.membership_id id";
1499 $additionalClause = "
1500 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1501 AND civicrm_membership_payment.membership_id {$componentClause} )
1504 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1505 $componentSelect = " civicrm_pledge_payment.id id";
1506 $additionalClause = "
1507 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1508 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1512 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1513 trxn_id, {$componentSelect}
1514 FROM civicrm_contribution
1515 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1516 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1517 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1518 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1519 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1520 AND option_group_contribution_status.id = contribution_status.option_group_id )
1524 $dao = CRM_Core_DAO
::executeQuery($query);
1526 while ($dao->fetch()) {
1527 $paymentDetails[$dao->id
] = array(
1528 'total_amount' => $dao->total_amount
,
1529 'contribution_status' => $dao->status
,
1530 'receive_date' => $dao->receive_date
,
1531 'pay_instru' => $dao->payment_instrument
,
1532 'trxn_id' => $dao->trxn_id
,
1536 return $paymentDetails;
1540 * Create address associated with contribution record.
1542 * As long as there is one or more billing field in the parameters we will create the address.
1544 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1547 * @param array $params
1548 * @param int $billingLocationTypeID
1553 public static function createAddress($params, $billingLocationTypeID) {
1554 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1555 if ($hasBillingField) {
1556 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1557 return $address->id
;
1564 * Delete billing address record related contribution.
1566 * @param int $contributionId
1567 * @param int $contactId
1569 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1571 $contactJoin = NULL;
1573 if ($contributionId) {
1574 $clauses[] = "cc.id = {$contributionId}";
1578 $clauses[] = "cco.id = {$contactId}";
1579 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1582 if (empty($clauses)) {
1583 CRM_Core_Error
::fatal();
1586 $condition = implode(' OR ', $clauses);
1590 FROM civicrm_address ca
1591 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1595 $dao = CRM_Core_DAO
::executeQuery($query);
1597 while ($dao->fetch()) {
1598 $params = array('id' => $dao->id
);
1599 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1604 * This function check online pending contribution associated w/
1605 * Online Event Registration or Online Membership signup.
1607 * @param int $componentId
1608 * Participant/membership id.
1609 * @param string $componentName
1613 * pending contribution id.
1615 public static function checkOnlinePendingContribution($componentId, $componentName) {
1616 $contributionId = NULL;
1617 if (!$componentId ||
1618 !in_array($componentName, array('Event', 'Membership'))
1620 return $contributionId;
1623 if ($componentName == 'Event') {
1624 $idName = 'participant_id';
1625 $componentTable = 'civicrm_participant';
1626 $paymentTable = 'civicrm_participant_payment';
1627 $source = ts('Online Event Registration');
1630 if ($componentName == 'Membership') {
1631 $idName = 'membership_id';
1632 $componentTable = 'civicrm_membership';
1633 $paymentTable = 'civicrm_membership_payment';
1634 $source = ts('Online Contribution');
1637 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
1640 SELECT component.id as {$idName},
1641 componentPayment.contribution_id as contribution_id,
1642 contribution.source source,
1643 contribution.contribution_status_id as contribution_status_id,
1644 contribution.is_pay_later as is_pay_later
1645 FROM $componentTable component
1646 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
1647 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1648 WHERE component.id = {$componentId}";
1650 $dao = CRM_Core_DAO
::executeQuery($query);
1652 while ($dao->fetch()) {
1653 if ($dao->contribution_id
&&
1654 $dao->is_pay_later
&&
1655 $dao->contribution_status_id
== $pendingStatusId &&
1656 strpos($dao->source
, $source) !== FALSE
1658 $contributionId = $dao->contribution_id
;
1662 return $contributionId;
1666 * Update contribution as well as related objects.
1668 * This function by-passes hooks - to address this - don't use this function.
1672 * Use api contribute.completetransaction
1673 * For failures use failPayment (preferably exposing by api in the process).
1675 * @param array $params
1676 * @param bool $processContributionObject
1679 * @throws \Exception
1681 public static function transitionComponents($params, $processContributionObject = FALSE) {
1682 // get minimum required values.
1683 $contactId = CRM_Utils_Array
::value('contact_id', $params);
1684 $componentId = CRM_Utils_Array
::value('component_id', $params);
1685 $componentName = CRM_Utils_Array
::value('componentName', $params);
1686 $contributionId = CRM_Utils_Array
::value('contribution_id', $params);
1687 $contributionStatusId = CRM_Utils_Array
::value('contribution_status_id', $params);
1689 // if we already processed contribution object pass previous status id.
1690 $previousContriStatusId = CRM_Utils_Array
::value('previous_contribution_status_id', $params);
1692 $updateResult = array();
1694 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1696 // we process only ( Completed, Cancelled, or Failed ) contributions.
1697 if (!$contributionId ||
1698 !in_array($contributionStatusId, array(
1699 array_search('Completed', $contributionStatuses),
1700 array_search('Cancelled', $contributionStatuses),
1701 array_search('Failed', $contributionStatuses),
1704 return $updateResult;
1707 if (!$componentName ||
!$componentId) {
1708 // get the related component details.
1709 $componentDetails = self
::getComponentDetails($contributionId);
1712 $componentDetails['contact_id'] = $contactId;
1713 $componentDetails['component'] = $componentName;
1715 if ($componentName == 'event') {
1716 $componentDetails['participant'] = $componentId;
1719 $componentDetails['membership'] = $componentId;
1723 if (!empty($componentDetails['contact_id'])) {
1724 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
1730 // do check for required ids.
1731 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
1732 return $updateResult;
1735 //now we are ready w/ required ids, start processing.
1737 $baseIPN = new CRM_Core_Payment_BaseIPN();
1739 $input = $ids = $objects = array();
1741 $input['component'] = CRM_Utils_Array
::value('component', $componentDetails);
1742 $ids['contribution'] = $contributionId;
1743 $ids['contact'] = CRM_Utils_Array
::value('contact_id', $componentDetails);
1744 $ids['membership'] = CRM_Utils_Array
::value('membership', $componentDetails);
1745 $ids['participant'] = CRM_Utils_Array
::value('participant', $componentDetails);
1746 $ids['event'] = CRM_Utils_Array
::value('event', $componentDetails);
1747 $ids['pledge_payment'] = CRM_Utils_Array
::value('pledge_payment', $componentDetails);
1748 $ids['contributionRecur'] = NULL;
1749 $ids['contributionPage'] = NULL;
1751 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1752 CRM_Core_Error
::fatal();
1755 $memberships = &$objects['membership'];
1756 $participant = &$objects['participant'];
1757 $pledgePayment = &$objects['pledge_payment'];
1758 $contribution = &$objects['contribution'];
1760 if ($pledgePayment) {
1761 $pledgePaymentIDs = array();
1762 foreach ($pledgePayment as $key => $object) {
1763 $pledgePaymentIDs[] = $object->id
;
1765 $pledgeID = $pledgePayment[0]->pledge_id
;
1768 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
1771 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
1772 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1777 // we might want to process contribution object.
1778 $processContribution = FALSE;
1779 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1780 if (is_array($memberships)) {
1781 foreach ($memberships as $membership) {
1783 //Update Membership status if there is no other completed contribution associated with the membership.
1784 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1785 foreach ($relatedContributions as $contriId) {
1786 if ($contriId == $contributionId) {
1789 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1790 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1794 if ($membership && $update) {
1795 $newStatus = array_search('Cancelled', $membershipStatuses);
1798 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
1799 $activityParam = array(
1800 'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
1801 'source_contact_id' => CRM_Core_Session
::singleton()->get('userID'),
1802 'target_contact_id' => $membership->contact_id
,
1803 'source_record_id' => $membership->id
,
1804 'activity_type_id' => 'Change Membership Status',
1805 'status_id' => 'Completed',
1806 'priority_id' => 'Normal',
1807 'activity_date_time' => 'now',
1810 $membership->status_id
= $newStatus;
1811 $membership->is_override
= TRUE;
1812 $membership->status_override_end_date
= 'null';
1813 $membership->save();
1814 civicrm_api3('activity', 'create', $activityParam);
1816 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1817 if ($processContributionObject) {
1818 $processContribution = TRUE;
1825 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1826 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1828 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1829 if ($processContributionObject) {
1830 $processContribution = TRUE;
1834 if ($pledgePayment) {
1835 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1837 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1838 if ($processContributionObject) {
1839 $processContribution = TRUE;
1843 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1844 if (is_array($memberships)) {
1845 foreach ($memberships as $membership) {
1847 //Update Membership status if there is no other completed contribution associated with the membership.
1848 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1849 foreach ($relatedContributions as $contriId) {
1850 if ($contriId == $contributionId) {
1853 $statusId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1854 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1858 if ($membership && $update) {
1859 $membership->status_id
= array_search('Expired', $membershipStatuses);
1860 $membership->is_override
= TRUE;
1861 $membership->status_override_end_date
= 'null';
1862 $membership->save();
1864 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1865 if ($processContributionObject) {
1866 $processContribution = TRUE;
1872 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1873 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1875 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1876 if ($processContributionObject) {
1877 $processContribution = TRUE;
1881 if ($pledgePayment) {
1882 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1884 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1885 if ($processContributionObject) {
1886 $processContribution = TRUE;
1890 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1892 // only pending contribution related object processed.
1893 if ($previousContriStatusId &&
1894 !in_array($contributionStatuses[$previousContriStatusId], array('Pending', 'Partially paid'))
1896 // this is case when we already processed contribution object.
1897 return $updateResult;
1899 elseif (!$previousContriStatusId &&
1900 !in_array($contributionStatuses[$contribution->contribution_status_id
], array('Pending', 'Partially paid'))
1902 // this is case when we are going to process contribution object later.
1903 return $updateResult;
1906 if (is_array($memberships)) {
1907 foreach ($memberships as $membership) {
1912 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
1913 $membership->membership_type_id
,
1914 $membership->is_test
, $membership->id
1917 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1918 // this picks up membership type changes during renewals
1920 SELECT membership_type_id
1921 FROM civicrm_membership_log
1922 WHERE membership_id=$membership->id
1925 $dao = new CRM_Core_DAO();
1927 if ($dao->fetch()) {
1928 if (!empty($dao->membership_type_id
)) {
1929 $membership->membership_type_id
= $dao->membership_type_id
;
1930 $membership->save();
1933 // else fall back to using current membership type
1934 // Figure out number of terms
1936 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
1937 foreach ($lineitems as $lineitem) {
1938 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
1939 $numterms = CRM_Utils_Array
::value('membership_num_terms', $lineitem);
1941 // in case membership_num_terms comes through as null or zero
1942 $numterms = $numterms >= 1 ?
$numterms : 1;
1947 // CRM-15735-to update the membership status as per the contribution receive date
1949 $oldStatus = $membership->status_id
;
1950 if (!empty($params['receive_date'])) {
1951 $joinDate = $params['receive_date'];
1952 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
1953 $membership->end_date
,
1954 $membership->join_date
,
1955 $params['receive_date'],
1957 $membership->membership_type_id
,
1960 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
1961 $membership->save();
1964 if ($currentMembership) {
1965 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1966 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
1967 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1970 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
1973 //get the status for membership.
1974 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
1976 $dates['join_date'],
1979 $membership->membership_type_id
,
1983 $formattedParams = array(
1984 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
1985 array_search('Current', $membershipStatuses)
1987 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
1988 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
1989 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
1992 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
1994 $membership->copyValues($formattedParams);
1995 $membership->save();
1997 //updating the membership log
1998 $membershipLog = array();
1999 $membershipLog = $formattedParams;
2000 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
2001 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
2003 $membershipLog['start_date'] = $logStartDate;
2004 $membershipLog['membership_id'] = $membership->id
;
2005 $membershipLog['modified_id'] = $membership->contact_id
;
2006 $membershipLog['modified_date'] = date('Ymd');
2007 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
2009 CRM_Member_BAO_MembershipLog
::add($membershipLog);
2011 //update related Memberships.
2012 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
2014 foreach (array('Membership Signup', 'Membership Renewal') as $activityType) {
2015 $scheduledActivityID = CRM_Utils_Array
::value('id',
2016 civicrm_api3('Activity', 'Get',
2018 'source_record_id' => $membership->id
,
2019 'activity_type_id' => $activityType,
2020 'status_id' => 'Scheduled',
2023 'sort' => 'id DESC',
2028 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2029 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2030 if ($scheduledActivityID) {
2031 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, array('id' => $scheduledActivityID));
2036 // track membership status change if any
2037 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
2038 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
2039 CRM_Activity_BAO_Activity
::addActivity($membership,
2040 'Change Membership Status',
2043 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2044 'source_contact_id' => $membershipLog['modified_id'],
2045 'priority_id' => 'Normal',
2050 $updateResult['membership_end_date'] = CRM_Utils_Date
::customFormat($dates['end_date'],
2053 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
2054 if ($processContributionObject) {
2055 $processContribution = TRUE;
2058 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2064 $updatedStatusId = array_search('Registered', $participantStatuses);
2065 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2067 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2068 if ($processContributionObject) {
2069 $processContribution = TRUE;
2073 if ($pledgePayment) {
2074 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2076 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2077 if ($processContributionObject) {
2078 $processContribution = TRUE;
2083 // process contribution object.
2084 if ($processContribution) {
2085 $contributionParams = array();
2092 'payment_instrument_id',
2095 'financial_type_id',
2096 'contribution_status_id',
2097 'non_deductible_amount',
2101 foreach ($fields as $field) {
2102 if (empty($params[$field])) {
2105 $contributionParams[$field] = $params[$field];
2108 $ids = array('contribution' => $contributionId);
2109 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2112 return $updateResult;
2116 * Returns all contribution related object ids.
2118 * @param $contributionId
2122 public static function getComponentDetails($contributionId) {
2123 $componentDetails = $pledgePayment = array();
2124 if (!$contributionId) {
2125 return $componentDetails;
2129 SELECT c.id as contribution_id,
2130 c.contact_id as contact_id,
2131 c.contribution_recur_id,
2132 mp.membership_id as membership_id,
2133 m.membership_type_id as membership_type_id,
2134 pp.participant_id as participant_id,
2135 p.event_id as event_id,
2136 pgp.id as pledge_payment_id
2137 FROM civicrm_contribution c
2138 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2139 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2140 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2141 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2142 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2143 WHERE c.id = $contributionId";
2145 $dao = CRM_Core_DAO
::executeQuery($query);
2146 $componentDetails = array();
2148 while ($dao->fetch()) {
2149 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2150 $componentDetails['contact_id'] = $dao->contact_id
;
2151 if ($dao->event_id
) {
2152 $componentDetails['event'] = $dao->event_id
;
2154 if ($dao->participant_id
) {
2155 $componentDetails['participant'] = $dao->participant_id
;
2157 if ($dao->membership_id
) {
2158 if (!isset($componentDetails['membership'])) {
2159 $componentDetails['membership'] = $componentDetails['membership_type'] = array();
2161 $componentDetails['membership'][] = $dao->membership_id
;
2162 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2164 if ($dao->pledge_payment_id
) {
2165 $pledgePayment[] = $dao->pledge_payment_id
;
2167 if ($dao->contribution_recur_id
) {
2168 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2172 if ($pledgePayment) {
2173 $componentDetails['pledge_payment'] = $pledgePayment;
2176 return $componentDetails;
2180 * @param int $contactId
2181 * @param bool $includeSoftCredit
2183 * @return null|string
2185 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2189 $financialTypes = CRM_Financial_BAO_FinancialType
::getAllAvailableFinancialTypes();
2190 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2191 $liWhere = " AND i.financial_type_id IN (0)";
2192 if (!empty($financialTypes)) {
2193 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2194 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2196 $contactContributionsSQL = "
2197 SELECT contribution.id AS id
2198 FROM civicrm_contribution contribution
2199 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2200 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2204 $contactSoftCreditContributionsSQL = "
2205 SELECT contribution.id
2206 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2207 ON ( contribution.id = softContribution.contribution_id )
2208 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2209 $query = "SELECT count( x.id ) count FROM ( ";
2210 $query .= $contactContributionsSQL;
2212 if ($includeSoftCredit) {
2213 $query .= " UNION ";
2214 $query .= $contactSoftCreditContributionsSQL;
2219 return CRM_Core_DAO
::singleValueQuery($query);
2223 * Repeat a transaction as part of a recurring series.
2225 * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2226 * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2227 * subsequent call to the contribution.completetransaction api.
2229 * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2231 * @param CRM_Contribute_BAO_Contribution $contribution
2232 * @param array $input
2233 * @param array $contributionParams
2234 * @param int $paymentProcessorID
2237 * @throws CiviCRM_API3_Exception
2239 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2240 if (!empty($contribution->id
)) {
2243 if (empty($contribution->id
)) {
2244 // Unclear why this would only be set for repeats.
2245 if (!empty($input['amount'])) {
2246 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2249 if (!empty($contributionParams['contribution_recur_id'])) {
2250 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2251 'id' => $contributionParams['contribution_recur_id'],
2253 if (!empty($recurringContribution['campaign_id'])) {
2254 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2255 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2257 if (!empty($recurringContribution['financial_type_id'])) {
2258 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2259 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2262 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2263 $contributionParams['contribution_recur_id'],
2264 array_intersect_key($contributionParams, array('total_amount' => TRUE, 'financial_type_id' => TRUE))
2266 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2268 $contributionParams['status_id'] = 'Pending';
2269 if (isset($contributionParams['financial_type_id'])) {
2270 // Give precedence to passed in type.
2271 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2274 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2276 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2277 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2279 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2280 //do not create CC or BCC emails or profile notifications.
2281 //The if is just to be safe. Not sure if we can ever arrive with this unset
2282 // but per CRM-19478 it seems it can be 'null'
2283 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2284 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2287 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2288 $contribution->id
= $createContribution['id'];
2289 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2295 * Get individual id for onbehalf contribution.
2297 * @param int $contributionId
2299 * @param int $contributorId
2303 * containing organization id and individual id
2305 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2309 if (!$contributionId) {
2313 // fetch contributor id if null
2314 if (!$contributorId) {
2315 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2316 $contributionId, 'contact_id'
2320 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2321 $activityTypeId = array_search('Contribution', $activityTypeIds);
2323 if ($activityTypeId && $contributorId) {
2325 SELECT civicrm_activity_contact.contact_id
2326 FROM civicrm_activity_contact
2327 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2328 WHERE civicrm_activity.activity_type_id = %1
2329 AND civicrm_activity.source_record_id = %2
2330 AND civicrm_activity_contact.record_type_id = %3
2333 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
2334 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2337 1 => array($activityTypeId, 'Integer'),
2338 2 => array($contributionId, 'Integer'),
2339 3 => array($sourceID, 'Integer'),
2342 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2344 // for on behalf contribution source is individual and contributor is organization
2345 if ($sourceContactId && $sourceContactId != $contributorId) {
2346 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2347 // get rel type id for employee of relation
2348 foreach ($relationshipTypeIds as $id => $typeVals) {
2349 if ($typeVals['name_a_b'] == 'Employee of') {
2350 $relationshipTypeId = $id;
2355 $rel = new CRM_Contact_DAO_Relationship();
2356 $rel->relationship_type_id
= $relationshipTypeId;
2357 $rel->contact_id_a
= $sourceContactId;
2358 $rel->contact_id_b
= $contributorId;
2359 if ($rel->find(TRUE)) {
2360 $ids['individual_id'] = $rel->contact_id_a
;
2361 $ids['organization_id'] = $rel->contact_id_b
;
2372 public static function getContributionDates() {
2373 $config = CRM_Core_Config
::singleton();
2374 $currentMonth = date('m');
2375 $currentDay = date('d');
2376 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2377 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2378 (int ) $config->fiscalYearStart
['d'] > $currentDay
2381 $year = date('Y') - 1;
2386 $year = array('Y' => $year);
2387 $yearDate = $config->fiscalYearStart
;
2388 $yearDate = array_merge($year, $yearDate);
2389 $yearDate = CRM_Utils_Date
::format($yearDate);
2391 $monthDate = date('Ym') . '01';
2397 'yearDate' => $yearDate,
2398 'monthDate' => $monthDate,
2403 * Load objects relations to contribution object.
2404 * Objects are stored in the $_relatedObjects property
2405 * In the first instance we are just moving functionality from BASEIpn -
2406 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2408 * Note that the unit test for the BaseIPN class tests this function
2410 * @param array $input
2411 * Input as delivered from Payment Processor.
2413 * Ids as Loaded by Payment Processor.
2414 * @param bool $loadAll
2415 * Load all related objects - even where id not passed in? (allows API to call this).
2420 public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2421 // @todo deprecate this function - the steps should be
2422 // 1) add additional functions like 'getRelatedMemberships'
2423 // 2) switch all calls that refer to ->_relatedObjects to
2424 // using the helper functions
2425 // 3) make ->_relatedObjects noisy in some way (deprecation won't work for properties - hmm
2426 // 4) make ->_relatedObjects protected
2427 // 5) hone up the individual functions to not use rely on this having been called
2428 // 6) deprecate like mad
2430 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2431 if (empty($ids['contact']) && isset($this->contact_id
)) {
2432 $ids['contact'] = $this->contact_id
;
2435 if (empty($this->_component
)) {
2436 if (!empty($ids['event'])) {
2437 $this->_component
= 'event';
2440 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2444 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2445 // refactoring than anything else, and has unit test coverage.
2446 if (empty($this->financial_type_id
)) {
2450 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2455 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2456 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2457 $this->contribution_page_id
,
2460 if ($paymentProcessorID) {
2461 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2465 $ids['contributionType'] = $this->financial_type_id
;
2466 $ids['financialType'] = $this->financial_type_id
;
2467 if ($this->contribution_page_id
) {
2468 $ids['contributionPage'] = $this->contribution_page_id
;
2471 $this->loadRelatedEntitiesByID($ids);
2473 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2474 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2477 if (!empty($ids['pledge_payment'])) {
2478 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2479 if (empty($paymentID)) {
2482 $payment = new CRM_Pledge_BAO_PledgePayment();
2483 $payment->id
= $paymentID;
2484 if (!$payment->find(TRUE)) {
2485 throw new Exception("Could not find pledge payment record: " . $paymentID);
2487 $this->_relatedObjects
['pledge_payment'][] = $payment;
2491 // These are probably no longer accessed from anywhere
2492 // @todo remove this line, after ensuring not used.
2493 $ids = $this->loadRelatedMembershipObjects($ids);
2495 if ($this->_component
!= 'contribute') {
2496 // we are in event mode
2497 // make sure event exists and is valid
2498 $event = new CRM_Event_BAO_Event();
2499 $event->id
= $ids['event'];
2500 if ($ids['event'] &&
2503 throw new Exception("Could not find event: " . $ids['event']);
2506 $this->_relatedObjects
['event'] = &$event;
2508 $participant = new CRM_Event_BAO_Participant();
2509 $participant->id
= $ids['participant'];
2510 if ($ids['participant'] &&
2511 !$participant->find(TRUE)
2513 throw new Exception("Could not find participant: " . $ids['participant']);
2515 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2517 $this->_relatedObjects
['participant'] = &$participant;
2519 // get the payment processor id from event - this is inaccurate see CRM-16923
2520 // in future we should look at throwing an exception here rather than an dubious guess.
2521 if (!$paymentProcessorID) {
2522 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2523 if ($paymentProcessorID) {
2524 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2529 if ($paymentProcessorID) {
2530 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2531 $this->is_test ?
'test' : 'live'
2533 $ids['paymentProcessor'] = $paymentProcessorID;
2534 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2537 // Add contribution id to $ids. CRM-20401
2538 $ids['contribution'] = $this->id
;
2543 * Create array of message information - ie. return html version, txt version, to field
2545 * @param array $input
2546 * Incoming information.
2547 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2548 * just check presence of recur object but maintaining legacy approach
2551 * IDs of related objects.
2552 * @param array $values
2553 * Any values that may have already been compiled by calling process.
2554 * This is augmented by values 'gathered' by gatherMessageValues
2555 * @param bool $returnMessageText
2556 * Distinguishes between whether to send message or return.
2557 * message text. We are working towards this function ALWAYS returning message text & calling
2558 * function doing emails / pdfs with it
2564 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2565 $this->loadRelatedObjects($input, $ids);
2567 if (empty($this->_component
)) {
2568 $this->_component
= CRM_Utils_Array
::value('component', $input);
2571 //not really sure what params might be passed in but lets merge em into values
2572 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2573 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2574 if (!empty($input['receipt_date'])) {
2575 $values['receipt_date'] = $input['receipt_date'];
2578 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2579 //what does recur 'mean here - to do with payment processor return functionality but
2580 // what is the importance
2581 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2582 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2584 $entityID = $entity = NULL;
2585 if (isset($ids['contribution'])) {
2586 $entity = 'contribution';
2587 $entityID = $ids['contribution'];
2589 if (!empty($ids['membership'])) {
2590 //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
2591 // 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
2592 // line having loaded an array
2593 $ids['membership'] = (array) $ids['membership'];
2594 $entity = 'membership';
2595 $entityID = $ids['membership'][0];
2598 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2599 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2600 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2602 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2603 //direct mode showing billing block, so use directIPN for temporary
2604 $template->assign('contributeMode', 'directIPN');
2607 // todo remove strtolower - check consistency
2608 if (strtolower($this->_component
) == 'event') {
2609 $eventParams = array('id' => $this->_relatedObjects
['participant']->event_id
);
2610 $values['event'] = array();
2612 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2614 //get location details
2615 $locationParams = array('entity_id' => $this->_relatedObjects
['participant']->event_id
, 'entity_table' => 'civicrm_event');
2616 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2618 $ufJoinParams = array(
2619 'entity_table' => 'civicrm_event',
2620 'entity_id' => $ids['event'],
2621 'module' => 'CiviEvent',
2624 list($custom_pre_id,
2626 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2628 $values['custom_pre_id'] = $custom_pre_id;
2629 $values['custom_post_id'] = $custom_post_ids;
2630 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2631 //and cases involving status updation through ipn
2632 // whatever that means!
2633 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2634 // perhaps we should throw an e-notice if amount is set & force total_amount?
2635 if (!empty($input['amount'])) {
2636 $values['totalAmount'] = $input['amount'];
2638 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2639 if ($values['event']['is_email_confirm']) {
2640 $values['is_email_receipt'] = 1;
2643 if (!empty($ids['contribution'])) {
2644 $values['contributionId'] = $ids['contribution'];
2647 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
2648 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
2652 $values['contribution_id'] = $this->id
;
2653 if (!empty($ids['related_contact'])) {
2654 $values['related_contact'] = $ids['related_contact'];
2655 if (isset($ids['onbehalf_dupe_alert'])) {
2656 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2658 $entityBlock = array(
2659 'contact_id' => $ids['contact'],
2660 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
2661 'Home', 'id', 'name'
2664 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
2665 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2668 if ($this->is_test
) {
2671 if (!empty($this->_relatedObjects
['membership'])) {
2672 foreach ($this->_relatedObjects
['membership'] as $membership) {
2673 if ($membership->id
) {
2674 $values['membership_id'] = $membership->id
;
2675 $values['isMembership'] = TRUE;
2676 $values['membership_assign'] = TRUE;
2678 // need to set the membership values here
2679 $template->assign('membership_name',
2680 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
2682 $template->assign('mem_start_date', $membership->start_date
);
2683 $template->assign('mem_join_date', $membership->join_date
);
2684 $template->assign('mem_end_date', $membership->end_date
);
2685 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
2686 $template->assign('mem_status', $membership_status);
2687 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
2688 $values['is_pay_later'] = 1;
2690 // Pass amount to floatval as string '0.00' is considered a
2691 // valid amount and includes Fee section in the mail.
2692 if (isset($values['amount'])) {
2693 $values['amount'] = floatval($values['amount']);
2696 if (!empty($this->contribution_recur_id
) && $paymentObject) {
2697 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
2698 $template->assign('cancelSubscriptionUrl', $url);
2699 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
2700 $template->assign('updateSubscriptionBillingUrl', $url);
2701 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2702 $template->assign('updateSubscriptionUrl', $url);
2705 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2708 // otherwise if its about sending emails, continue sending without return, as we
2709 // don't want to exit the loop.
2714 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2720 * Gather values for contribution mail - this function has been created
2721 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2722 * Values related to the contribution in question are gathered
2724 * @param array $input
2725 * Input into function (probably from payment processor).
2726 * @param array $values
2728 * The set of ids related to the input.
2732 public function _gatherMessageValues($input, &$values, $ids = array()) {
2733 // set display address of contributor
2734 if ($this->address_id
) {
2735 $addressParams = array('id' => $this->address_id
);
2736 $addressDetails = CRM_Core_BAO_Address
::getValues($addressParams, FALSE, 'id');
2737 $addressDetails = array_values($addressDetails);
2739 // Else we assign the billing address of the contribution contact.
2741 $addressParams = array('contact_id' => $this->contact_id
, 'is_billing' => 1);
2742 $addressDetails = (array) CRM_Core_BAO_Address
::getValues($addressParams);
2743 $addressDetails = array_values($addressDetails);
2746 if (!empty($addressDetails[0]['display'])) {
2747 $values['address'] = $addressDetails[0]['display'];
2750 if ($this->_component
== 'contribute') {
2751 //get soft contributions
2752 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
2753 if (!empty($softContributions)) {
2754 $values['softContributions'] = $softContributions['soft_credit'];
2756 if (isset($this->contribution_page_id
)) {
2757 // This is a call we want to use less, in favour of loading related objects.
2758 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
2759 if ($this->contribution_page_id
) {
2760 // This is precautionary as there are some legacy flows, but it should really be
2762 if (!isset($this->_relatedObjects
['contributionPage'])) {
2763 $this->loadRelatedEntitiesByID(array('contributionPage' => $this->contribution_page_id
));
2765 // CRM-8254 - override default currency if applicable
2766 $config = CRM_Core_Config
::singleton();
2767 $config->defaultCurrency
= CRM_Utils_Array
::value(
2770 $config->defaultCurrency
2774 // no contribution page -probably back office
2776 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2777 $values['title'] = 'Contribution';
2779 // set lineItem for contribution
2781 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
2782 if (!empty($lineItems)) {
2783 $firstLineItem = reset($lineItems);
2784 $priceSet = array();
2785 if (CRM_Utils_Array
::value('price_set_id', $firstLineItem)) {
2786 $priceSet = civicrm_api3('PriceSet', 'getsingle', array('id' => $firstLineItem['price_set_id'], 'return' => 'is_quick_config, id'));
2787 $values['priceSetID'] = $priceSet['id'];
2789 foreach ($lineItems as &$eachItem) {
2790 if (isset($this->_relatedObjects
['membership'])
2791 && is_array($this->_relatedObjects
['membership'])
2792 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
2793 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
2794 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
2795 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
2797 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
2798 // However, that does create upgrade pain so would be better to be phased in.
2799 $values['useForMember'] = empty($priceSet['is_quick_config']);
2801 $values['lineItem'][0] = $lineItems;
2805 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
2809 // if this is onbehalf of contribution then set related contact
2810 if (!empty($relatedContact['individual_id'])) {
2811 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2816 $eventParams = array(
2817 'id' => $this->_relatedObjects
['event']->id
,
2819 $values['event'] = array();
2821 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2822 // add custom fields for event
2823 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', NULL, $this->_relatedObjects
['event']->id
);
2825 $eventCustomGroup = array();
2826 foreach ($eventGroupTree as $key => $group) {
2827 if ($key === 'info') {
2831 foreach ($group['fields'] as $k => $customField) {
2832 $groupLabel = $group['title'];
2833 if (!empty($customField['customValue'])) {
2834 foreach ($customField['customValue'] as $customFieldValues) {
2835 $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2840 $values['event']['customGroup'] = $eventCustomGroup;
2842 //get participant details
2843 $participantParams = array(
2844 'id' => $this->_relatedObjects
['participant']->id
,
2847 $values['participant'] = array();
2849 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
2850 // add custom fields for event
2851 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', NULL, $this->_relatedObjects
['participant']->id
);
2852 $participantCustomGroup = array();
2853 foreach ($participantGroupTree as $key => $group) {
2854 if ($key === 'info') {
2858 foreach ($group['fields'] as $k => $customField) {
2859 $groupLabel = $group['title'];
2860 if (!empty($customField['customValue'])) {
2861 foreach ($customField['customValue'] as $customFieldValues) {
2862 $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2867 $values['participant']['customGroup'] = $participantCustomGroup;
2869 //get location details
2870 $locationParams = array(
2871 'entity_id' => $this->_relatedObjects
['event']->id
,
2872 'entity_table' => 'civicrm_event',
2874 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2876 $ufJoinParams = array(
2877 'entity_table' => 'civicrm_event',
2878 'entity_id' => $ids['event'],
2879 'module' => 'CiviEvent',
2882 list($custom_pre_id,
2884 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2886 $values['custom_pre_id'] = $custom_pre_id;
2887 $values['custom_post_id'] = $custom_post_ids;
2889 // set lineItem for event contribution
2891 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($this->id
);
2892 if (!empty($participantIds)) {
2893 foreach ($participantIds as $pIDs) {
2894 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
2895 if (!CRM_Utils_System
::isNull($lineItem)) {
2896 $values['lineItem'][] = $lineItem;
2903 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', NULL, $this->id
);
2905 $customGroup = array();
2906 foreach ($groupTree as $key => $group) {
2907 if ($key === 'info') {
2911 foreach ($group['fields'] as $k => $customField) {
2912 $groupLabel = $group['title'];
2913 if (!empty($customField['customValue'])) {
2914 foreach ($customField['customValue'] as $customFieldValues) {
2915 $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2920 $values['customGroup'] = $customGroup;
2922 $values['is_pay_later'] = $this->is_pay_later
;
2928 * Assign message variables to template but try to break the habit.
2930 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2931 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2932 * multiple recurring payments for processors like IATS that use tokens.
2934 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2935 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2936 * Note we send directly from this function in some cases because it is only partly refactored.
2938 * Don't call this function directly as the signature will change.
2942 * @param bool $returnMessageText
2946 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
2947 // @todo - this should have a better separation of concerns - ie.
2948 // gatherMessageValues should build an array of values to be assigned to the template
2949 // and this function should assign them (assigning null if not set).
2950 // the way the pcpParams & honor Params section works is a baby-step towards this.
2951 $template = CRM_Core_Smarty
::singleton();
2952 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
2953 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
2954 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
2956 // For some unit tests contribution cannot contain paymentProcessor information
2957 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
2958 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
2960 //assign honor information to receipt message
2961 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
2963 $honorParams = ['soft_credit_type' => NULL, 'honor_block_is_active' => NULL];
2964 if (isset($softRecord['soft_credit'])) {
2965 //if id of contribution page is present
2966 if (!empty($values['id'])) {
2967 $values['honor'] = array(
2968 'honor_profile_values' => array(),
2969 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2970 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2973 $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
2974 $honorParams['honor_block_is_active'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
2977 //offline contribution
2978 $softCreditTypes = $softCredits = array();
2979 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2980 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2981 $softCredits[$key] = array(
2982 'Name' => $softCredit['contact_name'],
2983 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
2986 $template->assign('softCreditTypes', $softCreditTypes);
2987 $template->assign('softCredits', $softCredits);
2991 $dao = new CRM_Contribute_DAO_ContributionProduct();
2992 $dao->contribution_id
= $this->id
;
2993 if ($dao->find(TRUE)) {
2994 $premiumId = $dao->product_id
;
2995 $template->assign('option', $dao->product_option
);
2997 $productDAO = new CRM_Contribute_DAO_Product();
2998 $productDAO->id
= $premiumId;
2999 $productDAO->find(TRUE);
3000 $template->assign('selectPremium', TRUE);
3001 $template->assign('product_name', $productDAO->name
);
3002 $template->assign('price', $productDAO->price
);
3003 $template->assign('sku', $productDAO->sku
);
3005 $template->assign('title', CRM_Utils_Array
::value('title', $values));
3006 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
3007 if (!$values['amount'] && isset($this->total_amount
)) {
3008 $values['amount'] = $this->total_amount
;
3011 $pcpParams = ['pcpBlock' => NULL, 'pcp_display_in_roll' => NULL, 'pcp_roll_nickname' => NULL, 'pcp_personal_note' => NULL, 'title' => NULL];
3013 if (strtolower($this->_component
) == 'contribute') {
3015 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3016 $softDAO->contribution_id
= $this->id
;
3017 if ($softDAO->find(TRUE)) {
3018 $pcpParams['pcpBlock'] = TRUE;
3019 $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll
;
3020 $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname
;
3021 $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note
;
3023 //assign the pcp page title for email subject
3024 $pcpDAO = new CRM_PCP_DAO_PCP();
3025 $pcpDAO->id
= $softDAO->pcp_id
;
3026 if ($pcpDAO->find(TRUE)) {
3027 $pcpParams['title'] = $pcpDAO->title
;
3031 foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3032 $template->assign($templateKey, $templateValue);
3035 if ($this->financial_type_id
) {
3036 $values['financial_type_id'] = $this->financial_type_id
;
3039 $template->assign('trxn_id', $this->trxn_id
);
3040 $template->assign('receive_date',
3041 CRM_Utils_Date
::processDate($this->receive_date
)
3043 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
3044 $template->assign('action', $this->is_test ?
1024 : 1);
3045 $template->assign('receipt_text',
3046 CRM_Utils_Array
::value('receipt_text',
3050 $template->assign('is_monetary', 1);
3051 $template->assign('is_recur', !empty($this->contribution_recur_id
));
3052 $template->assign('currency', $this->currency
);
3053 $template->assign('address', CRM_Utils_Address
::format($input));
3054 if (!empty($values['customGroup'])) {
3055 $template->assign('customGroup', $values['customGroup']);
3057 if (!empty($values['softContributions'])) {
3058 $template->assign('softContributions', $values['softContributions']);
3060 if ($this->_component
== 'event') {
3061 $template->assign('title', $values['event']['title']);
3062 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
3063 $viewRoles = array();
3064 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
3065 $viewRoles[] = $participantRoles[$v];
3067 $values['event']['participant_role'] = implode(', ', $viewRoles);
3068 $template->assign('event', $values['event']);
3069 $template->assign('participant', $values['participant']);
3070 $template->assign('location', $values['location']);
3071 $template->assign('customPre', $values['custom_pre_id']);
3072 $template->assign('customPost', $values['custom_post_id']);
3075 if ($this->_relatedObjects
['participant']->is_test
) {
3079 $values['params'] = array();
3080 //to get email of primary participant.
3081 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
3082 $primaryAmount[] = array(
3083 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3084 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3086 //build an array of cId/pId of participants
3087 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3088 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3089 //send receipt to additional participant if exists
3090 if (count($additionalIDs)) {
3091 $template->assign('isPrimary', 0);
3092 $template->assign('customProfile', NULL);
3093 //set additionalParticipant true
3094 $values['params']['additionalParticipant'] = TRUE;
3095 foreach ($additionalIDs as $pId => $cId) {
3097 //to change the status pending to completed
3098 $additional = new CRM_Event_DAO_Participant();
3099 $additional->id
= $pId;
3100 $additional->contact_id
= $cId;
3101 $additional->find(TRUE);
3102 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3103 $additional->status_id
= 1;
3104 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3105 //if additional participant dont have email
3107 if (!$additionalParticipantInfo) {
3108 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3110 $amount[0] = array('label' => $additional->fee_level
, 'amount' => $additional->fee_amount
);
3111 $primaryAmount[] = array(
3112 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3113 'amount' => $additional->fee_amount
,
3115 $additional->save();
3116 $template->assign('amount', $amount);
3117 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3121 //build an array of custom profile and assigning it to template
3122 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3124 if (count($customProfile)) {
3125 $template->assign('customProfile', $customProfile);
3128 // for primary contact
3129 $values['params']['additionalParticipant'] = FALSE;
3130 $template->assign('isPrimary', 1);
3131 $template->assign('amount', $primaryAmount);
3132 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3133 if ($this->payment_instrument_id
) {
3134 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3135 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3137 // carry paylater, since we did not created billing,
3138 // so need to pull email from primary location, CRM-4395
3139 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3145 * Check whether payment processor supports
3146 * cancellation of contribution subscription
3148 * @param int $contributionId
3151 * @param bool $isNotCancelled
3155 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3156 $cacheKeyString = "$contributionId";
3157 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3159 static $supportsCancel = array();
3161 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3162 $supportsCancel[$cacheKeyString] = FALSE;
3163 $isCancelled = FALSE;
3165 if ($isNotCancelled) {
3166 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3169 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3170 if (!empty($paymentObject)) {
3171 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3174 return $supportsCancel[$cacheKeyString];
3178 * Check whether subscription is already cancelled.
3180 * @param int $contributionId
3184 * contribution status
3186 public static function isSubscriptionCancelled($contributionId) {
3188 SELECT cr.contribution_status_id
3189 FROM civicrm_contribution_recur cr
3190 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3191 WHERE con.id = %1 LIMIT 1";
3192 $params = array(1 => array($contributionId, 'Integer'));
3193 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3194 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId);
3195 if ($status == 'Cancelled') {
3202 * Create all financial accounts entry.
3204 * @param array $params
3205 * Contribution object, line item array and params for trxn.
3208 * @param array $financialTrxnValues
3210 * @return null|\CRM_Core_BAO_FinancialTrxn
3212 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3213 $skipRecords = $update = $return = $isRelatedId = FALSE;
3215 $additionalParticipantId = array();
3216 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3217 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3219 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3220 $entityId = $params['participant_id'];
3221 $entityTable = 'civicrm_participant';
3222 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3224 elseif (!empty($params['membership_id'])) {
3225 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3226 // are created off one contribution should be handled elsewhere
3227 $entityId = $params['membership_id'];
3228 $entityTable = 'civicrm_membership';
3231 $entityId = $params['contribution']->id
;
3232 $entityTable = 'civicrm_contribution';
3235 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3236 $isRelatedId = TRUE;
3239 $entityID[] = $entityId;
3240 if (!empty($additionalParticipantId)) {
3241 $entityID +
= $additionalParticipantId;
3243 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3244 if (empty($params['prevContribution'])) {
3251 $statusId = $params['contribution']->contribution_status_id
;
3252 // CRM-13964 partial payment
3253 if ($contributionStatus == 'Partially paid'
3254 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3256 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_to_pay']);
3257 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3259 $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3260 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3261 $params['total_amount'] = $partialAmtPay;
3263 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3264 if (empty($balanceTrxnInfo['trxn_id'])) {
3265 // create new balance transaction record
3266 $toFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3268 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3269 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3270 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3271 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3272 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3273 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3274 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3275 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3276 $balanceTrxnParams['status_id'] = $statusId;
3277 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3278 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3279 $balanceTrxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3280 $balanceTrxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3281 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3282 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3284 $balanceTrxnParams['is_payment'] = 1;
3286 if (!empty($params['payment_processor'])) {
3287 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3289 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3293 // build line item array if its not set in $params
3294 if (empty($params['line_item']) ||
$additionalParticipantId) {
3295 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3298 if ($contributionStatus != 'Failed' &&
3299 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3301 $skipRecords = TRUE;
3302 $pendingStatus = array(
3306 if (in_array($contributionStatus, $pendingStatus)) {
3307 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3308 $params['financial_type_id'],
3309 'Accounts Receivable Account is'
3312 elseif (!empty($params['payment_processor'])) {
3313 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3314 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', array(
3315 'id' => $params['payment_processor'],
3316 'return' => 'payment_instrument_id',
3319 elseif (!empty($params['payment_instrument_id'])) {
3320 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3323 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3324 $queryParams = array(1 => array($relationTypeId, 'Integer'));
3325 $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);
3328 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
3329 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3330 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3332 //build financial transaction params
3333 $trxnParams = array(
3334 'contribution_id' => $params['contribution']->id
,
3335 'to_financial_account_id' => $params['to_financial_account_id'],
3336 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3337 'total_amount' => $totalAmount,
3338 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $params),
3339 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3340 'currency' => $params['contribution']->currency
,
3341 'trxn_id' => $params['contribution']->trxn_id
,
3342 'status_id' => $statusId,
3343 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3344 'check_number' => CRM_Utils_Array
::value('check_number', $params),
3345 'pan_truncation' => CRM_Utils_Array
::value('pan_truncation', $params),
3346 'card_type_id' => CRM_Utils_Array
::value('card_type_id', $params),
3348 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3349 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3350 if (isset($params['refund_trxn_id'])) {
3351 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3352 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3355 //CRM-16259, set is_payment flag for non pending status
3356 if (!in_array($contributionStatus, $pendingStatus)) {
3357 $trxnParams['is_payment'] = 1;
3359 if (!empty($params['payment_processor'])) {
3360 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3363 if (isset($fromFinancialAccountId)) {
3364 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3367 // consider external values passed for recording transaction entry
3368 if (!empty($financialTrxnValues)) {
3369 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3371 if (empty($trxnParams['payment_processor_id'])) {
3372 unset($trxnParams['payment_processor_id']);
3375 $params['trxnParams'] = $trxnParams;
3377 if (!empty($params['prevContribution'])) {
3379 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3380 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3381 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3382 if (!isset($params['trxnParams']['trxn_id'])) {
3383 // Actually I have no idea why we are overwriting any values from the previous contribution.
3384 // (filling makes sense to me). However, only protecting this value as I really really know we
3385 // don't want this one overwritten.
3387 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3389 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3391 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3392 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3393 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3395 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3396 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3399 //if financial type is changed
3400 if (!empty($params['financial_type_id']) &&
3401 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3403 $accountRelationship = 'Income Account is';
3404 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3405 $accountRelationship = 'Deferred Revenue Account is';
3407 $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id
, $accountRelationship);
3408 $newFinancialAccount = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3409 if ($oldFinancialAccount != $newFinancialAccount) {
3410 $params['total_amount'] = 0;
3411 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3412 $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3413 $params['prevContribution']->financial_type_id
, $accountRelationship);
3416 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3417 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3418 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3421 self
::updateFinancialAccounts($params, 'changeFinancialType');
3422 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3423 $params['financial_account_id'] = $newFinancialAccount;
3424 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3425 self
::updateFinancialAccounts($params);
3426 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3428 $params['deferred_financial_account_id'] = $newFinancialAccount;
3432 //Update contribution status
3433 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3434 if (!isset($params['refund_trxn_id'])) {
3435 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3436 // gets preference over another so I am only 'protecting' a very specific tested flow
3437 // and letting natural justice take care of the rest.
3438 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3440 if (!empty($params['contribution_status_id']) &&
3441 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3443 //Update Financial Records
3444 self
::updateFinancialAccounts($params, 'changedStatus');
3448 // change Payment Instrument for a Completed contribution
3449 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3450 // instrument is null and now new payment instrument is added along with the payment
3451 if (!$params['contribution']->payment_instrument_id
) {
3452 $params['contribution']->find(TRUE);
3454 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3455 $params['trxnParams']['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3457 if (self
::isPaymentInstrumentChange($params, $pendingStatus)) {
3458 $updated = CRM_Core_BAO_FinancialTrxn
::updateFinancialAccountsOnPaymentInstrumentChange($params);
3461 //if Change contribution amount
3462 $params['trxnParams']['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3463 $params['trxnParams']['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3464 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3465 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3466 if (isset($totalAmount) &&
3467 $totalAmount != $params['prevContribution']->total_amount
3469 //Update Financial Records
3470 $params['trxnParams']['from_financial_account_id'] = NULL;
3471 self
::updateFinancialAccounts($params, 'changedAmount');
3476 // Looks like we might have a data correction update.
3477 // This would be a case where a transaction id has been entered but it is incorrect &
3478 // the person goes back in & fixes it, as opposed to a new transaction.
3479 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3480 // the data fix scenario.
3482 if (isset($params['refund_trxn_id'])) {
3483 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3484 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3485 civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3488 $cardType = CRM_Utils_Array
::value('card_type_id', $params);
3489 $panTruncation = CRM_Utils_Array
::value('pan_truncation', $params);
3490 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3495 // records finanical trxn and entity financial trxn
3496 // also make it available as return value
3497 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3498 $trxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3499 $trxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3500 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3501 $params['entity_id'] = $financialTxn->id
;
3502 if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3503 self
::$_trxnIDs[] = $financialTxn->id
;
3507 // record line items and financial items
3508 if (empty($params['skipLineItem'])) {
3509 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $update);
3512 // create batch entry if batch_id is passed and
3513 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3514 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3515 $entityParams = array(
3516 'batch_id' => $params['batch_id'],
3517 'entity_table' => 'civicrm_financial_trxn',
3518 'entity_id' => $financialTxn->id
,
3520 CRM_Batch_BAO_EntityBatch
::create($entityParams);
3523 // when a fee is charged
3524 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3525 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3528 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3529 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3531 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3532 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3533 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3535 unset($params['line_item']);
3536 self
::$_trxnIDs = NULL;
3541 * Update all financial accounts entry.
3543 * @param array $params
3544 * Contribution object, line item array and params for trxn.
3546 * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3547 * adds unpredictability.
3549 * @param string $context
3553 public static function updateFinancialAccounts(&$params, $context = NULL) {
3555 $inputParams = $params;
3557 $currentContributionStatus = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
3558 $previousContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['prevContribution']->contribution_status_id
, 'name');
3560 if (($previousContributionStatus == 'Pending'
3561 ||
$previousContributionStatus == 'In Progress')
3562 && $currentContributionStatus == 'Completed'
3563 && $context == 'changePaymentInstrument'
3567 if ((($previousContributionStatus == 'Partially paid'
3568 && $currentContributionStatus == 'Completed')
3569 ||
($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later
== TRUE
3570 && $currentContributionStatus == 'Partially paid'))
3571 && $context == 'changedStatus'
3575 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3576 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3577 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3579 if ($context == 'changedStatus') {
3580 if ($previousContributionStatus == 'Completed'
3581 && (self
::isContributionStatusNegative($params['contribution']->contribution_status_id
))
3584 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3585 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3586 if (empty($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3587 $creditNoteId = self
::createCreditNoteId();
3588 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3591 elseif (($previousContributionStatus == 'Pending'
3592 && $params['prevContribution']->is_pay_later
) ||
$previousContributionStatus == 'In Progress'
3594 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $params) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
3595 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
3597 if ($currentContributionStatus == 'Cancelled') {
3598 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3599 $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3600 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3601 if (is_null($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3602 $creditNoteId = self
::createCreditNoteId();
3603 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3607 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3608 $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3613 if ($context == 'changedStatus') {
3614 if (($previousContributionStatus == 'Pending'
3615 ||
$previousContributionStatus == 'In Progress')
3616 && ($currentContributionStatus == 'Completed')
3618 if (empty($params['line_item'])) {
3620 //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3621 // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3622 // & this can be removed
3625 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3626 // This is an update so original currency if none passed in.
3627 $params['trxnParams']['currency'] = CRM_Utils_Array
::value('currency', $params, $params['prevContribution']->currency
);
3629 self
::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
3630 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3631 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3632 $params['entity_id'] = self
::$_trxnIDs[] = $trxn->id
;
3633 $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3634 $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3636 $entityParams = array(
3637 'entity_table' => 'civicrm_financial_item',
3639 foreach ($params['line_item'] as $fieldId => $fields) {
3640 foreach ($fields as $fieldValueId => $lineItemDetails) {
3642 1 => array(CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'), 'Integer'),
3643 2 => array($lineItemDetails['id'], 'Integer'),
3645 CRM_Core_DAO
::executeQuery($query, $fparams);
3647 1 => array($lineItemDetails['id'], 'Integer'),
3649 $financialItem = CRM_Core_DAO
::executeQuery($sql, $fparams);
3650 while ($financialItem->fetch()) {
3651 $entityParams['entity_id'] = $financialItem->id
;
3652 $entityParams['amount'] = $financialItem->amount
;
3653 foreach (self
::$_trxnIDs as $tID) {
3654 $entityParams['financial_trxn_id'] = $tID;
3655 CRM_Financial_BAO_FinancialItem
::createEntityTrxn($entityParams);
3664 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3665 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3666 $params['entity_id'] = $trxn->id
;
3667 if ($context != 'changePaymentInstrument') {
3668 $itemParams['entity_table'] = 'civicrm_line_item';
3669 $trxnIds['id'] = $params['entity_id'];
3670 $previousLineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($params['contribution']->id
);
3671 foreach ($params['line_item'] as $fieldId => $fields) {
3672 foreach ($fields as $fieldValueId => $lineItemDetails) {
3673 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($lineItemDetails['id']);
3674 $receiveDate = CRM_Utils_Date
::isoToMysql($params['prevContribution']->receive_date
);
3675 if ($params['contribution']->receive_date
) {
3676 $receiveDate = CRM_Utils_Date
::isoToMysql($params['contribution']->receive_date
);
3679 $financialAccount = self
::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array
::value('financial_account_id', $prevFinancialItem));
3681 $currency = $params['prevContribution']->currency
;
3682 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3683 if ($params['contribution']->currency
) {
3684 $currency = $params['contribution']->currency
;
3686 $previousLineItemTotal = CRM_Utils_Array
::value('line_total', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3687 $itemParams = array(
3688 'transaction_date' => $receiveDate,
3689 'contact_id' => $params['prevContribution']->contact_id
,
3690 'currency' => $currency,
3691 'amount' => self
::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
3692 'description' => CRM_Utils_Array
::value('description', $prevFinancialItem),
3693 'status_id' => $prevFinancialItem['status_id'],
3694 'financial_account_id' => $financialAccount,
3695 'entity_table' => 'civicrm_line_item',
3696 'entity_id' => $lineItemDetails['id'],
3698 $financialItem = CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3699 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3700 $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
3701 $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id
;
3703 if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') ||
($context == 'changeFinancialType')) {
3704 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
3705 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
3706 $taxAmount = (float) $lineItemDetails['tax_amount'];
3707 if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
3708 // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
3709 $taxAmount = CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3711 elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
3712 $taxAmount -= CRM_Utils_Array
::value('tax_amount', CRM_Utils_Array
::value($fieldValueId, $previousLineItems), 0);
3714 $itemParams['amount'] = self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $taxAmount;
3715 $itemParams['description'] = $taxTerm;
3716 if ($lineItemDetails['financial_type_id']) {
3717 $itemParams['financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount(
3718 $lineItemDetails['financial_type_id'],
3719 'Sales Tax Account is'
3722 CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3727 if ($context == 'changeFinancialType') {
3728 // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3729 $params['skipLineItem'] = FALSE;
3730 foreach ($params['line_item'] as &$lineItems) {
3731 foreach ($lineItems as &$line) {
3732 $line['financial_type_id'] = $params['financial_type_id'];
3737 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, $context);
3741 * Is this contribution status a reversal.
3743 * If so we would expect to record a negative value in the financial_trxn table.
3745 * @param int $status_id
3749 public static function isContributionStatusNegative($status_id) {
3750 $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3751 return in_array(CRM_Contribute_PseudoConstant
::contributionStatus($status_id, 'name'), $reversalStatuses);
3755 * Check status validation on update of a contribution.
3757 * @param array $values
3758 * Previous form values before submit.
3760 * @param array $fields
3761 * The input form values.
3763 * @param array $errors
3768 public static function checkStatusValidation($values, &$fields, &$errors) {
3769 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3770 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3771 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3775 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3776 $checkStatus = array(
3777 'Cancelled' => array('Completed', 'Refunded'),
3778 'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3779 'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3780 'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3781 'Refunded' => array('Cancelled', 'Completed'),
3782 'Partially paid' => array('Completed'),
3785 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3786 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3788 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3789 1 => $contributionStatuses[$values['contribution_status_id']],
3790 2 => $contributionStatuses[$fields['contribution_status_id']],
3796 * Delete contribution of contact.
3800 * @param int $contactId
3804 public static function deleteContactContribution($contactId) {
3805 $contribution = new CRM_Contribute_DAO_Contribution();
3806 $contribution->contact_id
= $contactId;
3807 $contribution->find();
3808 while ($contribution->fetch()) {
3809 self
::deleteContribution($contribution->id
);
3814 * Get options for a given contribution field.
3815 * @see CRM_Core_DAO::buildOptions
3817 * @param string $fieldName
3818 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3819 * @param array $props whatever is known about this dao object.
3821 * @return array|bool
3823 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3824 $className = __CLASS__
;
3826 if (isset($props['orderColumn'])) {
3827 $params['orderColumn'] = $props['orderColumn'];
3829 switch ($fieldName) {
3830 // This field is not part of this object but the api supports it
3831 case 'payment_processor':
3832 $className = 'CRM_Contribute_BAO_ContributionPage';
3833 // Filter results by contribution page
3834 if (!empty($props['contribution_page_id'])) {
3835 $page = civicrm_api('contribution_page', 'getsingle', array(
3837 'id' => ($props['contribution_page_id']),
3839 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3840 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3844 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3845 case 'honor_type_id':
3846 $className = 'CRM_Contribute_BAO_ContributionSoft';
3847 $fieldName = 'soft_credit_type_id';
3848 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3851 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3855 * Validate financial type.
3859 * @param int $financialTypeId
3860 * Financial Type id.
3862 * @param string $relationName
3864 * @return array|bool
3866 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3867 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
3869 if (!$financialAccount) {
3870 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
3877 * Function to record additional payment for partial and refund contributions.
3879 * @param int $contributionId
3880 * is the invoice contribution id (got created after processing participant payment).
3881 * @param array $trxnsData
3882 * to take user provided input of transaction details.
3883 * @param string $paymentType
3884 * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3885 * @param int $participantId
3886 * @param bool $updateStatus
3888 * @return null|object
3890 public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3892 if ($paymentType == 'owed') {
3893 $financialTrxn = CRM_Financial_BAO_Payment
::recordPayment($contributionId, $trxnsData, $participantId);
3895 elseif ($paymentType == 'refund') {
3896 $financialTrxn = CRM_Financial_BAO_Payment
::recordRefundPayment($contributionId, $trxnsData, $updateStatus);
3897 if ($participantId) {
3898 // update participant status
3899 // @todo this doesn't make sense...
3900 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
3901 $ids = CRM_Event_BAO_Participant
::getParticipantIds($contributionId);
3902 foreach ($ids as $val) {
3903 $participantUpdate['id'] = $val;
3904 $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3905 CRM_Event_BAO_Participant
::add($participantUpdate);
3910 if (!empty($financialTrxn)) {
3911 self
::recordPaymentActivity($contributionId, $participantId, $financialTrxn);
3912 return $financialTrxn;
3920 * @param $activityType
3922 * @param int $contributionId
3924 * @throws CRM_Core_Exception
3926 public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3927 if ($component == 'event') {
3928 $title = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id
, 'title');
3931 $title = ts('Contribution');
3933 $paymentAmount = CRM_Utils_Money
::format($trxnObj->total_amount
, $trxnObj->currency
);
3934 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
3935 $date = CRM_Utils_Date
::isoToMysql($trxnObj->trxn_date
);
3936 $targetCid = $entityObj->contact_id
;
3937 // source record id would be the contribution id
3938 $srcRecId = $contributionId;
3941 $activityParams = array(
3942 'source_contact_id' => $targetCid,
3943 'source_record_id' => $srcRecId,
3944 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
3945 'subject' => $subject,
3946 'activity_date_time' => $date,
3947 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
3948 'skipRecentView' => TRUE,
3951 // create activity with target contacts
3952 $session = CRM_Core_Session
::singleton();
3953 $id = $session->get('userID');
3955 $activityParams['source_contact_id'] = $id;
3956 $activityParams['target_contact_id'][] = $targetCid;
3959 CRM_Activity_BAO_Activity
::create($activityParams);
3963 * Get list of payments displayed by Contribute_Page_PaymentInfo.
3967 * @param bool $getTrxnInfo
3968 * @param bool $usingLineTotal
3972 public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3973 // @todo deprecate passing in component - always call with contribution.
3974 if ($component == 'event') {
3975 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3977 if (!$contributionId) {
3978 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3979 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3980 $id = $primaryParticipantId;
3982 if (!$contributionId) {
3987 elseif ($component == 'membership') {
3988 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
3991 $contributionId = $id;
3994 $total = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
3995 $baseTrxnId = !empty($total['trxn_id']) ?
$total['trxn_id'] : NULL;
3997 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
3998 $baseTrxnId = $baseTrxnId['financialTrxnId'];
4000 if (!CRM_Utils_Array
::value('total_amount', $total) ||
$usingLineTotal) {
4001 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4004 $baseTrxnId = $total['trxn_id'];
4005 $total = $total['total_amount'];
4008 $paymentBalance = CRM_Contribute_BAO_Contribution
::getContributionBalance($contributionId, $total);
4010 $contribution = civicrm_api3('Contribution', 'getsingle', array('id' => $contributionId, 'return' => array('currency', 'is_pay_later', 'contribution_status_id', 'financial_type_id')));
4012 $info['payLater'] = $contribution['is_pay_later'];
4013 $info['contribution_status'] = $contribution['contribution_status'];
4014 $info['currency'] = $contribution['currency'];
4016 $financialTypeId = $contribution['financial_type_id'];
4017 $feeFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, 'Expense Account is');
4019 if ($paymentBalance == 0 && $info['payLater']) {
4020 // @todo - review - this looks very unlikely to be correct.
4021 // the balance should be correct based on payment transactions not
4023 $paymentBalance = $total;
4026 $info['total'] = $total;
4027 $info['paid'] = $total - $paymentBalance;
4028 $info['balance'] = $paymentBalance;
4030 $info['component'] = $component;
4032 if ($getTrxnInfo && $baseTrxnId) {
4033 // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
4035 SELECT GROUP_CONCAT(fa.`name`) as financial_account,
4037 ft.payment_instrument_id,
4038 ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
4040 FROM civicrm_contribution con
4041 LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4042 INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4043 AND ft.to_financial_account_id != %2
4044 LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4045 LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4046 LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4048 WHERE con.id = %1 AND ft.is_payment = 1
4050 $queryParams = array(
4051 1 => array($contributionId, 'Integer'),
4052 2 => array($feeFinancialAccount, 'Integer'),
4054 $resultDAO = CRM_Core_DAO
::executeQuery($sql, $queryParams);
4055 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
4057 while ($resultDAO->fetch()) {
4058 $paidByLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4059 $paidByName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4060 if ($resultDAO->card_type_id
) {
4061 $creditCardType = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id
);
4062 $pantruncation = '';
4063 if ($resultDAO->pan_truncation
) {
4064 $pantruncation = ": {$resultDAO->pan_truncation}";
4066 $paidByLabel .= " ({$creditCardType}{$pantruncation})";
4069 // show payment edit link only for payments done via backoffice form
4070 $paymentEditLink = '';
4071 if (empty($resultDAO->payment_processor_id
) && CRM_Core_Permission
::check('edit contributions')) {
4073 CRM_Core_Action
::UPDATE
=> array(
4074 'name' => "<i class='crm-i fa-pencil'></i>",
4075 'url' => 'civicrm/payment/edit',
4076 'class' => 'medium-popup',
4077 'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
4078 'title' => ts('Edit Payment'),
4081 $paymentEditLink = CRM_Core_Action
::formLink(
4083 CRM_Core_Action
::mask(array(CRM_Core_Permission
::EDIT
)),
4085 'id' => $resultDAO->id
,
4086 'contribution_id' => $contributionId,
4092 'id' => $resultDAO->id
,
4093 'total_amount' => $resultDAO->total_amount
,
4094 'financial_type' => $resultDAO->financial_account
,
4095 'payment_instrument' => $paidByLabel,
4096 'receive_date' => $resultDAO->trxn_date
,
4097 'trxn_id' => $resultDAO->trxn_id
,
4098 'status' => $statuses[$resultDAO->status_id
],
4099 'currency' => $resultDAO->currency
,
4100 'action' => $paymentEditLink,
4102 if ($paidByName == 'Check') {
4103 $val['check_number'] = $resultDAO->check_number
;
4107 $info['transaction'] = $rows;
4110 $info['payment_links'] = self
::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4115 * Get the outstanding balance on a contribution.
4117 * @param int $contributionId
4118 * @param float $contributionTotal
4119 * Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4123 public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4124 if ($contributionTotal === NULL) {
4125 $contributionTotal = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4128 return CRM_Utils_Money
::subtractCurrencies(
4130 CRM_Core_BAO_FinancialTrxn
::getTotalPayments($contributionId, TRUE) ?
: 0,
4131 CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4136 * Get the tax amount (misnamed function).
4138 * @param array $params
4139 * @param bool $isLineItem
4143 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4144 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4146 // This function should be only called after standardisation (removal of
4147 // thousand separator & using a decimal point for cents separator.
4148 // However, we don't know if that is always true :-(
4149 // There is a deprecation notice tho :-)
4150 $unknownIfMoneyIsClean = empty($params['skipCleanMoney']) && !$isLineItem;
4151 // Update contribution.
4152 if (!empty($params['id'])) {
4153 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4154 // there are no tax implications - early return.
4155 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4158 if (empty($params['prevContribution'])) {
4159 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4162 foreach (array('total_amount', 'financial_type_id', 'fee_amount') as $field) {
4163 if (!isset($params[$field])) {
4164 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4165 // Tax amount gets added back on later....
4166 $params['total_amount'] = $params['prevContribution']->total_amount
-
4167 $params['prevContribution']->tax_amount
;
4170 $params[$field] = $params['prevContribution']->$field;
4171 if ($params[$field] != $params['prevContribution']->$field) {
4177 self
::calculateMissingAmountParams($params, $params['id']);
4178 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4179 // Assign tax Amount on update of contribution
4180 if (!empty($params['prevContribution']->tax_amount
)) {
4181 $params['tax_amount'] = 'null';
4182 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4183 foreach ($params['line_item'] as $setID => $priceField) {
4184 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4185 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4192 // New Contribution and update of contribution with tax rate financial type
4193 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4194 empty($params['skipLineItem']) && !$isLineItem
4196 $taxRateParams = $taxRates[$params['financial_type_id']];
4197 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams, $unknownIfMoneyIsClean);
4198 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4200 // Get Line Item on update of contribution
4201 if (isset($params['id'])) {
4202 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4205 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4207 foreach ($params['line_item'] as $setID => $priceField) {
4208 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4209 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4212 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4214 elseif (isset($params['api.line_item.create'])) {
4215 // Update total amount of contribution using lineItem
4216 $taxAmountArray = array();
4217 foreach ($params['api.line_item.create'] as $key => $value) {
4218 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4219 $taxRate = $taxRates[$value['financial_type_id']];
4220 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4221 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4224 $params['tax_amount'] = array_sum($taxAmountArray);
4225 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4228 // update line item of contrbution
4229 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4230 $taxRate = $taxRates[$params['financial_type_id']];
4231 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate, $unknownIfMoneyIsClean);
4232 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4239 * Check financial type validation on update of a contribution.
4241 * @param Integer $financialTypeId
4242 * Value of latest Financial Type.
4244 * @param Integer $contributionId
4247 * @param array $errors
4252 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4253 if (!empty($financialTypeId)) {
4254 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4255 if ($oldFinancialTypeId == $financialTypeId) {
4259 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4261 '1' => array($contributionId, 'Integer'),
4263 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4264 if ($result->N
> 1) {
4265 $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.');
4270 * Update related pledge payment payments.
4272 * This function has been refactored out of the back office contribution form and may
4273 * still overlap with other functions.
4275 * @param string $action
4276 * @param int $pledgePaymentID
4277 * @param int $contributionID
4278 * @param bool $adjustTotalAmount
4279 * @param float $total_amount
4280 * @param float $original_total_amount
4281 * @param int $contribution_status_id
4282 * @param int $original_contribution_status_id
4284 public static function updateRelatedPledge(
4290 $original_total_amount,
4291 $contribution_status_id,
4292 $original_contribution_status_id
4294 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4298 if ($pledgePaymentID) {
4299 //store contribution id in payment record.
4300 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4303 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4310 if (!$pledgePaymentID) {
4313 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4319 $updatePledgePaymentStatus = FALSE;
4321 // If either the status or the amount has changed we update the pledge status.
4322 if ($action & CRM_Core_Action
::ADD
) {
4323 $updatePledgePaymentStatus = TRUE;
4325 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4326 ($original_total_amount != $total_amount))
4328 $updatePledgePaymentStatus = TRUE;
4331 if ($updatePledgePaymentStatus) {
4332 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4333 array($pledgePaymentID),
4334 $contribution_status_id,
4343 * Compute the stats values
4347 * @param string $stat either 'mode' or 'median'
4348 * @param string $sql
4349 * @param string $alias of civicrm_contribution
4351 * @return array|null
4353 public static function computeStats($stat, $sql, $alias = NULL) {
4354 CRM_Core_Error
::deprecatedFunctionWarning('computeStats is now deprecated');
4359 * Is there only one line item attached to the contribution.
4365 * @throws \CiviCRM_API3_Exception
4367 public static function isSingleLineItem($id) {
4368 $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4369 return ($lineItemCount == 1);
4373 * Complete an order.
4375 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4377 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4379 * Moving it out of the BaseIPN class is just the first step.
4381 * @param array $input
4383 * @param array $objects
4384 * @param CRM_Core_Transaction $transaction
4386 * @param CRM_Contribute_BAO_Contribution $contribution
4390 public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution) {
4391 $primaryContributionID = isset($contribution->id
) ?
$contribution->id
: $objects['first_contribution']->id
;
4392 // The previous details are used when calculating line items so keep it before any code that 'does something'
4393 if (!empty($contribution->id
)) {
4394 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(array('id' => $contribution->id
),
4395 CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
4397 $inputContributionWhiteList = array(
4402 'payment_instrument_id',
4407 'contribution_status_id',
4411 if (self
::isSingleLineItem($primaryContributionID)) {
4412 $inputContributionWhiteList[] = 'financial_type_id';
4415 $participant = CRM_Utils_Array
::value('participant', $objects);
4416 $recurContrib = CRM_Utils_Array
::value('contributionRecur', $objects);
4417 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4418 $event = CRM_Utils_Array
::value('event', $objects);
4420 $paymentProcessorId = '';
4421 if (isset($objects['paymentProcessor'])) {
4422 if (is_array($objects['paymentProcessor'])) {
4423 $paymentProcessorId = $objects['paymentProcessor']['id'];
4426 $paymentProcessorId = $objects['paymentProcessor']->id
;
4430 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4432 $contributionParams = array_merge(array(
4433 'contribution_status_id' => $completedContributionStatusID,
4434 'source' => self
::getRecurringContributionDescription($contribution, $event),
4435 ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4438 // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4439 if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency
)) {
4440 $contributionParams['currency'] = $objects['first_contribution']->currency
;
4443 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4445 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4446 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4447 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4448 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4451 if ($recurringContributionID) {
4452 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4454 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4456 if (empty($contributionParams['receive_date']) && $changeDate) {
4457 $contributionParams['receive_date'] = $changeDate;
4460 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4461 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4464 if (isset($input['is_email_receipt'])) {
4465 $values['is_email_receipt'] = $input['is_email_receipt'];
4468 if ($input['component'] == 'contribute') {
4469 if ($contribution->contribution_page_id
) {
4470 // Figure out what we gain from this.
4471 // Note that we may have overwritten the is_email_receipt input, fix that below.
4472 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4474 elseif ($recurContrib && $recurringContributionID) {
4475 $values['amount'] = $recurContrib->amount
;
4476 $values['financial_type_id'] = $objects['contributionType']->id
;
4477 $values['title'] = $source = ts('Offline Recurring Contribution');
4480 if (isset($input['is_email_receipt'])) {
4481 // CRM-19601 - we may have overwritten this above.
4482 $values['is_email_receipt'] = $input['is_email_receipt'];
4484 elseif ($recurContrib && $recurringContributionID) {
4485 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4486 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4487 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4490 if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4491 self
::updateMembershipBasedOnCompletionOfContribution(
4493 $primaryContributionID,
4499 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4500 if ($event->is_email_confirm
) {
4501 // @todo this should be set by the function that sends the mail after sending.
4502 $contributionParams['receipt_date'] = $changeDate;
4504 $participantParams['id'] = $participant->id
;
4505 $participantParams['status_id'] = 'Registered';
4506 civicrm_api3('Participant', 'create', $participantParams);
4510 $contributionParams['id'] = $contribution->id
;
4512 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4513 // unsetting it here does NOT cause any other contribution test to fail!
4514 unset($contributionParams['financial_type_id']);
4515 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4517 // Add new soft credit against current $contribution.
4518 if (CRM_Utils_Array
::value('contributionRecur', $objects) && $objects['contributionRecur']->id
) {
4519 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4522 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4523 'labelColumn' => 'name',
4526 if (isset($input['prevContribution']) && (!$input['prevContribution']->is_pay_later
&& $input['prevContribution']->contribution_status_id
== $contributionStatuses['Pending'])) {
4527 $input['payment_processor'] = $paymentProcessorId;
4530 if (!empty($contribution->_relatedObjects
['participant'])) {
4531 $input['contribution_mode'] = 'participant';
4532 $input['participant_id'] = $contribution->_relatedObjects
['participant']->id
;
4534 elseif (!empty($contribution->_relatedObjects
['membership'])) {
4535 // @todo - use getRelatedMemberships instead
4536 $input['contribution_mode'] = 'membership';
4537 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4538 $contribution->trxn_id
= CRM_Utils_Array
::value('trxn_id', $input);
4539 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4542 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4543 $transaction->commit();
4545 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4546 $contributionParams['contribution_status_id'], $input['amount']);
4548 // create an activity record
4549 if ($input['component'] == 'contribute') {
4551 $targetContactID = NULL;
4552 if (!empty($ids['related_contact'])) {
4553 $targetContactID = $contribution->contact_id
;
4554 $contribution->contact_id
= $ids['related_contact'];
4556 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4559 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4560 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4561 if (!array_key_exists('is_email_receipt', $values) ||
4562 $values['is_email_receipt'] == 1
4564 civicrm_api3('Contribution', 'sendconfirmation', array(
4565 'id' => $contribution->id
,
4566 'payment_processor_id' => $paymentProcessorId,
4568 CRM_Core_Error
::debug_log_message("Receipt sent");
4571 CRM_Core_Error
::debug_log_message("Success: Database updated");
4572 return $contributionResult;
4576 * Send receipt from contribution.
4578 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4580 * Note that the compose message part has been moved to contribution
4581 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4583 * @param array $input
4584 * Incoming data from Payment processor.
4586 * Related object IDs.
4587 * @param int $contributionID
4588 * @param array $values
4589 * Values related to objects that have already been loaded.
4590 * @param bool $returnMessageText
4591 * Should text be returned instead of sent. This.
4592 * is because the function is also used to generate pdfs
4595 * @throws \CRM_Core_Exception
4596 * @throws \CiviCRM_API3_Exception
4598 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4599 $returnMessageText = FALSE) {
4601 $contribution = new CRM_Contribute_BAO_Contribution();
4602 $contribution->id
= $contributionID;
4603 if (!$contribution->find(TRUE)) {
4604 throw new CRM_Core_Exception('Contribution does not exist');
4606 $contribution->loadRelatedObjects($input, $ids, TRUE);
4607 // set receipt from e-mail and name in value
4608 if (!$returnMessageText) {
4609 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4611 $values['contribution_status'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id
);
4612 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4613 if ((!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4614 civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id
));
4620 * Generate From email and from name in an array values
4621 * @param array $input
4622 * @param \CRM_Contribute_BAO_Contribution $contribution
4625 public static function generateFromEmailAndName($input, $contribution) {
4626 // Use input value if supplied.
4627 if (!empty($input['receipt_from_email'])) {
4628 return array(CRM_Utils_array
::value('receipt_from_name', $input, ''), $input['receipt_from_email']);
4630 // if we are still empty see if we can use anything from a contribution page.
4631 $pageValues = array();
4632 if (!empty($contribution->contribution_page_id
)) {
4633 $pageValues = civicrm_api3('ContributionPage', 'getsingle', array('id' => $contribution->contribution_page_id
));
4635 // if we are still empty see if we can use anything from a contribution page.
4636 if (!empty($pageValues['receipt_from_email'])) {
4637 return array($pageValues['receipt_from_name'], $pageValues['receipt_from_email']);
4639 // If we are still empty fall back to the domain or logged in user information.
4640 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4644 * Generate credit note id with next avaible number
4649 public static function createCreditNoteId() {
4650 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
4652 $creditNoteNum = CRM_Core_DAO
::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution WHERE creditnote_id IS NOT NULL");
4653 $creditNoteId = NULL;
4657 $creditNoteId = CRM_Utils_Array
::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4658 $result = civicrm_api3('Contribution', 'getcount', array(
4660 'creditnote_id' => $creditNoteId,
4662 } while ($result > 0);
4664 return $creditNoteId;
4668 * Load related memberships.
4672 * Note that in theory it should be possible to retrieve these from the line_item table
4673 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4674 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4675 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4676 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4678 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4682 * @return array $ids
4686 public function loadRelatedMembershipObjects($ids = []) {
4688 SELECT membership_id
4689 FROM civicrm_membership_payment
4690 WHERE contribution_id = %1 ";
4691 $params = array(1 => array($this->id
, 'Integer'));
4692 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, array());
4694 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4695 while ($dao->fetch()) {
4696 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4697 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4701 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4702 foreach ($ids['membership'] as $id) {
4704 $membership = new CRM_Member_BAO_Membership();
4705 $membership->id
= $id;
4706 if (!$membership->find(TRUE)) {
4707 throw new Exception("Could not find membership record: $id");
4709 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4710 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4711 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4712 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4720 * This function is used to record partial payments for contribution
4722 * @param array $contribution
4724 * @param array $params
4726 * @return CRM_Financial_DAO_FinancialTrxn
4728 public static function recordPartialPayment($contribution, $params) {
4730 $balanceTrxnParams['to_financial_account_id'] = self
::getToFinancialAccount($contribution, $params);
4731 $balanceTrxnParams['from_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship($contribution['financial_type_id'], 'Accounts Receivable Account is');
4732 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4733 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4734 $balanceTrxnParams['trxn_date'] = CRM_Utils_Array
::value('trxn_date', $params, CRM_Utils_Array
::value('contribution_receive_date', $params, date('YmdHis')));
4735 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
4736 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('total_amount', $params);
4737 $balanceTrxnParams['currency'] = $contribution['currency'];
4738 $balanceTrxnParams['trxn_id'] = CRM_Utils_Array
::value('contribution_trxn_id', $params, NULL);
4739 $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4740 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4741 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
4742 $balanceTrxnParams['is_payment'] = 1;
4744 if (!empty($params['payment_processor'])) {
4745 // I can't find evidence this is passed in - I was gonna just remove it but decided to deprecate as I see self::getToFinancialAccount
4746 // also anticipates it.
4747 CRM_Core_Error
::deprecatedFunctionWarning('passing payment_processor is deprecated - use payment_processor_id');
4748 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4750 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4754 * Get the description (source field) for the recurring contribution.
4756 * @param CRM_Contribute_BAO_Contribution $contribution
4757 * @param CRM_Event_DAO_Event|null $event
4760 * @throws \CiviCRM_API3_Exception
4762 protected static function getRecurringContributionDescription($contribution, $event) {
4763 if (!empty($contribution->source
)) {
4764 return $contribution->source
;
4766 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4767 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4768 'id' => $contribution->contribution_page_id
,
4769 'return' => 'title',
4771 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4774 return ts('Online Event Registration') . ': ' . $event->title
;
4776 elseif (!empty($contribution->contribution_recur_id
)) {
4777 return 'recurring contribution';
4783 * Function to add payments for contribution
4784 * for Partially Paid status
4786 * @param array $contributions
4787 * @param string $contributionStatusId
4790 public static function addPayments($contributions, $contributionStatusId = NULL) {
4791 // get financial trxn which is a payment
4792 $ftSql = "SELECT ft.id, ft.total_amount
4793 FROM civicrm_financial_trxn ft
4794 INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4795 WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4796 $contributionStatus = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4797 'labelColumn' => 'name',
4799 foreach ($contributions as $contribution) {
4800 if (!($contributionStatus[$contribution->contribution_status_id
] == 'Partially paid'
4801 || CRM_Utils_Array
::value($contributionStatusId, $contributionStatus) == 'Partially paid')
4805 $ftDao = CRM_Core_DAO
::executeQuery($ftSql, array(1 => array($contribution->id
, 'Integer')));
4808 // store financial item Proportionaly.
4809 $trxnParams = array(
4810 'total_amount' => $ftDao->total_amount
,
4811 'contribution_id' => $contribution->id
,
4813 self
::assignProportionalLineItems($trxnParams, $ftDao->id
, $contribution->total_amount
);
4818 * Function use to store line item proportionaly in
4819 * in entity financial trxn table
4821 * @param array $trxnParams
4823 * @param Integer $trxnId
4825 * @param float $contributionTotalAmount
4828 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4829 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
4830 if (!empty($lineItems)) {
4831 // get financial item
4832 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
4833 $entityParams = array(
4834 'contribution_total_amount' => $contributionTotalAmount,
4835 'trxn_total_amount' => $trxnParams['total_amount'],
4836 'trxn_id' => $trxnId,
4838 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4843 * Checks if line items total amounts
4844 * match the contribution total amount.
4846 * @param array $params
4847 * array of order params.
4849 * @throws \API_Exception
4851 public static function checkLineItems(&$params) {
4852 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
4853 $lineItemAmount = 0;
4855 foreach ($params['line_items'] as &$lineItems) {
4856 foreach ($lineItems['line_item'] as &$item) {
4857 if (empty($item['financial_type_id'])) {
4858 $item['financial_type_id'] = $params['financial_type_id'];
4860 $lineItemAmount +
= $item['line_total'] + CRM_Utils_Array
::value('tax_amount', $item, 0.00);
4864 if (!isset($totalAmount)) {
4865 $params['total_amount'] = $lineItemAmount;
4868 $currency = CRM_Utils_Array
::value('currency', $params, '');
4870 if (empty($currency)) {
4871 $currency = CRM_Core_Config
::singleton()->defaultCurrency
;
4874 if (!CRM_Utils_Money
::equals($totalAmount, $lineItemAmount, $currency)) {
4875 throw new CRM_Contribute_Exception_CheckLineItemsException();
4881 * Get the financial account for the item associated with the new transaction.
4883 * @param array $params
4884 * @param int $default
4888 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4890 if (!empty($params['financial_account_id'])) {
4891 return $params['financial_account_id'];
4894 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
4895 $preferredAccountsRelationships = array(
4896 'Refunded' => 'Credit/Contra Revenue Account is',
4897 'Chargeback' => 'Chargeback Account is',
4900 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4901 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
4902 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
4904 $preferredAccountsRelationships[$contributionStatus]
4912 * ContributionPage values were being imposed onto values.
4914 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4915 * REALLY didn't want superimposed. The rest are left there in their overkill out
4918 * The rationale for making this explicit is that it was a case of carefully set values being
4919 * seemingly randonly overwritten without much care. In general I think array randomly setting
4920 * variables en mass is risky.
4922 * @param array $values
4926 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4927 $contributionPageValues = array();
4928 CRM_Contribute_BAO_ContributionPage
::setValues(
4929 $this->contribution_page_id
,
4930 $contributionPageValues
4932 $valuesToCopy = array(
4933 // These are the values that I believe to be useful.
4936 'pay_later_receipt',
4938 'receipt_from_email',
4939 'receipt_from_name',
4943 'honoree_profile_id',
4944 'onbehalf_profile_id',
4945 'honor_block_is_active',
4946 // Kinda might be - but would be on the contribution...
4949 // Included for 'fear of regression' but can't justify any use for these....
4951 'payment_processor',
4952 'financial_type_id',
4953 'amount_block_is_active',
4958 'default_amount_id',
4962 'initial_amount_help_text',
4963 'initial_amount_label',
4965 'is_allow_other_amount',
4966 'is_billing_required',
4967 'is_confirm_enabled',
4968 'is_credit_card_only',
4970 'is_partial_payment',
4971 'is_recur_installments',
4972 'is_recur_interval',
4976 'min_initial_amount',
4977 'recur_frequency_unit',
4984 foreach ($valuesToCopy as $valueToCopy) {
4985 if (isset($contributionPageValues[$valueToCopy])) {
4986 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
4993 * Get values of CiviContribute Settings
4994 * and check if its enabled or not.
4995 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
4996 * in serialized form. Usually this should be stored as flat settings for each form fields
4997 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
4998 * settings we will live with an inconsistency because it's too hard to change for now.
4999 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
5002 * @param string $name
5003 * @param bool $checkInvoicing
5007 public static function checkContributeSettings($name = NULL, $checkInvoicing = FALSE) {
5008 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
5010 if ($checkInvoicing && !CRM_Utils_Array
::value('invoicing', $contributeSettings)) {
5015 return CRM_Utils_Array
::value($name, $contributeSettings);
5017 return $contributeSettings;
5021 * This function process contribution related objects.
5023 * @param int $contributionId
5024 * @param int $statusId
5025 * @param int|null $previousStatusId
5027 * @param string $receiveDate
5029 * @return null|string
5031 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
5033 if (!$contributionId ||
!$statusId) {
5038 'contribution_id' => $contributionId,
5039 'contribution_status_id' => $statusId,
5040 'previous_contribution_status_id' => $previousStatusId,
5041 'receive_date' => $receiveDate,
5044 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
5046 if (!is_array($updateResult) ||
5047 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
5048 !is_array($updatedComponents) ||
5049 empty($updatedComponents)
5054 // get the user display name.
5056 SELECT display_name as displayName
5057 FROM civicrm_contact
5058 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5059 WHERE civicrm_contribution.id = {$contributionId}";
5060 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5062 // get the status message for user.
5063 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5065 if ($componentName == 'CiviMember') {
5066 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5067 CRM_Member_PseudoConstant
::membershipStatus()
5069 if ($updatedStatusName == 'Cancelled') {
5070 $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
5072 elseif ($updatedStatusName == 'Expired') {
5073 $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
5076 $endDate = CRM_Utils_Array
::value('membership_end_date', $updateResult);
5078 $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
5080 1 => $userDisplayName,
5088 if ($componentName == 'CiviEvent') {
5089 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5090 CRM_Event_PseudoConstant
::participantStatus()
5092 if ($updatedStatusName == 'Cancelled') {
5093 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
5095 elseif ($updatedStatusName == 'Registered') {
5096 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
5100 if ($componentName == 'CiviPledge') {
5101 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5102 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5104 if ($updatedStatusName == 'Cancelled') {
5105 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
5107 elseif ($updatedStatusName == 'Failed') {
5108 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
5110 elseif ($updatedStatusName == 'Completed') {
5111 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
5120 * Get the contribution as it is in the database before being updated.
5122 * @param int $contributionID
5124 * @return \CRM_Contribute_BAO_Contribution|null
5126 private static function getOriginalContribution($contributionID) {
5127 return self
::getValues(array('id' => $contributionID), CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
5131 * Get the amount for the financial item row.
5133 * Helper function to start to break down recordFinancialTransactions for readability.
5135 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5137 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5138 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5141 * @todo move recordFinancialAccounts & helper functions to their own class?
5143 * @param array $params
5144 * Params as passed to contribution.create
5146 * @param string $context
5147 * changeFinancialType| changedAmount
5148 * @param array $lineItemDetails
5150 * @param bool $isARefund
5151 * Is this a refund / negative transaction.
5155 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5156 if ($context == 'changedAmount') {
5157 $lineTotal = $lineItemDetails['line_total'];
5158 if ($lineTotal != $previousLineItemTotal) {
5159 $lineTotal -= $previousLineItemTotal;
5163 elseif ($context == 'changeFinancialType') {
5164 return -$lineItemDetails['line_total'];
5166 elseif ($context == 'changedStatus') {
5167 $cancelledTaxAmount = 0;
5169 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $lineItemDetails, '0.00');
5171 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total'] +
(float) $cancelledTaxAmount);
5173 elseif ($context === NULL) {
5174 // erm, yes because? but, hey, it's tested.
5175 return $lineItemDetails['line_total'];
5177 elseif (empty($lineItemDetails['line_total'])) {
5178 // follow legacy code path
5180 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', array('civi.tag' => 'deprecated'));
5181 return $params['total_amount'];
5184 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ((float) $lineItemDetails['line_total']);
5189 * Get the multiplier for adjusting rows.
5191 * If we are dealing with a refund or cancellation then it will be a negative
5192 * amount to reflect the negative transaction.
5194 * If we are changing Financial Type it will be a negative amount to
5195 * adjust down the old type.
5197 * @param int $contribution_status_id
5198 * @param string $context
5202 protected static function getMultiplier($contribution_status_id, $context) {
5203 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5210 * Does this transaction reflect a payment instrument change.
5212 * @param array $params
5213 * @param array $pendingStatuses
5217 protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5218 $contributionStatus = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
5220 if (array_key_exists('payment_instrument_id', $params)) {
5221 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
5222 !CRM_Utils_System
::isNull($params['payment_instrument_id'])
5224 //check if status is changed from Pending to Completed
5225 // do not update payment instrument changes for Pending to Completed
5226 if (!($contributionStatus == 'Completed' &&
5227 in_array($params['prevContribution']->contribution_status_id
, $pendingStatuses))
5232 elseif ((!CRM_Utils_System
::isNull($params['payment_instrument_id']) &&
5233 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
5234 $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5238 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
5239 $params['contribution']->check_number
!= $params['prevContribution']->check_number
5241 // another special case when check number is changed, create new financial records
5242 // create financial trxn with negative amount
5250 * Update the memberships associated with a contribution if it has been completed.
5252 * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5253 * load them in this function. Code clean up would compensate for any minor performance implication.
5255 * @param \CRM_Contribute_BAO_Contribution $contribution
5256 * @param int $primaryContributionID
5257 * @param string $changeDate
5259 * @throws \CRM_Core_Exception
5260 * @throws \CiviCRM_API3_Exception
5262 public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5263 $memberships = self
::getRelatedMemberships($contribution->id
);
5264 foreach ($memberships as $membership) {
5265 $membershipParams = array(
5266 'id' => $membership['id'],
5267 'contact_id' => $membership['contact_id'],
5268 'is_test' => $membership['is_test'],
5269 'membership_type_id' => $membership['membership_type_id'],
5270 'membership_activity_status' => 'Completed',
5273 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
5274 $membershipParams['membership_type_id'],
5275 $membershipParams['is_test'],
5276 $membershipParams['id']
5279 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5280 // this picks up membership type changes during renewals
5281 // @todo this is almost certainly an obsolete sql call, the pre-change
5282 // membership is accessible via $this->_relatedObjects
5284 SELECT membership_type_id
5285 FROM civicrm_membership_log
5286 WHERE membership_id={$membershipParams['id']}
5289 $dao = CRM_Core_DAO
::executeQuery($sql);
5290 if ($dao->fetch()) {
5291 if (!empty($dao->membership_type_id
)) {
5292 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
5296 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5297 $membershipParams['membership_type_id'],
5298 $primaryContributionID
5300 // @todo remove all this stuff in favour of letting the api call further down handle in
5301 // (it is a duplication of what the api does).
5302 $dates = array_fill_keys(array(
5307 if ($currentMembership) {
5309 * Fixed FOR CRM-4433
5310 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5311 * when Contribution mode is notify and membership is for renewal )
5313 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5315 // @todo - we should pass membership_type_id instead of null here but not
5316 // adding as not sure of testing
5317 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
5318 $changeDate, NULL, $membershipParams['num_terms']
5320 $dates['join_date'] = $currentMembership['join_date'];
5323 //get the status for membership.
5324 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
5326 $dates['join_date'],
5329 $membershipParams['membership_type_id'],
5333 unset($dates['end_date']);
5334 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
5335 //we might be renewing membership,
5336 //so make status override false.
5337 $membershipParams['is_override'] = FALSE;
5338 $membershipParams['status_override_end_date'] = 'null';
5340 //CRM-17723 - reset static $relatedContactIds array()
5341 // @todo move it to Civi Statics.
5343 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
5344 civicrm_api3('Membership', 'create', $membershipParams);
5349 * Get payment links as they relate to a contribution.
5351 * If a payment can be made then include a payment link & if a refund is appropriate
5352 * then a refund link.
5355 * @param float $balance
5356 * @param string $contributionStatus
5358 * @return array $actionLinks Links array containing:
5362 protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5363 if ($contributionStatus === 'Failed' ||
!CRM_Core_Permission
::check('edit contributions')) {
5364 // In general the balance is the best way to determine if a payment can be added or not,
5365 // but not for Failed contributions, where we don't accept additional payments at the moment.
5366 // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5367 // do accept more payments agains them.
5370 $actionLinks = array();
5371 if ((int) $balance > 0) {
5372 if (CRM_Core_Config
::isEnabledBackOfficeCreditCardPayments()) {
5373 $actionLinks[] = array(
5374 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5380 'title' => ts('Submit Credit Card payment'),
5383 $actionLinks[] = array(
5384 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5389 'title' => ts('Record Payment'),
5392 elseif ((int) $balance < 0) {
5393 $actionLinks[] = array(
5394 'url' => CRM_Utils_System
::url('civicrm/payment', array(
5399 'title' => ts('Record Refund'),
5402 return $actionLinks;
5406 * Get a query to determine the amount donated by the contact/s in the current financial year.
5408 * @param array $contactIDs
5412 public static function getAnnualQuery($contactIDs) {
5413 $contactIDs = implode(',', $contactIDs);
5414 $config = CRM_Core_Config
::singleton();
5415 $currentMonth = date('m');
5416 $currentDay = date('d');
5418 (int) $config->fiscalYearStart
['M'] > $currentMonth ||
5420 (int) $config->fiscalYearStart
['M'] == $currentMonth &&
5421 (int) $config->fiscalYearStart
['d'] > $currentDay
5424 $year = date('Y') - 1;
5429 $nextYear = $year +
1;
5431 if ($config->fiscalYearStart
) {
5432 $newFiscalYearStart = $config->fiscalYearStart
;
5433 if ($newFiscalYearStart['M'] < 10) {
5434 // This is just a clumsy way of adding padding.
5435 // @todo next round look for a nicer way.
5436 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5438 if ($newFiscalYearStart['d'] < 10) {
5439 // This is just a clumsy way of adding padding.
5440 // @todo next round look for a nicer way.
5441 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5443 $config->fiscalYearStart
= $newFiscalYearStart;
5444 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
5447 // First of January.
5450 $startDate = "$year$monthDay";
5451 $endDate = "$nextYear$monthDay";
5454 'contact_id' => 'IN (' . $contactIDs . ')',
5455 'is_test' => ' = 0',
5456 'receive_date' => ['>=' . $startDate, '< ' . $endDate],
5458 $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5459 CRM_Financial_BAO_FinancialType
::addACLClausesToWhereClauses($whereClauses);
5462 foreach ($whereClauses as $key => $clause) {
5463 $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5465 $whereClauseString = implode(' AND ', $clauses);
5467 // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5468 // this group by + having on contribution_status_id improves performance
5470 SELECT COUNT(*) as count,
5471 SUM(total_amount) as amount,
5472 AVG(total_amount) as average,
5474 FROM civicrm_contribution b
5475 WHERE " . $whereClauseString . "
5476 GROUP BY currency, contribution_status_id
5477 HAVING $havingClause
5483 * Assign Test Value.
5485 * @param string $fieldName
5486 * @param array $fieldDef
5487 * @param int $counter
5489 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5490 if ($fieldName == 'tax_amount') {
5491 $this->{$fieldName} = "0.00";
5493 elseif ($fieldName == 'net_amount') {
5494 $this->{$fieldName} = "2.00";
5496 elseif ($fieldName == 'total_amount') {
5497 $this->{$fieldName} = "3.00";
5499 elseif ($fieldName == 'fee_amount') {
5500 $this->{$fieldName} = "1.00";
5503 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5508 * Check if contribution has participant/membership payment.
5510 * @param int $contributionId
5515 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5516 // get line item for contribution
5517 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5518 // check if line item is for membership or participant
5519 foreach ($lineItems as $items) {
5520 if ($items['entity_table'] == 'civicrm_participant') {
5524 elseif ($items['entity_table'] == 'civicrm_membership') {
5536 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5538 * @param array $trxnParams
5539 * Financial trxn params
5540 * @param array $contributionParams
5541 * Contribution Params
5545 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5546 if (!self
::checkContributeSettings('always_post_to_accounts_receivable')) {
5549 $statusId = $contributionParams['contribution']->contribution_status_id
;
5550 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5551 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5552 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5553 // Return if contribution status is not completed.
5554 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5555 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5556 && $contributionParams['prevContribution']->is_pay_later
== 0
5562 $params = $trxnParams;
5563 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $contributionParams) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5564 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5565 $params['to_financial_account_id'] = $arAccountId;
5566 $params['status_id'] = array_search('Pending', $contributionStatuses);
5567 $params['is_payment'] = FALSE;
5568 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5569 self
::$_trxnIDs[] = $trxn->id
;
5570 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5574 * Calculate financial item amount when contribution is updated.
5576 * @param array $params
5577 * contribution params
5578 * @param array $amountParams
5580 * @param string $context
5584 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5585 if (!empty($params['is_quick_config'])) {
5586 $amount = $amountParams['item_amount'];
5588 $amount = $params['total_amount'];
5589 if ($context === NULL) {
5590 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5595 $amount = $amountParams['line_total'];
5596 if ($context == 'changedAmount') {
5597 $amount -= $amountParams['previous_line_total'];
5599 $amount *= $amountParams['diff'];
5605 * Retrieve Sales Tax Financial Accounts.
5611 public static function getSalesTaxFinancialAccounts() {
5612 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5613 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5614 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5615 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5616 $queryParams = array(1 => array($accountRel, 'Integer'));
5617 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5618 $financialAccount = array();
5619 while ($dao->fetch()) {
5620 $financialAccount[$dao->id
] = $dao->id
;
5622 return $financialAccount;
5626 * Create tax entry in civicrm_entity_financial_trxn table.
5628 * @param array $entityParams
5630 * @param array $eftParams
5633 public static function createProportionalEntry($entityParams, $eftParams) {
5635 if ($entityParams['contribution_total_amount'] != 0) {
5636 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5638 // Record Entity Financial Trxn; CRM-20145
5639 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5640 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5644 * Create array of last financial item id's.
5646 * @param int $contributionId
5650 public static function getLastFinancialItemIds($contributionId) {
5651 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5652 FROM civicrm_financial_item fi
5653 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5654 WHERE li.contribution_id = %1";
5655 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($contributionId, 'Integer')));
5656 $ftIds = $taxItems = array();
5657 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5658 while ($dao->fetch()) {
5659 /* if sales tax item*/
5660 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5661 $taxItems[$dao->price_field_value_id
] = array(
5662 'financial_item_id' => $dao->id
,
5663 'amount' => $dao->tax_amount
,
5667 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5670 return array($ftIds, $taxItems);
5674 * Create proportional entries in civicrm_entity_financial_trxn.
5676 * @param array $entityParams
5678 * @param array $lineItems
5680 * @param array $ftIds
5682 * @param array $taxItems
5685 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5687 'entity_table' => 'civicrm_financial_item',
5688 'financial_trxn_id' => $entityParams['trxn_id'],
5690 foreach ($lineItems as $key => $value) {
5691 if ($value['qty'] == 0) {
5694 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5695 $entityParams['line_item_amount'] = $value['line_total'];
5696 self
::createProportionalEntry($entityParams, $eftParams);
5697 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5698 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5699 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5700 self
::createProportionalEntry($entityParams, $eftParams);
5706 * Load entities related to the contribution into $this->_relatedObjects.
5710 * @throws \CRM_Core_Exception
5712 protected function loadRelatedEntitiesByID($ids) {
5714 'contact' => 'CRM_Contact_BAO_Contact',
5715 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5716 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5717 'financialType' => 'CRM_Financial_BAO_FinancialType',
5718 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5720 foreach ($entities as $entity => $bao) {
5721 if (!empty($ids[$entity])) {
5722 $this->_relatedObjects
[$entity] = new $bao();
5723 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5724 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5725 throw new CRM_Core_Exception($entity . ' could not be loaded');
5732 * Should an email receipt be sent for this contribution when complete.
5734 * @param array $input
5738 protected function isEmailReceipt($input) {
5739 if (isset($input['is_email_receipt'])) {
5740 return $input['is_email_receipt'];
5742 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5743 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5749 * Function to replace contribution tokens.
5751 * @param array $contributionIds
5753 * @param string $subject
5755 * @param array $subjectToken
5757 * @param string $text
5759 * @param string $html
5761 * @param array $messageToken
5763 * @param bool $escapeSmarty
5767 public static function replaceContributionTokens(
5776 if (empty($contributionIds)) {
5779 $contributionDetails = array();
5780 foreach ($contributionIds as $id) {
5781 $result = civicrm_api3('Contribution', 'get', array('id' => $id));
5782 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5783 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5784 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5786 return $contributionDetails;
5790 * Get invoice_number for contribution.
5792 * @param int $contributionID
5796 public static function getInvoiceNumber($contributionID) {
5797 if ($invoicePrefix = self
::checkContributeSettings('invoice_prefix', TRUE)) {
5798 return $invoicePrefix . $contributionID;