3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2019
35 * Class to parse contribution csv files.
37 class CRM_Contribute_Import_Parser_Contribution
extends CRM_Contribute_Import_Parser
{
39 protected $_mapperKeys;
41 private $_contactIdIndex;
42 private $_totalAmountIndex;
43 private $_contributionTypeIndex;
45 protected $_mapperSoftCredit;
46 //protected $_mapperPhoneType;
49 * Array of successfully imported contribution id's
53 protected $_newContributions;
59 * @param array $mapperSoftCredit
60 * @param null $mapperPhoneType
61 * @param array $mapperSoftCreditType
63 public function __construct(&$mapperKeys, $mapperSoftCredit = [], $mapperPhoneType = NULL, $mapperSoftCreditType = []) {
64 parent
::__construct();
65 $this->_mapperKeys
= &$mapperKeys;
66 $this->_mapperSoftCredit
= &$mapperSoftCredit;
67 $this->_mapperSoftCreditType
= &$mapperSoftCreditType;
71 * The initializer code, called before the processing
73 public function init() {
74 $fields = CRM_Contribute_BAO_Contribution
::importableFields($this->_contactType
, FALSE);
76 $fields = array_merge($fields,
79 'title' => ts('Soft Credit'),
81 'headerPattern' => '/Soft Credit/i',
86 // add pledge fields only if its is enabled
87 if (CRM_Core_Permission
::access('CiviPledge')) {
90 'title' => ts('Pledge Payment'),
91 'headerPattern' => '/Pledge Payment/i',
94 'title' => ts('Pledge ID'),
95 'headerPattern' => '/Pledge ID/i',
99 $fields = array_merge($fields, $pledgeFields);
101 foreach ($fields as $name => $field) {
102 $field['type'] = CRM_Utils_Array
::value('type', $field, CRM_Utils_Type
::T_INT
);
103 $field['dataPattern'] = CRM_Utils_Array
::value('dataPattern', $field, '//');
104 $field['headerPattern'] = CRM_Utils_Array
::value('headerPattern', $field, '//');
105 $this->addField($name, $field['title'], $field['type'], $field['headerPattern'], $field['dataPattern']);
108 $this->_newContributions
= [];
110 $this->setActiveFields($this->_mapperKeys
);
111 $this->setActiveFieldSoftCredit($this->_mapperSoftCredit
);
112 $this->setActiveFieldSoftCreditType($this->_mapperSoftCreditType
);
114 // FIXME: we should do this in one place together with Form/MapField.php
115 $this->_contactIdIndex
= -1;
116 $this->_totalAmountIndex
= -1;
117 $this->_contributionTypeIndex
= -1;
120 foreach ($this->_mapperKeys
as $key) {
122 case 'contribution_contact_id':
123 $this->_contactIdIndex
= $index;
127 $this->_totalAmountIndex
= $index;
130 case 'financial_type':
131 $this->_contributionTypeIndex
= $index;
139 * Handle the values in mapField mode.
141 * @param array $values
142 * The array of values belonging to this line.
146 public function mapField(&$values) {
147 return CRM_Import_Parser
::VALID
;
151 * Handle the values in preview mode.
153 * @param array $values
154 * The array of values belonging to this line.
157 * the result of this processing
159 public function preview(&$values) {
160 return $this->summary($values);
164 * Handle the values in summary mode.
166 * @param array $values
167 * The array of values belonging to this line.
170 * the result of this processing
172 public function summary(&$values) {
173 $erroneousField = NULL;
174 $response = $this->setActiveFieldValues($values, $erroneousField);
176 $params = &$this->getActiveFieldParams();
177 $errorMessage = NULL;
180 $errorMessage = implode('; ', $this->formatDateFields($params));
181 //date-Format part ends
183 $params['contact_type'] = 'Contribution';
185 //checking error in custom data
186 CRM_Contact_Import_Parser_Contact
::isErrorInCustomData($params, $errorMessage);
189 $tempMsg = "Invalid value for field(s) : $errorMessage";
190 array_unshift($values, $tempMsg);
191 $errorMessage = NULL;
192 return CRM_Import_Parser
::ERROR
;
195 return CRM_Import_Parser
::VALID
;
199 * Handle the values in import mode.
201 * @param int $onDuplicate
202 * The code for what action to take on duplicates.
203 * @param array $values
204 * The array of values belonging to this line.
207 * the result of this processing
209 public function import($onDuplicate, &$values) {
210 // first make sure this is a valid line
211 $response = $this->summary($values);
212 if ($response != CRM_Import_Parser
::VALID
) {
216 $params = &$this->getActiveFieldParams();
217 $formatted = ['version' => 3, 'skipRecentView' => TRUE, 'skipCleanMoney' => FALSE];
220 if (isset($params['total_amount']) && $params['total_amount'] == 0) {
221 $params['total_amount'] = '0.00';
223 $this->formatInput($params);
225 static $indieFields = NULL;
226 if ($indieFields == NULL) {
227 $tempIndieFields = CRM_Contribute_DAO_Contribution
::import();
228 $indieFields = $tempIndieFields;
232 foreach ($params as $key => $field) {
233 if ($field == NULL ||
$field === '') {
236 $paramValues[$key] = $field;
239 //import contribution record according to select contact type
240 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_SKIP
&&
241 (!empty($paramValues['contribution_contact_id']) ||
!empty($paramValues['external_identifier']))
243 $paramValues['contact_type'] = $this->_contactType
;
245 elseif ($onDuplicate == CRM_Import_Parser
::DUPLICATE_UPDATE
&&
246 (!empty($paramValues['contribution_id']) ||
!empty($values['trxn_id']) ||
!empty($paramValues['invoice_id']))
248 $paramValues['contact_type'] = $this->_contactType
;
250 elseif (!empty($params['soft_credit'])) {
251 $paramValues['contact_type'] = $this->_contactType
;
253 elseif (!empty($paramValues['pledge_payment'])) {
254 $paramValues['contact_type'] = $this->_contactType
;
257 //need to pass $onDuplicate to check import mode.
258 if (!empty($paramValues['pledge_payment'])) {
259 $paramValues['onDuplicate'] = $onDuplicate;
261 $formatError = $this->deprecatedFormatParams($paramValues, $formatted, TRUE, $onDuplicate);
264 array_unshift($values, $formatError['error_message']);
265 if (CRM_Utils_Array
::value('error_data', $formatError) == 'soft_credit') {
266 return CRM_Contribute_Import_Parser
::SOFT_CREDIT_ERROR
;
268 elseif (CRM_Utils_Array
::value('error_data', $formatError) == 'pledge_payment') {
269 return CRM_Contribute_Import_Parser
::PLEDGE_PAYMENT_ERROR
;
271 return CRM_Import_Parser
::ERROR
;
274 if ($onDuplicate != CRM_Import_Parser
::DUPLICATE_UPDATE
) {
275 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
281 //fix for CRM-2219 - Update Contribution
282 // onDuplicate == CRM_Import_Parser::DUPLICATE_UPDATE
283 if (!empty($paramValues['invoice_id']) ||
!empty($paramValues['trxn_id']) ||
!empty($paramValues['contribution_id'])) {
285 'id' => CRM_Utils_Array
::value('contribution_id', $paramValues),
286 'trxn_id' => CRM_Utils_Array
::value('trxn_id', $paramValues),
287 'invoice_id' => CRM_Utils_Array
::value('invoice_id', $paramValues),
290 $ids['contribution'] = CRM_Contribute_BAO_Contribution
::checkDuplicateIds($dupeIds);
292 if ($ids['contribution']) {
293 $formatted['id'] = $ids['contribution'];
294 $formatted['custom'] = CRM_Core_BAO_CustomField
::postProcess($formatted,
299 if (!empty($paramValues['note'])) {
301 $contactID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $ids['contribution'], 'contact_id');
302 $daoNote = new CRM_Core_BAO_Note();
303 $daoNote->entity_table
= 'civicrm_contribution';
304 $daoNote->entity_id
= $ids['contribution'];
305 if ($daoNote->find(TRUE)) {
306 $noteID['id'] = $daoNote->id
;
310 'entity_table' => 'civicrm_contribution',
311 'note' => $paramValues['note'],
312 'entity_id' => $ids['contribution'],
313 'contact_id' => $contactID,
315 CRM_Core_BAO_Note
::add($noteParams, $noteID);
316 unset($formatted['note']);
319 //need to check existing soft credit contribution, CRM-3968
320 if (!empty($formatted['soft_credit'])) {
322 'contact_id' => $formatted['soft_credit'],
323 'contribution_id' => $ids['contribution'],
326 //Delete all existing soft Contribution from contribution_soft table for pcp_id is_null
327 $existingSoftCredit = CRM_Contribute_BAO_ContributionSoft
::getSoftContribution($dupeSoftCredit['contribution_id']);
328 if (isset($existingSoftCredit['soft_credit']) && !empty($existingSoftCredit['soft_credit'])) {
329 foreach ($existingSoftCredit['soft_credit'] as $key => $existingSoftCreditValues) {
330 if (!empty($existingSoftCreditValues['soft_credit_id'])) {
331 civicrm_api3('ContributionSoft', 'delete', [
332 'id' => $existingSoftCreditValues['soft_credit_id'],
340 $newContribution = CRM_Contribute_BAO_Contribution
::create($formatted, $ids);
341 $this->_newContributions
[] = $newContribution->id
;
343 //return soft valid since we need to show how soft credits were added
344 if (!empty($formatted['soft_credit'])) {
345 return CRM_Contribute_Import_Parser
::SOFT_CREDIT
;
348 // process pledge payment assoc w/ the contribution
349 return self
::processPledgePayments($formatted);
351 return CRM_Import_Parser
::VALID
;
355 'id' => 'Contribution ID',
356 'trxn_id' => 'Transaction ID',
357 'invoice_id' => 'Invoice ID',
359 foreach ($dupeIds as $k => $v) {
361 $errorMsg[] = "$labels[$k] $v";
364 $errorMsg = implode(' AND ', $errorMsg);
365 array_unshift($values, 'Matching Contribution record not found for ' . $errorMsg . '. Row was skipped.');
366 return CRM_Import_Parser
::ERROR
;
371 if ($this->_contactIdIndex
< 0) {
372 // set the contact type if its not set
373 if (!isset($paramValues['contact_type'])) {
374 $paramValues['contact_type'] = $this->_contactType
;
377 $error = $this->checkContactDuplicate($paramValues);
379 if (CRM_Core_Error
::isAPIError($error, CRM_Core_ERROR
::DUPLICATE_CONTACT
)) {
380 $matchedIDs = explode(',', $error['error_message']['params'][0]);
381 if (count($matchedIDs) > 1) {
382 array_unshift($values, 'Multiple matching contact records detected for this row. The contribution was not imported');
383 return CRM_Import_Parser
::ERROR
;
386 $cid = $matchedIDs[0];
387 $formatted['contact_id'] = $cid;
389 $newContribution = civicrm_api('contribution', 'create', $formatted);
390 if (civicrm_error($newContribution)) {
391 if (is_array($newContribution['error_message'])) {
392 array_unshift($values, $newContribution['error_message']['message']);
393 if ($newContribution['error_message']['params'][0]) {
394 return CRM_Import_Parser
::DUPLICATE
;
398 array_unshift($values, $newContribution['error_message']);
399 return CRM_Import_Parser
::ERROR
;
403 $this->_newContributions
[] = $newContribution['id'];
404 $formatted['contribution_id'] = $newContribution['id'];
406 //return soft valid since we need to show how soft credits were added
407 if (!empty($formatted['soft_credit'])) {
408 return CRM_Contribute_Import_Parser
::SOFT_CREDIT
;
411 // process pledge payment assoc w/ the contribution
412 return self
::processPledgePayments($formatted);
414 return CRM_Import_Parser
::VALID
;
418 // Using new Dedupe rule.
420 'contact_type' => $this->_contactType
,
421 'used' => 'Unsupervised',
423 $fieldsArray = CRM_Dedupe_BAO_Rule
::dedupeRuleFields($ruleParams);
425 foreach ($fieldsArray as $value) {
426 if (array_key_exists(trim($value), $params)) {
427 $paramValue = $params[trim($value)];
428 if (is_array($paramValue)) {
429 $disp .= $params[trim($value)][0][trim($value)] . " ";
432 $disp .= $params[trim($value)] . " ";
437 if (!empty($params['external_identifier'])) {
439 $disp .= "AND {$params['external_identifier']}";
442 $disp = $params['external_identifier'];
446 array_unshift($values, 'No matching Contact found for (' . $disp . ')');
447 return CRM_Import_Parser
::ERROR
;
451 if (!empty($paramValues['external_identifier'])) {
452 $checkCid = new CRM_Contact_DAO_Contact();
453 $checkCid->external_identifier
= $paramValues['external_identifier'];
454 $checkCid->find(TRUE);
455 if ($checkCid->id
!= $formatted['contact_id']) {
456 array_unshift($values, 'Mismatch of External ID:' . $paramValues['external_identifier'] . ' and Contact Id:' . $formatted['contact_id']);
457 return CRM_Import_Parser
::ERROR
;
460 $newContribution = civicrm_api('contribution', 'create', $formatted);
461 if (civicrm_error($newContribution)) {
462 if (is_array($newContribution['error_message'])) {
463 array_unshift($values, $newContribution['error_message']['message']);
464 if ($newContribution['error_message']['params'][0]) {
465 return CRM_Import_Parser
::DUPLICATE
;
469 array_unshift($values, $newContribution['error_message']);
470 return CRM_Import_Parser
::ERROR
;
474 $this->_newContributions
[] = $newContribution['id'];
475 $formatted['contribution_id'] = $newContribution['id'];
477 //return soft valid since we need to show how soft credits were added
478 if (!empty($formatted['soft_credit'])) {
479 return CRM_Contribute_Import_Parser
::SOFT_CREDIT
;
482 // process pledge payment assoc w/ the contribution
483 return self
::processPledgePayments($formatted);
485 return CRM_Import_Parser
::VALID
;
490 * Process pledge payments.
492 * @param array $formatted
496 public function processPledgePayments(&$formatted) {
497 if (!empty($formatted['pledge_payment_id']) && !empty($formatted['pledge_id'])) {
498 //get completed status
499 $completeStatusID = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
501 //need to update payment record to map contribution_id
502 CRM_Core_DAO
::setFieldValue('CRM_Pledge_DAO_PledgePayment', $formatted['pledge_payment_id'],
503 'contribution_id', $formatted['contribution_id']
506 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($formatted['pledge_id'],
507 [$formatted['pledge_payment_id']],
510 $formatted['total_amount']
513 return CRM_Contribute_Import_Parser
::PLEDGE_PAYMENT
;
518 * Get the array of successfully imported contribution id's
522 public function &getImportedContributions() {
523 return $this->_newContributions
;
527 * The initializer code, called before the processing.
529 public function fini() {
533 * Format date fields from input to mysql.
535 * @param array $params
538 * Error messages, if any.
540 public function formatDateFields(&$params) {
542 $dateType = CRM_Core_Session
::singleton()->get('dateTypes');
543 foreach ($params as $key => $val) {
547 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
548 $params[$key] = $dateValue;
551 $errorMessage[] = ts('Receive Date');
556 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
557 $params[$key] = $dateValue;
560 $errorMessage[] = ts('Cancel Date');
565 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
566 $params[$key] = $dateValue;
569 $errorMessage[] = ts('Receipt date');
573 case 'thankyou_date':
574 if ($dateValue = CRM_Utils_Date
::formatDate($params[$key], $dateType)) {
575 $params[$key] = $dateValue;
578 $errorMessage[] = ts('Thankyou Date');
584 return $errorMessage;
588 * Format input params to suit api handling.
590 * Over time all the parts of deprecatedFormatParams
591 * and all the parts of the import function on this class that relate to
592 * reformatting input should be moved here and tests should be added in
593 * CRM_Contribute_Import_Parser_ContributionTest.
595 * @param array $params
597 public function formatInput(&$params) {
598 $dateType = CRM_Core_Session
::singleton()->get('dateTypes');
599 $customDataType = !empty($params['contact_type']) ?
$params['contact_type'] : 'Contribution';
600 $customFields = CRM_Core_BAO_CustomField
::getFields($customDataType);
601 // @todo call formatDateFields & move custom data handling there.
602 // Also note error handling for dates is currently in deprecatedFormatParams
603 // we should use the error handling in formatDateFields.
604 foreach ($params as $key => $val) {
605 // @todo - call formatDateFields instead.
611 case 'thankyou_date':
612 $params[$key] = CRM_Utils_Date
::formatDate($params[$key], $dateType);
615 case 'pledge_payment':
616 $params[$key] = CRM_Utils_String
::strtobool($val);
620 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
621 if ($customFields[$customFieldID]['data_type'] == 'Date') {
622 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $params, $dateType, $key);
623 unset($params[$key]);
625 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
626 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
634 * take the input parameter list as specified in the data model and
635 * convert it into the same format that we use in QF and BAO object
637 * @param array $params
638 * Associative array of property name/value.
639 * pairs to insert in new contact.
640 * @param array $values
641 * The reformatted properties that we can use internally.
644 * @param bool $create
645 * @param null $onDuplicate
647 * @return array|CRM_Error
649 private function deprecatedFormatParams($params, &$values, $create = FALSE, $onDuplicate = NULL) {
650 require_once 'CRM/Utils/DeprecatedUtils.php';
651 // copy all the contribution fields as is
652 require_once 'api/v3/utils.php';
653 $fields = CRM_Core_DAO
::getExportableFieldsWithPseudoConstants('CRM_Contribute_BAO_Contribution');
655 _civicrm_api3_store_values($fields, $params, $values);
657 $customFields = CRM_Core_BAO_CustomField
::getFields('Contribution', FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE);
659 foreach ($params as $key => $value) {
660 // ignore empty values or empty arrays etc
661 if (CRM_Utils_System
::isNull($value)) {
665 // Handling Custom Data
666 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
667 $values[$key] = $value;
668 $type = $customFields[$customFieldID]['html_type'];
669 if ($type == 'CheckBox' ||
$type == 'Multi-Select') {
670 $mulValues = explode(',', $value);
671 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
673 foreach ($mulValues as $v1) {
674 foreach ($customOption as $customValueID => $customLabel) {
675 $customValue = $customLabel['value'];
676 if ((strtolower($customLabel['label']) == strtolower(trim($v1))) ||
677 (strtolower($customValue) == strtolower(trim($v1)))
679 if ($type == 'CheckBox') {
680 $values[$key][$customValue] = 1;
683 $values[$key][] = $customValue;
689 elseif ($type == 'Select' ||
$type == 'Radio' ||
690 ($type == 'Autocomplete-Select' &&
691 $customFields[$customFieldID]['data_type'] == 'String'
694 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
695 foreach ($customOption as $customFldID => $customValue) {
696 $val = CRM_Utils_Array
::value('value', $customValue);
697 $label = CRM_Utils_Array
::value('label', $customValue);
698 $label = strtolower($label);
699 $value = strtolower(trim($value));
700 if (($value == $label) ||
($value == strtolower($val))) {
701 $values[$key] = $val;
708 case 'contribution_contact_id':
709 if (!CRM_Utils_Rule
::integer($value)) {
710 return civicrm_api3_create_error("contact_id not valid: $value");
712 $dao = new CRM_Core_DAO();
714 $svq = $dao->singleValueQuery("SELECT is_deleted FROM civicrm_contact WHERE id = $value",
718 return civicrm_api3_create_error("Invalid Contact ID: There is no contact record with contact_id = $value.");
721 return civicrm_api3_create_error("Invalid Contact ID: contact_id $value is a soft-deleted contact.");
724 $values['contact_id'] = $values['contribution_contact_id'];
725 unset($values['contribution_contact_id']);
729 // import contribution record according to select contact type
730 require_once 'CRM/Contact/DAO/Contact.php';
731 $contactType = new CRM_Contact_DAO_Contact();
732 $contactId = CRM_Utils_Array
::value('contribution_contact_id', $params);
733 $externalId = CRM_Utils_Array
::value('external_identifier', $params);
734 $email = CRM_Utils_Array
::value('email', $params);
735 //when insert mode check contact id or external identifier
736 if ($contactId ||
$externalId) {
737 $contactType->id
= $contactId;
738 $contactType->external_identifier
= $externalId;
739 if ($contactType->find(TRUE)) {
740 if ($params['contact_type'] != $contactType->contact_type
) {
741 return civicrm_api3_create_error("Contact Type is wrong: $contactType->contact_type");
746 if (!CRM_Utils_Rule
::email($email)) {
747 return civicrm_api3_create_error("Invalid email address $email provided. Row was skipped");
750 // get the contact id from duplicate contact rule, if more than one contact is returned
751 // we should return error, since current interface allows only one-one mapping
752 $emailParams = ['email' => $email, 'contact_type' => $params['contact_type']];
753 $checkDedupe = _civicrm_api3_deprecated_duplicate_formatted_contact($emailParams);
754 if (!$checkDedupe['is_error']) {
755 return civicrm_api3_create_error("Invalid email address(doesn't exist) $email. Row was skipped");
758 $matchingContactIds = explode(',', $checkDedupe['error_message']['params'][0]);
759 if (count($matchingContactIds) > 1) {
760 return civicrm_api3_create_error("Invalid email address(duplicate) $email. Row was skipped");
762 elseif (count($matchingContactIds) == 1) {
763 $params['contribution_contact_id'] = $matchingContactIds[0];
767 elseif (!empty($params['contribution_id']) ||
!empty($params['trxn_id']) ||
!empty($params['invoice_id'])) {
768 // when update mode check contribution id or trxn id or
770 $contactId = new CRM_Contribute_DAO_Contribution();
771 if (!empty($params['contribution_id'])) {
772 $contactId->id
= $params['contribution_id'];
774 elseif (!empty($params['trxn_id'])) {
775 $contactId->trxn_id
= $params['trxn_id'];
777 elseif (!empty($params['invoice_id'])) {
778 $contactId->invoice_id
= $params['invoice_id'];
780 if ($contactId->find(TRUE)) {
781 $contactType->id
= $contactId->contact_id
;
782 if ($contactType->find(TRUE)) {
783 if ($params['contact_type'] != $contactType->contact_type
) {
784 return civicrm_api3_create_error("Contact Type is wrong: $contactType->contact_type");
790 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_UPDATE
) {
791 return civicrm_api3_create_error("Empty Contribution and Invoice and Transaction ID. Row was skipped.");
799 case 'thankyou_date':
800 if (!CRM_Utils_Rule
::dateTime($value)) {
801 return civicrm_api3_create_error("$key not a valid date: $value");
805 case 'non_deductible_amount':
809 // @todo add test like testPaymentTypeLabel & remove these lines as we can anticipate error will still be caught & handled.
810 if (!CRM_Utils_Rule
::money($value)) {
811 return civicrm_api3_create_error("$key not a valid amount: $value");
816 if (!CRM_Utils_Rule
::currencyCode($value)) {
817 return civicrm_api3_create_error("currency not a valid code: $value");
821 case 'financial_type':
822 // @todo add test like testPaymentTypeLabel & remove these lines in favour of 'default' part of switch.
823 require_once 'CRM/Contribute/PseudoConstant.php';
824 $contriTypes = CRM_Contribute_PseudoConstant
::financialType();
825 foreach ($contriTypes as $val => $type) {
826 if (strtolower($value) == strtolower($type)) {
827 $values['financial_type_id'] = $val;
831 if (empty($values['financial_type_id'])) {
832 return civicrm_api3_create_error("Financial Type is not valid: $value");
837 // import contribution record according to select contact type
838 // validate contact id and external identifier.
839 $value[$key] = $mismatchContactType = $softCreditContactIds = '';
840 if (isset($params[$key]) && is_array($params[$key])) {
841 foreach ($params[$key] as $softKey => $softParam) {
842 $contactId = CRM_Utils_Array
::value('contact_id', $softParam);
843 $externalId = CRM_Utils_Array
::value('external_identifier', $softParam);
844 $email = CRM_Utils_Array
::value('email', $softParam);
845 if ($contactId ||
$externalId) {
846 require_once 'CRM/Contact/DAO/Contact.php';
847 $contact = new CRM_Contact_DAO_Contact();
848 $contact->id
= $contactId;
849 $contact->external_identifier
= $externalId;
851 if (!$contact->find(TRUE)) {
852 $field = $contactId ?
ts('Contact ID') : ts('External ID');
853 $errorMsg = ts("Soft Credit %1 - %2 doesn't exist. Row was skipped.",
854 [1 => $field, 2 => $contactId ?
$contactId : $externalId]);
858 return civicrm_api3_create_error($errorMsg);
861 // finally get soft credit contact id.
862 $values[$key][$softKey] = $softParam;
863 $values[$key][$softKey]['contact_id'] = $contact->id
;
866 if (!CRM_Utils_Rule
::email($email)) {
867 return civicrm_api3_create_error("Invalid email address $email provided for Soft Credit. Row was skipped");
870 // get the contact id from duplicate contact rule, if more than one contact is returned
871 // we should return error, since current interface allows only one-one mapping
872 $emailParams = ['email' => $email, 'contact_type' => $params['contact_type']];
873 $checkDedupe = _civicrm_api3_deprecated_duplicate_formatted_contact($emailParams);
874 if (!$checkDedupe['is_error']) {
875 return civicrm_api3_create_error("Invalid email address(doesn't exist) $email for Soft Credit. Row was skipped");
878 $matchingContactIds = explode(',', $checkDedupe['error_message']['params'][0]);
879 if (count($matchingContactIds) > 1) {
880 return civicrm_api3_create_error("Invalid email address(duplicate) $email for Soft Credit. Row was skipped");
882 elseif (count($matchingContactIds) == 1) {
883 $contactId = $matchingContactIds[0];
884 unset($softParam['email']);
885 $values[$key][$softKey] = $softParam +
['contact_id' => $contactId];
893 case 'pledge_payment':
896 // giving respect to pledge_payment flag.
897 if (empty($params['pledge_payment'])) {
901 // get total amount of from import fields
902 $totalAmount = CRM_Utils_Array
::value('total_amount', $params);
904 $onDuplicate = CRM_Utils_Array
::value('onDuplicate', $params);
906 // we need to get contact id $contributionContactID to
907 // retrieve pledge details as well as to validate pledge ID
909 // first need to check for update mode
910 if ($onDuplicate == CRM_Import_Parser
::DUPLICATE_UPDATE
&&
911 ($params['contribution_id'] ||
$params['trxn_id'] ||
$params['invoice_id'])
913 $contribution = new CRM_Contribute_DAO_Contribution();
914 if ($params['contribution_id']) {
915 $contribution->id
= $params['contribution_id'];
917 elseif ($params['trxn_id']) {
918 $contribution->trxn_id
= $params['trxn_id'];
920 elseif ($params['invoice_id']) {
921 $contribution->invoice_id
= $params['invoice_id'];
924 if ($contribution->find(TRUE)) {
925 $contributionContactID = $contribution->contact_id
;
927 $totalAmount = $contribution->total_amount
;
931 return civicrm_api3_create_error('No match found for specified contact in pledge payment data. Row was skipped.');
935 // first get the contact id for given contribution record.
936 if (!empty($params['contribution_contact_id'])) {
937 $contributionContactID = $params['contribution_contact_id'];
939 elseif (!empty($params['external_identifier'])) {
940 require_once 'CRM/Contact/DAO/Contact.php';
941 $contact = new CRM_Contact_DAO_Contact();
942 $contact->external_identifier
= $params['external_identifier'];
943 if ($contact->find(TRUE)) {
944 $contributionContactID = $params['contribution_contact_id'] = $values['contribution_contact_id'] = $contact->id
;
947 return civicrm_api3_create_error('No match found for specified contact in pledge payment data. Row was skipped.');
951 // we need to get contribution contact using de dupe
952 $error = _civicrm_api3_deprecated_check_contact_dedupe($params);
954 if (isset($error['error_message']['params'][0])) {
955 $matchedIDs = explode(',', $error['error_message']['params'][0]);
957 // check if only one contact is found
958 if (count($matchedIDs) > 1) {
959 return civicrm_api3_create_error($error['error_message']['message']);
962 $contributionContactID = $params['contribution_contact_id'] = $values['contribution_contact_id'] = $matchedIDs[0];
966 return civicrm_api3_create_error('No match found for specified contact in contribution data. Row was skipped.');
971 if (!empty($params['pledge_id'])) {
972 if (CRM_Core_DAO
::getFieldValue('CRM_Pledge_DAO_Pledge', $params['pledge_id'], 'contact_id') != $contributionContactID) {
973 return civicrm_api3_create_error('Invalid Pledge ID provided. Contribution row was skipped.');
975 $values['pledge_id'] = $params['pledge_id'];
978 // check if there are any pledge related to this contact, with payments pending or in progress
979 require_once 'CRM/Pledge/BAO/Pledge.php';
980 $pledgeDetails = CRM_Pledge_BAO_Pledge
::getContactPledges($contributionContactID);
982 if (empty($pledgeDetails)) {
983 return civicrm_api3_create_error('No open pledges found for this contact. Contribution row was skipped.');
985 elseif (count($pledgeDetails) > 1) {
986 return civicrm_api3_create_error('This contact has more than one open pledge. Unable to determine which pledge to apply the contribution to. Contribution row was skipped.');
989 // this mean we have only one pending / in progress pledge
990 $values['pledge_id'] = $pledgeDetails[0];
993 // we need to check if oldest payment amount equal to contribution amount
994 require_once 'CRM/Pledge/BAO/PledgePayment.php';
995 $pledgePaymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($values['pledge_id']);
997 if ($pledgePaymentDetails['amount'] == $totalAmount) {
998 $values['pledge_payment_id'] = $pledgePaymentDetails['id'];
1001 return civicrm_api3_create_error('Contribution and Pledge Payment amount mismatch for this record. Contribution row was skipped.');
1006 // Hande name or label for fields with options.
1007 if (isset($fields[$key]) &&
1008 // Yay - just for a surprise we are inconsistent on whether we pass the pseudofield (payment_instrument)
1009 // or the field name (contribution_status_id)
1010 (!empty($fields[$key]['is_pseudofield_for']) ||
!empty($fields[$key]['pseudoconstant']))
1012 $realField = $fields[$key]['is_pseudofield_for'] ??
$key;
1013 $realFieldSpec = $fields[$realField];
1014 /* @var \CRM_Core_DAO $bao */
1015 $bao = $realFieldSpec['bao'];
1016 // Get names & labels - we will try to match name first but if not available then see if
1017 // we have a label that can be converted to a name.
1018 // For historical reasons use validate as context - ie disabled name matches ARE permitted per prior to change.
1019 $nameOptions = $bao::buildOptions($realField, 'validate');
1020 if (!isset($nameOptions[$value])) {
1021 $labelOptions = array_flip($bao::buildOptions($realField, 'match'));
1022 if (isset($labelOptions[$params[$key]])) {
1023 $values[$key] = $labelOptions[$params[$key]];
1031 if (array_key_exists('note', $params)) {
1032 $values['note'] = $params['note'];
1036 // CRM_Contribute_BAO_Contribution::add() handles contribution_source
1037 // So, if $values contains contribution_source, convert it to source
1038 $changes = ['contribution_source' => 'source'];
1040 foreach ($changes as $orgVal => $changeVal) {
1041 if (isset($values[$orgVal])) {
1042 $values[$changeVal] = $values[$orgVal];
1043 unset($values[$orgVal]);