3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 abstract class CRM_Contact_Import_Parser
extends CRM_Import_Parser
{
19 protected $_tableName;
22 * Total number of lines in file
29 * Running total number of un-matched Contacts.
33 protected $_unMatchCount;
36 * Array of unmatched lines.
43 * Total number of contacts with unparsed addresses
46 protected $_unparsedAddressCount;
49 * Filename of mismatch data
53 protected $_misMatchFilemName;
55 protected $_primaryKeyName;
56 protected $_statusFieldName;
58 protected $fieldMetadata = [];
67 * Dedupe rule group id to use if set
71 public $_dedupeRuleGroupID = NULL;
76 * @param string $tableName
77 * @param array $mapper
79 * @param int $contactType
80 * @param string $primaryKeyName
81 * @param string $statusFieldName
82 * @param int $onDuplicate
83 * @param int $statusID
84 * @param int $totalRowCount
85 * @param bool $doGeocodeAddress
87 * @param string $contactSubType
88 * @param int $dedupeRuleGroupID
95 $mode = self
::MODE_PREVIEW
,
96 $contactType = self
::CONTACT_INDIVIDUAL
,
97 $primaryKeyName = '_id',
98 $statusFieldName = '_status',
99 $onDuplicate = self
::DUPLICATE_SKIP
,
101 $totalRowCount = NULL,
102 $doGeocodeAddress = FALSE,
103 $timeout = CRM_Contact_Import_Parser
::DEFAULT_TIMEOUT
,
104 $contactSubType = NULL,
105 $dedupeRuleGroupID = NULL
108 // TODO: Make the timeout actually work
109 $this->_onDuplicate
= $onDuplicate;
110 $this->_dedupeRuleGroupID
= $dedupeRuleGroupID;
112 switch ($contactType) {
113 case CRM_Import_Parser
::CONTACT_INDIVIDUAL
:
114 $this->_contactType
= 'Individual';
117 case CRM_Import_Parser
::CONTACT_HOUSEHOLD
:
118 $this->_contactType
= 'Household';
121 case CRM_Import_Parser
::CONTACT_ORGANIZATION
:
122 $this->_contactType
= 'Organization';
125 $this->_contactSubType
= $contactSubType;
129 $this->_rowCount
= $this->_warningCount
= 0;
130 $this->_invalidRowCount
= $this->_validCount
= 0;
131 $this->_totalCount
= $this->_conflictCount
= 0;
134 $this->_warnings
= [];
135 $this->_conflicts
= [];
136 $this->_unparsedAddresses
= [];
138 $this->_tableName
= $tableName;
139 $this->_primaryKeyName
= $primaryKeyName;
140 $this->_statusFieldName
= $statusFieldName;
142 if ($mode == self
::MODE_MAPFIELD
) {
146 $this->_activeFieldCount
= count($this->_activeFields
);
149 if ($mode == self
::MODE_IMPORT
) {
150 //get the key of email field
151 foreach ($mapper as $key => $value) {
152 if (strtolower($value) == 'email') {
160 $this->progressImport($statusID);
161 $startTimestamp = $currTimestamp = $prevTimestamp = time();
163 // get the contents of the temp. import table
164 $query = "SELECT * FROM $tableName";
165 if ($mode == self
::MODE_IMPORT
) {
166 $query .= " WHERE $statusFieldName = 'NEW'";
169 $result = CRM_Core_DAO
::executeQuery($query);
171 while ($result->fetch()) {
172 $values = array_values($result->toArray());
175 /* trim whitespace around the values */
176 foreach ($values as $k => $v) {
177 $values[$k] = trim($v, " \t\r\n");
179 if (CRM_Utils_System
::isNull($values)) {
183 $this->_totalCount++
;
185 if ($mode == self
::MODE_MAPFIELD
) {
186 $returnCode = $this->mapField($values);
188 elseif ($mode == self
::MODE_PREVIEW
) {
189 $returnCode = $this->preview($values);
191 elseif ($mode == self
::MODE_SUMMARY
) {
192 $returnCode = $this->summary($values);
194 elseif ($mode == self
::MODE_IMPORT
) {
195 //print "Running parser in import mode<br/>\n";
196 $returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress);
197 if ($statusID && (($this->_rowCount %
50) == 0)) {
198 $prevTimestamp = $this->progressImport($statusID, FALSE, $startTimestamp, $prevTimestamp, $totalRowCount);
202 $returnCode = self
::ERROR
;
205 // note that a line could be valid but still produce a warning
206 if ($returnCode & self
::VALID
) {
207 $this->_validCount++
;
208 if ($mode == self
::MODE_MAPFIELD
) {
209 $this->_rows
[] = $values;
210 $this->_activeFieldCount
= max($this->_activeFieldCount
, count($values));
214 if ($returnCode & self
::WARNING
) {
215 $this->_warningCount++
;
216 if ($this->_warningCount
< $this->_maxWarningCount
) {
217 $this->_warningCount
[] = $line;
221 if ($returnCode & self
::ERROR
) {
222 $this->_invalidRowCount++
;
223 array_unshift($values, $this->_rowCount
);
224 $this->_errors
[] = $values;
227 if ($returnCode & self
::CONFLICT
) {
228 $this->_conflictCount++
;
229 array_unshift($values, $this->_rowCount
);
230 $this->_conflicts
[] = $values;
233 if ($returnCode & self
::NO_MATCH
) {
234 $this->_unMatchCount++
;
235 array_unshift($values, $this->_rowCount
);
236 $this->_unMatch
[] = $values;
239 if ($returnCode & self
::DUPLICATE
) {
240 if ($returnCode & self
::MULTIPLE_DUPE
) {
241 /* TODO: multi-dupes should be counted apart from singles
242 * on non-skip action */
244 $this->_duplicateCount++
;
245 array_unshift($values, $this->_rowCount
);
246 $this->_duplicates
[] = $values;
247 if ($onDuplicate != self
::DUPLICATE_SKIP
) {
248 $this->_validCount++
;
252 if ($returnCode & self
::UNPARSED_ADDRESS_WARNING
) {
253 $this->_unparsedAddressCount++
;
254 array_unshift($values, $this->_rowCount
);
255 $this->_unparsedAddresses
[] = $values;
257 // we give the derived class a way of aborting the process
258 // note that the return code could be multiple code or'ed together
259 if ($returnCode & self
::STOP
) {
263 // if we are done processing the maxNumber of lines, break
264 if ($this->_maxLinesToProcess
> 0 && $this->_validCount
>= $this->_maxLinesToProcess
) {
268 // see if we've hit our timeout yet
269 /* if ( $the_thing_with_the_stuff ) {
274 if ($mode == self
::MODE_PREVIEW ||
$mode == self
::MODE_IMPORT
) {
275 $customHeaders = $mapper;
277 $customfields = CRM_Core_BAO_CustomField
::getFields($this->_contactType
);
278 foreach ($customHeaders as $key => $value) {
279 if ($id = CRM_Core_BAO_CustomField
::getKeyID($value)) {
280 $customHeaders[$key] = $customfields[$id][0];
284 if ($this->_invalidRowCount
) {
285 // removed view url for invlaid contacts
286 $headers = array_merge([
290 $this->_errorFileName
= self
::errorFileName(self
::ERROR
);
291 self
::exportCSV($this->_errorFileName
, $headers, $this->_errors
);
293 if ($this->_conflictCount
) {
294 $headers = array_merge([
298 $this->_conflictFileName
= self
::errorFileName(self
::CONFLICT
);
299 self
::exportCSV($this->_conflictFileName
, $headers, $this->_conflicts
);
301 if ($this->_duplicateCount
) {
302 $headers = array_merge([
304 ts('View Contact URL'),
307 $this->_duplicateFileName
= self
::errorFileName(self
::DUPLICATE
);
308 self
::exportCSV($this->_duplicateFileName
, $headers, $this->_duplicates
);
310 if ($this->_unMatchCount
) {
311 $headers = array_merge([
316 $this->_misMatchFilemName
= self
::errorFileName(self
::NO_MATCH
);
317 self
::exportCSV($this->_misMatchFilemName
, $headers, $this->_unMatch
);
319 if ($this->_unparsedAddressCount
) {
320 $headers = array_merge([
322 ts('Contact Edit URL'),
324 $this->_errorFileName
= self
::errorFileName(self
::UNPARSED_ADDRESS_WARNING
);
325 self
::exportCSV($this->_errorFileName
, $headers, $this->_unparsedAddresses
);
328 //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
329 return $this->fini();
333 * Given a list of the importable field keys that the user has selected.
334 * set the active fields array to this list
336 * @param array $fieldKeys
337 * Mapped array of values.
339 public function setActiveFields($fieldKeys) {
340 $this->_activeFieldCount
= count($fieldKeys);
341 foreach ($fieldKeys as $key) {
342 if (empty($this->_fields
[$key])) {
343 $this->_activeFields
[] = new CRM_Contact_Import_Field('', ts('- do not import -'));
346 $this->_activeFields
[] = clone($this->_fields
[$key]);
354 public function setActiveFieldLocationTypes($elements) {
355 for ($i = 0; $i < count($elements); $i++
) {
356 $this->_activeFields
[$i]->_hasLocationType
= $elements[$i];
367 public function setActiveFieldPhoneTypes($elements) {
368 for ($i = 0; $i < count($elements); $i++
) {
369 $this->_activeFields
[$i]->_phoneType
= $elements[$i];
376 public function setActiveFieldWebsiteTypes($elements) {
377 for ($i = 0; $i < count($elements); $i++
) {
378 $this->_activeFields
[$i]->_websiteType
= $elements[$i];
383 * Set IM Service Provider type fields.
385 * @param array $elements
386 * IM service provider type ids.
388 public function setActiveFieldImProviders($elements) {
389 for ($i = 0; $i < count($elements); $i++
) {
390 $this->_activeFields
[$i]->_imProvider
= $elements[$i];
397 public function setActiveFieldRelated($elements) {
398 for ($i = 0; $i < count($elements); $i++
) {
399 $this->_activeFields
[$i]->_related
= $elements[$i];
406 public function setActiveFieldRelatedContactType($elements) {
407 for ($i = 0; $i < count($elements); $i++
) {
408 $this->_activeFields
[$i]->_relatedContactType
= $elements[$i];
415 public function setActiveFieldRelatedContactDetails($elements) {
416 for ($i = 0; $i < count($elements); $i++
) {
417 $this->_activeFields
[$i]->_relatedContactDetails
= $elements[$i];
424 public function setActiveFieldRelatedContactLocType($elements) {
425 for ($i = 0; $i < count($elements); $i++
) {
426 $this->_activeFields
[$i]->_relatedContactLocType
= $elements[$i];
431 * Set active field for related contact's phone type.
433 * @param array $elements
435 public function setActiveFieldRelatedContactPhoneType($elements) {
436 for ($i = 0; $i < count($elements); $i++
) {
437 $this->_activeFields
[$i]->_relatedContactPhoneType
= $elements[$i];
444 public function setActiveFieldRelatedContactWebsiteType($elements) {
445 for ($i = 0; $i < count($elements); $i++
) {
446 $this->_activeFields
[$i]->_relatedContactWebsiteType
= $elements[$i];
451 * Set IM Service Provider type fields for related contacts.
453 * @param array $elements
454 * IM service provider type ids of related contact.
456 public function setActiveFieldRelatedContactImProvider($elements) {
457 for ($i = 0; $i < count($elements); $i++
) {
458 $this->_activeFields
[$i]->_relatedContactImProvider
= $elements[$i];
463 * Format the field values for input to the api.
466 * (reference ) associative array of name/value pairs
468 public function &getActiveFieldParams() {
471 for ($i = 0; $i < $this->_activeFieldCount
; $i++
) {
472 if ($this->_activeFields
[$i]->_name
== 'do_not_import') {
476 if (isset($this->_activeFields
[$i]->_value
)) {
477 if (isset($this->_activeFields
[$i]->_hasLocationType
)) {
478 if (!isset($params[$this->_activeFields
[$i]->_name
])) {
479 $params[$this->_activeFields
[$i]->_name
] = [];
483 $this->_activeFields
[$i]->_name
=> $this->_activeFields
[$i]->_value
,
484 'location_type_id' => $this->_activeFields
[$i]->_hasLocationType
,
487 if (isset($this->_activeFields
[$i]->_phoneType
)) {
488 $value['phone_type_id'] = $this->_activeFields
[$i]->_phoneType
;
491 // get IM service Provider type id
492 if (isset($this->_activeFields
[$i]->_imProvider
)) {
493 $value['provider_id'] = $this->_activeFields
[$i]->_imProvider
;
496 $params[$this->_activeFields
[$i]->_name
][] = $value;
498 elseif (isset($this->_activeFields
[$i]->_websiteType
)) {
500 $this->_activeFields
[$i]->_name
=> $this->_activeFields
[$i]->_value
,
501 'website_type_id' => $this->_activeFields
[$i]->_websiteType
,
504 $params[$this->_activeFields
[$i]->_name
][] = $value;
507 if (!isset($params[$this->_activeFields
[$i]->_name
])) {
508 if (!isset($this->_activeFields
[$i]->_related
)) {
509 $params[$this->_activeFields
[$i]->_name
] = $this->_activeFields
[$i]->_value
;
513 //minor fix for CRM-4062
514 if (isset($this->_activeFields
[$i]->_related
)) {
515 if (!isset($params[$this->_activeFields
[$i]->_related
])) {
516 $params[$this->_activeFields
[$i]->_related
] = [];
519 if (!isset($params[$this->_activeFields
[$i]->_related
]['contact_type']) && !empty($this->_activeFields
[$i]->_relatedContactType
)) {
520 $params[$this->_activeFields
[$i]->_related
]['contact_type'] = $this->_activeFields
[$i]->_relatedContactType
;
523 if (isset($this->_activeFields
[$i]->_relatedContactLocType
) && !empty($this->_activeFields
[$i]->_value
)) {
524 if (!empty($params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
]) &&
525 !is_array($params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
])
527 $params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
] = [];
530 $this->_activeFields
[$i]->_relatedContactDetails
=> $this->_activeFields
[$i]->_value
,
531 'location_type_id' => $this->_activeFields
[$i]->_relatedContactLocType
,
534 if (isset($this->_activeFields
[$i]->_relatedContactPhoneType
)) {
535 $value['phone_type_id'] = $this->_activeFields
[$i]->_relatedContactPhoneType
;
538 // get IM service Provider type id for related contact
539 if (isset($this->_activeFields
[$i]->_relatedContactImProvider
)) {
540 $value['provider_id'] = $this->_activeFields
[$i]->_relatedContactImProvider
;
543 $params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
][] = $value;
545 elseif (isset($this->_activeFields
[$i]->_relatedContactWebsiteType
)) {
546 $params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
][] = [
547 'url' => $this->_activeFields
[$i]->_value
,
548 'website_type_id' => $this->_activeFields
[$i]->_relatedContactWebsiteType
,
552 $params[$this->_activeFields
[$i]->_related
][$this->_activeFields
[$i]->_relatedContactDetails
] = $this->_activeFields
[$i]->_value
;
564 public function getColumnPatterns() {
565 CRM_Core_Error
::deprecatedFunctionWarning('no longer used- use CRM_Contact_Import_MetadataTrait');
567 foreach ($this->_fields
as $name => $field) {
568 $values[$name] = $field->_columnPattern
;
574 * @param string $name
577 * @param string $headerPattern
578 * @param string $dataPattern
579 * @param bool $hasLocationType
581 public function addField(
582 $name, $title, $type = CRM_Utils_Type
::T_INT
,
583 $headerPattern = '//', $dataPattern = '//',
584 $hasLocationType = FALSE
586 $this->_fields
[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
588 $this->_fields
['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
593 * Store parser values.
595 * @param CRM_Core_Session $store
599 public function set($store, $mode = self
::MODE_SUMMARY
) {
600 $store->set('rowCount', $this->_rowCount
);
601 $store->set('fields', $this->getSelectValues());
602 $store->set('fieldTypes', $this->getSelectTypes());
604 $store->set('columnCount', $this->_activeFieldCount
);
606 $store->set('totalRowCount', $this->_totalCount
);
607 $store->set('validRowCount', $this->_validCount
);
608 $store->set('invalidRowCount', $this->_invalidRowCount
);
609 $store->set('conflictRowCount', $this->_conflictCount
);
610 $store->set('unMatchCount', $this->_unMatchCount
);
612 switch ($this->_contactType
) {
614 $store->set('contactType', CRM_Import_Parser
::CONTACT_INDIVIDUAL
);
618 $store->set('contactType', CRM_Import_Parser
::CONTACT_HOUSEHOLD
);
622 $store->set('contactType', CRM_Import_Parser
::CONTACT_ORGANIZATION
);
625 if ($this->_invalidRowCount
) {
626 $store->set('errorsFileName', $this->_errorFileName
);
628 if ($this->_conflictCount
) {
629 $store->set('conflictsFileName', $this->_conflictFileName
);
631 if (isset($this->_rows
) && !empty($this->_rows
)) {
632 $store->set('dataValues', $this->_rows
);
635 if ($this->_unMatchCount
) {
636 $store->set('mismatchFileName', $this->_misMatchFilemName
);
639 if ($mode == self
::MODE_IMPORT
) {
640 $store->set('duplicateRowCount', $this->_duplicateCount
);
641 $store->set('unparsedAddressCount', $this->_unparsedAddressCount
);
642 if ($this->_duplicateCount
) {
643 $store->set('duplicatesFileName', $this->_duplicateFileName
);
645 if ($this->_unparsedAddressCount
) {
646 $store->set('errorsFileName', $this->_errorFileName
);
649 //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
653 * Export data to a CSV file.
655 * @param string $fileName
656 * @param array $header
659 public static function exportCSV($fileName, $header, $data) {
661 if (file_exists($fileName) && !is_writable($fileName)) {
662 CRM_Core_Error
::movedSiteError($fileName);
664 //hack to remove '_status', '_statusMsg' and '_id' from error file
666 $dbRecordStatus = ['IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW'];
667 foreach ($data as $rowCount => $rowValues) {
669 foreach ($rowValues as $key => $val) {
670 if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) {
673 $errorValues[$rowCount][$key] = $val;
677 $data = $errorValues;
680 $fd = fopen($fileName, 'w');
682 foreach ($header as $key => $value) {
683 $header[$key] = "\"$value\"";
685 $config = CRM_Core_Config
::singleton();
686 $output[] = implode($config->fieldSeparator
, $header);
688 foreach ($data as $datum) {
689 foreach ($datum as $key => $value) {
690 $datum[$key] = "\"$value\"";
692 $output[] = implode($config->fieldSeparator
, $datum);
694 fwrite($fd, implode("\n", $output));
699 * Update the record with PK $id in the import database table.
702 * @param array $params
704 public function updateImportRecord($id, &$params) {
705 $statusFieldName = $this->_statusFieldName
;
706 $primaryKeyName = $this->_primaryKeyName
;
708 if ($statusFieldName && $primaryKeyName) {
709 $dao = new CRM_Core_DAO();
710 $db = $dao->getDatabaseConnection();
712 $query = "UPDATE $this->_tableName
713 SET $statusFieldName = ?,
714 ${statusFieldName}Msg = ?
715 WHERE $primaryKeyName = ?";
717 $params[$statusFieldName],
718 CRM_Utils_Array
::value("${statusFieldName}Msg", $params),
722 //print "Running query: $query<br/>With arguments: ".$params[$statusFieldName].", ".$params["${statusFieldName}Msg"].", $id<br/>";
724 $db->query($query, $args);
729 * Format common params data to proper format to store.
731 * @param array $params
732 * Contain record values.
733 * @param array $formatted
734 * Array of formatted data.
735 * @param array $contactFields
736 * Contact DAO fields.
738 public function formatCommonData($params, &$formatted, &$contactFields) {
740 CRM_Utils_Array
::value('contact_type', $formatted),
744 //add custom fields for contact sub type
745 if (!empty($this->_contactSubType
)) {
746 $csType = $this->_contactSubType
;
749 if ($relCsType = CRM_Utils_Array
::value('contact_sub_type', $formatted)) {
750 $csType = $relCsType;
753 $customFields = CRM_Core_BAO_CustomField
::getFields($formatted['contact_type'], FALSE, FALSE, $csType);
755 $addressCustomFields = CRM_Core_BAO_CustomField
::getFields('Address');
756 $customFields = $customFields +
$addressCustomFields;
758 //if a Custom Email Greeting, Custom Postal Greeting or Custom Addressee is mapped, and no "Greeting / Addressee Type ID" is provided, then automatically set the type = Customized, CRM-4575
760 'email_greeting_custom' => 'email_greeting',
761 'postal_greeting_custom' => 'postal_greeting',
762 'addressee_custom' => 'addressee',
764 foreach ($elements as $k => $v) {
765 if (array_key_exists($k, $params) && !(array_key_exists($v, $params))) {
766 $label = key(CRM_Core_OptionGroup
::values($v, TRUE, NULL, NULL, 'AND v.name = "Customized"'));
767 $params[$v] = $label;
772 $session = CRM_Core_Session
::singleton();
773 $dateType = $session->get("dateTypes");
774 foreach ($params as $key => $val) {
775 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key);
776 if ($customFieldID &&
777 !array_key_exists($customFieldID, $addressCustomFields)
779 //we should not update Date to null, CRM-4062
780 if ($val && ($customFields[$customFieldID]['data_type'] == 'Date')) {
782 CRM_Contact_Import_Parser_Contact
::formatCustomDate($params, $formatted, $dateType, $key);
784 elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
785 if (empty($val) && !is_numeric($val) && $this->_onDuplicate
== CRM_Import_Parser
::DUPLICATE_FILL
) {
786 //retain earlier value when Import mode is `Fill`
787 unset($params[$key]);
790 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
795 if ($key == 'birth_date' && $val) {
796 CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key);
798 elseif ($key == 'deceased_date' && $val) {
799 CRM_Utils_Date
::convertToDefaultDate($params, $dateType, $key);
800 $params['is_deceased'] = 1;
802 elseif ($key == 'is_deceased' && $val) {
803 $params[$key] = CRM_Utils_String
::strtoboolstr($val);
807 //now format custom data.
808 foreach ($params as $key => $field) {
809 if (is_array($field)) {
810 $isAddressCustomField = FALSE;
811 foreach ($field as $value) {
813 if (is_array($value)) {
814 foreach ($value as $name => $testForEmpty) {
815 if ($addressCustomFieldID = CRM_Core_BAO_CustomField
::getKeyID($name)) {
816 $isAddressCustomField = TRUE;
819 // check if $value does not contain IM provider or phoneType
820 if (($name !== 'phone_type_id' ||
$name !== 'provider_id') && ($testForEmpty === '' ||
$testForEmpty == NULL)) {
831 if (!empty($value['location_type_id'])) {
832 $this->formatLocationBlock($value, $formatted);
835 CRM_Core_Error
::deprecatedFunctionWarning('this is not expected to be reachable now');
836 $this->formatContactParameters($value, $formatted);
840 if (!$isAddressCustomField) {
849 if (($key !== 'preferred_communication_method') && (array_key_exists($key, $contactFields))) {
850 // due to merging of individual table and
851 // contact table, we need to avoid
852 // preferred_communication_method forcefully
853 $formatValues['contact_type'] = $formatted['contact_type'];
856 if ($key == 'id' && isset($field)) {
857 $formatted[$key] = $field;
859 $this->formatContactParameters($formatValues, $formatted);
861 //Handling Custom Data
862 // note: Address custom fields will be handled separately inside formatContactParameters
863 if (($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) &&
864 array_key_exists($customFieldID, $customFields) &&
865 !array_key_exists($customFieldID, $addressCustomFields)
868 $extends = $customFields[$customFieldID]['extends'] ??
NULL;
869 $htmlType = $customFields[$customFieldID]['html_type'] ??
NULL;
870 $dataType = $customFields[$customFieldID]['data_type'] ??
NULL;
871 $serialized = CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID]);
873 if (!$serialized && in_array($htmlType, ['Select', 'Radio', 'Autocomplete-Select']) && in_array($dataType, ['String', 'Int'])) {
874 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
875 foreach ($customOption as $customValue) {
876 $val = $customValue['value'] ??
NULL;
877 $label = strtolower($customValue['label'] ??
'');
878 $value = strtolower(trim($formatted[$key]));
879 if (($value == $label) ||
($value == strtolower($val))) {
880 $params[$key] = $formatted[$key] = $val;
884 elseif ($serialized && !empty($formatted[$key]) && !empty($params[$key])) {
885 $mulValues = explode(',', $formatted[$key]);
886 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
887 $formatted[$key] = [];
889 foreach ($mulValues as $v1) {
890 foreach ($customOption as $v2) {
891 if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
892 (strtolower($v2['value']) == strtolower(trim($v1)))
894 if ($htmlType == 'CheckBox') {
895 $params[$key][$v2['value']] = $formatted[$key][$v2['value']] = 1;
898 $params[$key][] = $formatted[$key][] = $v2['value'];
907 if (!empty($key) && ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) && array_key_exists($customFieldID, $customFields) &&
908 !array_key_exists($customFieldID, $addressCustomFields)
910 // @todo calling api functions directly is not supported
911 _civicrm_api3_custom_format_params($params, $formatted, $extends);
914 // to check if not update mode and unset the fields with empty value.
915 if (!$this->_updateWithId
&& array_key_exists('custom', $formatted)) {
916 foreach ($formatted['custom'] as $customKey => $customvalue) {
917 if (empty($formatted['custom'][$customKey][-1]['is_required'])) {
918 $formatted['custom'][$customKey][-1]['is_required'] = $customFields[$customKey]['is_required'];
920 $emptyValue = $customvalue[-1]['value'] ??
NULL;
921 if (!isset($emptyValue)) {
922 unset($formatted['custom'][$customKey]);
927 // parse street address, CRM-5450
928 if ($this->_parseStreetAddress
) {
929 if (array_key_exists('address', $formatted) && is_array($formatted['address'])) {
930 foreach ($formatted['address'] as $instance => & $address) {
931 $streetAddress = $address['street_address'] ??
NULL;
932 if (empty($streetAddress)) {
935 // parse address field.
936 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($streetAddress);
938 //street address consider to be parsed properly,
939 //If we get street_name and street_number.
940 if (empty($parsedFields['street_name']) ||
empty($parsedFields['street_number'])) {
941 $parsedFields = array_fill_keys(array_keys($parsedFields), '');
944 // merge parse address w/ main address block.
945 $address = array_merge($address, $parsedFields);
952 * Format contact parameters.
954 * @todo this function needs re-writing & re-merging into the main function.
958 * @param array $values
959 * @param array $params
963 protected function formatContactParameters(&$values, &$params) {
964 // Crawl through the possible classes:
977 // first add core contact values since for other Civi modules they are not added
978 $contactFields = CRM_Contact_DAO_Contact
::fields();
979 _civicrm_api3_store_values($contactFields, $values, $params);
981 if (isset($values['contact_type'])) {
982 // we're an individual/household/org property
984 $fields[$values['contact_type']] = CRM_Contact_DAO_Contact
::fields();
986 _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
990 // Cache the various object fields
991 // @todo - remove this after confirming this is just a compilation of other-wise-cached fields.
994 if (isset($values['individual_prefix'])) {
995 if (!empty($params['prefix_id'])) {
996 $prefixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'prefix_id');
997 $params['prefix'] = $prefixes[$params['prefix_id']];
1000 $params['prefix'] = $values['individual_prefix'];
1005 if (isset($values['individual_suffix'])) {
1006 if (!empty($params['suffix_id'])) {
1007 $suffixes = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'suffix_id');
1008 $params['suffix'] = $suffixes[$params['suffix_id']];
1011 $params['suffix'] = $values['individual_suffix'];
1017 if (isset($values['email_greeting'])) {
1018 if (!empty($params['email_greeting_id'])) {
1019 $emailGreetingFilter = [
1020 'contact_type' => $params['contact_type'] ??
NULL,
1021 'greeting_type' => 'email_greeting',
1023 $emailGreetings = CRM_Core_PseudoConstant
::greeting($emailGreetingFilter);
1024 $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
1027 $params['email_greeting'] = $values['email_greeting'];
1033 if (isset($values['postal_greeting'])) {
1034 if (!empty($params['postal_greeting_id'])) {
1035 $postalGreetingFilter = [
1036 'contact_type' => $params['contact_type'] ??
NULL,
1037 'greeting_type' => 'postal_greeting',
1039 $postalGreetings = CRM_Core_PseudoConstant
::greeting($postalGreetingFilter);
1040 $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
1043 $params['postal_greeting'] = $values['postal_greeting'];
1048 if (isset($values['addressee'])) {
1049 if (!empty($params['addressee_id'])) {
1050 $addresseeFilter = [
1051 'contact_type' => $params['contact_type'] ??
NULL,
1052 'greeting_type' => 'addressee',
1054 $addressee = CRM_Core_PseudoConstant
::addressee($addresseeFilter);
1055 $params['addressee'] = $addressee[$params['addressee_id']];
1058 $params['addressee'] = $values['addressee'];
1063 if (isset($values['gender'])) {
1064 if (!empty($params['gender_id'])) {
1065 $genders = CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'gender_id');
1066 $params['gender'] = $genders[$params['gender_id']];
1069 $params['gender'] = $values['gender'];
1074 if (!empty($values['preferred_communication_method'])) {
1076 $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant
::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER
);
1078 $preffComm = explode(',', $values['preferred_communication_method']);
1079 foreach ($preffComm as $v) {
1080 $v = strtolower(trim($v));
1081 if (array_key_exists($v, $pcm)) {
1082 $comm[$pcm[$v]] = 1;
1086 $params['preferred_communication_method'] = $comm;
1090 // format the website params.
1091 if (!empty($values['url'])) {
1092 static $websiteFields;
1093 if (!is_array($websiteFields)) {
1094 $websiteFields = CRM_Core_DAO_Website
::fields();
1096 if (!array_key_exists('website', $params) ||
1097 !is_array($params['website'])
1099 $params['website'] = [];
1102 $websiteCount = count($params['website']);
1103 _civicrm_api3_store_values($websiteFields, $values,
1104 $params['website'][++
$websiteCount]
1110 // get the formatted location blocks into params - w/ 3.0 format, CRM-4605
1111 if (!empty($values['location_type_id'])) {
1112 CRM_Core_Error
::deprecatedFunctionWarning('this is not expected to be reachable now');
1113 return $this->formatLocationBlock($values, $params);
1116 if (isset($values['note'])) {
1118 if (!isset($params['note'])) {
1119 $params['note'] = [];
1121 $noteBlock = count($params['note']) +
1;
1123 $params['note'][$noteBlock] = [];
1124 if (!isset($fields['Note'])) {
1125 $fields['Note'] = CRM_Core_DAO_Note
::fields();
1128 // get the current logged in civicrm user
1129 $session = CRM_Core_Session
::singleton();
1130 $userID = $session->get('userID');
1133 $values['contact_id'] = $userID;
1136 _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
1141 // Check for custom field values
1142 $customFields = CRM_Core_BAO_CustomField
::getFields(CRM_Utils_Array
::value('contact_type', $values),
1143 FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
1146 foreach ($values as $key => $value) {
1147 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key)) {
1148 // check if it's a valid custom field id
1150 if (!array_key_exists($customFieldID, $customFields)) {
1151 return civicrm_api3_create_error('Invalid custom field ID');
1154 $params[$key] = $value;
1162 * Format location block ready for importing.
1164 * There is some test coverage for this in CRM_Contact_Import_Parser_ContactTest
1165 * e.g. testImportPrimaryAddress.
1167 * @param array $values
1168 * @param array $params
1172 protected function formatLocationBlock(&$values, &$params) {
1177 'openid' => 'OpenID',
1178 'phone_ext' => 'Phone',
1180 foreach ($blockTypes as $blockFieldName => $block) {
1181 if (!array_key_exists($blockFieldName, $values)) {
1184 $blockIndex = $values['location_type_id'] . (!empty($values['phone_type_id']) ?
'_' . $values['phone_type_id'] : '');
1186 // block present in value array.
1187 if (!array_key_exists($blockFieldName, $params) ||
!is_array($params[$blockFieldName])) {
1188 $params[$blockFieldName] = [];
1191 $fields[$block] = $this->getMetadataForEntity($block);
1193 // copy value to dao field name.
1194 if ($blockFieldName == 'im') {
1195 $values['name'] = $values[$blockFieldName];
1198 _civicrm_api3_store_values($fields[$block], $values,
1199 $params[$blockFieldName][$blockIndex]
1202 $this->fillPrimary($params[$blockFieldName][$blockIndex], $values, $block, CRM_Utils_Array
::value('id', $params));
1204 if (empty($params['id']) && (count($params[$blockFieldName]) == 1)) {
1205 $params[$blockFieldName][$blockIndex]['is_primary'] = TRUE;
1208 // we only process single block at a time.
1212 // handle address fields.
1213 if (!array_key_exists('address', $params) ||
!is_array($params['address'])) {
1214 $params['address'] = [];
1217 // Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
1218 // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
1219 // the address in CRM_Core_BAO_Address::create method
1220 if (!empty($values['location_type_id'])) {
1221 static $customFields = [];
1222 if (empty($customFields)) {
1223 $customFields = CRM_Core_BAO_CustomField
::getFields('Address');
1225 // make a copy of values, as we going to make changes
1226 $newValues = $values;
1227 foreach ($values as $key => $val) {
1228 $customFieldID = CRM_Core_BAO_CustomField
::getKeyID($key);
1229 if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
1231 $htmlType = $customFields[$customFieldID]['html_type'] ??
NULL;
1232 if (CRM_Core_BAO_CustomField
::isSerialized($customFields[$customFieldID]) && $val) {
1233 $mulValues = explode(',', $val);
1234 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldID, TRUE);
1235 $newValues[$key] = [];
1236 foreach ($mulValues as $v1) {
1237 foreach ($customOption as $v2) {
1238 if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
1239 (strtolower($v2['value']) == strtolower(trim($v1)))
1241 if ($htmlType == 'CheckBox') {
1242 $newValues[$key][$v2['value']] = 1;
1245 $newValues[$key][] = $v2['value'];
1253 // consider new values
1254 $values = $newValues;
1257 $fields['Address'] = $this->getMetadataForEntity('Address');
1258 // @todo this is kinda replicated below....
1259 _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]);
1265 'supplemental_address_1',
1266 'supplemental_address_2',
1267 'supplemental_address_3',
1268 'StateProvince.name',
1270 foreach (array_keys($customFields) as $customFieldID) {
1271 $addressFields[] = 'custom_' . $customFieldID;
1274 foreach ($addressFields as $field) {
1275 if (array_key_exists($field, $values)) {
1276 if (!array_key_exists('address', $params)) {
1277 $params['address'] = [];
1279 $params['address'][$values['location_type_id']][$field] = $values[$field];
1283 $this->fillPrimary($params['address'][$values['location_type_id']], $values, 'address', CRM_Utils_Array
::value('id', $params));
1288 * Get the field metadata for the relevant entity.
1290 * @param string $entity
1294 protected function getMetadataForEntity($entity) {
1295 if (!isset($this->fieldMetadata
[$entity])) {
1296 $className = "CRM_Core_DAO_$entity";
1297 $this->fieldMetadata
[$entity] = $className::fields();
1299 return $this->fieldMetadata
[$entity];
1303 * Fill in the primary location.
1305 * If the contact has a primary address we update it. Otherwise
1306 * we add an address of the default location type.
1308 * @param array $params
1309 * Address block parameters
1310 * @param array $values
1312 * @param string $entity
1313 * - address, email, phone
1314 * @param int|null $contactID
1316 * @throws \CiviCRM_API3_Exception
1318 protected function fillPrimary(&$params, $values, $entity, $contactID) {
1319 if ($values['location_type_id'] === 'Primary') {
1321 $primary = civicrm_api3($entity, 'get', [
1322 'return' => 'location_type_id',
1323 'contact_id' => $contactID,
1328 $defaultLocationType = CRM_Core_BAO_LocationType
::getDefault();
1329 $params['location_type_id'] = (int) (isset($primary) && $primary['count']) ?
$primary['values'][0]['location_type_id'] : $defaultLocationType->id
;
1330 $params['is_primary'] = 1;