3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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|void
102 public static function add(&$params, $ids = array()) {
103 if (empty($params)) {
106 //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
107 $contributionID = CRM_Utils_Array
::value('contribution', $ids, CRM_Utils_Array
::value('id', $params));
108 $duplicates = array();
109 if (self
::checkDuplicate($params, $duplicates, $contributionID)) {
110 $error = CRM_Core_Error
::singleton();
111 $d = implode(', ', $duplicates);
112 $error->push(CRM_Core_Error
::DUPLICATE_CONTRIBUTION
,
115 "Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: $d"
120 // first clean up all the money fields
121 $moneyFields = array(
125 'non_deductible_amount',
128 //if priceset is used, no need to cleanup money
129 if (!empty($params['skipCleanMoney'])) {
130 unset($moneyFields[0]);
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());
144 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
145 //if contribution is created with cancelled or refunded status, add credit note id
146 if (!empty($params['contribution_status_id'])) {
147 // @todo - should we include Chargeback? If so use self::isContributionStatusNegative($params['contribution_status_id'])
148 if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
149 ||
$params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
151 if (empty($params['creditnote_id']) ||
$params['creditnote_id'] == "null") {
152 $params['creditnote_id'] = self
::createCreditNoteId();
157 // Since the fee amount is expecting this (later on) ensure it is always set.
158 // It would only not be set for an update where it is unchanged.
159 $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', array('id' => $contributionID, 'return' => 'contribution_status_id'));
163 && CRM_Utils_Array
::value('membership_id', $params)
164 && self
::checkContributeSettings('deferred_revenue_enabled')
166 $memberStartDate = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
167 if ($memberStartDate) {
168 $params['revenue_recognition_date'] = date('Ymd', strtotime($memberStartDate));
171 self
::calculateMissingAmountParams($params, $contributionID);
173 if (!empty($params['payment_instrument_id'])) {
174 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument('name');
175 if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
176 $params['check_number'] = 'null';
180 $setPrevContribution = TRUE;
181 // CRM-13964 partial payment
182 if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
183 $partialAmtTotal = $params['partial_payment_total'];
184 $partialAmtPay = $params['partial_amount_pay'];
185 $params['total_amount'] = $partialAmtTotal;
186 if ($partialAmtPay < $partialAmtTotal) {
187 $params['contribution_status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Partially paid');
188 $params['is_pay_later'] = 0;
189 $setPrevContribution = FALSE;
192 if ($contributionID && $setPrevContribution) {
193 $params['prevContribution'] = self
::getOriginalContribution($contributionID);
196 if ($contributionID && !empty($params['revenue_recognition_date']) && !empty($params['prevContribution'])
197 && !($contributionStatus[$params['prevContribution']->contribution_status_id
] == 'Pending')
198 && !self
::allowUpdateRevenueRecognitionDate($contributionID)
200 unset($params['revenue_recognition_date']);
203 if (!isset($params['tax_amount']) && $setPrevContribution && (isset($params['total_amount']) ||
204 isset($params['financial_type_id']))) {
205 $params = CRM_Contribute_BAO_Contribution
::checkTaxAmount($params);
208 if ($contributionID) {
209 CRM_Utils_Hook
::pre('edit', 'Contribution', $contributionID, $params);
212 CRM_Utils_Hook
::pre('create', 'Contribution', NULL, $params);
214 $contribution = new CRM_Contribute_BAO_Contribution();
215 $contribution->copyValues($params);
217 $contribution->id
= $contributionID;
219 if (empty($contribution->id
)) {
220 // (only) on 'create', make sure that a valid currency is set (CRM-16845)
221 if (!CRM_Utils_Rule
::currencyCode($contribution->currency
)) {
222 $contribution->currency
= CRM_Core_Config
::singleton()->defaultCurrency
;
226 $result = $contribution->save();
228 // Add financial_trxn details as part of fix for CRM-4724
229 $contribution->trxn_result_code
= CRM_Utils_Array
::value('trxn_result_code', $params);
230 $contribution->payment_processor
= CRM_Utils_Array
::value('payment_processor', $params);
232 //add Account details
233 $params['contribution'] = $contribution;
234 self
::recordFinancialAccounts($params);
236 if (self
::isUpdateToRecurringContribution($params)) {
237 CRM_Contribute_BAO_ContributionRecur
::updateOnNewPayment(
238 (!empty($params['contribution_recur_id']) ?
$params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id
),
239 $contributionStatus[$params['contribution_status_id']],
240 CRM_Utils_Array
::value('receive_date', $params)
244 CRM_Contact_BAO_GroupContactCache
::opportunisticCacheFlush();
246 if ($contributionID) {
247 CRM_Utils_Hook
::post('edit', 'Contribution', $contribution->id
, $contribution);
250 CRM_Utils_Hook
::post('create', 'Contribution', $contribution->id
, $contribution);
257 * Is this contribution updating an existing recurring contribution.
259 * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
260 * pending payment is being confirmed (or failing).
262 * @param array $params
266 public static function isUpdateToRecurringContribution($params) {
267 if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
270 if (empty($params['prevContribution']) ||
empty($params['contribution_status_id'])) {
273 if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id
)) {
276 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
277 if ($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatus)) {
284 * Get defaults for new entity.
287 public static function getDefaults() {
289 'payment_instrument_id' => key(CRM_Core_OptionGroup
::values('payment_instrument',
290 FALSE, FALSE, FALSE, 'AND is_default = 1')
292 'contribution_status_id' => CRM_Core_Pseudoconstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
297 * Fetch the object and store the values in the values array.
299 * @param array $params
300 * Input parameters to find object.
301 * @param array $values
302 * Output values of the object.
304 * The array that holds all the db ids.
306 * @return CRM_Contribute_BAO_Contribution|null
307 * The found object or null
309 public static function getValues($params, &$values, &$ids) {
310 if (empty($params)) {
313 $contribution = new CRM_Contribute_BAO_Contribution();
315 $contribution->copyValues($params);
317 if ($contribution->find(TRUE)) {
318 $ids['contribution'] = $contribution->id
;
320 CRM_Core_DAO
::storeValues($contribution, $values);
322 return $contribution;
324 $null = NULL; // return by reference
329 * Get the values and resolve the most common mappings.
331 * Since contribution status is resolved in almost every function that calls getValues it makes
332 * sense to have an extra function to resolve it rather than repeat the code.
334 * Think carefully before adding more mappings to be resolved as there could be performance implications
335 * if this function starts to be called from more iterative functions.
337 * @param array $params
338 * Input parameters to find object.
341 * Array of the found contribution.
342 * @throws CRM_Core_Exception
344 public static function getValuesWithMappings($params) {
345 $values = $ids = array();
346 $contribution = self
::getValues($params, $values, $ids);
347 if (is_null($contribution)) {
348 throw new CRM_Core_Exception('No contribution found');
350 $values['contribution_status'] = CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
355 * Calculate net_amount & fee_amount if they are not set.
357 * Net amount should be total - fee.
358 * This should only be called for new contributions.
360 * @param array $params
361 * Params for a new contribution before they are saved.
362 * @param int|null $contributionID
363 * Contribution ID if we are dealing with an update.
365 * @throws \CiviCRM_API3_Exception
367 public static function calculateMissingAmountParams(&$params, $contributionID) {
368 if (!$contributionID && !isset($params['fee_amount'])) {
369 if (isset($params['total_amount']) && isset($params['net_amount'])) {
370 $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
373 $params['fee_amount'] = 0;
376 if (!isset($params['net_amount'])) {
377 if (!$contributionID) {
378 $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
381 if (isset($params['fee_amount']) ||
isset($params['total_amount'])) {
382 // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
383 // net_amount may need adjusting.
384 $contribution = civicrm_api3('Contribution', 'getsingle', array(
385 'id' => $contributionID,
386 'return' => array('total_amount', 'net_amount'),
388 $totalAmount = isset($params['total_amount']) ?
$params['total_amount'] : CRM_Utils_Array
::value('total_amount', $contribution);
389 $feeAmount = isset($params['fee_amount']) ?
$params['fee_amount'] : CRM_Utils_Array
::value('fee_amount', $contribution);
390 $params['net_amount'] = $totalAmount - $feeAmount;
398 * @param $billingLocationTypeID
402 protected static function getBillingAddressParams($params, $billingLocationTypeID) {
403 $hasBillingField = FALSE;
404 $billingFields = array(
412 //build address array
413 $addressParams = array();
414 $addressParams['location_type_id'] = $billingLocationTypeID;
415 $addressParams['is_billing'] = 1;
417 $billingFirstName = CRM_Utils_Array
::value('billing_first_name', $params);
418 $billingMiddleName = CRM_Utils_Array
::value('billing_middle_name', $params);
419 $billingLastName = CRM_Utils_Array
::value('billing_last_name', $params);
420 $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingMiddleName}" . CRM_Core_DAO
::VALUE_SEPARATOR
. "{$billingLastName}";
422 foreach ($billingFields as $value) {
423 $addressParams[$value] = CRM_Utils_Array
::value("billing_{$value}-{$billingLocationTypeID}", $params);
424 if (!empty($addressParams[$value])) {
425 $hasBillingField = TRUE;
428 return array($hasBillingField, $addressParams);
432 * Get address params ready to be passed to the payment processor.
434 * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
435 * To create an address we need state_province_id.
437 * @param array $params
438 * @param int $billingLocationTypeID
442 public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
443 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
444 foreach ($addressParams as $name => $field) {
445 if (substr($name, 0, 8) == 'billing_') {
446 $addressParams[substr($name, 9)] = $addressParams[$field];
449 return array($hasBillingField, $addressParams);
453 * Get the number of terms for this contribution for a given membership type
454 * based on querying the line item table and relevant price field values
455 * Note that any one contribution should only be able to have one line item relating to a particular membership
458 * @param int $membershipTypeID
460 * @param int $contributionID
464 public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
465 $numTerms = CRM_Core_DAO
::singleValueQuery("
466 SELECT membership_num_terms FROM civicrm_line_item li
467 LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
468 WHERE contribution_id = %1 AND membership_type_id = %2",
469 array(1 => array($contributionID, 'Integer'), 2 => array($membershipTypeID, 'Integer'))
471 // default of 1 is precautionary
472 return empty($numTerms) ?
1 : $numTerms;
476 * Takes an associative array and creates a contribution object.
478 * @param array $params
479 * (reference ) an assoc array of name/value pairs.
481 * The array that holds all the db ids.
483 * @return CRM_Contribute_BAO_Contribution
485 public static function create(&$params, $ids = array()) {
486 $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date', 'revenue_recognition_date');
487 foreach ($dateFields as $df) {
488 if (isset($params[$df])) {
489 $params[$df] = CRM_Utils_Date
::isoToMysql($params[$df]);
493 //if contribution is created with cancelled or refunded status, add credit note id
494 if (!empty($params['contribution_status_id'])) {
495 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
497 if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
498 ||
$params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
500 if (empty($params['creditnote_id']) ||
$params['creditnote_id'] == "null") {
501 $params['creditnote_id'] = self
::createCreditNoteId();
506 $transaction = new CRM_Core_Transaction();
508 $contribution = self
::add($params, $ids);
510 if (is_a($contribution, 'CRM_Core_Error')) {
511 $transaction->rollback();
512 return $contribution;
515 $params['contribution_id'] = $contribution->id
;
517 if (!empty($params['custom']) &&
518 is_array($params['custom'])
520 CRM_Core_BAO_CustomValueTable
::store($params['custom'], 'civicrm_contribution', $contribution->id
);
523 $session = CRM_Core_Session
::singleton();
525 if (!empty($params['note'])) {
527 'entity_table' => 'civicrm_contribution',
528 'note' => $params['note'],
529 'entity_id' => $contribution->id
,
530 'contact_id' => $session->get('userID'),
531 'modified_date' => date('Ymd'),
533 if (!$noteParams['contact_id']) {
534 $noteParams['contact_id'] = $params['contact_id'];
536 CRM_Core_BAO_Note
::add($noteParams);
539 // make entry in batch entity batch table
540 if (!empty($params['batch_id'])) {
541 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
542 $titleFields = array(
548 $retrieveRequired = 0;
549 foreach ($titleFields as $titleField) {
550 if (!isset($contribution->$titleField)) {
551 $retrieveRequired = 1;
555 if ($retrieveRequired == 1) {
556 $contribution->find(TRUE);
560 CRM_Contribute_BAO_ContributionSoft
::processSoftContribution($params, $contribution);
562 $transaction->commit();
564 $activity = civicrm_api3('Activity', 'get', array(
565 'source_record_id' => $contribution->id
,
566 'options' => array('limit' => 1),
568 'activity_type_id' => 'Contribution',
569 'return' => array('id', 'campaign'),
572 //CRM-18406: Update activity when edit contribution.
573 if ($activity['count']) {
574 // CRM-13237 : if activity record found, update it with campaign id of contribution
575 // @todo compare campaign ids first.
576 CRM_Core_DAO
::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id
);
577 $contribution->activity_id
= $activity['id'];
580 if (empty($contribution->contact_id
)) {
581 $contribution->find(TRUE);
583 CRM_Activity_BAO_Activity
::addActivity($contribution, 'Contribution');
585 // do not add to recent items for import, CRM-4399
586 if (empty($params['skipRecentView'])) {
587 $url = CRM_Utils_System
::url('civicrm/contact/view/contribution',
588 "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
590 // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
591 $titleFields = array(
597 $retrieveRequired = 0;
598 foreach ($titleFields as $titleField) {
599 if (!isset($contribution->$titleField)) {
600 $retrieveRequired = 1;
604 if ($retrieveRequired == 1) {
605 $contribution->find(TRUE);
607 $contributionTypes = CRM_Contribute_PseudoConstant
::financialType();
608 $title = CRM_Contact_BAO_Contact
::displayName($contribution->contact_id
) . ' - (' . CRM_Utils_Money
::format($contribution->total_amount
, $contribution->currency
) . ' ' . ' - ' . $contributionTypes[$contribution->financial_type_id
] . ')';
610 $recentOther = array();
611 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::UPDATE
)) {
612 $recentOther['editUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
613 "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
617 if (CRM_Core_Permission
::checkActionPermission('CiviContribute', CRM_Core_Action
::DELETE
)) {
618 $recentOther['deleteUrl'] = CRM_Utils_System
::url('civicrm/contact/view/contribution',
619 "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
623 // add the recently created Contribution
624 CRM_Utils_Recent
::add($title,
628 $contribution->contact_id
,
634 return $contribution;
638 * Get the values for pseudoconstants for name->value and reverse.
640 * @param array $defaults
641 * (reference) the default values, some of which need to be resolved.
642 * @param bool $reverse
643 * True if we want to resolve the values in the reverse direction (value -> name).
645 public static function resolveDefaults(&$defaults, $reverse = FALSE) {
646 self
::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant
::financialType(), $reverse);
647 self
::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant
::paymentInstrument(), $reverse);
648 self
::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant
::contributionStatus(), $reverse);
649 self
::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant
::pcPage(), $reverse);
653 * Convert associative array names to values and vice-versa.
655 * This function is used by both the web form layer and the api. Note that
656 * the api needs the name => value conversion, also the view layer typically
657 * requires value => name conversion
659 * @param array $defaults
660 * @param string $property
661 * @param array $lookup
662 * @param bool $reverse
666 public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
667 $id = $property . '_id';
669 $src = $reverse ?
$property : $id;
670 $dst = $reverse ?
$id : $property;
672 if (!array_key_exists($src, $defaults)) {
676 $look = $reverse ?
array_flip($lookup) : $lookup;
678 if (is_array($look)) {
679 if (!array_key_exists($defaults[$src], $look)) {
683 $defaults[$dst] = $look[$defaults[$src]];
688 * Retrieve DB object based on input parameters.
690 * It also stores all the retrieved values in the default array.
692 * @param array $params
693 * (reference ) an assoc array of name/value pairs.
694 * @param array $defaults
695 * (reference ) an assoc array to hold the name / value pairs.
696 * in a hierarchical manner
698 * (reference) the array that holds all the db ids.
700 * @return CRM_Contribute_BAO_Contribution
702 public static function retrieve(&$params, &$defaults, &$ids) {
703 $contribution = CRM_Contribute_BAO_Contribution
::getValues($params, $defaults, $ids);
704 return $contribution;
708 * Combine all the importable fields from the lower levels object.
710 * The ordering is important, since currently we do not have a weight
711 * scheme. Adding weight is super important and should be done in the
712 * next week or so, before this can be called complete.
714 * @param string $contactType
715 * @param bool $status
718 * array of importable Fields
720 public static function &importableFields($contactType = 'Individual', $status = TRUE) {
721 if (!self
::$_importableFields) {
722 if (!self
::$_importableFields) {
723 self
::$_importableFields = array();
727 $fields = array('' => array('title' => ts('- do not import -')));
730 $fields = array('' => array('title' => ts('- Contribution Fields -')));
733 $note = CRM_Core_DAO_Note
::import();
734 $tmpFields = CRM_Contribute_DAO_Contribution
::import();
735 unset($tmpFields['option_value']);
736 $optionFields = CRM_Core_OptionValue
::getFields($mode = 'contribute');
737 $contactFields = CRM_Contact_BAO_Contact
::importableFields($contactType, NULL);
739 // Using new Dedupe rule.
741 'contact_type' => $contactType,
742 'used' => 'Unsupervised',
744 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
745 $tmpContactField = array();
746 if (is_array($fieldsArray)) {
747 foreach ($fieldsArray as $value) {
748 //skip if there is no dupe rule
749 if ($value == 'none') {
752 $customFieldId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
757 $value = $customFieldId ?
'custom_' . $customFieldId : $value;
758 $tmpContactField[trim($value)] = $contactFields[trim($value)];
760 $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
763 $title = $tmpContactField[trim($value)]['title'];
765 $tmpContactField[trim($value)]['title'] = $title;
769 $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
770 $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
771 $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
772 $fields = array_merge($fields, $tmpContactField);
773 $fields = array_merge($fields, $tmpFields);
774 $fields = array_merge($fields, $note);
775 $fields = array_merge($fields, $optionFields);
776 $fields = array_merge($fields, CRM_Financial_DAO_FinancialType
::export());
777 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
778 self
::$_importableFields = $fields;
780 return self
::$_importableFields;
784 * Get exportable fields with pseudoconstants rendered as an extra field.
786 public static function getExportableFieldsWithPseudoConstants() {
787 $fields = self
::exportableFields();
788 CRM_Core_DAO
::appendPseudoConstantsToFields($fields);
793 * Combine all the exportable fields from the lower level objects.
795 * @param bool $checkPermission
798 * array of exportable Fields
800 public static function &exportableFields($checkPermission = TRUE) {
801 if (!self
::$_exportableFields) {
802 if (!self
::$_exportableFields) {
803 self
::$_exportableFields = array();
806 $impFields = CRM_Contribute_DAO_Contribution
::export();
807 $expFieldProduct = CRM_Contribute_DAO_Product
::export();
808 $expFieldsContrib = CRM_Contribute_DAO_ContributionProduct
::export();
809 $typeField = CRM_Financial_DAO_FinancialType
::export();
810 $financialAccount = CRM_Financial_DAO_FinancialAccount
::export();
812 $contributionPage = array(
813 'contribution_page' => array(
814 'title' => ts('Contribution Page'),
815 'name' => 'contribution_page',
816 'where' => 'civicrm_contribution_page.title',
817 'data_type' => CRM_Utils_Type
::T_STRING
,
821 $contributionNote = array(
822 'contribution_note' => array(
823 'title' => ts('Contribution Note'),
824 'name' => 'contribution_note',
825 'data_type' => CRM_Utils_Type
::T_TEXT
,
829 $extraFields = array(
830 'contribution_batch' => array(
831 'title' => ts('Batch Name'),
836 $campaignTitle = array(
837 'contribution_campaign_title' => array(
838 'title' => ts('Campaign Title'),
839 'name' => 'campaign_title',
840 'where' => 'civicrm_campaign.title',
841 'data_type' => CRM_Utils_Type
::T_STRING
,
844 $softCreditFields = array(
845 'contribution_soft_credit_name' => array(
846 'name' => 'contribution_soft_credit_name',
847 'title' => ts('Soft Credit For'),
848 'where' => 'civicrm_contact_d.display_name',
849 'data_type' => CRM_Utils_Type
::T_STRING
,
851 'contribution_soft_credit_amount' => array(
852 'name' => 'contribution_soft_credit_amount',
853 'title' => ts('Soft Credit Amount'),
854 'where' => 'civicrm_contribution_soft.amount',
855 'data_type' => CRM_Utils_Type
::T_MONEY
,
857 'contribution_soft_credit_type' => array(
858 'name' => 'contribution_soft_credit_type',
859 'title' => ts('Soft Credit Type'),
860 'where' => 'contribution_softcredit_type.label',
861 'data_type' => CRM_Utils_Type
::T_STRING
,
863 'contribution_soft_credit_contribution_id' => array(
864 'name' => 'contribution_soft_credit_contribution_id',
865 'title' => ts('Soft Credit For Contribution ID'),
866 'where' => 'civicrm_contribution_soft.contribution_id',
867 'data_type' => CRM_Utils_Type
::T_INT
,
869 'contribution_soft_credit_contact_id' => array(
870 'name' => 'contribution_soft_credit_contact_id',
871 'title' => ts('Soft Credit For Contact ID'),
872 'where' => 'civicrm_contact_d.id',
873 'data_type' => CRM_Utils_Type
::T_INT
,
877 // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
879 'contribution_product_id' => array(
880 'title' => ts('Premium'),
881 'name' => 'contribution_product_id',
882 'where' => 'civicrm_product.id',
883 'data_type' => CRM_Utils_Type
::T_INT
,
887 $fields = array_merge($impFields, $typeField, $contributionPage, $expFieldProduct,
888 $expFieldsContrib, $contributionNote, $extraFields, $softCreditFields, $financialAccount, $premiums, $campaignTitle,
889 CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
892 self
::$_exportableFields = $fields;
895 return self
::$_exportableFields;
899 * @param null $status
900 * @param null $startDate
901 * @param null $endDate
905 public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
909 $where[] = 'contribution_status_id = 1';
913 $where[] = 'contribution_status_id = 3';
918 $where[] = "receive_date >= '" . CRM_Utils_Type
::escape($startDate, 'Timestamp') . "'";
921 $where[] = "receive_date <= '" . CRM_Utils_Type
::escape($endDate, 'Timestamp') . "'";
923 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
924 if ($financialTypes) {
925 $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
926 $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
929 $where[] = "c.financial_type_id IN (0)";
932 $whereCond = implode(' AND ', $where);
935 SELECT sum( total_amount ) as total_amount,
936 count( c.id ) as total_count,
938 FROM civicrm_contribution c
939 INNER JOIN civicrm_contact contact ON ( contact.id = c.contact_id )
940 LEFT JOIN civicrm_line_item i ON ( i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution' )
942 AND ( is_test = 0 OR is_test IS NULL )
943 AND contact.is_deleted = 0
947 $dao = CRM_Core_DAO
::executeQuery($query);
950 while ($dao->fetch()) {
951 $count +
= $dao->total_count
;
952 $amount[] = CRM_Utils_Money
::format($dao->total_amount
, $dao->currency
);
956 'amount' => implode(', ', $amount),
964 * Delete the indirect records associated with this contribution first.
969 * $results no of deleted Contribution on success, false otherwise
971 public static function deleteContribution($id) {
972 CRM_Utils_Hook
::pre('delete', 'Contribution', $id, CRM_Core_DAO
::$_nullArray);
974 $transaction = new CRM_Core_Transaction();
977 //delete activity record
979 'source_record_id' => $id,
980 // activity type id for contribution
981 'activity_type_id' => 6,
984 CRM_Activity_BAO_Activity
::deleteActivity($params);
986 //delete billing address if exists for this contribution.
987 self
::deleteAddress($id);
989 //update pledge and pledge payment, CRM-3961
990 CRM_Pledge_BAO_PledgePayment
::resetPledgePayment($id);
992 // remove entry from civicrm_price_set_entity, CRM-5095
993 if (CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution', $id)) {
994 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution', $id);
996 // cleanup line items.
997 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
999 // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1000 CRM_Core_BAO_FinancialTrxn
::deleteFinancialTrxn($id);
1002 if ($participantId) {
1003 CRM_Price_BAO_LineItem
::deleteLineItems($participantId, 'civicrm_participant');
1006 CRM_Price_BAO_LineItem
::deleteLineItems($id, 'civicrm_contribution');
1010 $note = CRM_Core_BAO_Note
::getNote($id, 'civicrm_contribution');
1011 $noteId = key($note);
1013 CRM_Core_BAO_Note
::del($noteId, FALSE);
1016 $dao = new CRM_Contribute_DAO_Contribution();
1019 $results = $dao->delete();
1021 $transaction->commit();
1023 CRM_Utils_Hook
::post('delete', 'Contribution', $dao->id
, $dao);
1025 // delete the recently created Contribution
1026 $contributionRecent = array(
1028 'type' => 'Contribution',
1030 CRM_Utils_Recent
::del($contributionRecent);
1036 * React to a financial transaction (payment) failure.
1038 * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1039 * payments is important for forensic and outreach reasons.
1041 * @param int $contributionID
1042 * @param int $contactID
1043 * @param string $message
1045 * @throws \CiviCRM_API3_Exception
1047 public static function failPayment($contributionID, $contactID, $message) {
1048 civicrm_api3('activity', 'create', array(
1049 'activity_type_id' => 'Failed Payment',
1050 'details' => $message,
1051 'subject' => ts('Payment failed at payment processor'),
1052 'source_record_id' => $contributionID,
1053 'source_contact_id' => CRM_Core_Session
::getLoggedInContactID() ? CRM_Core_Session
::getLoggedInContactID() :
1057 // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1058 civicrm_api3('contribution', 'create', array(
1059 'id' => $contributionID,
1060 'contribution_status_id' => 'Failed',
1065 * Check if there is a contribution with the same trxn_id or invoice_id.
1067 * @param array $input
1068 * An assoc array of name/value pairs.
1069 * @param array $duplicates
1070 * (reference) store ids of duplicate contribs.
1074 * true if duplicate, false otherwise
1076 public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1078 $id = CRM_Utils_Array
::value('id', $input);
1080 $trxn_id = CRM_Utils_Array
::value('trxn_id', $input);
1081 $invoice_id = CRM_Utils_Array
::value('invoice_id', $input);
1087 $clause[] = "trxn_id = %1";
1088 $input[1] = array($trxn_id, 'String');
1092 $clause[] = "invoice_id = %2";
1093 $input[2] = array($invoice_id, 'String');
1096 if (empty($clause)) {
1100 $clause = implode(' OR ', $clause);
1102 $clause = "( $clause ) AND id != %3";
1103 $input[3] = array($id, 'Integer');
1106 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1107 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1109 while ($dao->fetch()) {
1110 $duplicates[] = $dao->id
;
1117 * Takes an associative array and creates a contribution_product object.
1119 * the function extract all the params it needs to initialize the create a
1120 * contribution_product object. the params array could contain additional unused name/value
1123 * @param array $params
1124 * (reference) an assoc array of name/value pairs.
1126 * @return CRM_Contribute_DAO_ContributionProduct
1128 public static function addPremium(&$params) {
1129 $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1130 $contributionProduct->copyValues($params);
1131 return $contributionProduct->save();
1135 * Get list of contribution fields for profile.
1136 * For now we only allow custom contribution fields to be in
1139 * @param bool $addExtraFields
1140 * True if special fields needs to be added.
1143 * the list of contribution fields
1145 public static function getContributionFields($addExtraFields = TRUE) {
1146 $contributionFields = CRM_Contribute_DAO_Contribution
::export();
1147 // @todo remove this - this line was added because payment_instrument_id was not
1148 // set to exportable - but now it is.
1149 $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue
::getFields($mode = 'contribute'));
1151 if ($addExtraFields) {
1152 $contributionFields = array_merge($contributionFields, self
::getSpecialContributionFields());
1155 $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType
::export());
1157 foreach ($contributionFields as $key => $var) {
1158 if ($key == 'contribution_contact_id') {
1161 elseif ($key == 'contribution_campaign_id') {
1162 $var['title'] = ts('Campaign');
1164 $fields[$key] = $var;
1167 $fields = array_merge($fields, CRM_Core_BAO_CustomField
::getFieldsForImport('Contribution'));
1172 * Add extra fields specific to contribution.
1174 public static function getSpecialContributionFields() {
1175 $extraFields = array(
1176 'contribution_soft_credit_name' => array(
1177 'name' => 'contribution_soft_credit_name',
1178 'title' => ts('Soft Credit Name'),
1179 'headerPattern' => '/^soft_credit_name$/i',
1180 'where' => 'civicrm_contact_d.display_name',
1182 'contribution_soft_credit_email' => array(
1183 'name' => 'contribution_soft_credit_email',
1184 'title' => ts('Soft Credit Email'),
1185 'headerPattern' => '/^soft_credit_email$/i',
1186 'where' => 'soft_email.email',
1188 'contribution_soft_credit_phone' => array(
1189 'name' => 'contribution_soft_credit_phone',
1190 'title' => ts('Soft Credit Phone'),
1191 'headerPattern' => '/^soft_credit_phone$/i',
1192 'where' => 'soft_phone.phone',
1194 'contribution_soft_credit_contact_id' => array(
1195 'name' => 'contribution_soft_credit_contact_id',
1196 'title' => ts('Soft Credit Contact ID'),
1197 'headerPattern' => '/^soft_credit_contact_id$/i',
1198 'where' => 'civicrm_contribution_soft.contact_id',
1200 'contribution_pcp_title' => array(
1201 'name' => 'contribution_pcp_title',
1202 'title' => ts('Personal Campaign Page Title'),
1203 'headerPattern' => '/^contribution_pcp_title$/i',
1204 'where' => 'contribution_pcp.title',
1208 return $extraFields;
1212 * @param int $pageID
1216 public static function getCurrentandGoalAmount($pageID) {
1218 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1219 FROM civicrm_contribution_page p,
1220 civicrm_contribution c
1221 WHERE p.id = c.contribution_page_id
1223 AND c.cancel_date is null
1227 $config = CRM_Core_Config
::singleton();
1228 $params = array(1 => array($pageID, 'Integer'));
1229 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1231 if ($dao->fetch()) {
1232 return array($dao->goal
, $dao->total
);
1235 return array(NULL, NULL);
1240 * Get list of contributions which credit the passed in contact ID.
1242 * The returned array provides details about the original contribution & donor.
1244 * @todo - this is a confusing function called from one place. It has a test. It would be
1245 * nice to deprecate it.
1247 * @param int $honorId
1248 * In Honor of Contact ID.
1251 * list of contribution fields
1253 public static function getHonorContacts($honorId) {
1255 $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1256 $honorDAO->contact_id
= $honorId;
1259 $type = CRM_Contribute_PseudoConstant
::financialType();
1261 while ($honorDAO->fetch()) {
1262 $contributionDAO = new CRM_Contribute_DAO_Contribution();
1263 $contributionDAO->id
= $honorDAO->contribution_id
;
1265 if ($contributionDAO->find(TRUE)) {
1266 $params[$contributionDAO->id
]['honor_type'] = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id
);
1267 $params[$contributionDAO->id
]['honorId'] = $contributionDAO->contact_id
;
1268 $params[$contributionDAO->id
]['display_name'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id
, 'display_name');
1269 $params[$contributionDAO->id
]['type'] = $type[$contributionDAO->financial_type_id
];
1270 $params[$contributionDAO->id
]['type_id'] = $contributionDAO->financial_type_id
;
1271 $params[$contributionDAO->id
]['amount'] = CRM_Utils_Money
::format($contributionDAO->total_amount
, $contributionDAO->currency
);
1272 $params[$contributionDAO->id
]['source'] = $contributionDAO->source
;
1273 $params[$contributionDAO->id
]['receive_date'] = $contributionDAO->receive_date
;
1274 $params[$contributionDAO->id
]['contribution_status'] = CRM_Contribute_PseudoConstant
::contributionStatus($contributionDAO->contribution_status_id
);
1282 * Get the sort name of a contact for a particular contribution.
1285 * Id of the contribution.
1287 * @return null|string
1288 * sort name of the contact if found
1290 public static function sortName($id) {
1291 $id = CRM_Utils_Type
::escape($id, 'Integer');
1294 SELECT civicrm_contact.sort_name
1295 FROM civicrm_contribution, civicrm_contact
1296 WHERE civicrm_contribution.contact_id = civicrm_contact.id
1297 AND civicrm_contribution.id = {$id}
1299 return CRM_Core_DAO
::singleValueQuery($query);
1303 * @param int $contactID
1307 public static function annual($contactID) {
1308 if (is_array($contactID)) {
1309 $contactIDs = implode(',', $contactID);
1312 $contactIDs = $contactID;
1315 $config = CRM_Core_Config
::singleton();
1316 $startDate = $endDate = NULL;
1318 $currentMonth = date('m');
1319 $currentDay = date('d');
1320 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
1321 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
1322 (int ) $config->fiscalYearStart
['d'] > $currentDay
1325 $year = date('Y') - 1;
1330 $nextYear = $year +
1;
1332 if ($config->fiscalYearStart
) {
1333 $newFiscalYearStart = $config->fiscalYearStart
;
1334 if ($newFiscalYearStart['M'] < 10) {
1335 $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
1337 if ($newFiscalYearStart['d'] < 10) {
1338 $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
1340 $config->fiscalYearStart
= $newFiscalYearStart;
1341 $monthDay = $config->fiscalYearStart
['M'] . $config->fiscalYearStart
['d'];
1346 $startDate = "$year$monthDay";
1347 $endDate = "$nextYear$monthDay";
1348 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
1349 $additionalWhere = " AND b.financial_type_id IN (0)";
1350 $liWhere = " AND i.financial_type_id IN (0)";
1351 if (!empty($financialTypes)) {
1352 $additionalWhere = " AND b.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND i.id IS NULL";
1353 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
1356 SELECT count(*) as count,
1357 sum(total_amount) as amount,
1358 avg(total_amount) as average,
1360 FROM civicrm_contribution b
1361 LEFT JOIN civicrm_line_item i ON i.contribution_id = b.id AND i.entity_table = 'civicrm_contribution' $liWhere
1362 WHERE b.contact_id IN ( $contactIDs )
1363 AND b.contribution_status_id = 1
1365 AND b.receive_date >= $startDate
1366 AND b.receive_date < $endDate
1370 $dao = CRM_Core_DAO
::executeQuery($query);
1372 $amount = $average = array();
1373 while ($dao->fetch()) {
1374 if ($dao->count
> 0 && $dao->amount
> 0) {
1375 $count +
= $dao->count
;
1376 $amount[] = CRM_Utils_Money
::format($dao->amount
, $dao->currency
);
1377 $average[] = CRM_Utils_Money
::format($dao->average
, $dao->currency
);
1383 implode(', ', $amount),
1384 implode(', ', $average),
1387 return array(0, 0, 0);
1391 * Check if there is a contribution with the params passed in.
1393 * Used for trxn_id,invoice_id and contribution_id
1395 * @param array $params
1396 * An assoc array of name/value pairs.
1399 * contribution id if success else NULL
1401 public static function checkDuplicateIds($params) {
1402 $dao = new CRM_Contribute_DAO_Contribution();
1406 foreach ($params as $k => $v) {
1408 $clause[] = "$k = '$v'";
1411 $clause = implode(' AND ', $clause);
1412 $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1413 $dao = CRM_Core_DAO
::executeQuery($query, $input);
1415 while ($dao->fetch()) {
1423 * Get the contribution details for component export.
1425 * @param int $exportMode
1427 * @param string $componentIds
1433 public static function getContributionDetails($exportMode, $componentIds) {
1434 $paymentDetails = array();
1435 $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1437 if ($exportMode == CRM_Export_Form_Select
::EVENT_EXPORT
) {
1438 $componentSelect = " civicrm_participant_payment.participant_id id";
1439 $additionalClause = "
1440 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1441 AND civicrm_participant_payment.participant_id {$componentClause} )
1444 elseif ($exportMode == CRM_Export_Form_Select
::MEMBER_EXPORT
) {
1445 $componentSelect = " civicrm_membership_payment.membership_id id";
1446 $additionalClause = "
1447 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1448 AND civicrm_membership_payment.membership_id {$componentClause} )
1451 elseif ($exportMode == CRM_Export_Form_Select
::PLEDGE_EXPORT
) {
1452 $componentSelect = " civicrm_pledge_payment.id id";
1453 $additionalClause = "
1454 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1455 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1459 $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1460 trxn_id, {$componentSelect}
1461 FROM civicrm_contribution
1462 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1463 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1464 AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1465 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1466 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1467 AND option_group_contribution_status.id = contribution_status.option_group_id )
1471 $dao = CRM_Core_DAO
::executeQuery($query);
1473 while ($dao->fetch()) {
1474 $paymentDetails[$dao->id
] = array(
1475 'total_amount' => $dao->total_amount
,
1476 'contribution_status' => $dao->status
,
1477 'receive_date' => $dao->receive_date
,
1478 'pay_instru' => $dao->payment_instrument
,
1479 'trxn_id' => $dao->trxn_id
,
1483 return $paymentDetails;
1487 * Create address associated with contribution record.
1489 * As long as there is one or more billing field in the parameters we will create the address.
1491 * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1494 * @param array $params
1495 * @param int $billingLocationTypeID
1500 public static function createAddress($params, $billingLocationTypeID) {
1501 list($hasBillingField, $addressParams) = self
::getBillingAddressParams($params, $billingLocationTypeID);
1502 if ($hasBillingField) {
1503 $address = CRM_Core_BAO_Address
::add($addressParams, FALSE);
1504 return $address->id
;
1511 * Delete billing address record related contribution.
1513 * @param int $contributionId
1514 * @param int $contactId
1516 public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1518 $contactJoin = NULL;
1520 if ($contributionId) {
1521 $clauses[] = "cc.id = {$contributionId}";
1525 $clauses[] = "cco.id = {$contactId}";
1526 $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1529 if (empty($clauses)) {
1530 CRM_Core_Error
::fatal();
1533 $condition = implode(' OR ', $clauses);
1537 FROM civicrm_address ca
1538 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1542 $dao = CRM_Core_DAO
::executeQuery($query);
1544 while ($dao->fetch()) {
1545 $params = array('id' => $dao->id
);
1546 CRM_Core_BAO_Block
::blockDelete('Address', $params);
1551 * This function check online pending contribution associated w/
1552 * Online Event Registration or Online Membership signup.
1554 * @param int $componentId
1555 * Participant/membership id.
1556 * @param string $componentName
1560 * pending contribution id.
1562 public static function checkOnlinePendingContribution($componentId, $componentName) {
1563 $contributionId = NULL;
1564 if (!$componentId ||
1565 !in_array($componentName, array('Event', 'Membership'))
1567 return $contributionId;
1570 if ($componentName == 'Event') {
1571 $idName = 'participant_id';
1572 $componentTable = 'civicrm_participant';
1573 $paymentTable = 'civicrm_participant_payment';
1574 $source = ts('Online Event Registration');
1577 if ($componentName == 'Membership') {
1578 $idName = 'membership_id';
1579 $componentTable = 'civicrm_membership';
1580 $paymentTable = 'civicrm_membership_payment';
1581 $source = ts('Online Contribution');
1584 $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name'));
1587 SELECT component.id as {$idName},
1588 componentPayment.contribution_id as contribution_id,
1589 contribution.source source,
1590 contribution.contribution_status_id as contribution_status_id,
1591 contribution.is_pay_later as is_pay_later
1592 FROM $componentTable component
1593 LEFT JOIN $paymentTable componentPayment ON ( componentPayment.{$idName} = component.id )
1594 LEFT JOIN civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1595 WHERE component.id = {$componentId}";
1597 $dao = CRM_Core_DAO
::executeQuery($query);
1599 while ($dao->fetch()) {
1600 if ($dao->contribution_id
&&
1601 $dao->is_pay_later
&&
1602 $dao->contribution_status_id
== $pendingStatusId &&
1603 strpos($dao->source
, $source) !== FALSE
1605 $contributionId = $dao->contribution_id
;
1610 return $contributionId;
1614 * Update contribution as well as related objects.
1616 * This function by-passes hooks - to address this - don't use this function.
1620 * Use api contribute.completetransaction
1621 * For failures use failPayment (preferably exposing by api in the process).
1623 * @param array $params
1624 * @param bool $processContributionObject
1627 * @throws \Exception
1629 public static function transitionComponents($params, $processContributionObject = FALSE) {
1630 // get minimum required values.
1631 $contactId = CRM_Utils_Array
::value('contact_id', $params);
1632 $componentId = CRM_Utils_Array
::value('component_id', $params);
1633 $componentName = CRM_Utils_Array
::value('componentName', $params);
1634 $contributionId = CRM_Utils_Array
::value('contribution_id', $params);
1635 $contributionStatusId = CRM_Utils_Array
::value('contribution_status_id', $params);
1637 // if we already processed contribution object pass previous status id.
1638 $previousContriStatusId = CRM_Utils_Array
::value('previous_contribution_status_id', $params);
1640 $updateResult = array();
1642 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
1644 // we process only ( Completed, Cancelled, or Failed ) contributions.
1645 if (!$contributionId ||
1646 !in_array($contributionStatusId, array(
1647 array_search('Completed', $contributionStatuses),
1648 array_search('Cancelled', $contributionStatuses),
1649 array_search('Failed', $contributionStatuses),
1652 return $updateResult;
1655 if (!$componentName ||
!$componentId) {
1656 // get the related component details.
1657 $componentDetails = self
::getComponentDetails($contributionId);
1660 $componentDetails['contact_id'] = $contactId;
1661 $componentDetails['component'] = $componentName;
1663 if ($componentName == 'event') {
1664 $componentDetails['participant'] = $componentId;
1667 $componentDetails['membership'] = $componentId;
1671 if (!empty($componentDetails['contact_id'])) {
1672 $componentDetails['contact_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
1678 // do check for required ids.
1679 if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) ||
empty($componentDetails['contact_id'])) {
1680 return $updateResult;
1683 //now we are ready w/ required ids, start processing.
1685 $baseIPN = new CRM_Core_Payment_BaseIPN();
1687 $input = $ids = $objects = array();
1689 $input['component'] = CRM_Utils_Array
::value('component', $componentDetails);
1690 $ids['contribution'] = $contributionId;
1691 $ids['contact'] = CRM_Utils_Array
::value('contact_id', $componentDetails);
1692 $ids['membership'] = CRM_Utils_Array
::value('membership', $componentDetails);
1693 $ids['participant'] = CRM_Utils_Array
::value('participant', $componentDetails);
1694 $ids['event'] = CRM_Utils_Array
::value('event', $componentDetails);
1695 $ids['pledge_payment'] = CRM_Utils_Array
::value('pledge_payment', $componentDetails);
1696 $ids['contributionRecur'] = NULL;
1697 $ids['contributionPage'] = NULL;
1699 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1700 CRM_Core_Error
::fatal();
1703 $memberships = &$objects['membership'];
1704 $participant = &$objects['participant'];
1705 $pledgePayment = &$objects['pledge_payment'];
1706 $contribution = &$objects['contribution'];
1708 if ($pledgePayment) {
1709 $pledgePaymentIDs = array();
1710 foreach ($pledgePayment as $key => $object) {
1711 $pledgePaymentIDs[] = $object->id
;
1713 $pledgeID = $pledgePayment[0]->pledge_id
;
1716 $membershipStatuses = CRM_Member_PseudoConstant
::membershipStatus();
1719 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
1720 $oldStatus = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
1725 // we might want to process contribution object.
1726 $processContribution = FALSE;
1727 if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1728 if (is_array($memberships)) {
1729 foreach ($memberships as $membership) {
1731 //Update Membership status if there is no other completed contribution associated with the membership.
1732 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1733 foreach ($relatedContributions as $contriId) {
1734 if ($contriId == $contributionId) {
1737 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contriId) === 'Completed') {
1741 if ($membership && $update) {
1742 $newStatus = array_search('Cancelled', $membershipStatuses);
1745 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
1746 $activityParam = array(
1747 'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
1748 'source_contact_id' => CRM_Core_Session
::singleton()->get('userID'),
1749 'target_contact_id' => $membership->contact_id
,
1750 'source_record_id' => $membership->id
,
1751 'activity_type_id' => 'Change Membership Status',
1752 'status_id' => 'Completed',
1753 'priority_id' => 'Normal',
1754 'activity_date_time' => 'now',
1757 $membership->status_id
= $newStatus;
1758 $membership->save();
1759 civicrm_api3('activity', 'create', $activityParam);
1761 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1762 if ($processContributionObject) {
1763 $processContribution = TRUE;
1770 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1771 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1773 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1774 if ($processContributionObject) {
1775 $processContribution = TRUE;
1779 if ($pledgePayment) {
1780 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1782 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1783 if ($processContributionObject) {
1784 $processContribution = TRUE;
1788 elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1789 if (is_array($memberships)) {
1790 foreach ($memberships as $membership) {
1792 //Update Membership status if there is no other completed contribution associated with the membership.
1793 $relatedContributions = CRM_Member_BAO_Membership
::getMembershipContributionId($membership->id
, TRUE);
1794 foreach ($relatedContributions as $contriId) {
1795 if ($contriId == $contributionId) {
1798 if (CRM_Core_PseudoConstant
::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contriId) === 'Completed') {
1802 if ($membership && $update) {
1803 $membership->status_id
= array_search('Expired', $membershipStatuses);
1804 $membership->save();
1806 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1807 if ($processContributionObject) {
1808 $processContribution = TRUE;
1814 $updatedStatusId = array_search('Cancelled', $participantStatuses);
1815 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
1817 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1818 if ($processContributionObject) {
1819 $processContribution = TRUE;
1823 if ($pledgePayment) {
1824 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1826 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1827 if ($processContributionObject) {
1828 $processContribution = TRUE;
1832 elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1834 // only pending contribution related object processed.
1835 if ($previousContriStatusId &&
1836 ($previousContriStatusId != array_search('Pending', $contributionStatuses))
1838 // this is case when we already processed contribution object.
1839 return $updateResult;
1841 elseif (!$previousContriStatusId &&
1842 $contribution->contribution_status_id
!= array_search('Pending', $contributionStatuses)
1844 // this is case when we are going to process contribution object later.
1845 return $updateResult;
1848 if (is_array($memberships)) {
1849 foreach ($memberships as $membership) {
1854 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
1855 $membership->membership_type_id
,
1856 $membership->is_test
, $membership->id
1859 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1860 // this picks up membership type changes during renewals
1862 SELECT membership_type_id
1863 FROM civicrm_membership_log
1864 WHERE membership_id=$membership->id
1867 $dao = new CRM_Core_DAO();
1869 if ($dao->fetch()) {
1870 if (!empty($dao->membership_type_id
)) {
1871 $membership->membership_type_id
= $dao->membership_type_id
;
1872 $membership->save();
1875 // else fall back to using current membership type
1878 // Figure out number of terms
1880 $lineitems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
1881 foreach ($lineitems as $lineitem) {
1882 if ($membership->membership_type_id
== CRM_Utils_Array
::value('membership_type_id', $lineitem)) {
1883 $numterms = CRM_Utils_Array
::value('membership_num_terms', $lineitem);
1885 // in case membership_num_terms comes through as null or zero
1886 $numterms = $numterms >= 1 ?
$numterms : 1;
1891 // CRM-15735-to update the membership status as per the contribution receive date
1893 $oldStatus = $membership->status_id
;
1894 if (!empty($params['receive_date'])) {
1895 $joinDate = $params['receive_date'];
1896 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($membership->start_date
,
1897 $membership->end_date
,
1898 $membership->join_date
,
1899 $params['receive_date'],
1901 $membership->membership_type_id
,
1904 $membership->status_id
= CRM_Utils_Array
::value('id', $status, $membership->status_id
);
1905 $membership->save();
1908 if ($currentMembership) {
1909 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1910 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
, NULL, NULL, $numterms);
1911 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
1914 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, $joinDate, NULL, NULL, $numterms);
1917 //get the status for membership.
1918 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
1920 $dates['join_date'],
1923 $membership->membership_type_id
,
1927 $formattedParams = array(
1928 'status_id' => CRM_Utils_Array
::value('id', $calcStatus,
1929 array_search('Current', $membershipStatuses)
1931 'join_date' => CRM_Utils_Date
::customFormat($dates['join_date'], $format),
1932 'start_date' => CRM_Utils_Date
::customFormat($dates['start_date'], $format),
1933 'end_date' => CRM_Utils_Date
::customFormat($dates['end_date'], $format),
1936 CRM_Utils_Hook
::pre('edit', 'Membership', $membership->id
, $formattedParams);
1938 $membership->copyValues($formattedParams);
1939 $membership->save();
1941 //updating the membership log
1942 $membershipLog = array();
1943 $membershipLog = $formattedParams;
1944 $logStartDate = CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('log_start_date', $dates), $format);
1945 $logStartDate = ($logStartDate) ? CRM_Utils_Date
::isoToMysql($logStartDate) : $formattedParams['start_date'];
1947 $membershipLog['start_date'] = $logStartDate;
1948 $membershipLog['membership_id'] = $membership->id
;
1949 $membershipLog['modified_id'] = $membership->contact_id
;
1950 $membershipLog['modified_date'] = date('Ymd');
1951 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
1953 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
1955 //update related Memberships.
1956 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formattedParams);
1958 foreach (array('Membership Signup', 'Membership Renewal') as $activityType) {
1959 $scheduledActivityID = CRM_Utils_Array
::value('id',
1960 civicrm_api3('Activity', 'Get',
1962 'source_record_id' => $membership->id
,
1963 'activity_type_id' => $activityType,
1964 'status_id' => 'Scheduled',
1967 'sort' => 'id DESC',
1972 // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
1973 // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
1974 if ($scheduledActivityID) {
1975 CRM_Activity_BAO_Activity
::addActivity($membership, $activityType, $membership->contact_id
, array('id' => $scheduledActivityID));
1980 // track membership status change if any
1981 if (!empty($oldStatus) && $membership->status_id
!= $oldStatus) {
1982 $allStatus = CRM_Member_BAO_Membership
::buildOptions('status_id', 'get');
1983 CRM_Activity_BAO_Activity
::addActivity($membership,
1984 'Change Membership Status',
1987 'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
1988 'source_contact_id' => $membershipLog['modified_id'],
1989 'priority_id' => 'Normal',
1994 $updateResult['membership_end_date'] = CRM_Utils_Date
::customFormat($dates['end_date'],
1997 $updateResult['updatedComponents']['CiviMember'] = $membership->status_id
;
1998 if ($processContributionObject) {
1999 $processContribution = TRUE;
2002 CRM_Utils_Hook
::post('edit', 'Membership', $membership->id
, $membership);
2008 $updatedStatusId = array_search('Registered', $participantStatuses);
2009 CRM_Event_BAO_Participant
::updateParticipantStatus($participant->id
, $oldStatus, $updatedStatusId, TRUE);
2011 $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2012 if ($processContributionObject) {
2013 $processContribution = TRUE;
2017 if ($pledgePayment) {
2018 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2020 $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2021 if ($processContributionObject) {
2022 $processContribution = TRUE;
2027 // process contribution object.
2028 if ($processContribution) {
2029 $contributionParams = array();
2036 'payment_instrument_id',
2039 'financial_type_id',
2040 'contribution_status_id',
2041 'non_deductible_amount',
2045 foreach ($fields as $field) {
2046 if (empty($params[$field])) {
2049 $contributionParams[$field] = $params[$field];
2052 $ids = array('contribution' => $contributionId);
2053 $contribution = CRM_Contribute_BAO_Contribution
::create($contributionParams, $ids);
2056 return $updateResult;
2060 * Returns all contribution related object ids.
2062 * @param $contributionId
2066 public static function getComponentDetails($contributionId) {
2067 $componentDetails = $pledgePayment = array();
2068 if (!$contributionId) {
2069 return $componentDetails;
2073 SELECT c.id as contribution_id,
2074 c.contact_id as contact_id,
2075 c.contribution_recur_id,
2076 mp.membership_id as membership_id,
2077 m.membership_type_id as membership_type_id,
2078 pp.participant_id as participant_id,
2079 p.event_id as event_id,
2080 pgp.id as pledge_payment_id
2081 FROM civicrm_contribution c
2082 LEFT JOIN civicrm_membership_payment mp ON mp.contribution_id = c.id
2083 LEFT JOIN civicrm_participant_payment pp ON pp.contribution_id = c.id
2084 LEFT JOIN civicrm_participant p ON pp.participant_id = p.id
2085 LEFT JOIN civicrm_membership m ON m.id = mp.membership_id
2086 LEFT JOIN civicrm_pledge_payment pgp ON pgp.contribution_id = c.id
2087 WHERE c.id = $contributionId";
2089 $dao = CRM_Core_DAO
::executeQuery($query);
2090 $componentDetails = array();
2092 while ($dao->fetch()) {
2093 $componentDetails['component'] = $dao->participant_id ?
'event' : 'contribute';
2094 $componentDetails['contact_id'] = $dao->contact_id
;
2095 if ($dao->event_id
) {
2096 $componentDetails['event'] = $dao->event_id
;
2098 if ($dao->participant_id
) {
2099 $componentDetails['participant'] = $dao->participant_id
;
2101 if ($dao->membership_id
) {
2102 if (!isset($componentDetails['membership'])) {
2103 $componentDetails['membership'] = $componentDetails['membership_type'] = array();
2105 $componentDetails['membership'][] = $dao->membership_id
;
2106 $componentDetails['membership_type'][] = $dao->membership_type_id
;
2108 if ($dao->pledge_payment_id
) {
2109 $pledgePayment[] = $dao->pledge_payment_id
;
2111 if ($dao->contribution_recur_id
) {
2112 $componentDetails['contributionRecur'] = $dao->contribution_recur_id
;
2116 if ($pledgePayment) {
2117 $componentDetails['pledge_payment'] = $pledgePayment;
2120 return $componentDetails;
2124 * @param int $contactId
2125 * @param bool $includeSoftCredit
2127 * @return null|string
2129 public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2133 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialTypes);
2134 $additionalWhere = " AND contribution.financial_type_id IN (0)";
2135 $liWhere = " AND i.financial_type_id IN (0)";
2136 if (!empty($financialTypes)) {
2137 $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2138 $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2140 $contactContributionsSQL = "
2141 SELECT contribution.id AS id
2142 FROM civicrm_contribution contribution
2143 LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2144 WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2148 $contactSoftCreditContributionsSQL = "
2149 SELECT contribution.id
2150 FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2151 ON ( contribution.id = softContribution.contribution_id )
2152 WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2153 $query = "SELECT count( x.id ) count FROM ( ";
2154 $query .= $contactContributionsSQL;
2156 if ($includeSoftCredit) {
2157 $query .= " UNION ";
2158 $query .= $contactSoftCreditContributionsSQL;
2163 return CRM_Core_DAO
::singleValueQuery($query);
2167 * Repeat a transaction as part of a recurring series.
2169 * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2170 * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2171 * subsequent call to the contribution.completetransaction api.
2173 * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2175 * @param CRM_Contribute_BAO_Contribution $contribution
2176 * @param array $input
2177 * @param array $contributionParams
2178 * @param int $paymentProcessorID
2181 * @throws CiviCRM_API3_Exception
2183 protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2184 if (!empty($contribution->id
)) {
2187 if (empty($contribution->id
)) {
2188 // Unclear why this would only be set for repeats.
2189 if (!empty($input['amount'])) {
2190 $contribution->total_amount
= $contributionParams['total_amount'] = $input['amount'];
2193 if (!empty($contributionParams['contribution_recur_id'])) {
2194 $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2195 'id' => $contributionParams['contribution_recur_id'],
2197 if (!empty($recurringContribution['campaign_id'])) {
2198 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2199 $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2201 if (!empty($recurringContribution['financial_type_id'])) {
2202 // CRM-17718 the campaign id on the contribution recur record should get precedence.
2203 $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2206 $templateContribution = CRM_Contribute_BAO_ContributionRecur
::getTemplateContribution(
2207 $contributionParams['contribution_recur_id'],
2208 array_intersect_key($contributionParams, array('total_amount' => TRUE, 'financial_type_id' => TRUE))
2210 $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2212 $contributionParams['status_id'] = 'Pending';
2213 if (isset($contributionParams['financial_type_id'])) {
2214 // Give precedence to passed in type.
2215 $contribution->financial_type_id
= $contributionParams['financial_type_id'];
2218 $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2220 $contributionParams['contact_id'] = $templateContribution['contact_id'];
2221 $contributionParams['source'] = empty($templateContribution['source']) ?
ts('Recurring contribution') : $templateContribution['source'];
2223 //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2224 //do not create CC or BCC emails or profile notifications.
2225 //The if is just to be safe. Not sure if we can ever arrive with this unset
2226 // but per CRM-19478 it seems it can be 'null'
2227 if (isset($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
2228 $contributionParams['contribution_page_id'] = $contribution->contribution_page_id
;
2231 $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2232 $contribution->id
= $createContribution['id'];
2233 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id
);
2239 * Get individual id for onbehalf contribution.
2241 * @param int $contributionId
2243 * @param int $contributorId
2247 * containing organization id and individual id
2249 public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2253 if (!$contributionId) {
2257 // fetch contributor id if null
2258 if (!$contributorId) {
2259 $contributorId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
2260 $contributionId, 'contact_id'
2264 $activityTypeIds = CRM_Core_PseudoConstant
::activityType(TRUE, FALSE, FALSE, 'name');
2265 $activityTypeId = array_search('Contribution', $activityTypeIds);
2267 if ($activityTypeId && $contributorId) {
2269 SELECT civicrm_activity_contact.contact_id
2270 FROM civicrm_activity_contact
2271 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2272 WHERE civicrm_activity.activity_type_id = %1
2273 AND civicrm_activity.source_record_id = %2
2274 AND civicrm_activity_contact.record_type_id = %3
2277 $activityContacts = CRM_Core_OptionGroup
::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2278 $sourceID = CRM_Utils_Array
::key('Activity Source', $activityContacts);
2281 1 => array($activityTypeId, 'Integer'),
2282 2 => array($contributionId, 'Integer'),
2283 3 => array($sourceID, 'Integer'),
2286 $sourceContactId = CRM_Core_DAO
::singleValueQuery($activityQuery, $params);
2288 // for on behalf contribution source is individual and contributor is organization
2289 if ($sourceContactId && $sourceContactId != $contributorId) {
2290 $relationshipTypeIds = CRM_Core_PseudoConstant
::relationshipType('name');
2291 // get rel type id for employee of relation
2292 foreach ($relationshipTypeIds as $id => $typeVals) {
2293 if ($typeVals['name_a_b'] == 'Employee of') {
2294 $relationshipTypeId = $id;
2299 $rel = new CRM_Contact_DAO_Relationship();
2300 $rel->relationship_type_id
= $relationshipTypeId;
2301 $rel->contact_id_a
= $sourceContactId;
2302 $rel->contact_id_b
= $contributorId;
2303 if ($rel->find(TRUE)) {
2304 $ids['individual_id'] = $rel->contact_id_a
;
2305 $ids['organization_id'] = $rel->contact_id_b
;
2316 public static function getContributionDates() {
2317 $config = CRM_Core_Config
::singleton();
2318 $currentMonth = date('m');
2319 $currentDay = date('d');
2320 if ((int ) $config->fiscalYearStart
['M'] > $currentMonth ||
2321 ((int ) $config->fiscalYearStart
['M'] == $currentMonth &&
2322 (int ) $config->fiscalYearStart
['d'] > $currentDay
2325 $year = date('Y') - 1;
2330 $year = array('Y' => $year);
2331 $yearDate = $config->fiscalYearStart
;
2332 $yearDate = array_merge($year, $yearDate);
2333 $yearDate = CRM_Utils_Date
::format($yearDate);
2335 $monthDate = date('Ym') . '01';
2341 'yearDate' => $yearDate,
2342 'monthDate' => $monthDate,
2347 * Load objects relations to contribution object.
2348 * Objects are stored in the $_relatedObjects property
2349 * In the first instance we are just moving functionality from BASEIpn -
2350 * @see http://issues.civicrm.org/jira/browse/CRM-9996
2352 * Note that the unit test for the BaseIPN class tests this function
2354 * @param array $input
2355 * Input as delivered from Payment Processor.
2357 * Ids as Loaded by Payment Processor.
2358 * @param bool $loadAll
2359 * Load all related objects - even where id not passed in? (allows API to call this).
2364 public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2366 $ids = array_merge($this->getComponentDetails($this->id
), $ids);
2367 if (empty($ids['contact']) && isset($this->contact_id
)) {
2368 $ids['contact'] = $this->contact_id
;
2371 if (empty($this->_component
)) {
2372 if (!empty($ids['event'])) {
2373 $this->_component
= 'event';
2376 $this->_component
= strtolower(CRM_Utils_Array
::value('component', $input, 'contribute'));
2380 // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2381 // refactoring than anything else, and has unit test coverage.
2382 if (empty($this->financial_type_id
)) {
2386 $paymentProcessorID = CRM_Utils_Array
::value('payment_processor_id', $input, CRM_Utils_Array
::value(
2391 if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id
) {
2392 $paymentProcessorID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2393 $this->contribution_page_id
,
2396 if ($paymentProcessorID) {
2397 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2401 $ids['contributionType'] = $this->financial_type_id
;
2402 $ids['financialType'] = $this->financial_type_id
;
2403 if ($this->contribution_page_id
) {
2404 $ids['contributionPage'] = $this->contribution_page_id
;
2407 $this->loadRelatedEntitiesByID($ids);
2409 if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2410 $paymentProcessorID = $this->_relatedObjects
['contributionRecur']->payment_processor_id
;
2413 if (!empty($ids['pledge_payment'])) {
2414 foreach ($ids['pledge_payment'] as $key => $paymentID) {
2415 if (empty($paymentID)) {
2418 $payment = new CRM_Pledge_BAO_PledgePayment();
2419 $payment->id
= $paymentID;
2420 if (!$payment->find(TRUE)) {
2421 throw new Exception("Could not find pledge payment record: " . $paymentID);
2423 $this->_relatedObjects
['pledge_payment'][] = $payment;
2427 $this->loadRelatedMembershipObjects($ids);
2429 if ($this->_component
!= 'contribute') {
2430 // we are in event mode
2431 // make sure event exists and is valid
2432 $event = new CRM_Event_BAO_Event();
2433 $event->id
= $ids['event'];
2434 if ($ids['event'] &&
2437 throw new Exception("Could not find event: " . $ids['event']);
2440 $this->_relatedObjects
['event'] = &$event;
2442 $participant = new CRM_Event_BAO_Participant();
2443 $participant->id
= $ids['participant'];
2444 if ($ids['participant'] &&
2445 !$participant->find(TRUE)
2447 throw new Exception("Could not find participant: " . $ids['participant']);
2449 $participant->register_date
= CRM_Utils_Date
::isoToMysql($participant->register_date
);
2451 $this->_relatedObjects
['participant'] = &$participant;
2453 // get the payment processor id from event - this is inaccurate see CRM-16923
2454 // in future we should look at throwing an exception here rather than an dubious guess.
2455 if (!$paymentProcessorID) {
2456 $paymentProcessorID = $this->_relatedObjects
['event']->payment_processor
;
2457 if ($paymentProcessorID) {
2458 $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2463 if ($paymentProcessorID) {
2464 $paymentProcessor = CRM_Financial_BAO_PaymentProcessor
::getPayment($paymentProcessorID,
2465 $this->is_test ?
'test' : 'live'
2467 $ids['paymentProcessor'] = $paymentProcessorID;
2468 $this->_relatedObjects
['paymentProcessor'] = $paymentProcessor;
2474 * Create array of message information - ie. return html version, txt version, to field
2476 * @param array $input
2477 * Incoming information.
2478 * - is_recur - should this be treated as recurring (not sure why you wouldn't
2479 * just check presence of recur object but maintaining legacy approach
2482 * IDs of related objects.
2483 * @param array $values
2484 * Any values that may have already been compiled by calling process.
2485 * This is augmented by values 'gathered' by gatherMessageValues
2486 * @param bool $returnMessageText
2487 * Distinguishes between whether to send message or return.
2488 * message text. We are working towards this function ALWAYS returning message text & calling
2489 * function doing emails / pdfs with it
2495 public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2496 $this->loadRelatedObjects($input, $ids);
2498 if (empty($this->_component
)) {
2499 $this->_component
= CRM_Utils_Array
::value('component', $input);
2502 //not really sure what params might be passed in but lets merge em into values
2503 $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2504 $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2505 if (!empty($input['receipt_date'])) {
2506 $values['receipt_date'] = $input['receipt_date'];
2509 $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2510 //what does recur 'mean here - to do with payment processor return functionality but
2511 // what is the importance
2512 if (!empty($this->contribution_recur_id
) && !empty($this->_relatedObjects
['paymentProcessor'])) {
2513 $paymentObject = Civi\Payment\System
::singleton()->getByProcessor($this->_relatedObjects
['paymentProcessor']);
2515 $entityID = $entity = NULL;
2516 if (isset($ids['contribution'])) {
2517 $entity = 'contribution';
2518 $entityID = $ids['contribution'];
2520 if (!empty($ids['membership'])) {
2521 //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
2522 // 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
2523 // line having loaded an array
2524 $ids['membership'] = (array) $ids['membership'];
2525 $entity = 'membership';
2526 $entityID = $ids['membership'][0];
2529 $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2530 $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2531 $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2533 if ($this->_relatedObjects
['paymentProcessor']['billing_mode'] & CRM_Core_Payment
::BILLING_MODE_FORM
) {
2534 //direct mode showing billing block, so use directIPN for temporary
2535 $template->assign('contributeMode', 'directIPN');
2538 // todo remove strtolower - check consistency
2539 if (strtolower($this->_component
) == 'event') {
2540 $eventParams = array('id' => $this->_relatedObjects
['participant']->event_id
);
2541 $values['event'] = array();
2543 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2545 //get location details
2546 $locationParams = array('entity_id' => $this->_relatedObjects
['participant']->event_id
, 'entity_table' => 'civicrm_event');
2547 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2549 $ufJoinParams = array(
2550 'entity_table' => 'civicrm_event',
2551 'entity_id' => $ids['event'],
2552 'module' => 'CiviEvent',
2555 list($custom_pre_id,
2557 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2559 $values['custom_pre_id'] = $custom_pre_id;
2560 $values['custom_post_id'] = $custom_post_ids;
2561 //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2562 //and cases involving status updation through ipn
2563 // whatever that means!
2564 // total_amount appears to be the preferred input param & it is unclear why we support amount here
2565 // perhaps we should throw an e-notice if amount is set & force total_amount?
2566 if (!empty($input['amount'])) {
2567 $values['totalAmount'] = $input['amount'];
2569 // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2570 if ($values['event']['is_email_confirm']) {
2571 $values['is_email_receipt'] = 1;
2574 if (!empty($ids['contribution'])) {
2575 $values['contributionId'] = $ids['contribution'];
2578 return CRM_Event_BAO_Event
::sendMail($ids['contact'], $values,
2579 $this->_relatedObjects
['participant']->id
, $this->is_test
, $returnMessageText
2583 $values['contribution_id'] = $this->id
;
2584 if (!empty($ids['related_contact'])) {
2585 $values['related_contact'] = $ids['related_contact'];
2586 if (isset($ids['onbehalf_dupe_alert'])) {
2587 $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2589 $entityBlock = array(
2590 'contact_id' => $ids['contact'],
2591 'location_type_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_LocationType',
2592 'Home', 'id', 'name'
2595 $address = CRM_Core_BAO_Address
::getValues($entityBlock);
2596 $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2599 if ($this->is_test
) {
2602 if (!empty($this->_relatedObjects
['membership'])) {
2603 foreach ($this->_relatedObjects
['membership'] as $membership) {
2604 if ($membership->id
) {
2605 $values['isMembership'] = TRUE;
2606 $values['membership_assign'] = TRUE;
2608 // need to set the membership values here
2609 $template->assign('membership_name',
2610 CRM_Member_PseudoConstant
::membershipType($membership->membership_type_id
)
2612 $template->assign('mem_start_date', $membership->start_date
);
2613 $template->assign('mem_join_date', $membership->join_date
);
2614 $template->assign('mem_end_date', $membership->end_date
);
2615 $membership_status = CRM_Member_PseudoConstant
::membershipStatus($membership->status_id
, NULL, 'label');
2616 $template->assign('mem_status', $membership_status);
2617 if ($membership_status == 'Pending' && $membership->is_pay_later
== 1) {
2618 $values['is_pay_later'] = 1;
2620 // Pass amount to floatval as string '0.00' is considered a
2621 // valid amount and includes Fee section in the mail.
2622 if (isset($values['amount'])) {
2623 $values['amount'] = floatval($values['amount']);
2626 if (!empty($this->contribution_recur_id
) && $paymentObject) {
2627 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'cancel');
2628 $template->assign('cancelSubscriptionUrl', $url);
2629 $url = $paymentObject->subscriptionURL($membership->id
, 'membership', 'billing');
2630 $template->assign('updateSubscriptionBillingUrl', $url);
2631 $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2632 $template->assign('updateSubscriptionUrl', $url);
2635 $result = CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2638 // otherwise if its about sending emails, continue sending without return, as we
2639 // don't want to exit the loop.
2644 return CRM_Contribute_BAO_ContributionPage
::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2650 * Gather values for contribution mail - this function has been created
2651 * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2652 * Values related to the contribution in question are gathered
2654 * @param array $input
2655 * Input into function (probably from payment processor).
2656 * @param array $values
2658 * The set of ids related to the input.
2662 public function _gatherMessageValues($input, &$values, $ids = array()) {
2663 // set display address of contributor
2664 if ($this->address_id
) {
2665 $addressParams = array('id' => $this->address_id
);
2666 $addressDetails = CRM_Core_BAO_Address
::getValues($addressParams, FALSE, 'id');
2667 $addressDetails = array_values($addressDetails);
2669 // Else we assign the billing address of the contribution contact.
2671 $addressParams = array('contact_id' => $this->contact_id
, 'is_billing' => 1);
2672 $addressDetails = (array) CRM_Core_BAO_Address
::getValues($addressParams);
2673 $addressDetails = array_values($addressDetails);
2676 if (!empty($addressDetails[0]['display'])) {
2677 $values['address'] = $addressDetails[0]['display'];
2680 if ($this->_component
== 'contribute') {
2681 //get soft contributions
2682 $softContributions = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
, TRUE);
2683 if (!empty($softContributions)) {
2684 $values['softContributions'] = $softContributions['soft_credit'];
2686 if (isset($this->contribution_page_id
)) {
2687 // This is a call we want to use less, in favour of loading related objects.
2688 $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
2689 if ($this->contribution_page_id
) {
2690 // This is precautionary as there are some legacy flows, but it should really be
2692 if (!isset($this->_relatedObjects
['contributionPage'])) {
2693 $this->loadRelatedEntitiesByID(array('contributionPage' => $this->contribution_page_id
));
2695 // CRM-8254 - override default currency if applicable
2696 $config = CRM_Core_Config
::singleton();
2697 $config->defaultCurrency
= CRM_Utils_Array
::value(
2700 $config->defaultCurrency
2704 // no contribution page -probably back office
2706 // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2707 $values['title'] = 'Contribution';
2709 // set lineItem for contribution
2711 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($this->id
);
2712 if (!empty($lineItems)) {
2713 $firstLineItem = reset($lineItems);
2714 $priceSet = civicrm_api3('PriceSet', 'getsingle', array('id' => $firstLineItem['price_set_id'], 'return' => 'is_quick_config, id'));
2715 $values['priceSetID'] = $priceSet['id'];
2716 foreach ($lineItems as &$eachItem) {
2717 if (isset($this->_relatedObjects
['membership'])
2718 && is_array($this->_relatedObjects
['membership'])
2719 && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects
['membership'])) {
2720 $eachItem['join_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->join_date
);
2721 $eachItem['start_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->start_date
);
2722 $eachItem['end_date'] = CRM_Utils_Date
::customFormat($this->_relatedObjects
['membership'][$eachItem['membership_type_id']]->end_date
);
2724 // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
2725 // However, that does create upgrade pain so would be better to be phased in.
2726 $values['useForMember'] = !$priceSet['is_quick_config'];
2728 $values['lineItem'][0] = $lineItems;
2732 $relatedContact = CRM_Contribute_BAO_Contribution
::getOnbehalfIds(
2736 // if this is onbehalf of contribution then set related contact
2737 if (!empty($relatedContact['individual_id'])) {
2738 $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2743 $eventParams = array(
2744 'id' => $this->_relatedObjects
['event']->id
,
2746 $values['event'] = array();
2748 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
2749 // add custom fields for event
2750 $eventGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Event', $this->_relatedObjects
['event'], $this->_relatedObjects
['event']->id
);
2752 $eventCustomGroup = array();
2753 foreach ($eventGroupTree as $key => $group) {
2754 if ($key === 'info') {
2758 foreach ($group['fields'] as $k => $customField) {
2759 $groupLabel = $group['title'];
2760 if (!empty($customField['customValue'])) {
2761 foreach ($customField['customValue'] as $customFieldValues) {
2762 $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2767 $values['event']['customGroup'] = $eventCustomGroup;
2769 //get participant details
2770 $participantParams = array(
2771 'id' => $this->_relatedObjects
['participant']->id
,
2774 $values['participant'] = array();
2776 CRM_Event_BAO_Participant
::getValues($participantParams, $values['participant'], $participantIds);
2777 // add custom fields for event
2778 $participantGroupTree = CRM_Core_BAO_CustomGroup
::getTree('Participant', $this->_relatedObjects
['participant'], $this->_relatedObjects
['participant']->id
);
2779 $participantCustomGroup = array();
2780 foreach ($participantGroupTree as $key => $group) {
2781 if ($key === 'info') {
2785 foreach ($group['fields'] as $k => $customField) {
2786 $groupLabel = $group['title'];
2787 if (!empty($customField['customValue'])) {
2788 foreach ($customField['customValue'] as $customFieldValues) {
2789 $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2794 $values['participant']['customGroup'] = $participantCustomGroup;
2796 //get location details
2797 $locationParams = array(
2798 'entity_id' => $this->_relatedObjects
['event']->id
,
2799 'entity_table' => 'civicrm_event',
2801 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
2803 $ufJoinParams = array(
2804 'entity_table' => 'civicrm_event',
2805 'entity_id' => $ids['event'],
2806 'module' => 'CiviEvent',
2809 list($custom_pre_id,
2811 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
2813 $values['custom_pre_id'] = $custom_pre_id;
2814 $values['custom_post_id'] = $custom_post_ids;
2816 // set lineItem for event contribution
2818 $participantIds = CRM_Event_BAO_Participant
::getParticipantIds($this->id
);
2819 if (!empty($participantIds)) {
2820 foreach ($participantIds as $pIDs) {
2821 $lineItem = CRM_Price_BAO_LineItem
::getLineItems($pIDs);
2822 if (!CRM_Utils_System
::isNull($lineItem)) {
2823 $values['lineItem'][] = $lineItem;
2830 $groupTree = CRM_Core_BAO_CustomGroup
::getTree('Contribution', $this, $this->id
);
2832 $customGroup = array();
2833 foreach ($groupTree as $key => $group) {
2834 if ($key === 'info') {
2838 foreach ($group['fields'] as $k => $customField) {
2839 $groupLabel = $group['title'];
2840 if (!empty($customField['customValue'])) {
2841 foreach ($customField['customValue'] as $customFieldValues) {
2842 $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array
::value('data', $customFieldValues);
2847 $values['customGroup'] = $customGroup;
2853 * Assign message variables to template but try to break the habit.
2855 * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2856 * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2857 * multiple recurring payments for processors like IATS that use tokens.
2859 * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2860 * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2861 * Note we send directly from this function in some cases because it is only partly refactored.
2863 * Don't call this function directly as the signature will change.
2867 * @param bool $returnMessageText
2871 public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
2872 $template = CRM_Core_Smarty
::singleton();
2873 $template->assign('first_name', $this->_relatedObjects
['contact']->first_name
);
2874 $template->assign('last_name', $this->_relatedObjects
['contact']->last_name
);
2875 $template->assign('displayName', $this->_relatedObjects
['contact']->display_name
);
2877 // For some unit tests contribution cannot contain paymentProcessor information
2878 $billingMode = empty($this->_relatedObjects
['paymentProcessor']) ? CRM_Core_Payment
::BILLING_MODE_NOTIFY
: $this->_relatedObjects
['paymentProcessor']['billing_mode'];
2879 $template->assign('contributeMode', CRM_Utils_Array
::value($billingMode, CRM_Core_SelectValues
::contributeMode()));
2881 //assign honor information to receipt message
2882 $softRecord = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($this->id
);
2884 if (isset($softRecord['soft_credit'])) {
2885 //if id of contribution page is present
2886 if (!empty($values['id'])) {
2887 $values['honor'] = array(
2888 'honor_profile_values' => array(),
2889 'honor_profile_id' => CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2890 'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2893 $template->assign('soft_credit_type', $softRecord['soft_credit'][1]['soft_credit_type_label']);
2894 $template->assign('honor_block_is_active', CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
2897 //offline contribution
2898 $softCreditTypes = $softCredits = array();
2899 foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2900 $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2901 $softCredits[$key] = array(
2902 'Name' => $softCredit['contact_name'],
2903 'Amount' => CRM_Utils_Money
::format($softCredit['amount'], $softCredit['currency']),
2906 $template->assign('softCreditTypes', $softCreditTypes);
2907 $template->assign('softCredits', $softCredits);
2911 $dao = new CRM_Contribute_DAO_ContributionProduct();
2912 $dao->contribution_id
= $this->id
;
2913 if ($dao->find(TRUE)) {
2914 $premiumId = $dao->product_id
;
2915 $template->assign('option', $dao->product_option
);
2917 $productDAO = new CRM_Contribute_DAO_Product();
2918 $productDAO->id
= $premiumId;
2919 $productDAO->find(TRUE);
2920 $template->assign('selectPremium', TRUE);
2921 $template->assign('product_name', $productDAO->name
);
2922 $template->assign('price', $productDAO->price
);
2923 $template->assign('sku', $productDAO->sku
);
2925 $template->assign('title', CRM_Utils_Array
::value('title', $values));
2926 $values['amount'] = CRM_Utils_Array
::value('total_amount', $input, (CRM_Utils_Array
::value('amount', $input)), NULL);
2927 if (!$values['amount'] && isset($this->total_amount
)) {
2928 $values['amount'] = $this->total_amount
;
2931 // add the new contribution values
2932 if (strtolower($this->_component
) == 'contribute') {
2934 $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2935 $softDAO->contribution_id
= $this->id
;
2936 if ($softDAO->find(TRUE)) {
2937 $template->assign('pcpBlock', TRUE);
2938 $template->assign('pcp_display_in_roll', $softDAO->pcp_display_in_roll
);
2939 $template->assign('pcp_roll_nickname', $softDAO->pcp_roll_nickname
);
2940 $template->assign('pcp_personal_note', $softDAO->pcp_personal_note
);
2942 //assign the pcp page title for email subject
2943 $pcpDAO = new CRM_PCP_DAO_PCP();
2944 $pcpDAO->id
= $softDAO->pcp_id
;
2945 if ($pcpDAO->find(TRUE)) {
2946 $template->assign('title', $pcpDAO->title
);
2951 if ($this->financial_type_id
) {
2952 $values['financial_type_id'] = $this->financial_type_id
;
2955 $template->assign('trxn_id', $this->trxn_id
);
2956 $template->assign('receive_date',
2957 CRM_Utils_Date
::processDate($this->receive_date
)
2959 $values['receipt_date'] = (empty($this->receipt_date
) ?
NULL : $this->receipt_date
);
2960 $template->assign('action', $this->is_test ?
1024 : 1);
2961 $template->assign('receipt_text',
2962 CRM_Utils_Array
::value('receipt_text',
2966 $template->assign('is_monetary', 1);
2967 $template->assign('is_recur', !empty($this->contribution_recur_id
));
2968 $template->assign('currency', $this->currency
);
2969 $template->assign('address', CRM_Utils_Address
::format($input));
2970 if (!empty($values['customGroup'])) {
2971 $template->assign('customGroup', $values['customGroup']);
2973 if (!empty($values['softContributions'])) {
2974 $template->assign('softContributions', $values['softContributions']);
2976 if ($this->_component
== 'event') {
2977 $template->assign('title', $values['event']['title']);
2978 $participantRoles = CRM_Event_PseudoConstant
::participantRole();
2979 $viewRoles = array();
2980 foreach (explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $this->_relatedObjects
['participant']->role_id
) as $k => $v) {
2981 $viewRoles[] = $participantRoles[$v];
2983 $values['event']['participant_role'] = implode(', ', $viewRoles);
2984 $template->assign('event', $values['event']);
2985 $template->assign('participant', $values['participant']);
2986 $template->assign('location', $values['location']);
2987 $template->assign('customPre', $values['custom_pre_id']);
2988 $template->assign('customPost', $values['custom_post_id']);
2991 if ($this->_relatedObjects
['participant']->is_test
) {
2995 $values['params'] = array();
2996 //to get email of primary participant.
2997 $primaryEmail = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects
['participant']->contact_id
, 'email', 'contact_id');
2998 $primaryAmount[] = array(
2999 'label' => $this->_relatedObjects
['participant']->fee_level
. ' - ' . $primaryEmail,
3000 'amount' => $this->_relatedObjects
['participant']->fee_amount
,
3002 //build an array of cId/pId of participants
3003 $additionalIDs = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, NULL, $this->_relatedObjects
['contact']->id
, $isTest, TRUE);
3004 unset($additionalIDs[$this->_relatedObjects
['participant']->id
]);
3005 //send receipt to additional participant if exists
3006 if (count($additionalIDs)) {
3007 $template->assign('isPrimary', 0);
3008 $template->assign('customProfile', NULL);
3009 //set additionalParticipant true
3010 $values['params']['additionalParticipant'] = TRUE;
3011 foreach ($additionalIDs as $pId => $cId) {
3013 //to change the status pending to completed
3014 $additional = new CRM_Event_DAO_Participant();
3015 $additional->id
= $pId;
3016 $additional->contact_id
= $cId;
3017 $additional->find(TRUE);
3018 $additional->register_date
= $this->_relatedObjects
['participant']->register_date
;
3019 $additional->status_id
= 1;
3020 $additionalParticipantInfo = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id
, 'email', 'contact_id');
3021 //if additional participant dont have email
3023 if (!$additionalParticipantInfo) {
3024 $additionalParticipantInfo = CRM_Contact_BAO_Contact
::displayName($additional->contact_id
);
3026 $amount[0] = array('label' => $additional->fee_level
, 'amount' => $additional->fee_amount
);
3027 $primaryAmount[] = array(
3028 'label' => $additional->fee_level
. ' - ' . $additionalParticipantInfo,
3029 'amount' => $additional->fee_amount
,
3031 $additional->save();
3032 $additional->free();
3033 $template->assign('amount', $amount);
3034 CRM_Event_BAO_Event
::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3038 //build an array of custom profile and assigning it to template
3039 $customProfile = CRM_Event_BAO_Event
::buildCustomProfile($this->_relatedObjects
['participant']->id
, $values, NULL, $isTest);
3041 if (count($customProfile)) {
3042 $template->assign('customProfile', $customProfile);
3045 // for primary contact
3046 $values['params']['additionalParticipant'] = FALSE;
3047 $template->assign('isPrimary', 1);
3048 $template->assign('amount', $primaryAmount);
3049 $template->assign('register_date', CRM_Utils_Date
::isoToMysql($this->_relatedObjects
['participant']->register_date
));
3050 if ($this->payment_instrument_id
) {
3051 $paymentInstrument = CRM_Contribute_PseudoConstant
::paymentInstrument();
3052 $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id
]);
3054 // carry paylater, since we did not created billing,
3055 // so need to pull email from primary location, CRM-4395
3056 $values['params']['is_pay_later'] = $this->_relatedObjects
['participant']->is_pay_later
;
3062 * Check whether payment processor supports
3063 * cancellation of contribution subscription
3065 * @param int $contributionId
3068 * @param bool $isNotCancelled
3072 public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3073 $cacheKeyString = "$contributionId";
3074 $cacheKeyString .= $isNotCancelled ?
'_1' : '_0';
3076 static $supportsCancel = array();
3078 if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3079 $supportsCancel[$cacheKeyString] = FALSE;
3080 $isCancelled = FALSE;
3082 if ($isNotCancelled) {
3083 $isCancelled = self
::isSubscriptionCancelled($contributionId);
3086 $paymentObject = CRM_Financial_BAO_PaymentProcessor
::getProcessorForEntity($contributionId, 'contribute', 'obj');
3087 if (!empty($paymentObject)) {
3088 $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3091 return $supportsCancel[$cacheKeyString];
3095 * Check whether subscription is already cancelled.
3097 * @param int $contributionId
3101 * contribution status
3103 public static function isSubscriptionCancelled($contributionId) {
3105 SELECT cr.contribution_status_id
3106 FROM civicrm_contribution_recur cr
3107 LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3108 WHERE con.id = %1 LIMIT 1";
3109 $params = array(1 => array($contributionId, 'Integer'));
3110 $statusId = CRM_Core_DAO
::singleValueQuery($sql, $params);
3111 $status = CRM_Contribute_PseudoConstant
::contributionStatus($statusId);
3112 if ($status == 'Cancelled') {
3119 * Create all financial accounts entry.
3121 * @param array $params
3122 * Contribution object, line item array and params for trxn.
3125 * @param array $financialTrxnValues
3127 * @return null|object
3129 public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3130 $skipRecords = $update = $return = $isRelatedId = FALSE;
3132 $additionalParticipantId = array();
3133 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3134 $contributionStatus = empty($params['contribution_status_id']) ?
NULL : $contributionStatuses[$params['contribution_status_id']];
3136 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'participant') {
3137 $entityId = $params['participant_id'];
3138 $entityTable = 'civicrm_participant';
3139 $additionalParticipantId = CRM_Event_BAO_Participant
::getAdditionalParticipantIds($entityId);
3141 elseif (!empty($params['membership_id'])) {
3142 //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3143 // are created off one contribution should be handled elsewhere
3144 $entityId = $params['membership_id'];
3145 $entityTable = 'civicrm_membership';
3148 $entityId = $params['contribution']->id
;
3149 $entityTable = 'civicrm_contribution';
3152 if (CRM_Utils_Array
::value('contribution_mode', $params) == 'membership') {
3153 $isRelatedId = TRUE;
3156 $entityID[] = $entityId;
3157 if (!empty($additionalParticipantId)) {
3158 $entityID +
= $additionalParticipantId;
3160 // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3161 if (empty($params['prevContribution'])) {
3168 $statusId = $params['contribution']->contribution_status_id
;
3169 // CRM-13964 partial payment
3170 if ($contributionStatus == 'Partially paid'
3171 && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])
3173 $partialAmtPay = CRM_Utils_Rule
::cleanMoney($params['partial_amount_pay']);
3174 $partialAmtTotal = CRM_Utils_Rule
::cleanMoney($params['partial_payment_total']);
3176 $fromFinancialAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['financial_type_id'], 'Accounts Receivable Account is');
3177 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3178 $params['total_amount'] = $partialAmtPay;
3180 $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($params['contribution']->id
, $params['financial_type_id']);
3181 if (empty($balanceTrxnInfo['trxn_id'])) {
3182 // create new balance transaction record
3183 $toFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['financial_type_id'], 'Accounts Receivable Account is');
3185 $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3186 $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3187 $balanceTrxnParams['contribution_id'] = $params['contribution']->id
;
3188 $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis');
3189 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3190 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3191 $balanceTrxnParams['currency'] = $params['contribution']->currency
;
3192 $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id
;
3193 $balanceTrxnParams['status_id'] = $statusId;
3194 $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3195 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3196 $balanceTrxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3197 $balanceTrxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3198 if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3199 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
3201 $balanceTrxnParams['is_payment'] = 1;
3203 if (!empty($params['payment_processor'])) {
3204 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3206 $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
3210 // build line item array if its not set in $params
3211 if (empty($params['line_item']) ||
$additionalParticipantId) {
3212 CRM_Price_BAO_LineItem
::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3215 if ($contributionStatus != 'Failed' &&
3216 !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later
)
3218 $skipRecords = TRUE;
3219 $pendingStatus = array(
3223 if (in_array($contributionStatus, $pendingStatus)) {
3224 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
3225 $params['financial_type_id'],
3226 'Accounts Receivable Account is'
3229 elseif (!empty($params['payment_processor'])) {
3230 $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3231 $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', array(
3232 'id' => $params['payment_processor'],
3233 'return' => 'payment_instrument_id',
3236 elseif (!empty($params['payment_instrument_id'])) {
3237 $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($params['payment_instrument_id']);
3240 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3241 $queryParams = array(1 => array($relationTypeId, 'Integer'));
3242 $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);
3245 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
3246 if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3247 $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount
;
3249 //build financial transaction params
3250 $trxnParams = array(
3251 'contribution_id' => $params['contribution']->id
,
3252 'to_financial_account_id' => $params['to_financial_account_id'],
3253 'trxn_date' => !empty($params['contribution']->receive_date
) ?
$params['contribution']->receive_date
: date('YmdHis'),
3254 'total_amount' => $totalAmount,
3255 'fee_amount' => CRM_Utils_Array
::value('fee_amount', $params),
3256 'net_amount' => CRM_Utils_Array
::value('net_amount', $params, $totalAmount),
3257 'currency' => $params['contribution']->currency
,
3258 'trxn_id' => $params['contribution']->trxn_id
,
3259 'status_id' => $statusId,
3260 'payment_instrument_id' => CRM_Utils_Array
::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id
),
3261 'check_number' => CRM_Utils_Array
::value('check_number', $params),
3262 'pan_truncation' => CRM_Utils_Array
::value('pan_truncation', $params),
3263 'card_type_id' => CRM_Utils_Array
::value('card_type_id', $params),
3265 if ($contributionStatus == 'Refunded' ||
$contributionStatus == 'Chargeback' ||
$contributionStatus == 'Cancelled') {
3266 $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date
) ?
$params['contribution']->cancel_date
: date('YmdHis');
3267 if (isset($params['refund_trxn_id'])) {
3268 // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3269 $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3272 //CRM-16259, set is_payment flag for non pending status
3273 if (!in_array($contributionStatus, $pendingStatus)) {
3274 $trxnParams['is_payment'] = 1;
3276 if (!empty($params['payment_processor'])) {
3277 $trxnParams['payment_processor_id'] = $params['payment_processor'];
3280 if (isset($fromFinancialAccountId)) {
3281 $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3284 // consider external values passed for recording transaction entry
3285 if (!empty($financialTrxnValues)) {
3286 $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3288 if (empty($trxnParams['payment_processor_id'])) {
3289 unset($trxnParams['payment_processor_id']);
3292 $params['trxnParams'] = $trxnParams;
3294 if (!empty($params['prevContribution'])) {
3296 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount
;
3297 $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount
;
3298 $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount
;
3299 if (!isset($params['trxnParams']['trxn_id'])) {
3300 // Actually I have no idea why we are overwriting any values from the previous contribution.
3301 // (filling makes sense to me). However, only protecting this value as I really really know we
3302 // don't want this one overwritten.
3304 $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id
;
3306 $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id
;
3308 if (!(($params['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses)
3309 ||
$params['prevContribution']->contribution_status_id
== array_search('In Progress', $contributionStatuses))
3310 && $params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses))
3312 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3313 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3316 //if financial type is changed
3317 if (!empty($params['financial_type_id']) &&
3318 $params['contribution']->financial_type_id
!= $params['prevContribution']->financial_type_id
3320 $accountRelationship = 'Income Account is';
3321 if (!empty($params['revenue_recognition_date']) ||
$params['prevContribution']->revenue_recognition_date
) {
3322 $accountRelationship = 'Deferred Revenue Account is';
3324 $oldFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['prevContribution']->financial_type_id
, $accountRelationship);
3325 $newFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['financial_type_id'], $accountRelationship);
3326 if ($oldFinancialAccount != $newFinancialAccount) {
3327 $params['total_amount'] = 0;
3328 if (in_array($params['contribution']->contribution_status_id
, $pendingStatus)) {
3329 $params['trxnParams']['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount(
3330 $params['prevContribution']->financial_type_id
, $accountRelationship);
3333 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC');
3334 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3335 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3338 self
::updateFinancialAccounts($params, 'changeFinancialType');
3339 /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3340 $params['financial_account_id'] = $newFinancialAccount;
3341 $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3342 self
::updateFinancialAccounts($params);
3343 $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3345 $params['deferred_financial_account_id'] = $newFinancialAccount;
3349 //Update contribution status
3350 $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id
;
3351 if (!isset($params['refund_trxn_id'])) {
3352 // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3353 // gets preference over another so I am only 'protecting' a very specific tested flow
3354 // and letting natural justice take care of the rest.
3355 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3357 if (!empty($params['contribution_status_id']) &&
3358 $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3360 //Update Financial Records
3361 self
::updateFinancialAccounts($params, 'changedStatus');
3365 // change Payment Instrument for a Completed contribution
3366 // first handle special case when contribution is changed from Pending to Completed status when initial payment
3367 // instrument is null and now new payment instrument is added along with the payment
3368 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3369 $params['trxnParams']['check_number'] = CRM_Utils_Array
::value('check_number', $params);
3370 if (array_key_exists('payment_instrument_id', $params)) {
3371 $params['trxnParams']['total_amount'] = -$trxnParams['total_amount'];
3372 if (CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
) &&
3373 !CRM_Utils_System
::isNull($params['contribution']->payment_instrument_id
)
3375 //check if status is changed from Pending to Completed
3376 // do not update payment instrument changes for Pending to Completed
3377 if (!($params['contribution']->contribution_status_id
== array_search('Completed', $contributionStatuses) &&
3378 in_array($params['prevContribution']->contribution_status_id
, $pendingStatus))
3380 // for all other statuses create new financial records
3381 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3382 $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3383 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3387 elseif ((!CRM_Utils_System
::isNull($params['contribution']->payment_instrument_id
) ||
3388 !CRM_Utils_System
::isNull($params['prevContribution']->payment_instrument_id
)) &&
3389 $params['contribution']->payment_instrument_id
!= $params['prevContribution']->payment_instrument_id
3391 // for any other payment instrument changes create new financial records
3392 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3393 $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3394 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3397 elseif (!CRM_Utils_System
::isNull($params['contribution']->check_number
) &&
3398 $params['contribution']->check_number
!= $params['prevContribution']->check_number
3400 // another special case when check number is changed, create new financial records
3401 // create financial trxn with negative amount
3402 $params['trxnParams']['check_number'] = $params['prevContribution']->check_number
;
3403 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3404 // create financial trxn with positive amount
3405 $params['trxnParams']['check_number'] = $params['contribution']->check_number
;
3406 $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3407 self
::updateFinancialAccounts($params, 'changePaymentInstrument');
3412 //if Change contribution amount
3413 $params['trxnParams']['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
3414 $params['trxnParams']['net_amount'] = CRM_Utils_Array
::value('net_amount', $params);
3415 $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3416 $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id
;
3417 if (isset($totalAmount) &&
3418 $totalAmount != $params['prevContribution']->total_amount
3420 //Update Financial Records
3421 $params['trxnParams']['from_financial_account_id'] = NULL;
3422 self
::updateFinancialAccounts($params, 'changedAmount');
3427 // Looks like we might have a data correction update.
3428 // This would be a case where a transaction id has been entered but it is incorrect &
3429 // the person goes back in & fixes it, as opposed to a new transaction.
3430 // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3431 // the data fix scenario.
3433 if (isset($params['refund_trxn_id'])) {
3434 $refundIDs = CRM_Core_BAO_FinancialTrxn
::getRefundTransactionIDs($params['id']);
3435 if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3436 civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3439 $cardType = CRM_Utils_Array
::value('card_type_id', $params);
3440 $panTruncation = CRM_Utils_Array
::value('pan_truncation', $params);
3441 CRM_Core_BAO_FinancialTrxn
::updateCreditCardDetails($params['contribution']->id
, $panTruncation, $cardType);
3446 // records finanical trxn and entity financial trxn
3447 // also make it available as return value
3448 self
::recordAlwaysAccountsReceivable($trxnParams, $params);
3449 $trxnParams['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $params);
3450 $trxnParams['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $params);
3451 $return = $financialTxn = CRM_Core_BAO_FinancialTrxn
::create($trxnParams);
3452 $params['entity_id'] = $financialTxn->id
;
3453 if (empty($params['partial_payment_total']) && empty($params['partial_amount_pay'])) {
3454 self
::$_trxnIDs[] = $financialTxn->id
;
3458 // record line items and financial items
3459 if (empty($params['skipLineItem'])) {
3460 CRM_Price_BAO_LineItem
::processPriceSet($entityId, CRM_Utils_Array
::value('line_item', $params), $params['contribution'], $entityTable, $update);
3463 // create batch entry if batch_id is passed and
3464 // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3465 if (!empty($params['batch_id']) && !empty($financialTxn)) {
3466 $entityParams = array(
3467 'batch_id' => $params['batch_id'],
3468 'entity_table' => 'civicrm_financial_trxn',
3469 'entity_id' => $financialTxn->id
,
3471 CRM_Batch_BAO_Batch
::addBatchEntity($entityParams);
3474 // when a fee is charged
3475 if (!empty($params['fee_amount']) && (empty($params['prevContribution']) ||
$params['contribution']->fee_amount
!= $params['prevContribution']->fee_amount
) && $skipRecords) {
3476 CRM_Core_BAO_FinancialTrxn
::recordFees($params);
3479 if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3480 && $params['prevContribution']->contribution_status_id
!= $params['contribution']->contribution_status_id
3482 $eventID = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3483 $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level
);
3484 CRM_Event_BAO_Participant
::createDiscountTrxn($eventID, $params, $feeLevel);
3486 unset($params['line_item']);
3487 self
::$_trxnIDs = NULL;
3492 * Update all financial accounts entry.
3494 * @param array $params
3495 * Contribution object, line item array and params for trxn.
3497 * @param string $context
3501 public static function updateFinancialAccounts(&$params, $context = NULL) {
3503 $inputParams = $params;
3505 $currentContributionStatus = CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id
);
3506 $previousContributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['prevContribution']->contribution_status_id
, 'name');
3508 if (($previousContributionStatus == 'Pending'
3509 ||
$previousContributionStatus == 'In Progress')
3510 && $currentContributionStatus == 'Completed'
3511 && $context == 'changePaymentInstrument'
3515 if ((($previousContributionStatus == 'Partially paid'
3516 && $currentContributionStatus == 'Completed')
3517 ||
($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later
== TRUE
3518 && $currentContributionStatus == 'Partially paid'))
3519 && $context == 'changedStatus'
3523 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
3524 $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount
);
3526 if ($context == 'changedStatus') {
3527 if ($previousContributionStatus == 'Completed'
3528 && (self
::isContributionStatusNegative($params['contribution']->contribution_status_id
))
3531 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3532 if (empty($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3533 $creditNoteId = self
::createCreditNoteId();
3534 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3537 elseif (($previousContributionStatus == 'Pending'
3538 && $params['prevContribution']->is_pay_later
) ||
$previousContributionStatus == 'In Progress'
3540 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $params) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
3541 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
3543 if ($currentContributionStatus == 'Cancelled') {
3544 $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3545 $params['trxnParams']['total_amount'] = -$params['total_amount'];
3546 if (is_null($params['contribution']->creditnote_id
) ||
$params['contribution']->creditnote_id
== "null") {
3547 $creditNoteId = self
::createCreditNoteId();
3548 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id
, 'creditnote_id', $creditNoteId);
3552 $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3556 elseif ($context == 'changePaymentInstrument') {
3557 $params['trxnParams']['net_amount'] = $params['trxnParams']['total_amount'];
3558 $deferredFinancialAccount = CRM_Utils_Array
::value('deferred_financial_account_id', $params);
3559 if (empty($deferredFinancialAccount)) {
3560 $deferredFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($params['prevContribution']->financial_type_id
, 'Deferred Revenue Account is');
3562 $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($params['prevContribution']->id
, 'DESC', FALSE, NULL, $deferredFinancialAccount);
3563 if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3564 if ($params['total_amount'] != $params['trxnParams']['total_amount']) {
3565 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3566 $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id
;
3569 $params['trxnParams']['to_financial_account_id'] = $params['to_financial_account_id'];
3570 $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id
;
3575 if ($context == 'changedStatus') {
3576 if (($previousContributionStatus == 'Pending'
3577 ||
$previousContributionStatus == 'In Progress')
3578 && ($currentContributionStatus == 'Completed')
3580 if (empty($params['line_item'])) {
3582 //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3583 // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3584 // & this can be removed
3587 self
::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
3588 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3589 $params['entity_id'] = self
::$_trxnIDs[] = $trxn->id
;
3590 $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3591 $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3593 $entityParams = array(
3594 'entity_table' => 'civicrm_financial_item',
3596 foreach ($params['line_item'] as $fieldId => $fields) {
3597 foreach ($fields as $fieldValueId => $lineItemDetails) {
3599 1 => array(CRM_Core_PseudoConstant
::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'), 'Integer'),
3600 2 => array($lineItemDetails['id'], 'Integer'),
3602 CRM_Core_DAO
::executeQuery($query, $fparams);
3604 1 => array($lineItemDetails['id'], 'Integer'),
3606 $financialItem = CRM_Core_DAO
::executeQuery($sql, $fparams);
3607 while ($financialItem->fetch()) {
3608 $entityParams['entity_id'] = $financialItem->id
;
3609 $entityParams['amount'] = $financialItem->amount
;
3610 foreach (self
::$_trxnIDs as $tID) {
3611 $entityParams['financial_trxn_id'] = $tID;
3612 CRM_Financial_BAO_FinancialItem
::createEntityTrxn($entityParams);
3621 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params['trxnParams']);
3622 $params['entity_id'] = $trxn->id
;
3623 if ($context != 'changePaymentInstrument') {
3624 $itemParams['entity_table'] = 'civicrm_line_item';
3625 $trxnIds['id'] = $params['entity_id'];
3626 foreach ($params['line_item'] as $fieldId => $fields) {
3627 foreach ($fields as $fieldValueId => $lineItemDetails) {
3628 $prevFinancialItem = CRM_Financial_BAO_FinancialItem
::getPreviousFinancialItem($lineItemDetails['id']);
3629 $receiveDate = CRM_Utils_Date
::isoToMysql($params['prevContribution']->receive_date
);
3630 if ($params['contribution']->receive_date
) {
3631 $receiveDate = CRM_Utils_Date
::isoToMysql($params['contribution']->receive_date
);
3634 $financialAccount = self
::getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem['financial_account_id']);
3636 $currency = $params['prevContribution']->currency
;
3637 if ($params['contribution']->currency
) {
3638 $currency = $params['contribution']->currency
;
3641 $itemParams = array(
3642 'transaction_date' => $receiveDate,
3643 'contact_id' => $params['prevContribution']->contact_id
,
3644 'currency' => $currency,
3645 'amount' => self
::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund),
3646 'description' => $prevFinancialItem['description'],
3647 'status_id' => $prevFinancialItem['status_id'],
3648 'financial_account_id' => $financialAccount,
3649 'entity_table' => 'civicrm_line_item',
3650 'entity_id' => $lineItemDetails['id'],
3652 $financialItem = CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3653 $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
3654 $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id
;
3656 if ($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') {
3657 $invoiceSettings = Civi
::settings()->get('contribution_invoice_settings');
3658 $taxTerm = CRM_Utils_Array
::value('tax_term', $invoiceSettings);
3659 $itemParams['amount'] = self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $lineItemDetails['tax_amount'];
3660 $itemParams['description'] = $taxTerm;
3661 if ($lineItemDetails['financial_type_id']) {
3662 $itemParams['financial_account_id'] = self
::getFinancialAccountId($lineItemDetails['financial_type_id']);
3664 CRM_Financial_BAO_FinancialItem
::create($itemParams, NULL, $trxnIds);
3669 if ($context == 'changeFinancialType') {
3670 $params['skipLineItem'] = FALSE;
3671 foreach ($params['line_item'] as &$lineItems) {
3672 foreach ($lineItems as &$line) {
3673 $line['financial_type_id'] = $params['financial_type_id'];
3677 if ($context == 'changePaymentInstrument') {
3678 // store financial item Proportionaly.
3679 $trxnParams = array(
3680 'total_amount' => $trxn->total_amount
,
3681 'contribution_id' => $params['contribution']->id
,
3683 self
::assignProportionalLineItems($trxnParams, $trxn->id
, $params['prevContribution']->total_amount
);
3685 CRM_Core_BAO_FinancialTrxn
::createDeferredTrxn(CRM_Utils_Array
::value('line_item', $params), $params['contribution'], TRUE, $context);
3689 * Is this contribution status a reversal.
3691 * If so we would expect to record a negative value in the financial_trxn table.
3693 * @param int $status_id
3697 public static function isContributionStatusNegative($status_id) {
3698 $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3699 return in_array(CRM_Contribute_PseudoConstant
::contributionStatus($status_id, 'name'), $reversalStatuses);
3703 * Check status validation on update of a contribution.
3705 * @param array $values
3706 * Previous form values before submit.
3708 * @param array $fields
3709 * The input form values.
3711 * @param array $errors
3716 public static function checkStatusValidation($values, &$fields, &$errors) {
3717 if (CRM_Utils_System
::isNull($values) && !empty($fields['id'])) {
3718 $values['contribution_status_id'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3719 if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3723 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
3724 $checkStatus = array(
3725 'Cancelled' => array('Completed', 'Refunded'),
3726 'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3727 'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3728 'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3729 'Refunded' => array('Cancelled', 'Completed'),
3730 'Partially paid' => array('Completed'),
3733 if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3734 CRM_Utils_Array
::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3736 $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3737 1 => $contributionStatuses[$values['contribution_status_id']],
3738 2 => $contributionStatuses[$fields['contribution_status_id']],
3744 * Delete contribution of contact.
3748 * @param int $contactId
3752 public static function deleteContactContribution($contactId) {
3753 $contribution = new CRM_Contribute_DAO_Contribution();
3754 $contribution->contact_id
= $contactId;
3755 $contribution->find();
3756 while ($contribution->fetch()) {
3757 self
::deleteContribution($contribution->id
);
3762 * Get options for a given contribution field.
3763 * @see CRM_Core_DAO::buildOptions
3765 * @param string $fieldName
3766 * @param string $context see CRM_Core_DAO::buildOptionsContext.
3767 * @param array $props whatever is known about this dao object.
3769 * @return array|bool
3771 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3772 $className = __CLASS__
;
3774 if (isset($props['orderColumn'])) {
3775 $params['orderColumn'] = $props['orderColumn'];
3777 switch ($fieldName) {
3778 // This field is not part of this object but the api supports it
3779 case 'payment_processor':
3780 $className = 'CRM_Contribute_BAO_ContributionPage';
3781 // Filter results by contribution page
3782 if (!empty($props['contribution_page_id'])) {
3783 $page = civicrm_api('contribution_page', 'getsingle', array(
3785 'id' => ($props['contribution_page_id']),
3787 $types = (array) CRM_Utils_Array
::value('payment_processor', $page, 0);
3788 $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3792 // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3793 case 'honor_type_id':
3794 $className = 'CRM_Contribute_BAO_ContributionSoft';
3795 $fieldName = 'soft_credit_type_id';
3796 $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3799 return CRM_Core_PseudoConstant
::get($className, $fieldName, $params, $context);
3803 * Validate financial type.
3807 * @param int $financialTypeId
3808 * Financial Type id.
3810 * @param string $relationName
3812 * @return array|bool
3814 public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3815 $financialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, $relationName);
3817 if (!$financialAccount) {
3818 return CRM_Contribute_PseudoConstant
::financialType($financialTypeId);
3825 * Function to record additional payment for partial and refund contributions.
3827 * @param int $contributionId
3828 * is the invoice contribution id (got created after processing participant payment).
3829 * @param array $trxnsData
3830 * to take user provided input of transaction details.
3831 * @param string $paymentType
3832 * 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3833 * @param int $participantId
3834 * @param bool $updateStatus
3836 * @return null|object
3838 public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3839 $statusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3840 $getInfoOf['id'] = $contributionId;
3841 $defaults = array();
3842 $contributionDAO = CRM_Contribute_BAO_Contribution
::retrieve($getInfoOf, $defaults, CRM_Core_DAO
::$_nullArray);
3843 if (!$participantId) {
3844 $participantId = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_ParticipantPayment', $contributionId, 'participant_id', 'contribution_id');
3847 // build params for recording financial trxn entry
3848 $params['contribution'] = $contributionDAO;
3849 $params = array_merge($defaults, $params);
3850 $params['skipLineItem'] = TRUE;
3851 $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ?
$trxnsData['trxn_date'] : date('YmdHis');
3852 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contributionDAO->financial_type_id
, 'Accounts Receivable Account is');
3853 if ($paymentType == 'owed') {
3854 $params['partial_payment_total'] = $contributionDAO->total_amount
;
3855 $params['partial_amount_pay'] = $trxnsData['total_amount'];
3856 $trxnsData['net_amount'] = !empty($trxnsData['net_amount']) ?
$trxnsData['net_amount'] : $trxnsData['total_amount'];
3857 $params['pan_truncation'] = CRM_Utils_Array
::value('pan_truncation', $trxnsData);
3858 $params['card_type_id'] = CRM_Utils_Array
::value('card_type_id', $trxnsData);
3861 $financialTrxn = CRM_Contribute_BAO_Contribution
::recordFinancialAccounts($params, $trxnsData);
3862 $toFinancialAccount = $arAccountId;
3863 $trxnId = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id
);
3864 if (!empty($trxnId)) {
3865 $trxnId = $trxnId['trxn_id'];
3867 elseif (!empty($contributionDAO->payment_instrument_id
)) {
3868 $trxnId = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($contributionDAO->payment_instrument_id
);
3871 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3872 $queryParams = array(1 => array($relationTypeId, 'Integer'));
3873 $trxnId = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3877 // criteria for updates contribution total_amount == financial_trxns of partial_payments
3878 $sql = "SELECT SUM(ft.total_amount) as sum_of_payments, SUM(ft.net_amount) as net_amount_total
3879 FROM civicrm_financial_trxn ft
3880 LEFT JOIN civicrm_entity_financial_trxn eft
3881 ON (ft.id = eft.financial_trxn_id)
3882 WHERE eft.entity_table = 'civicrm_contribution'
3883 AND eft.entity_id = {$contributionId}
3884 AND ft.to_financial_account_id != {$toFinancialAccount}
3885 AND ft.status_id = {$statusId}
3887 $query = CRM_Core_DAO
::executeQuery($sql);
3889 $sumOfPayments = $query->sum_of_payments
;
3892 if ($contributionDAO->total_amount
== $sumOfPayments) {
3893 // update contribution status and
3894 // clean cancel info (if any) if prev. contribution was updated in case of 'Refunded' => 'Completed'
3895 $contributionDAO->contribution_status_id
= $statusId;
3896 $contributionDAO->cancel_date
= 'null';
3897 $contributionDAO->cancel_reason
= NULL;
3898 $netAmount = !empty($trxnsData['net_amount']) ?
NULL : $trxnsData['total_amount'];
3899 $contributionDAO->net_amount
= $query->net_amount_total +
$netAmount;
3900 $contributionDAO->fee_amount
= $contributionDAO->total_amount
- $contributionDAO->net_amount
;
3901 $contributionDAO->save();
3903 //Change status of financial record too
3904 $financialTrxn->status_id
= $statusId;
3905 $financialTrxn->save();
3907 // note : not using the self::add method,
3908 // the reason because it performs 'status change' related code execution for financial records
3909 // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
3910 // are coded below i.e. just updating financial_item status to 'Paid'
3912 if ($participantId) {
3913 // update participant status
3914 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
3915 $ids = CRM_Event_BAO_Participant
::getParticipantIds($contributionId);
3916 foreach ($ids as $val) {
3917 $participantUpdate['id'] = $val;
3918 $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3919 CRM_Event_BAO_Participant
::add($participantUpdate);
3923 // update financial item statuses
3924 $financialItemStatus = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3925 $paidStatus = array_search('Paid', $financialItemStatus);
3927 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
3928 $sqlFinancialItemUpdate = "
3929 UPDATE civicrm_financial_item fi
3930 LEFT JOIN civicrm_entity_financial_trxn eft
3931 ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
3932 SET status_id = {$paidStatus}
3933 WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
3935 CRM_Core_DAO
::executeQuery($sqlFinancialItemUpdate);
3938 elseif ($paymentType == 'refund') {
3939 $trxnsData['total_amount'] = -$trxnsData['total_amount'];
3940 $trxnsData['from_financial_account_id'] = $arAccountId;
3941 $trxnsData['status_id'] = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Refunded');
3943 $financialTrxn = CRM_Contribute_BAO_Contribution
::recordFinancialAccounts($params, $trxnsData);
3945 // note : not using the self::add method,
3946 // the reason because it performs 'status change' related code execution for financial records
3947 // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
3948 // are coded below i.e. just updating financial_item status to 'Paid'
3949 if ($updateStatus) {
3950 $contributionDetails = CRM_Core_DAO
::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3952 // add financial item entry
3953 $financialItemStatus = CRM_Core_PseudoConstant
::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3954 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionDAO->id
);
3955 if (!empty($lineItems)) {
3956 foreach ($lineItems as $lineItemId => $lineItemValue) {
3957 $paid = $lineItemValue['line_total'] * ($financialTrxn->total_amount
/ $contributionDAO->total_amount
);
3958 $addFinancialEntry = array(
3959 'transaction_date' => $financialTrxn->trxn_date
,
3960 'contact_id' => $contributionDAO->contact_id
,
3961 'amount' => round($paid, 2),
3962 'status_id' => array_search('Paid', $financialItemStatus),
3963 'entity_id' => $lineItemId,
3964 'entity_table' => 'civicrm_line_item',
3966 $trxnIds['id'] = $financialTrxn->id
;
3967 CRM_Financial_BAO_FinancialItem
::create($addFinancialEntry, NULL, $trxnIds);
3970 if ($participantId) {
3971 // update participant status
3972 $participantStatuses = CRM_Event_PseudoConstant
::participantStatus();
3973 $ids = CRM_Event_BAO_Participant
::getParticipantIds($contributionId);
3974 foreach ($ids as $val) {
3975 $participantUpdate['id'] = $val;
3976 $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3977 CRM_Event_BAO_Participant
::add($participantUpdate);
3982 // activity creation
3983 if (!empty($financialTrxn)) {
3984 if ($participantId) {
3985 $inputParams['id'] = $participantId;
3988 $component = 'event';
3989 $entityObj = CRM_Event_BAO_Participant
::getValues($inputParams, $values, $ids);
3990 $entityObj = $entityObj[$participantId];
3993 $entityObj = $contributionDAO;
3994 $component = 'contribution';
3996 $activityType = ($paymentType == 'refund') ?
'Refund' : 'Payment';
3998 self
::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
3999 return $financialTrxn;
4007 * @param $activityType
4009 * @param int $contributionId
4011 * @throws CRM_Core_Exception
4013 public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
4014 if ($component == 'event') {
4015 $title = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id
, 'title');
4018 $title = ts('Contribution');
4020 $paymentAmount = CRM_Utils_Money
::format($trxnObj->total_amount
, $trxnObj->currency
);
4021 $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
4022 $date = CRM_Utils_Date
::isoToMysql($trxnObj->trxn_date
);
4023 $targetCid = $entityObj->contact_id
;
4024 // source record id would be the contribution id
4025 $srcRecId = $contributionId;
4028 $activityParams = array(
4029 'source_contact_id' => $targetCid,
4030 'source_record_id' => $srcRecId,
4031 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
4032 'subject' => $subject,
4033 'activity_date_time' => $date,
4034 'status_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
4035 'skipRecentView' => TRUE,
4038 // create activity with target contacts
4039 $session = CRM_Core_Session
::singleton();
4040 $id = $session->get('userID');
4042 $activityParams['source_contact_id'] = $id;
4043 $activityParams['target_contact_id'][] = $targetCid;
4046 CRM_Activity_BAO_Activity
::create($activityParams);
4050 * Get list of payments displayed by Contribute_Page_PaymentInfo.
4054 * @param bool $getTrxnInfo
4055 * @param bool $usingLineTotal
4059 public static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
4060 if ($component == 'event') {
4061 $entity = 'participant';
4062 $entityTable = 'civicrm_participant';
4063 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
4065 if (!$contributionId) {
4066 if ($primaryParticipantId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
4067 $contributionId = CRM_Core_DAO
::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
4068 $id = $primaryParticipantId;
4070 if (!$contributionId) {
4076 $contributionId = $id;
4077 $entity = 'contribution';
4078 $entityTable = 'civicrm_contribution';
4081 $total = CRM_Core_BAO_FinancialTrxn
::getBalanceTrxnAmt($contributionId);
4082 $baseTrxnId = !empty($total['trxn_id']) ?
$total['trxn_id'] : NULL;
4084 $baseTrxnId = CRM_Core_BAO_FinancialTrxn
::getFinancialTrxnId($contributionId);
4085 $baseTrxnId = $baseTrxnId['financialTrxnId'];
4087 if (!CRM_Utils_Array
::value('total_amount', $total) ||
$usingLineTotal) {
4088 $total = CRM_Price_BAO_LineItem
::getLineTotal($contributionId);
4091 $baseTrxnId = $total['trxn_id'];
4092 $total = $total['total_amount'];
4095 $paymentBalance = CRM_Core_BAO_FinancialTrxn
::getPartialPaymentWithType($id, $entity, FALSE, $total);
4096 $contributionIsPayLater = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'is_pay_later');
4098 $financialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4099 $feeFinancialAccount = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeId, 'Expense Account is');
4101 if ($paymentBalance == 0 && $contributionIsPayLater) {
4102 $paymentBalance = $total;
4105 $info['total'] = $total;
4106 $info['paid'] = $total - $paymentBalance;
4107 $info['balance'] = $paymentBalance;
4109 $info['component'] = $component;
4110 $info['payLater'] = $contributionIsPayLater;
4112 if ($getTrxnInfo && $baseTrxnId) {
4113 // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
4115 SELECT GROUP_CONCAT(fa.`name`) as financial_account,
4117 ft.payment_instrument_id,
4118 ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id
4120 FROM civicrm_contribution con
4121 LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4122 INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4123 AND ft.to_financial_account_id != %2
4124 LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4125 LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4126 LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4128 WHERE con.id = %1 AND ft.is_payment = 1
4130 $queryParams = array(
4131 1 => array($contributionId, 'Integer'),
4132 2 => array($feeFinancialAccount, 'Integer'),
4134 $resultDAO = CRM_Core_DAO
::executeQuery($sql, $queryParams);
4135 $statuses = CRM_Contribute_PseudoConstant
::contributionStatus();
4137 while ($resultDAO->fetch()) {
4138 $paidByLabel = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4139 $paidByName = CRM_Core_PseudoConstant
::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id
);
4140 if ($resultDAO->card_type_id
) {
4141 $creditCardType = CRM_Core_PseudoConstant
::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id
);
4142 $pantruncation = '';
4143 if ($resultDAO->pan_truncation
) {
4144 $pantruncation = ": {$resultDAO->pan_truncation}";
4146 $paidByLabel .= " ({$creditCardType}{$pantruncation})";
4149 'total_amount' => $resultDAO->total_amount
,
4150 'financial_type' => $resultDAO->financial_account
,
4151 'payment_instrument' => $paidByLabel,
4152 'receive_date' => $resultDAO->trxn_date
,
4153 'trxn_id' => $resultDAO->trxn_id
,
4154 'status' => $statuses[$resultDAO->status_id
],
4155 'currency' => $resultDAO->currency
,
4157 if ($paidByName == 'Check') {
4158 $val['check_number'] = $resultDAO->check_number
;
4162 $info['transaction'] = $rows;
4168 * Get financial account id has 'Sales Tax Account is' account relationship with financial type.
4170 * @param int $financialTypeId
4173 * Financial Account Id
4175 public static function getFinancialAccountId($financialTypeId) {
4176 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
4177 $searchParams = array(
4178 'entity_table' => 'civicrm_financial_type',
4179 'entity_id' => $financialTypeId,
4180 'account_relationship' => $accountRel,
4183 CRM_Financial_BAO_FinancialTypeAccount
::retrieve($searchParams, $result);
4185 return CRM_Utils_Array
::value('financial_account_id', $result);
4189 * Get the tax amount (misnamed function).
4191 * @param array $params
4192 * @param bool $isLineItem
4196 public static function checkTaxAmount($params, $isLineItem = FALSE) {
4197 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
4199 // Update contribution.
4200 if (!empty($params['id'])) {
4201 // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4202 // there are no tax implications - early return.
4203 if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4206 if (empty($params['prevContribution'])) {
4207 $params['prevContribution'] = self
::getOriginalContribution($params['id']);
4210 foreach (array('total_amount', 'financial_type_id', 'fee_amount') as $field) {
4211 if (!isset($params[$field])) {
4212 if ($field == 'total_amount' && $params['prevContribution']->tax_amount
) {
4213 // Tax amount gets added back on later....
4214 $params['total_amount'] = $params['prevContribution']->total_amount
-
4215 $params['prevContribution']->tax_amount
;
4218 $params[$field] = $params['prevContribution']->$field;
4219 if ($params[$field] != $params['prevContribution']->$field) {
4225 self
::calculateMissingAmountParams($params, $params['id']);
4226 if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4227 // Assign tax Amount on update of contribution
4228 if (!empty($params['prevContribution']->tax_amount
)) {
4229 $params['tax_amount'] = 'null';
4230 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4231 foreach ($params['line_item'] as $setID => $priceField) {
4232 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4233 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4240 // New Contribution and update of contribution with tax rate financial type
4241 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4242 empty($params['skipLineItem']) && !$isLineItem
4244 $taxRateParams = $taxRates[$params['financial_type_id']];
4245 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount(CRM_Utils_Array
::value('total_amount', $params), $taxRateParams);
4246 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4248 // Get Line Item on update of contribution
4249 if (isset($params['id'])) {
4250 CRM_Price_BAO_LineItem
::getLineItemArray($params, array($params['id']));
4253 CRM_Price_BAO_LineItem
::getLineItemArray($params);
4255 foreach ($params['line_item'] as $setID => $priceField) {
4256 foreach ($priceField as $priceFieldID => $priceFieldValue) {
4257 $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4260 $params['total_amount'] = CRM_Utils_Array
::value('total_amount', $params) +
$params['tax_amount'];
4262 elseif (isset($params['api.line_item.create'])) {
4263 // Update total amount of contribution using lineItem
4264 $taxAmountArray = array();
4265 foreach ($params['api.line_item.create'] as $key => $value) {
4266 if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4267 $taxRate = $taxRates[$value['financial_type_id']];
4268 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($value['line_total'], $taxRate);
4269 $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4272 $params['tax_amount'] = array_sum($taxAmountArray);
4273 $params['total_amount'] = $params['total_amount'] +
$params['tax_amount'];
4276 // update line item of contrbution
4277 if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4278 $taxRate = $taxRates[$params['financial_type_id']];
4279 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($params['line_total'], $taxRate);
4280 $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4287 * Check financial type validation on update of a contribution.
4289 * @param Integer $financialTypeId
4290 * Value of latest Financial Type.
4292 * @param Integer $contributionId
4295 * @param array $errors
4300 public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4301 if (!empty($financialTypeId)) {
4302 $oldFinancialTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4303 if ($oldFinancialTypeId == $financialTypeId) {
4307 $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4309 '1' => array($contributionId, 'Integer'),
4311 $result = CRM_Core_DAO
::executeQuery($sql, $params);
4312 if ($result->N
> 1) {
4313 $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.');
4318 * Update related pledge payment payments.
4320 * This function has been refactored out of the back office contribution form and may
4321 * still overlap with other functions.
4323 * @param string $action
4324 * @param int $pledgePaymentID
4325 * @param int $contributionID
4326 * @param bool $adjustTotalAmount
4327 * @param float $total_amount
4328 * @param float $original_total_amount
4329 * @param int $contribution_status_id
4330 * @param int $original_contribution_status_id
4332 public static function updateRelatedPledge(
4338 $original_total_amount,
4339 $contribution_status_id,
4340 $original_contribution_status_id
4342 if (!$pledgePaymentID && $action & CRM_Core_Action
::ADD
&& !$contributionID) {
4346 if ($pledgePaymentID) {
4347 //store contribution id in payment record.
4348 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4351 $pledgePaymentID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4358 if (!$pledgePaymentID) {
4361 $pledgeID = CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4367 $updatePledgePaymentStatus = FALSE;
4369 // If either the status or the amount has changed we update the pledge status.
4370 if ($action & CRM_Core_Action
::ADD
) {
4371 $updatePledgePaymentStatus = TRUE;
4373 elseif ($action & CRM_Core_Action
::UPDATE
&& (($original_contribution_status_id != $contribution_status_id) ||
4374 ($original_total_amount != $total_amount))
4376 $updatePledgePaymentStatus = TRUE;
4379 if ($updatePledgePaymentStatus) {
4380 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeID,
4381 array($pledgePaymentID),
4382 $contribution_status_id,
4391 * Compute the stats values
4393 * @param string $stat either 'mode' or 'median'
4394 * @param string $sql
4395 * @param string $alias of civicrm_contribution
4397 * @return array|null
4399 public static function computeStats($stat, $sql, $alias = NULL) {
4400 $mode = $median = array();
4403 $modeDAO = CRM_Core_DAO
::executeQuery($sql);
4404 while ($modeDAO->fetch()) {
4405 if ($modeDAO->civicrm_contribution_total_amount_count
> 1) {
4406 $mode[] = CRM_Utils_Money
::format($modeDAO->amount
, $modeDAO->currency
);
4415 $currencies = CRM_Core_OptionGroup
::values('currencies_enabled');
4416 foreach ($currencies as $currency => $val) {
4418 $where = "AND {$alias}.currency = '{$currency}'";
4419 $rowCount = CRM_Core_DAO
::singleValueQuery("SELECT count(*) as count {$sql} {$where}");
4423 $medianRow = floor($rowCount / 2);
4424 if ($rowCount %
2 == 0 && !empty($medianRow)) {
4430 $medianValue = "SELECT {$alias}.total_amount as median
4432 ORDER BY median LIMIT {$medianRow},{$offset}";
4433 $medianValDAO = CRM_Core_DAO
::executeQuery($medianValue);
4434 while ($medianValDAO->fetch()) {
4436 $midValue = $midValue +
$medianValDAO->median
;
4439 $median[] = CRM_Utils_Money
::format($medianValDAO->median
, $currency);
4443 $midValue = $midValue / 2;
4444 $median[] = CRM_Utils_Money
::format($midValue, $currency);
4455 * Is there only one line item attached to the contribution.
4461 * @throws \CiviCRM_API3_Exception
4463 public static function isSingleLineItem($id) {
4464 $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4465 return ($lineItemCount == 1);
4469 * Complete an order.
4471 * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4473 * Currently overloaded to complete a transaction & repeat a transaction - fix!
4475 * Moving it out of the BaseIPN class is just the first step.
4477 * @param array $input
4479 * @param array $objects
4480 * @param CRM_Core_Transaction $transaction
4482 * @param CRM_Contribute_BAO_Contribution $contribution
4486 public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution) {
4487 $primaryContributionID = isset($contribution->id
) ?
$contribution->id
: $objects['first_contribution']->id
;
4488 // The previous details are used when calculating line items so keep it before any code that 'does something'
4489 if (!empty($contribution->id
)) {
4490 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues(array('id' => $contribution->id
),
4491 CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
4493 $inputContributionWhiteList = array(
4498 'payment_instrument_id',
4503 'contribution_status_id',
4507 if (self
::isSingleLineItem($primaryContributionID)) {
4508 $inputContributionWhiteList[] = 'financial_type_id';
4511 $participant = CRM_Utils_Array
::value('participant', $objects);
4512 $memberships = CRM_Utils_Array
::value('membership', $objects);
4513 $recurContrib = CRM_Utils_Array
::value('contributionRecur', $objects);
4514 $recurringContributionID = (empty($recurContrib->id
)) ?
NULL : $recurContrib->id
;
4515 $event = CRM_Utils_Array
::value('event', $objects);
4517 $paymentProcessorId = '';
4518 if (isset($objects['paymentProcessor'])) {
4519 if (is_array($objects['paymentProcessor'])) {
4520 $paymentProcessorId = $objects['paymentProcessor']['id'];
4523 $paymentProcessorId = $objects['paymentProcessor']->id
;
4527 $completedContributionStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4529 $contributionParams = array_merge(array(
4530 'contribution_status_id' => $completedContributionStatusID,
4531 'source' => self
::getRecurringContributionDescription($contribution, $event),
4532 ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4534 $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4536 // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4537 // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4538 if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'])) {
4539 $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects
['paymentProcessor']['payment_instrument_id'];
4542 if ($recurringContributionID) {
4543 $contributionParams['contribution_recur_id'] = $recurringContributionID;
4545 $changeDate = CRM_Utils_Array
::value('trxn_date', $input, date('YmdHis'));
4547 if (empty($contributionParams['receive_date']) && $changeDate) {
4548 $contributionParams['receive_date'] = $changeDate;
4551 self
::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4552 $contributionParams['financial_type_id'] = $contribution->financial_type_id
;
4554 if (is_numeric($memberships)) {
4555 $memberships = array($objects['membership']);
4559 if (isset($input['is_email_receipt'])) {
4560 $values['is_email_receipt'] = $input['is_email_receipt'];
4563 if ($input['component'] == 'contribute') {
4564 if ($contribution->contribution_page_id
) {
4565 // Figure out what we gain from this.
4566 // Note that we may have overwritten the is_email_receipt input, fix that below.
4567 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
4569 elseif ($recurContrib && $recurringContributionID) {
4570 $values['amount'] = $recurContrib->amount
;
4571 $values['financial_type_id'] = $objects['contributionType']->id
;
4572 $values['title'] = $source = ts('Offline Recurring Contribution');
4575 if (isset($input['is_email_receipt'])) {
4576 // CRM-19601 - we may have overwritten this above.
4577 $values['is_email_receipt'] = $input['is_email_receipt'];
4579 elseif ($recurContrib && $recurringContributionID) {
4580 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4581 // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4582 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
4585 if (!empty($memberships)) {
4586 foreach ($memberships as $membershipTypeIdKey => $membership) {
4588 $membershipParams = array(
4589 'id' => $membership->id
,
4590 'contact_id' => $membership->contact_id
,
4591 'is_test' => $membership->is_test
,
4592 'membership_type_id' => $membership->membership_type_id
,
4595 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membershipParams['contact_id'],
4596 $membershipParams['membership_type_id'],
4597 $membershipParams['is_test'],
4598 $membershipParams['id']
4601 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
4602 // this picks up membership type changes during renewals
4603 // @todo this is almost certainly an obsolete sql call, the pre-change
4604 // membership is accessible via $this->_relatedObjects
4606 SELECT membership_type_id
4607 FROM civicrm_membership_log
4608 WHERE membership_id={$membershipParams['id']}
4611 $dao = CRM_Core_DAO
::executeQuery($sql);
4612 if ($dao->fetch()) {
4613 if (!empty($dao->membership_type_id
)) {
4614 $membershipParams['membership_type_id'] = $dao->membership_type_id
;
4619 if (CRM_Core_PseudoConstant
::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', CRM_Utils_Array
::value('contribution_status_id', $input)) === 'Pending') {
4620 $membershipParams['num_terms'] = 0;
4623 $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
4624 $membershipParams['membership_type_id'],
4625 $primaryContributionID
4627 // @todo remove all this stuff in favour of letting the api call further down handle in
4628 // (it is a duplication of what the api does).
4629 $dates = array_fill_keys(array('join_date', 'start_date', 'end_date'), NULL);
4630 if ($currentMembership) {
4632 * Fixed FOR CRM-4433
4633 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
4634 * when Contribution mode is notify and membership is for renewal )
4636 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
4638 // @todo - we should pass membership_type_id instead of null here but not
4639 // adding as not sure of testing
4640 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membershipParams['id'],
4641 $changeDate, NULL, $membershipParams['num_terms']
4644 $dates['join_date'] = $currentMembership['join_date'];
4647 //get the status for membership.
4648 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
4650 $dates['join_date'],
4653 $membershipParams['membership_type_id'],
4657 unset($dates['end_date']);
4658 $membershipParams['status_id'] = CRM_Utils_Array
::value('id', $calcStatus, 'New');
4659 //we might be renewing membership,
4660 //so make status override false.
4661 $membershipParams['is_override'] = FALSE;
4663 //CRM-17723 - reset static $relatedContactIds array()
4664 // @todo move it to Civi Statics.
4666 CRM_Member_BAO_Membership
::createRelatedMemberships($var, $var, TRUE);
4667 civicrm_api3('Membership', 'create', $membershipParams);
4673 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4674 if ($event->is_email_confirm
) {
4675 // @todo this should be set by the function that sends the mail after sending.
4676 $contributionParams['receipt_date'] = $changeDate;
4678 $participantParams['id'] = $participant->id
;
4679 $participantParams['status_id'] = 'Registered';
4680 civicrm_api3('Participant', 'create', $participantParams);
4684 $contributionParams['id'] = $contribution->id
;
4686 // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4687 // unsetting it here does NOT cause any other contribution test to fail!
4688 unset($contributionParams['financial_type_id']);
4689 $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4691 // Add new soft credit against current $contribution.
4692 if (CRM_Utils_Array
::value('contributionRecur', $objects) && $objects['contributionRecur']->id
) {
4693 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
4696 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4697 'labelColumn' => 'name',
4700 if (isset($input['prevContribution']) && (!$input['prevContribution']->is_pay_later
&& $input['prevContribution']->contribution_status_id
== $contributionStatuses['Pending'])) {
4701 $input['payment_processor'] = $paymentProcessorId;
4704 if (!empty($contribution->_relatedObjects
['participant'])) {
4705 $input['contribution_mode'] = 'participant';
4706 $input['participant_id'] = $contribution->_relatedObjects
['participant']->id
;
4708 elseif (!empty($contribution->_relatedObjects
['membership'])) {
4709 $input['contribution_mode'] = 'membership';
4710 $contribution->contribution_status_id
= $contributionParams['contribution_status_id'];
4711 $contribution->trxn_id
= CRM_Utils_Array
::value('trxn_id', $input);
4712 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
4715 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
4716 $transaction->commit();
4718 CRM_Contribute_BAO_ContributionRecur
::updateRecurLinkedPledge($contribution->id
, $recurringContributionID,
4719 $contributionParams['contribution_status_id'], $input['amount']);
4721 // create an activity record
4722 if ($input['component'] == 'contribute') {
4724 $targetContactID = NULL;
4725 if (!empty($ids['related_contact'])) {
4726 $targetContactID = $contribution->contact_id
;
4727 $contribution->contact_id
= $ids['related_contact'];
4729 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
4732 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4733 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4734 if (!array_key_exists('is_email_receipt', $values) ||
4735 $values['is_email_receipt'] == 1
4737 civicrm_api3('Contribution', 'sendconfirmation', array(
4738 'id' => $contribution->id
,
4739 'payment_processor_id' => $paymentProcessorId,
4741 CRM_Core_Error
::debug_log_message("Receipt sent");
4744 CRM_Core_Error
::debug_log_message("Success: Database updated");
4745 return $contributionResult;
4749 * Send receipt from contribution.
4751 * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4753 * Note that the compose message part has been moved to contribution
4754 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4756 * @param array $input
4757 * Incoming data from Payment processor.
4759 * Related object IDs.
4760 * @param int $contributionID
4761 * @param array $values
4762 * Values related to objects that have already been loaded.
4763 * @param bool $returnMessageText
4764 * Should text be returned instead of sent. This.
4765 * is because the function is also used to generate pdfs
4768 * @throws \CRM_Core_Exception
4769 * @throws \CiviCRM_API3_Exception
4771 public static function sendMail(&$input, &$ids, $contributionID, &$values,
4772 $returnMessageText = FALSE) {
4774 $contribution = new CRM_Contribute_BAO_Contribution();
4775 $contribution->id
= $contributionID;
4776 if (!$contribution->find(TRUE)) {
4777 throw new CRM_Core_Exception('Contribution does not exist');
4779 $contribution->loadRelatedObjects($input, $ids, TRUE);
4780 // set receipt from e-mail and name in value
4781 if (!$returnMessageText) {
4782 list($values['receipt_from_name'], $values['receipt_from_email']) = self
::generateFromEmailAndName($input, $contribution);
4784 $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4785 // Contribution ID should really always be set. But ?
4786 if (!$returnMessageText && (!isset($input['receipt_update']) ||
$input['receipt_update']) && empty($contribution->receipt_date
)) {
4787 civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id
));
4793 * Generate From email and from name in an array values
4795 public static function generateFromEmailAndName($input, $contribution) {
4796 // Use input valuse if supplied.
4797 if (!empty($input['receipt_from_email'])) {
4798 return array(CRM_Utils_array
::value('receipt_from_name', $input, ''), $input['receipt_from_email']);
4800 // if we are still empty see if we can use anything from a contribution page.
4801 $pageValues = array();
4802 if (!empty($contribution->contribution_page_id
)) {
4803 $pageValues = civicrm_api3('ContributionPage', 'getsingle', array('id' => $contribution->contribution_page_id
));
4805 // if we are still empty see if we can use anything from a contribution page.
4806 if (!empty($pageValues['receipt_from_email'])) {
4807 return array($pageValues['receipt_from_name'], $pageValues['receipt_from_email']);
4809 // If we are still empty fall back to the domain or logged in user information.
4810 return CRM_Core_BAO_Domain
::getDefaultReceiptFrom();
4814 * Generate credit note id with next avaible number
4819 public static function createCreditNoteId() {
4820 $prefixValue = Civi
::settings()->get('contribution_invoice_settings');
4822 $creditNoteNum = CRM_Core_DAO
::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution");
4823 $creditNoteId = NULL;
4827 $creditNoteId = CRM_Utils_Array
::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4828 $result = civicrm_api3('Contribution', 'getcount', array(
4830 'creditnote_id' => $creditNoteId,
4832 } while ($result > 0);
4834 return $creditNoteId;
4838 * Load related memberships.
4840 * Note that in theory it should be possible to retrieve these from the line_item table
4841 * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4842 * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4843 * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4844 * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4846 * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4852 public function loadRelatedMembershipObjects(&$ids) {
4854 SELECT membership_id
4855 FROM civicrm_membership_payment
4856 WHERE contribution_id = %1 ";
4857 $params = array(1 => array($this->id
, 'Integer'));
4858 $ids['membership'] = (array) CRM_Utils_Array
::value('membership', $ids, array());
4860 $dao = CRM_Core_DAO
::executeQuery($query, $params);
4861 while ($dao->fetch()) {
4862 if ($dao->membership_id
&& !in_array($dao->membership_id
, $ids['membership'])) {
4863 $ids['membership'][$dao->membership_id
] = $dao->membership_id
;
4867 if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4868 foreach ($ids['membership'] as $id) {
4870 $membership = new CRM_Member_BAO_Membership();
4871 $membership->id
= $id;
4872 if (!$membership->find(TRUE)) {
4873 throw new Exception("Could not find membership record: $id");
4875 $membership->join_date
= CRM_Utils_Date
::isoToMysql($membership->join_date
);
4876 $membership->start_date
= CRM_Utils_Date
::isoToMysql($membership->start_date
);
4877 $membership->end_date
= CRM_Utils_Date
::isoToMysql($membership->end_date
);
4878 $this->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
4879 $membership->free();
4886 * This function is used to record partial payments for contribution
4888 * @param array $contribution
4890 * @param array $params
4894 public static function recordPartialPayment($contribution, $params) {
4895 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
4896 $pendingStatus = array(
4897 array_search('Pending', $contributionStatuses),
4898 array_search('In Progress', $contributionStatuses),
4900 $statusId = array_search('Completed', $contributionStatuses);
4901 if (in_array(CRM_Utils_Array
::value('contribution_status_id', $contribution), $pendingStatus)) {
4902 $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
4904 elseif (!empty($params['payment_processor'])) {
4905 $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['payment_processor'], NULL, 'civicrm_payment_processor');
4907 elseif (!empty($params['payment_instrument_id'])) {
4908 $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount
::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
4911 $relationTypeId = key(CRM_Core_PseudoConstant
::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
4912 $queryParams = array(1 => array($relationTypeId, 'Integer'));
4913 $balanceTrxnParams['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);
4915 $fromFinancialAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
4916 $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4917 $balanceTrxnParams['total_amount'] = $params['total_amount'];
4918 $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4919 $balanceTrxnParams['trxn_date'] = !empty($params['contribution_receive_date']) ?
$params['contribution_receive_date'] : date('YmdHis');
4920 $balanceTrxnParams['fee_amount'] = CRM_Utils_Array
::value('fee_amount', $params);
4921 $balanceTrxnParams['net_amount'] = CRM_Utils_Array
::value('total_amount', $params);
4922 $balanceTrxnParams['currency'] = $contribution['currency'];
4923 $balanceTrxnParams['trxn_id'] = CRM_Utils_Array
::value('contribution_trxn_id', $params, NULL);
4924 $balanceTrxnParams['status_id'] = $statusId;
4925 $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array
::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4926 $balanceTrxnParams['check_number'] = CRM_Utils_Array
::value('check_number', $params);
4927 if ($fromFinancialAccountId != NULL &&
4928 ($statusId == array_search('Completed', $contributionStatuses) ||
$statusId == array_search('Partially paid', $contributionStatuses))
4930 $balanceTrxnParams['is_payment'] = 1;
4932 if (!empty($params['payment_processor'])) {
4933 $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4935 return CRM_Core_BAO_FinancialTrxn
::create($balanceTrxnParams);
4939 * Get the description (source field) for the recurring contribution.
4941 * @param CRM_Contribute_BAO_Contribution $contribution
4942 * @param CRM_Event_DAO_Event|null $event
4945 * @throws \CiviCRM_API3_Exception
4947 protected static function getRecurringContributionDescription($contribution, $event) {
4948 if (!empty($contribution->source
)) {
4949 return $contribution->source
;
4951 elseif (!empty($contribution->contribution_page_id
) && is_numeric($contribution->contribution_page_id
)) {
4952 $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4953 'id' => $contribution->contribution_page_id
,
4954 'return' => 'title',
4956 return ts('Online Contribution') . ': ' . $contributionPageTitle;
4959 return ts('Online Event Registration') . ': ' . $event->title
;
4961 elseif (!empty($contribution->contribution_recur_id
)) {
4962 return 'recurring contribution';
4968 * Function to add payments for contribution
4969 * for Partially Paid status
4971 * @param array $contributions
4972 * @param array $contributionStatusId
4975 public static function addPayments($contributions, $contributionStatusId = NULL) {
4976 // get financial trxn which is a payment
4977 $ftSql = "SELECT ft.id, ft.total_amount
4978 FROM civicrm_financial_trxn ft
4979 INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4980 WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4981 $contributionStatus = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4982 'labelColumn' => 'name',
4984 foreach ($contributions as $k => $contribution) {
4985 if (!($contributionStatus[$contribution->contribution_status_id
] == 'Partially paid'
4986 || CRM_Utils_Array
::value($contributionStatusId, $contributionStatus) == 'Partially paid')
4990 $ftDao = CRM_Core_DAO
::executeQuery($ftSql, array(1 => array($contribution->id
, 'Integer')));
4993 // store financial item Proportionaly.
4994 $trxnParams = array(
4995 'total_amount' => $ftDao->total_amount
,
4996 'contribution_id' => $contribution->id
,
4998 self
::assignProportionalLineItems($trxnParams, $ftDao->id
, $contribution->total_amount
);
5003 * Function use to store line item proportionaly in
5004 * in entity financial trxn table
5006 * @param array $trxnParams
5008 * @param Integer $trxnId
5010 * @param float $contributionTotalAmount
5013 public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
5014 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($trxnParams['contribution_id']);
5015 if (!empty($lineItems)) {
5016 // get financial item
5017 list($ftIds, $taxItems) = self
::getLastFinancialItemIds($trxnParams['contribution_id']);
5018 $entityParams = array(
5019 'contribution_total_amount' => $contributionTotalAmount,
5020 'trxn_total_amount' => $trxnParams['total_amount'],
5021 'trxn_id' => $trxnId,
5023 self
::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
5028 * Function to check line items.
5030 * @param array $params
5031 * array of order params.
5033 * @throws \API_Exception
5035 public static function checkLineItems(&$params) {
5036 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
5037 $lineItemAmount = 0;
5038 foreach ($params['line_items'] as &$lineItems) {
5039 foreach ($lineItems['line_item'] as &$item) {
5040 if (empty($item['financial_type_id'])) {
5041 $item['financial_type_id'] = $params['financial_type_id'];
5043 $lineItemAmount +
= $item['line_total'];
5046 if (!isset($totalAmount)) {
5047 $params['total_amount'] = $lineItemAmount;
5049 elseif ($totalAmount != $lineItemAmount) {
5050 throw new API_Exception("Line item total doesn't match with total amount.");
5055 * Get the financial account for the item associated with the new transaction.
5057 * @param array $params
5058 * @param int $default
5062 public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
5064 if (!empty($params['financial_account_id'])) {
5065 return $params['financial_account_id'];
5067 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus($params['contribution_status_id'], 'name');
5068 $preferredAccountsRelationships = array(
5069 'Refunded' => 'Credit/Contra Revenue Account is',
5070 'Chargeback' => 'Chargeback Account is',
5072 if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
5073 $financialTypeID = !empty($params['financial_type_id']) ?
$params['financial_type_id'] : $params['prevContribution']->financial_type_id
;
5074 return CRM_Financial_BAO_FinancialAccount
::getFinancialAccountForFinancialTypeByRelationship(
5076 $preferredAccountsRelationships[$contributionStatus]
5083 * ContributionPage values were being imposed onto values.
5085 * I have made this explicit and removed the couple (is_recur, is_pay_later) we
5086 * REALLY didn't want superimposed. The rest are left there in their overkill out
5089 * The rationale for making this explicit is that it was a case of carefully set values being
5090 * seemingly randonly overwritten without much care. In general I think array randomly setting
5091 * variables en mass is risky.
5093 * @param array $values
5097 protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
5098 $contributionPageValues = array();
5099 CRM_Contribute_BAO_ContributionPage
::setValues(
5100 $this->contribution_page_id
,
5101 $contributionPageValues
5103 $valuesToCopy = array(
5104 // These are the values that I believe to be useful.
5107 'pay_later_receipt',
5109 'receipt_from_email',
5110 'receipt_from_name',
5114 'honoree_profile_id',
5115 'onbehalf_profile_id',
5116 'honor_block_is_active',
5117 // Kinda might be - but would be on the contribution...
5120 // Included for 'fear of regression' but can't justify any use for these....
5122 'payment_processor',
5123 'financial_type_id',
5124 'amount_block_is_active',
5129 'default_amount_id',
5133 'initial_amount_help_text',
5134 'initial_amount_label',
5136 'is_allow_other_amount',
5137 'is_billing_required',
5138 'is_confirm_enabled',
5139 'is_credit_card_only',
5141 'is_partial_payment',
5142 'is_recur_installments',
5143 'is_recur_interval',
5147 'min_initial_amount',
5148 'recur_frequency_unit',
5155 foreach ($valuesToCopy as $valueToCopy) {
5156 if (isset($contributionPageValues[$valueToCopy])) {
5157 $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
5164 * Get values of CiviContribute Settings
5165 * and check if its enabled or not.
5166 * Note: The CiviContribute settings are stored as single entry in civicrm_setting
5167 * in serialized form. Usually this should be stored as flat settings for each form fields
5168 * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
5169 * settings we will live with an inconsistency because it's too hard to change for now.
5170 * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
5173 * @param string $name
5177 public static function checkContributeSettings($name = NULL) {
5178 $contributeSettings = Civi
::settings()->get('contribution_invoice_settings');
5181 return CRM_Utils_Array
::value($name, $contributeSettings);
5183 return $contributeSettings;
5187 * This function process contribution related objects.
5189 * @param int $contributionId
5190 * @param int $statusId
5191 * @param int|null $previousStatusId
5193 * @param string $receiveDate
5195 * @return null|string
5197 public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
5199 if (!$contributionId ||
!$statusId) {
5204 'contribution_id' => $contributionId,
5205 'contribution_status_id' => $statusId,
5206 'previous_contribution_status_id' => $previousStatusId,
5207 'receive_date' => $receiveDate,
5210 $updateResult = CRM_Contribute_BAO_Contribution
::transitionComponents($params);
5212 if (!is_array($updateResult) ||
5213 !($updatedComponents = CRM_Utils_Array
::value('updatedComponents', $updateResult)) ||
5214 !is_array($updatedComponents) ||
5215 empty($updatedComponents)
5220 // get the user display name.
5222 SELECT display_name as displayName
5223 FROM civicrm_contact
5224 LEFT JOIN civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5225 WHERE civicrm_contribution.id = {$contributionId}";
5226 $userDisplayName = CRM_Core_DAO
::singleValueQuery($sql);
5228 // get the status message for user.
5229 foreach ($updatedComponents as $componentName => $updatedStatusId) {
5231 if ($componentName == 'CiviMember') {
5232 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5233 CRM_Member_PseudoConstant
::membershipStatus()
5235 if ($updatedStatusName == 'Cancelled') {
5236 $statusMsg .= "<br />" . ts("Membership for %1 has been Cancelled.", array(1 => $userDisplayName));
5238 elseif ($updatedStatusName == 'Expired') {
5239 $statusMsg .= "<br />" . ts("Membership for %1 has been Expired.", array(1 => $userDisplayName));
5242 $endDate = CRM_Utils_Array
::value('membership_end_date', $updateResult);
5244 $statusMsg .= "<br />" . ts("Membership for %1 has been updated. The membership End Date is %2.",
5246 1 => $userDisplayName,
5254 if ($componentName == 'CiviEvent') {
5255 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5256 CRM_Event_PseudoConstant
::participantStatus()
5258 if ($updatedStatusName == 'Cancelled') {
5259 $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", array(1 => $userDisplayName));
5261 elseif ($updatedStatusName == 'Registered') {
5262 $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", array(1 => $userDisplayName));
5266 if ($componentName == 'CiviPledge') {
5267 $updatedStatusName = CRM_Utils_Array
::value($updatedStatusId,
5268 CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name')
5270 if ($updatedStatusName == 'Cancelled') {
5271 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", array(1 => $userDisplayName));
5273 elseif ($updatedStatusName == 'Failed') {
5274 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", array(1 => $userDisplayName));
5276 elseif ($updatedStatusName == 'Completed') {
5277 $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", array(1 => $userDisplayName));
5286 * Get the contribution as it is in the database before being updated.
5288 * @param int $contributionID
5292 private static function getOriginalContribution($contributionID) {
5293 return self
::getValues(array('id' => $contributionID), CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
5297 * Get the amount for the financial item row.
5299 * Helper function to start to break down recordFinancialTransactions for readability.
5301 * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5303 * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5304 * for historical reasons. Going forwards we can hope to add tests & improve readibility
5307 * @todo move recordFinancialAccounts & helper functions to their own class?
5309 * @param array $params
5310 * Params as passed to contribution.create
5312 * @param string $context
5313 * changeFinancialType| changedAmount
5314 * @param array $lineItemDetails
5316 * @param bool $isARefund
5317 * Is this a refund / negative transaction.
5321 protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund) {
5322 if ($context == 'changedAmount' ||
$context == 'changeFinancialType') {
5323 return $params['total_amount'] - $params['prevContribution']->total_amount
;
5325 elseif ($context == 'changedStatus') {
5326 $cancelledTaxAmount = 0;
5328 $cancelledTaxAmount = CRM_Utils_Array
::value('tax_amount', $params, '0.00');
5330 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * ($params['trxnParams']['total_amount'] +
$cancelledTaxAmount);
5332 elseif ($context === NULL) {
5333 // erm, yes because? but, hey, it's tested.
5334 return $params['total_amount'];
5336 elseif (empty($lineItemDetails['line_total'])) {
5337 // follow legacy code path
5339 ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', array('civi.tag' => 'deprecated'));
5340 return $params['total_amount'];
5343 return self
::getMultiplier($params['contribution']->contribution_status_id
, $context) * $lineItemDetails['line_total'];
5348 * Get the multiplier for adjusting rows.
5350 * If we are dealing with a refund or cancellation then it will be a negative
5351 * amount to reflect the negative transaction.
5353 * If we are changing Financial Type it will be a negative amount to
5354 * adjust down the old type.
5356 * @param int $contribution_status_id
5357 * @param string $context
5361 protected static function getMultiplier($contribution_status_id, $context) {
5362 if ($context == 'changeFinancialType' || self
::isContributionStatusNegative($contribution_status_id)) {
5369 * Assign Test Value.
5371 * @param string $fieldName
5372 * @param array $fieldDef
5373 * @param int $counter
5375 protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5376 if ($fieldName == 'tax_amount') {
5377 $this->{$fieldName} = "0.00";
5379 elseif ($fieldName == 'net_amount') {
5380 $this->{$fieldName} = "2.00";
5382 elseif ($fieldName == 'total_amount') {
5383 $this->{$fieldName} = "3.00";
5385 elseif ($fieldName == 'fee_amount') {
5386 $this->{$fieldName} = "1.00";
5389 parent
::assignTestValues($fieldName, $fieldDef, $counter);
5394 * Check if contribution has participant/membership payment.
5396 * @param int $contributionId
5401 public static function allowUpdateRevenueRecognitionDate($contributionId) {
5402 // get line item for contribution
5403 $lineItems = CRM_Price_BAO_LineItem
::getLineItemsByContributionID($contributionId);
5404 // check if line item is for membership or participant
5405 foreach ($lineItems as $items) {
5406 if ($items['entity_table'] == 'civicrm_participant') {
5410 elseif ($items['entity_table'] == 'civicrm_membership') {
5422 * Create Accounts Receivable financial trxn entry for Completed Contribution.
5424 * @param array $trxnParams
5425 * Financial trxn params
5426 * @param string $contributionParams
5427 * Contribution Params
5431 public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5432 if (!self
::checkContributeSettings('always_post_to_accounts_receivable')) {
5435 $statusId = $contributionParams['contribution']->contribution_status_id
;
5436 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
5437 $contributionStatus = empty($statusId) ?
NULL : $contributionStatuses[$statusId];
5438 $previousContributionStatus = empty($contributionParams['prevContribution']) ?
NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id
];
5439 // Return if contribution status is not completed.
5440 if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5441 ||
(!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5442 && $contributionParams['prevContribution']->is_pay_later
== 0
5448 $params = $trxnParams;
5449 $financialTypeID = CRM_Utils_Array
::value('financial_type_id', $contributionParams) ?
$contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id
;
5450 $arAccountId = CRM_Contribute_PseudoConstant
::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5451 $params['to_financial_account_id'] = $arAccountId;
5452 $params['status_id'] = array_search('Pending', $contributionStatuses);
5453 $params['is_payment'] = FALSE;
5454 $trxn = CRM_Core_BAO_FinancialTrxn
::create($params);
5455 self
::$_trxnIDs[] = $trxn->id
;
5456 $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5460 * Calculate financial item amount when contribution is updated.
5462 * @param array $params
5463 * contribution params
5464 * @param array $amountParams
5466 * @param string $context
5470 public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5471 if (!empty($params['is_quick_config'])) {
5472 $amount = $amountParams['item_amount'];
5474 $amount = $params['total_amount'];
5475 if ($context === NULL) {
5476 $amount -= CRM_Utils_Array
::value('tax_amount', $params, 0);
5481 $amount = $amountParams['line_total'];
5482 if ($context == 'changedAmount') {
5483 $amount -= $amountParams['previous_line_total'];
5485 $amount *= $amountParams['diff'];
5491 * Retrieve Sales Tax Financial Accounts.
5497 public static function getSalesTaxFinancialAccounts() {
5498 $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5499 INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5500 WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5501 $accountRel = key(CRM_Core_PseudoConstant
::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5502 $queryParams = array(1 => array($accountRel, 'Integer'));
5503 $dao = CRM_Core_DAO
::executeQuery($query, $queryParams);
5504 $financialAccount = array();
5505 while ($dao->fetch()) {
5506 $financialAccount[$dao->id
] = $dao->id
;
5508 return $financialAccount;
5512 * Create tax entry in civicrm_entity_financial_trxn table.
5514 * @param array $entityParams
5516 * @param array $eftParams
5519 public static function createProportionalEntry($entityParams, $eftParams) {
5520 $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5521 // Record Entity Financial Trxn; CRM-20145
5522 $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils
::formatAmount($paid);
5523 civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5527 * Create array of last financial item id's.
5529 * @param int $contributionId
5533 public static function getLastFinancialItemIds($contributionId) {
5534 $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5535 FROM civicrm_financial_item fi
5536 INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5537 WHERE li.contribution_id = %1";
5538 $dao = CRM_Core_DAO
::executeQuery($sql, array(1 => array($contributionId, 'Integer')));
5539 $ftIds = $taxItems = array();
5540 $salesTaxFinancialAccount = self
::getSalesTaxFinancialAccounts();
5541 while ($dao->fetch()) {
5542 /* if sales tax item*/
5543 if (in_array($dao->financial_account_id
, $salesTaxFinancialAccount)) {
5544 $taxItems[$dao->price_field_value_id
] = array(
5545 'financial_item_id' => $dao->id
,
5546 'amount' => $dao->tax_amount
,
5550 $ftIds[$dao->price_field_value_id
] = $dao->id
;
5553 return array($ftIds, $taxItems);
5557 * Create proportional entries in civicrm_entity_financial_trxn.
5559 * @param array $entityParams
5561 * @param array $lineItems
5563 * @param array $ftIds
5565 * @param array $taxItems
5568 public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5570 'entity_table' => 'civicrm_financial_item',
5571 'financial_trxn_id' => $entityParams['trxn_id'],
5573 foreach ($lineItems as $key => $value) {
5574 if ($value['qty'] == 0) {
5577 $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5578 $entityParams['line_item_amount'] = $value['line_total'];
5579 self
::createProportionalEntry($entityParams, $eftParams);
5580 if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5581 $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5582 $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5583 self
::createProportionalEntry($entityParams, $eftParams);
5589 * Load entities related to the contribution into $this->_relatedObjects.
5593 * @throws \CRM_Core_Exception
5595 protected function loadRelatedEntitiesByID($ids) {
5597 'contact' => 'CRM_Contact_BAO_Contact',
5598 'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5599 'contributionType' => 'CRM_Financial_BAO_FinancialType',
5600 'financialType' => 'CRM_Financial_BAO_FinancialType',
5601 'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5603 foreach ($entities as $entity => $bao) {
5604 if (!empty($ids[$entity])) {
5605 $this->_relatedObjects
[$entity] = new $bao();
5606 $this->_relatedObjects
[$entity]->id
= $ids[$entity];
5607 if (!$this->_relatedObjects
[$entity]->find(TRUE)) {
5608 throw new CRM_Core_Exception($entity . ' could not be loaded');
5615 * Should an email receipt be sent for this contribution when complete.
5617 * @param array $input
5621 protected function isEmailReceipt($input) {
5622 if (isset($input['is_email_receipt'])) {
5623 return $input['is_email_receipt'];
5625 if (!empty($this->_relatedObjects
['contribution_page_id'])) {
5626 return $this->_relatedObjects
['contribution_page_id']->is_email_receipt
;
5632 * Function to replace contribution tokens.
5634 * @param array $contributionIds
5636 * @param string $subject
5638 * @param array $subjectToken
5640 * @param string $text
5642 * @param string $html
5644 * @param array $messageToken
5646 * @param bool $escapeSmarty
5650 public static function replaceContributionTokens(
5659 if (empty($contributionIds)) {
5662 $contributionDetails = array();
5663 foreach ($contributionIds as $id) {
5664 $result = civicrm_api3('Contribution', 'get', array('id' => $id));
5665 $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token
::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5666 $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token
::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5667 $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token
::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5669 return $contributionDetails;