CRM/Contact/Import/Parser.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 abstract class CRM_Contact_Import_Parser extends CRM_Import_Parser {
  34
  35   protected $_tableName;
  36
  37   /**
  38    * Total number of lines in file
  39    *
  40    * @var int
  41    */
  42   protected $_rowCount;
  43
  44   /**
  45    * Running total number of un-matched Contacts.
  46    *
  47    * @var int
  48    */
  49   protected $_unMatchCount;
  50
  51   /**
  52    * Array of unmatched lines.
  53    *
  54    * @var array
  55    */
  56   protected $_unMatch;
  57
  58   /**
  59    * Total number of contacts with unparsed addresses
  60    * @var int
  61    */
  62   protected $_unparsedAddressCount;
  63
  64   /**
  65    * Filename of mismatch data
  66    *
  67    * @var string
  68    */
  69   protected $_misMatchFilemName;
  70
  71   protected $_primaryKeyName;
  72   protected $_statusFieldName;
  73
  74   protected $fieldMetadata = [];
  75   /**
  76    * On duplicate
  77    *
  78    * @var int
  79    */
  80   public $_onDuplicate;
  81
  82   /**
  83    * Dedupe rule group id to use if set
  84    *
  85    * @var int
  86    */
  87   public $_dedupeRuleGroupID = NULL;
  88
  89   /**
  90    * Run import.
  91    *
  92    * @param string $tableName
  93    * @param array $mapper
  94    * @param int $mode
  95    * @param int $contactType
  96    * @param string $primaryKeyName
  97    * @param string $statusFieldName
  98    * @param int $onDuplicate
  99    * @param int $statusID
 100    * @param int $totalRowCount
 101    * @param bool $doGeocodeAddress
 102    * @param int $timeout
 103    * @param string $contactSubType
 104    * @param int $dedupeRuleGroupID
 105    *
 106    * @return mixed
 107    */
 108   public function run(
 109     $tableName,
 110     $mapper = [],
 111     $mode = self::MODE_PREVIEW,
 112     $contactType = self::CONTACT_INDIVIDUAL,
 113     $primaryKeyName = '_id',
 114     $statusFieldName = '_status',
 115     $onDuplicate = self::DUPLICATE_SKIP,
 116     $statusID = NULL,
 117     $totalRowCount = NULL,
 118     $doGeocodeAddress = FALSE,
 119     $timeout = CRM_Contact_Import_Parser::DEFAULT_TIMEOUT,
 120     $contactSubType = NULL,
 121     $dedupeRuleGroupID = NULL
 122   ) {
 123
 124     // TODO: Make the timeout actually work
 125     $this->_onDuplicate = $onDuplicate;
 126     $this->_dedupeRuleGroupID = $dedupeRuleGroupID;
 127
 128     switch ($contactType) {
 129       case CRM_Import_Parser::CONTACT_INDIVIDUAL:
 130         $this->_contactType = 'Individual';
 131         break;
 132
 133       case CRM_Import_Parser::CONTACT_HOUSEHOLD:
 134         $this->_contactType = 'Household';
 135         break;
 136
 137       case CRM_Import_Parser::CONTACT_ORGANIZATION:
 138         $this->_contactType = 'Organization';
 139     }
 140
 141     $this->_contactSubType = $contactSubType;
 142
 143     $this->init();
 144
 145     $this->_rowCount = $this->_warningCount = 0;
 146     $this->_invalidRowCount = $this->_validCount = 0;
 147     $this->_totalCount = $this->_conflictCount = 0;
 148
 149     $this->_errors = [];
 150     $this->_warnings = [];
 151     $this->_conflicts = [];
 152     $this->_unparsedAddresses = [];
 153
 154     $this->_tableName = $tableName;
 155     $this->_primaryKeyName = $primaryKeyName;
 156     $this->_statusFieldName = $statusFieldName;
 157
 158     if ($mode == self::MODE_MAPFIELD) {
 159       $this->_rows = [];
 160     }
 161     else {
 162       $this->_activeFieldCount = count($this->_activeFields);
 163     }
 164
 165     if ($mode == self::MODE_IMPORT) {
 166       //get the key of email field
 167       foreach ($mapper as $key => $value) {
 168         if (strtolower($value) == 'email') {
 169           $emailKey = $key;
 170           break;
 171         }
 172       }
 173     }
 174
 175     if ($statusID) {
 176       $this->progressImport($statusID);
 177       $startTimestamp = $currTimestamp = $prevTimestamp = time();
 178     }
 179     // get the contents of the temp. import table
 180     $query = "SELECT * FROM $tableName";
 181     if ($mode == self::MODE_IMPORT) {
 182       $query .= " WHERE $statusFieldName = 'NEW'";
 183     }
 184
 185     $result = CRM_Core_DAO::executeQuery($query);
 186
 187     while ($result->fetch()) {
 188       $values = array_values($result->toArray());
 189       $this->_rowCount++;
 190
 191       /* trim whitespace around the values */
 192       foreach ($values as $k => $v) {
 193         $values[$k] = trim($v, " \t\r\n");
 194       }
 195       if (CRM_Utils_System::isNull($values)) {
 196         continue;
 197       }
 198
 199       $this->_totalCount++;
 200
 201       if ($mode == self::MODE_MAPFIELD) {
 202         $returnCode = $this->mapField($values);
 203       }
 204       elseif ($mode == self::MODE_PREVIEW) {
 205         $returnCode = $this->preview($values);
 206       }
 207       elseif ($mode == self::MODE_SUMMARY) {
 208         $returnCode = $this->summary($values);
 209       }
 210       elseif ($mode == self::MODE_IMPORT) {
 211         //print "Running parser in import mode<br/>\n";
 212         $returnCode = $this->import($onDuplicate, $values, $doGeocodeAddress);
 213         if ($statusID && (($this->_rowCount % 50) == 0)) {
 214           $prevTimestamp = $this->progressImport($statusID, FALSE, $startTimestamp, $prevTimestamp, $totalRowCount);
 215         }
 216       }
 217       else {
 218         $returnCode = self::ERROR;
 219       }
 220
 221       // note that a line could be valid but still produce a warning
 222       if ($returnCode & self::VALID) {
 223         $this->_validCount++;
 224         if ($mode == self::MODE_MAPFIELD) {
 225           $this->_rows[] = $values;
 226           $this->_activeFieldCount = max($this->_activeFieldCount, count($values));
 227         }
 228       }
 229
 230       if ($returnCode & self::WARNING) {
 231         $this->_warningCount++;
 232         if ($this->_warningCount < $this->_maxWarningCount) {
 233           $this->_warningCount[] = $line;
 234         }
 235       }
 236
 237       if ($returnCode & self::ERROR) {
 238         $this->_invalidRowCount++;
 239         array_unshift($values, $this->_rowCount);
 240         $this->_errors[] = $values;
 241       }
 242
 243       if ($returnCode & self::CONFLICT) {
 244         $this->_conflictCount++;
 245         array_unshift($values, $this->_rowCount);
 246         $this->_conflicts[] = $values;
 247       }
 248
 249       if ($returnCode & self::NO_MATCH) {
 250         $this->_unMatchCount++;
 251         array_unshift($values, $this->_rowCount);
 252         $this->_unMatch[] = $values;
 253       }
 254
 255       if ($returnCode & self::DUPLICATE) {
 256         if ($returnCode & self::MULTIPLE_DUPE) {
 257           /* TODO: multi-dupes should be counted apart from singles
 258            * on non-skip action */
 259         }
 260         $this->_duplicateCount++;
 261         array_unshift($values, $this->_rowCount);
 262         $this->_duplicates[] = $values;
 263         if ($onDuplicate != self::DUPLICATE_SKIP) {
 264           $this->_validCount++;
 265         }
 266       }
 267
 268       if ($returnCode & self::UNPARSED_ADDRESS_WARNING) {
 269         $this->_unparsedAddressCount++;
 270         array_unshift($values, $this->_rowCount);
 271         $this->_unparsedAddresses[] = $values;
 272       }
 273       // we give the derived class a way of aborting the process
 274       // note that the return code could be multiple code or'ed together
 275       if ($returnCode & self::STOP) {
 276         break;
 277       }
 278
 279       // if we are done processing the maxNumber of lines, break
 280       if ($this->_maxLinesToProcess > 0 && $this->_validCount >= $this->_maxLinesToProcess) {
 281         break;
 282       }
 283
 284       // see if we've hit our timeout yet
 285       /* if ( $the_thing_with_the_stuff ) {
 286       do_something( );
 287       } */
 288     }
 289
 290     if ($mode == self::MODE_PREVIEW || $mode == self::MODE_IMPORT) {
 291       $customHeaders = $mapper;
 292
 293       $customfields = CRM_Core_BAO_CustomField::getFields($this->_contactType);
 294       foreach ($customHeaders as $key => $value) {
 295         if ($id = CRM_Core_BAO_CustomField::getKeyID($value)) {
 296           $customHeaders[$key] = $customfields[$id][0];
 297         }
 298       }
 299
 300       if ($this->_invalidRowCount) {
 301         // removed view url for invlaid contacts
 302         $headers = array_merge([
 303           ts('Line Number'),
 304           ts('Reason'),
 305         ], $customHeaders);
 306         $this->_errorFileName = self::errorFileName(self::ERROR);
 307         self::exportCSV($this->_errorFileName, $headers, $this->_errors);
 308       }
 309       if ($this->_conflictCount) {
 310         $headers = array_merge([
 311           ts('Line Number'),
 312           ts('Reason'),
 313         ], $customHeaders);
 314         $this->_conflictFileName = self::errorFileName(self::CONFLICT);
 315         self::exportCSV($this->_conflictFileName, $headers, $this->_conflicts);
 316       }
 317       if ($this->_duplicateCount) {
 318         $headers = array_merge([
 319           ts('Line Number'),
 320           ts('View Contact URL'),
 321         ], $customHeaders);
 322
 323         $this->_duplicateFileName = self::errorFileName(self::DUPLICATE);
 324         self::exportCSV($this->_duplicateFileName, $headers, $this->_duplicates);
 325       }
 326       if ($this->_unMatchCount) {
 327         $headers = array_merge([
 328           ts('Line Number'),
 329           ts('Reason'),
 330         ], $customHeaders);
 331
 332         $this->_misMatchFilemName = self::errorFileName(self::NO_MATCH);
 333         self::exportCSV($this->_misMatchFilemName, $headers, $this->_unMatch);
 334       }
 335       if ($this->_unparsedAddressCount) {
 336         $headers = array_merge([
 337           ts('Line Number'),
 338           ts('Contact Edit URL'),
 339         ], $customHeaders);
 340         $this->_errorFileName = self::errorFileName(self::UNPARSED_ADDRESS_WARNING);
 341         self::exportCSV($this->_errorFileName, $headers, $this->_unparsedAddresses);
 342       }
 343     }
 344     //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
 345     return $this->fini();
 346   }
 347
 348   /**
 349    * Given a list of the importable field keys that the user has selected.
 350    * set the active fields array to this list
 351    *
 352    * @param array $fieldKeys
 353    *   Mapped array of values.
 354    */
 355   public function setActiveFields($fieldKeys) {
 356     $this->_activeFieldCount = count($fieldKeys);
 357     foreach ($fieldKeys as $key) {
 358       if (empty($this->_fields[$key])) {
 359         $this->_activeFields[] = new CRM_Contact_Import_Field('', ts('- do not import -'));
 360       }
 361       else {
 362         $this->_activeFields[] = clone($this->_fields[$key]);
 363       }
 364     }
 365   }
 366
 367   /**
 368    * @param $elements
 369    */
 370   public function setActiveFieldLocationTypes($elements) {
 371     for ($i = 0; $i < count($elements); $i++) {
 372       $this->_activeFields[$i]->_hasLocationType = $elements[$i];
 373     }
 374   }
 375
 376   /**
 377    * @param $elements
 378    */
 379
 380   /**
 381    * @param $elements
 382    */
 383   public function setActiveFieldPhoneTypes($elements) {
 384     for ($i = 0; $i < count($elements); $i++) {
 385       $this->_activeFields[$i]->_phoneType = $elements[$i];
 386     }
 387   }
 388
 389   /**
 390    * @param $elements
 391    */
 392   public function setActiveFieldWebsiteTypes($elements) {
 393     for ($i = 0; $i < count($elements); $i++) {
 394       $this->_activeFields[$i]->_websiteType = $elements[$i];
 395     }
 396   }
 397
 398   /**
 399    * Set IM Service Provider type fields.
 400    *
 401    * @param array $elements
 402    *   IM service provider type ids.
 403    */
 404   public function setActiveFieldImProviders($elements) {
 405     for ($i = 0; $i < count($elements); $i++) {
 406       $this->_activeFields[$i]->_imProvider = $elements[$i];
 407     }
 408   }
 409
 410   /**
 411    * @param $elements
 412    */
 413   public function setActiveFieldRelated($elements) {
 414     for ($i = 0; $i < count($elements); $i++) {
 415       $this->_activeFields[$i]->_related = $elements[$i];
 416     }
 417   }
 418
 419   /**
 420    * @param $elements
 421    */
 422   public function setActiveFieldRelatedContactType($elements) {
 423     for ($i = 0; $i < count($elements); $i++) {
 424       $this->_activeFields[$i]->_relatedContactType = $elements[$i];
 425     }
 426   }
 427
 428   /**
 429    * @param $elements
 430    */
 431   public function setActiveFieldRelatedContactDetails($elements) {
 432     for ($i = 0; $i < count($elements); $i++) {
 433       $this->_activeFields[$i]->_relatedContactDetails = $elements[$i];
 434     }
 435   }
 436
 437   /**
 438    * @param $elements
 439    */
 440   public function setActiveFieldRelatedContactLocType($elements) {
 441     for ($i = 0; $i < count($elements); $i++) {
 442       $this->_activeFields[$i]->_relatedContactLocType = $elements[$i];
 443     }
 444   }
 445
 446   /**
 447    * Set active field for related contact's phone type.
 448    *
 449    * @param array $elements
 450    */
 451   public function setActiveFieldRelatedContactPhoneType($elements) {
 452     for ($i = 0; $i < count($elements); $i++) {
 453       $this->_activeFields[$i]->_relatedContactPhoneType = $elements[$i];
 454     }
 455   }
 456
 457   /**
 458    * @param $elements
 459    */
 460   public function setActiveFieldRelatedContactWebsiteType($elements) {
 461     for ($i = 0; $i < count($elements); $i++) {
 462       $this->_activeFields[$i]->_relatedContactWebsiteType = $elements[$i];
 463     }
 464   }
 465
 466   /**
 467    * Set IM Service Provider type fields for related contacts.
 468    *
 469    * @param array $elements
 470    *   IM service provider type ids of related contact.
 471    */
 472   public function setActiveFieldRelatedContactImProvider($elements) {
 473     for ($i = 0; $i < count($elements); $i++) {
 474       $this->_activeFields[$i]->_relatedContactImProvider = $elements[$i];
 475     }
 476   }
 477
 478   /**
 479    * Format the field values for input to the api.
 480    *
 481    * @return array
 482    *   (reference ) associative array of name/value pairs
 483    */
 484   public function &getActiveFieldParams() {
 485     $params = [];
 486
 487     for ($i = 0; $i < $this->_activeFieldCount; $i++) {
 488       if ($this->_activeFields[$i]->_name == 'do_not_import') {
 489         continue;
 490       }
 491
 492       if (isset($this->_activeFields[$i]->_value)) {
 493         if (isset($this->_activeFields[$i]->_hasLocationType)) {
 494           if (!isset($params[$this->_activeFields[$i]->_name])) {
 495             $params[$this->_activeFields[$i]->_name] = [];
 496           }
 497
 498           $value = [
 499             $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
 500             'location_type_id' => $this->_activeFields[$i]->_hasLocationType,
 501           ];
 502
 503           if (isset($this->_activeFields[$i]->_phoneType)) {
 504             $value['phone_type_id'] = $this->_activeFields[$i]->_phoneType;
 505           }
 506
 507           // get IM service Provider type id
 508           if (isset($this->_activeFields[$i]->_imProvider)) {
 509             $value['provider_id'] = $this->_activeFields[$i]->_imProvider;
 510           }
 511
 512           $params[$this->_activeFields[$i]->_name][] = $value;
 513         }
 514         elseif (isset($this->_activeFields[$i]->_websiteType)) {
 515           $value = [
 516             $this->_activeFields[$i]->_name => $this->_activeFields[$i]->_value,
 517             'website_type_id' => $this->_activeFields[$i]->_websiteType,
 518           ];
 519
 520           $params[$this->_activeFields[$i]->_name][] = $value;
 521         }
 522
 523         if (!isset($params[$this->_activeFields[$i]->_name])) {
 524           if (!isset($this->_activeFields[$i]->_related)) {
 525             $params[$this->_activeFields[$i]->_name] = $this->_activeFields[$i]->_value;
 526           }
 527         }
 528
 529         //minor fix for CRM-4062
 530         if (isset($this->_activeFields[$i]->_related)) {
 531           if (!isset($params[$this->_activeFields[$i]->_related])) {
 532             $params[$this->_activeFields[$i]->_related] = [];
 533           }
 534
 535           if (!isset($params[$this->_activeFields[$i]->_related]['contact_type']) && !empty($this->_activeFields[$i]->_relatedContactType)) {
 536             $params[$this->_activeFields[$i]->_related]['contact_type'] = $this->_activeFields[$i]->_relatedContactType;
 537           }
 538
 539           if (isset($this->_activeFields[$i]->_relatedContactLocType) && !empty($this->_activeFields[$i]->_value)) {
 540             if (!empty($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails]) &&
 541               !is_array($params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails])
 542             ) {
 543               $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = [];
 544             }
 545             $value = [
 546               $this->_activeFields[$i]->_relatedContactDetails => $this->_activeFields[$i]->_value,
 547               'location_type_id' => $this->_activeFields[$i]->_relatedContactLocType,
 548             ];
 549
 550             if (isset($this->_activeFields[$i]->_relatedContactPhoneType)) {
 551               $value['phone_type_id'] = $this->_activeFields[$i]->_relatedContactPhoneType;
 552             }
 553
 554             // get IM service Provider type id for related contact
 555             if (isset($this->_activeFields[$i]->_relatedContactImProvider)) {
 556               $value['provider_id'] = $this->_activeFields[$i]->_relatedContactImProvider;
 557             }
 558
 559             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = $value;
 560           }
 561           elseif (isset($this->_activeFields[$i]->_relatedContactWebsiteType)) {
 562             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails][] = [
 563               'url' => $this->_activeFields[$i]->_value,
 564               'website_type_id' => $this->_activeFields[$i]->_relatedContactWebsiteType,
 565             ];
 566           }
 567           else {
 568             $params[$this->_activeFields[$i]->_related][$this->_activeFields[$i]->_relatedContactDetails] = $this->_activeFields[$i]->_value;
 569           }
 570         }
 571       }
 572     }
 573
 574     return $params;
 575   }
 576
 577   /**
 578    * @return array
 579    */
 580   public function getColumnPatterns() {
 581     CRM_Core_Error::deprecatedFunctionWarning('no  longer used- use   CRM_Contact_Import_MetadataTrait');
 582     $values = [];
 583     foreach ($this->_fields as $name => $field) {
 584       $values[$name] = $field->_columnPattern;
 585     }
 586     return $values;
 587   }
 588
 589   /**
 590    * @param string $name
 591    * @param $title
 592    * @param int $type
 593    * @param string $headerPattern
 594    * @param string $dataPattern
 595    * @param bool $hasLocationType
 596    */
 597   public function addField(
 598     $name, $title, $type = CRM_Utils_Type::T_INT,
 599     $headerPattern = '//', $dataPattern = '//',
 600     $hasLocationType = FALSE
 601   ) {
 602     $this->_fields[$name] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
 603     if (empty($name)) {
 604       $this->_fields['doNotImport'] = new CRM_Contact_Import_Field($name, $title, $type, $headerPattern, $dataPattern, $hasLocationType);
 605     }
 606   }
 607
 608   /**
 609    * Store parser values.
 610    *
 611    * @param CRM_Core_Session $store
 612    *
 613    * @param int $mode
 614    */
 615   public function set($store, $mode = self::MODE_SUMMARY) {
 616     $store->set('rowCount', $this->_rowCount);
 617     $store->set('fields', $this->getSelectValues());
 618     $store->set('fieldTypes', $this->getSelectTypes());
 619
 620     $store->set('dataPatterns', $this->getDataPatterns());
 621     $store->set('columnCount', $this->_activeFieldCount);
 622
 623     $store->set('totalRowCount', $this->_totalCount);
 624     $store->set('validRowCount', $this->_validCount);
 625     $store->set('invalidRowCount', $this->_invalidRowCount);
 626     $store->set('conflictRowCount', $this->_conflictCount);
 627     $store->set('unMatchCount', $this->_unMatchCount);
 628
 629     switch ($this->_contactType) {
 630       case 'Individual':
 631         $store->set('contactType', CRM_Import_Parser::CONTACT_INDIVIDUAL);
 632         break;
 633
 634       case 'Household':
 635         $store->set('contactType', CRM_Import_Parser::CONTACT_HOUSEHOLD);
 636         break;
 637
 638       case 'Organization':
 639         $store->set('contactType', CRM_Import_Parser::CONTACT_ORGANIZATION);
 640     }
 641
 642     if ($this->_invalidRowCount) {
 643       $store->set('errorsFileName', $this->_errorFileName);
 644     }
 645     if ($this->_conflictCount) {
 646       $store->set('conflictsFileName', $this->_conflictFileName);
 647     }
 648     if (isset($this->_rows) && !empty($this->_rows)) {
 649       $store->set('dataValues', $this->_rows);
 650     }
 651
 652     if ($this->_unMatchCount) {
 653       $store->set('mismatchFileName', $this->_misMatchFilemName);
 654     }
 655
 656     if ($mode == self::MODE_IMPORT) {
 657       $store->set('duplicateRowCount', $this->_duplicateCount);
 658       $store->set('unparsedAddressCount', $this->_unparsedAddressCount);
 659       if ($this->_duplicateCount) {
 660         $store->set('duplicatesFileName', $this->_duplicateFileName);
 661       }
 662       if ($this->_unparsedAddressCount) {
 663         $store->set('errorsFileName', $this->_errorFileName);
 664       }
 665     }
 666     //echo "$this->_totalCount,$this->_invalidRowCount,$this->_conflictCount,$this->_duplicateCount";
 667   }
 668
 669   /**
 670    * Export data to a CSV file.
 671    *
 672    * @param string $fileName
 673    * @param array $header
 674    * @param array $data
 675    */
 676   public static function exportCSV($fileName, $header, $data) {
 677
 678     if (file_exists($fileName) && !is_writable($fileName)) {
 679       CRM_Core_Error::movedSiteError($fileName);
 680     }
 681     //hack to remove '_status', '_statusMsg' and '_id' from error file
 682     $errorValues = [];
 683     $dbRecordStatus = ['IMPORTED', 'ERROR', 'DUPLICATE', 'INVALID', 'NEW'];
 684     foreach ($data as $rowCount => $rowValues) {
 685       $count = 0;
 686       foreach ($rowValues as $key => $val) {
 687         if (in_array($val, $dbRecordStatus) && $count == (count($rowValues) - 3)) {
 688           break;
 689         }
 690         $errorValues[$rowCount][$key] = $val;
 691         $count++;
 692       }
 693     }
 694     $data = $errorValues;
 695
 696     $output = [];
 697     $fd = fopen($fileName, 'w');
 698
 699     foreach ($header as $key => $value) {
 700       $header[$key] = "\"$value\"";
 701     }
 702     $config = CRM_Core_Config::singleton();
 703     $output[] = implode($config->fieldSeparator, $header);
 704
 705     foreach ($data as $datum) {
 706       foreach ($datum as $key => $value) {
 707         $datum[$key] = "\"$value\"";
 708       }
 709       $output[] = implode($config->fieldSeparator, $datum);
 710     }
 711     fwrite($fd, implode("\n", $output));
 712     fclose($fd);
 713   }
 714
 715   /**
 716    * Update the record with PK $id in the import database table.
 717    *
 718    * @param int $id
 719    * @param array $params
 720    */
 721   public function updateImportRecord($id, &$params) {
 722     $statusFieldName = $this->_statusFieldName;
 723     $primaryKeyName = $this->_primaryKeyName;
 724
 725     if ($statusFieldName && $primaryKeyName) {
 726       $dao = new CRM_Core_DAO();
 727       $db = $dao->getDatabaseConnection();
 728
 729       $query = "UPDATE $this->_tableName
 730                       SET    $statusFieldName = ?,
 731                              ${statusFieldName}Msg = ?
 732                       WHERE  $primaryKeyName = ?";
 733       $args = [
 734         $params[$statusFieldName],
 735         CRM_Utils_Array::value("${statusFieldName}Msg", $params),
 736         $id,
 737       ];
 738
 739       //print "Running query: $query<br/>With arguments: ".$params[$statusFieldName].", ".$params["${statusFieldName}Msg"].", $id<br/>";
 740
 741       $db->query($query, $args);
 742     }
 743   }
 744
 745   /**
 746    * Format common params data to proper format to store.
 747    *
 748    * @param array $params
 749    *   Contain record values.
 750    * @param array $formatted
 751    *   Array of formatted data.
 752    * @param array $contactFields
 753    *   Contact DAO fields.
 754    */
 755   public function formatCommonData($params, &$formatted, &$contactFields) {
 756     $csType = [
 757       CRM_Utils_Array::value('contact_type', $formatted),
 758     ];
 759
 760     //CRM-5125
 761     //add custom fields for contact sub type
 762     if (!empty($this->_contactSubType)) {
 763       $csType = $this->_contactSubType;
 764     }
 765
 766     if ($relCsType = CRM_Utils_Array::value('contact_sub_type', $formatted)) {
 767       $csType = $relCsType;
 768     }
 769
 770     $customFields = CRM_Core_BAO_CustomField::getFields($formatted['contact_type'], FALSE, FALSE, $csType);
 771
 772     $addressCustomFields = CRM_Core_BAO_CustomField::getFields('Address');
 773     $customFields = $customFields + $addressCustomFields;
 774
 775     //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
 776     $elements = [
 777       'email_greeting_custom' => 'email_greeting',
 778       'postal_greeting_custom' => 'postal_greeting',
 779       'addressee_custom' => 'addressee',
 780     ];
 781     foreach ($elements as $k => $v) {
 782       if (array_key_exists($k, $params) && !(array_key_exists($v, $params))) {
 783         $label = key(CRM_Core_OptionGroup::values($v, TRUE, NULL, NULL, 'AND v.name = "Customized"'));
 784         $params[$v] = $label;
 785       }
 786     }
 787
 788     //format date first
 789     $session = CRM_Core_Session::singleton();
 790     $dateType = $session->get("dateTypes");
 791     foreach ($params as $key => $val) {
 792       $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key);
 793       if ($customFieldID &&
 794         !array_key_exists($customFieldID, $addressCustomFields)
 795       ) {
 796         //we should not update Date to null, CRM-4062
 797         if ($val && ($customFields[$customFieldID]['data_type'] == 'Date')) {
 798           //CRM-21267
 799           CRM_Contact_Import_Parser_Contact::formatCustomDate($params, $formatted, $dateType, $key);
 800         }
 801         elseif ($customFields[$customFieldID]['data_type'] == 'Boolean') {
 802           if (empty($val) && !is_numeric($val) && $this->_onDuplicate == CRM_Import_Parser::DUPLICATE_FILL) {
 803             //retain earlier value when Import mode is `Fill`
 804             unset($params[$key]);
 805           }
 806           else {
 807             $params[$key] = CRM_Utils_String::strtoboolstr($val);
 808           }
 809         }
 810       }
 811
 812       if ($key == 'birth_date' && $val) {
 813         CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key);
 814       }
 815       elseif ($key == 'deceased_date' && $val) {
 816         CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key);
 817         $params['is_deceased'] = 1;
 818       }
 819       elseif ($key == 'is_deceased' && $val) {
 820         $params[$key] = CRM_Utils_String::strtoboolstr($val);
 821       }
 822     }
 823
 824     //now format custom data.
 825     foreach ($params as $key => $field) {
 826       if (is_array($field)) {
 827         $isAddressCustomField = FALSE;
 828         foreach ($field as $value) {
 829           $break = FALSE;
 830           if (is_array($value)) {
 831             foreach ($value as $name => $testForEmpty) {
 832               if ($addressCustomFieldID = CRM_Core_BAO_CustomField::getKeyID($name)) {
 833                 $isAddressCustomField = TRUE;
 834                 break;
 835               }
 836               // check if $value does not contain IM provider or phoneType
 837               if (($name !== 'phone_type_id' || $name !== 'provider_id') && ($testForEmpty === '' || $testForEmpty == NULL)) {
 838                 $break = TRUE;
 839                 break;
 840               }
 841             }
 842           }
 843           else {
 844             $break = TRUE;
 845           }
 846
 847           if (!$break) {
 848             if (!empty($value['location_type_id'])) {
 849               $this->formatLocationBlock($value, $formatted);
 850             }
 851             else {
 852               CRM_Core_Error::deprecatedFunctionWarning('this is not expected to be reachable now');
 853               $this->formatContactParameters($value, $formatted);
 854             }
 855           }
 856         }
 857         if (!$isAddressCustomField) {
 858           continue;
 859         }
 860       }
 861
 862       $formatValues = [
 863         $key => $field,
 864       ];
 865
 866       if (($key !== 'preferred_communication_method') && (array_key_exists($key, $contactFields))) {
 867         // due to merging of individual table and
 868         // contact table, we need to avoid
 869         // preferred_communication_method forcefully
 870         $formatValues['contact_type'] = $formatted['contact_type'];
 871       }
 872
 873       if ($key == 'id' && isset($field)) {
 874         $formatted[$key] = $field;
 875       }
 876       $this->formatContactParameters($formatValues, $formatted);
 877
 878       //Handling Custom Data
 879       // note: Address custom fields will be handled separately inside formatContactParameters
 880       if (($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) &&
 881         array_key_exists($customFieldID, $customFields) &&
 882         !array_key_exists($customFieldID, $addressCustomFields)
 883       ) {
 884
 885         $extends = CRM_Utils_Array::value('extends', $customFields[$customFieldID]);
 886         $htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]);
 887         switch ($htmlType) {
 888           case 'Select':
 889           case 'Radio':
 890           case 'Autocomplete-Select':
 891             if ($customFields[$customFieldID]['data_type'] == 'String' || $customFields[$customFieldID]['data_type'] == 'Int') {
 892               $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
 893               foreach ($customOption as $customValue) {
 894                 $val = CRM_Utils_Array::value('value', $customValue);
 895                 $label = CRM_Utils_Array::value('label', $customValue);
 896                 $label = strtolower($label);
 897                 $value = strtolower(trim($formatted[$key]));
 898                 if (($value == $label) || ($value == strtolower($val))) {
 899                   $params[$key] = $formatted[$key] = $val;
 900                 }
 901               }
 902             }
 903             break;
 904
 905           case 'CheckBox':
 906           case 'Multi-Select':
 907
 908             if (!empty($formatted[$key]) && !empty($params[$key])) {
 909               $mulValues = explode(',', $formatted[$key]);
 910               $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
 911               $formatted[$key] = [];
 912               $params[$key] = [];
 913               foreach ($mulValues as $v1) {
 914                 foreach ($customOption as $v2) {
 915                   if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
 916                     (strtolower($v2['value']) == strtolower(trim($v1)))
 917                   ) {
 918                     if ($htmlType == 'CheckBox') {
 919                       $params[$key][$v2['value']] = $formatted[$key][$v2['value']] = 1;
 920                     }
 921                     else {
 922                       $params[$key][] = $formatted[$key][] = $v2['value'];
 923                     }
 924                   }
 925                 }
 926               }
 927             }
 928             break;
 929         }
 930       }
 931     }
 932
 933     if (!empty($key) && ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) && array_key_exists($customFieldID, $customFields) &&
 934       !array_key_exists($customFieldID, $addressCustomFields)
 935     ) {
 936       // @todo calling api functions directly is not supported
 937       _civicrm_api3_custom_format_params($params, $formatted, $extends);
 938     }
 939
 940     // to check if not update mode and unset the fields with empty value.
 941     if (!$this->_updateWithId && array_key_exists('custom', $formatted)) {
 942       foreach ($formatted['custom'] as $customKey => $customvalue) {
 943         if (empty($formatted['custom'][$customKey][-1]['is_required'])) {
 944           $formatted['custom'][$customKey][-1]['is_required'] = $customFields[$customKey]['is_required'];
 945         }
 946         $emptyValue = CRM_Utils_Array::value('value', $customvalue[-1]);
 947         if (!isset($emptyValue)) {
 948           unset($formatted['custom'][$customKey]);
 949         }
 950       }
 951     }
 952
 953     // parse street address, CRM-5450
 954     if ($this->_parseStreetAddress) {
 955       if (array_key_exists('address', $formatted) && is_array($formatted['address'])) {
 956         foreach ($formatted['address'] as $instance => & $address) {
 957           $streetAddress = CRM_Utils_Array::value('street_address', $address);
 958           if (empty($streetAddress)) {
 959             continue;
 960           }
 961           // parse address field.
 962           $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($streetAddress);
 963
 964           //street address consider to be parsed properly,
 965           //If we get street_name and street_number.
 966           if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) {
 967             $parsedFields = array_fill_keys(array_keys($parsedFields), '');
 968           }
 969
 970           // merge parse address w/ main address block.
 971           $address = array_merge($address, $parsedFields);
 972         }
 973       }
 974     }
 975   }
 976
 977   /**
 978    * Format contact parameters.
 979    *
 980    * @todo this function needs re-writing & re-merging into the main function.
 981    *
 982    * Here be dragons.
 983    *
 984    * @param array $values
 985    * @param array $params
 986    *
 987    * @return bool
 988    */
 989   protected function formatContactParameters(&$values, &$params) {
 990     // Crawl through the possible classes:
 991     // Contact
 992     //      Individual
 993     //      Household
 994     //      Organization
 995     //          Location
 996     //              Address
 997     //              Email
 998     //              Phone
 999     //              IM
1000     //      Note
1001     //      Custom
1002
1003     // first add core contact values since for other Civi modules they are not added
1004     $contactFields = CRM_Contact_DAO_Contact::fields();
1005     _civicrm_api3_store_values($contactFields, $values, $params);
1006
1007     if (isset($values['contact_type'])) {
1008       // we're an individual/household/org property
1009
1010       $fields[$values['contact_type']] = CRM_Contact_DAO_Contact::fields();
1011
1012       _civicrm_api3_store_values($fields[$values['contact_type']], $values, $params);
1013       return TRUE;
1014     }
1015
1016     // Cache the various object fields
1017     // @todo - remove this after confirming this is just a compilation of other-wise-cached fields.
1018     static $fields = [];
1019
1020     if (isset($values['individual_prefix'])) {
1021       if (!empty($params['prefix_id'])) {
1022         $prefixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
1023         $params['prefix'] = $prefixes[$params['prefix_id']];
1024       }
1025       else {
1026         $params['prefix'] = $values['individual_prefix'];
1027       }
1028       return TRUE;
1029     }
1030
1031     if (isset($values['individual_suffix'])) {
1032       if (!empty($params['suffix_id'])) {
1033         $suffixes = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'suffix_id');
1034         $params['suffix'] = $suffixes[$params['suffix_id']];
1035       }
1036       else {
1037         $params['suffix'] = $values['individual_suffix'];
1038       }
1039       return TRUE;
1040     }
1041
1042     // CRM-4575
1043     if (isset($values['email_greeting'])) {
1044       if (!empty($params['email_greeting_id'])) {
1045         $emailGreetingFilter = [
1046           'contact_type' => CRM_Utils_Array::value('contact_type', $params),
1047           'greeting_type' => 'email_greeting',
1048         ];
1049         $emailGreetings = CRM_Core_PseudoConstant::greeting($emailGreetingFilter);
1050         $params['email_greeting'] = $emailGreetings[$params['email_greeting_id']];
1051       }
1052       else {
1053         $params['email_greeting'] = $values['email_greeting'];
1054       }
1055
1056       return TRUE;
1057     }
1058
1059     if (isset($values['postal_greeting'])) {
1060       if (!empty($params['postal_greeting_id'])) {
1061         $postalGreetingFilter = [
1062           'contact_type' => CRM_Utils_Array::value('contact_type', $params),
1063           'greeting_type' => 'postal_greeting',
1064         ];
1065         $postalGreetings = CRM_Core_PseudoConstant::greeting($postalGreetingFilter);
1066         $params['postal_greeting'] = $postalGreetings[$params['postal_greeting_id']];
1067       }
1068       else {
1069         $params['postal_greeting'] = $values['postal_greeting'];
1070       }
1071       return TRUE;
1072     }
1073
1074     if (isset($values['addressee'])) {
1075       if (!empty($params['addressee_id'])) {
1076         $addresseeFilter = [
1077           'contact_type' => CRM_Utils_Array::value('contact_type', $params),
1078           'greeting_type' => 'addressee',
1079         ];
1080         $addressee = CRM_Core_PseudoConstant::addressee($addresseeFilter);
1081         $params['addressee'] = $addressee[$params['addressee_id']];
1082       }
1083       else {
1084         $params['addressee'] = $values['addressee'];
1085       }
1086       return TRUE;
1087     }
1088
1089     if (isset($values['gender'])) {
1090       if (!empty($params['gender_id'])) {
1091         $genders = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'gender_id');
1092         $params['gender'] = $genders[$params['gender_id']];
1093       }
1094       else {
1095         $params['gender'] = $values['gender'];
1096       }
1097       return TRUE;
1098     }
1099
1100     if (!empty($values['preferred_communication_method'])) {
1101       $comm = [];
1102       $pcm = array_change_key_case(array_flip(CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'preferred_communication_method')), CASE_LOWER);
1103
1104       $preffComm = explode(',', $values['preferred_communication_method']);
1105       foreach ($preffComm as $v) {
1106         $v = strtolower(trim($v));
1107         if (array_key_exists($v, $pcm)) {
1108           $comm[$pcm[$v]] = 1;
1109         }
1110       }
1111
1112       $params['preferred_communication_method'] = $comm;
1113       return TRUE;
1114     }
1115
1116     // format the website params.
1117     if (!empty($values['url'])) {
1118       static $websiteFields;
1119       if (!is_array($websiteFields)) {
1120         $websiteFields = CRM_Core_DAO_Website::fields();
1121       }
1122       if (!array_key_exists('website', $params) ||
1123         !is_array($params['website'])
1124       ) {
1125         $params['website'] = [];
1126       }
1127
1128       $websiteCount = count($params['website']);
1129       _civicrm_api3_store_values($websiteFields, $values,
1130         $params['website'][++$websiteCount]
1131       );
1132
1133       return TRUE;
1134     }
1135
1136     // get the formatted location blocks into params - w/ 3.0 format, CRM-4605
1137     if (!empty($values['location_type_id'])) {
1138       CRM_Core_Error::deprecatedFunctionWarning('this is not expected to be reachable now');
1139       return $this->formatLocationBlock($values, $params);
1140     }
1141
1142     if (isset($values['note'])) {
1143       // add a note field
1144       if (!isset($params['note'])) {
1145         $params['note'] = [];
1146       }
1147       $noteBlock = count($params['note']) + 1;
1148
1149       $params['note'][$noteBlock] = [];
1150       if (!isset($fields['Note'])) {
1151         $fields['Note'] = CRM_Core_DAO_Note::fields();
1152       }
1153
1154       // get the current logged in civicrm user
1155       $session = CRM_Core_Session::singleton();
1156       $userID = $session->get('userID');
1157
1158       if ($userID) {
1159         $values['contact_id'] = $userID;
1160       }
1161
1162       _civicrm_api3_store_values($fields['Note'], $values, $params['note'][$noteBlock]);
1163
1164       return TRUE;
1165     }
1166
1167     // Check for custom field values
1168     $customFields = CRM_Core_BAO_CustomField::getFields(CRM_Utils_Array::value('contact_type', $values),
1169       FALSE, FALSE, NULL, NULL, FALSE, FALSE, FALSE
1170     );
1171
1172     foreach ($values as $key => $value) {
1173       if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($key)) {
1174         // check if it's a valid custom field id
1175
1176         if (!array_key_exists($customFieldID, $customFields)) {
1177           return civicrm_api3_create_error('Invalid custom field ID');
1178         }
1179         else {
1180           $params[$key] = $value;
1181         }
1182       }
1183     }
1184     return TRUE;
1185   }
1186
1187   /**
1188    * Format location block ready for importing.
1189    *
1190    * There is some test coverage for this in CRM_Contact_Import_Parser_ContactTest
1191    * e.g. testImportPrimaryAddress.
1192    *
1193    * @param array $values
1194    * @param array $params
1195    *
1196    * @return bool
1197    */
1198   protected function formatLocationBlock(&$values, &$params) {
1199     $blockTypes = [
1200       'phone' => 'Phone',
1201       'email' => 'Email',
1202       'im' => 'IM',
1203       'openid' => 'OpenID',
1204       'phone_ext' => 'Phone',
1205     ];
1206     foreach ($blockTypes as $blockFieldName => $block) {
1207       if (!array_key_exists($blockFieldName, $values)) {
1208         continue;
1209       }
1210       $blockIndex = $values['location_type_id'] . (!empty($values['phone_type_id']) ? '_' . $values['phone_type_id'] : '');
1211
1212       // block present in value array.
1213       if (!array_key_exists($blockFieldName, $params) || !is_array($params[$blockFieldName])) {
1214         $params[$blockFieldName] = [];
1215       }
1216
1217       $fields[$block] = $this->getMetadataForEntity($block);
1218
1219       // copy value to dao field name.
1220       if ($blockFieldName == 'im') {
1221         $values['name'] = $values[$blockFieldName];
1222       }
1223
1224       _civicrm_api3_store_values($fields[$block], $values,
1225         $params[$blockFieldName][$blockIndex]
1226       );
1227
1228       $this->fillPrimary($params[$blockFieldName][$blockIndex], $values, $block, CRM_Utils_Array::value('id', $params));
1229
1230       if (empty($params['id']) && (count($params[$blockFieldName]) == 1)) {
1231         $params[$blockFieldName][$blockIndex]['is_primary'] = TRUE;
1232       }
1233
1234       // we only process single block at a time.
1235       return TRUE;
1236     }
1237
1238     // handle address fields.
1239     if (!array_key_exists('address', $params) || !is_array($params['address'])) {
1240       $params['address'] = [];
1241     }
1242
1243     // Note: we doing multiple value formatting here for address custom fields, plus putting into right format.
1244     // The actual formatting (like date, country ..etc) for address custom fields is taken care of while saving
1245     // the address in CRM_Core_BAO_Address::create method
1246     if (!empty($values['location_type_id'])) {
1247       static $customFields = [];
1248       if (empty($customFields)) {
1249         $customFields = CRM_Core_BAO_CustomField::getFields('Address');
1250       }
1251       // make a copy of values, as we going to make changes
1252       $newValues = $values;
1253       foreach ($values as $key => $val) {
1254         $customFieldID = CRM_Core_BAO_CustomField::getKeyID($key);
1255         if ($customFieldID && array_key_exists($customFieldID, $customFields)) {
1256
1257           $htmlType = CRM_Utils_Array::value('html_type', $customFields[$customFieldID]);
1258           switch ($htmlType) {
1259             case 'CheckBox':
1260             case 'Multi-Select':
1261               if ($val) {
1262                 $mulValues = explode(',', $val);
1263                 $customOption = CRM_Core_BAO_CustomOption::getCustomOption($customFieldID, TRUE);
1264                 $newValues[$key] = [];
1265                 foreach ($mulValues as $v1) {
1266                   foreach ($customOption as $v2) {
1267                     if ((strtolower($v2['label']) == strtolower(trim($v1))) ||
1268                       (strtolower($v2['value']) == strtolower(trim($v1)))
1269                     ) {
1270                       if ($htmlType == 'CheckBox') {
1271                         $newValues[$key][$v2['value']] = 1;
1272                       }
1273                       else {
1274                         $newValues[$key][] = $v2['value'];
1275                       }
1276                     }
1277                   }
1278                 }
1279               }
1280               break;
1281           }
1282         }
1283       }
1284       // consider new values
1285       $values = $newValues;
1286     }
1287
1288     $fields['Address'] = $this->getMetadataForEntity('Address');
1289     // @todo this is kinda replicated below....
1290     _civicrm_api3_store_values($fields['Address'], $values, $params['address'][$values['location_type_id']]);
1291
1292     $addressFields = [
1293       'county',
1294       'country',
1295       'state_province',
1296       'supplemental_address_1',
1297       'supplemental_address_2',
1298       'supplemental_address_3',
1299       'StateProvince.name',
1300     ];
1301     foreach (array_keys($customFields) as $customFieldID) {
1302       $addressFields[] = 'custom_' . $customFieldID;
1303     }
1304
1305     foreach ($addressFields as $field) {
1306       if (array_key_exists($field, $values)) {
1307         if (!array_key_exists('address', $params)) {
1308           $params['address'] = [];
1309         }
1310         $params['address'][$values['location_type_id']][$field] = $values[$field];
1311       }
1312     }
1313
1314     $this->fillPrimary($params['address'][$values['location_type_id']], $values, 'address', CRM_Utils_Array::value('id', $params));
1315     return TRUE;
1316   }
1317
1318   /**
1319    * Get the field metadata for the relevant entity.
1320    *
1321    * @param string $entity
1322    *
1323    * @return array
1324    */
1325   protected function getMetadataForEntity($entity) {
1326     if (!isset($this->fieldMetadata[$entity])) {
1327       $className = "CRM_Core_DAO_$entity";
1328       $this->fieldMetadata[$entity] = $className::fields();
1329     }
1330     return $this->fieldMetadata[$entity];
1331   }
1332
1333   /**
1334    * Fill in the primary location.
1335    *
1336    * If the contact has a primary address we update it. Otherwise
1337    * we add an address of the default location type.
1338    *
1339    * @param array $params
1340    *   Address block parameters
1341    * @param array $values
1342    *   Input values
1343    * @param string $entity
1344    *  - address, email, phone
1345    * @param int|null $contactID
1346    *
1347    * @throws \CiviCRM_API3_Exception
1348    */
1349   protected function fillPrimary(&$params, $values, $entity, $contactID) {
1350     if ($values['location_type_id'] === 'Primary') {
1351       if ($contactID) {
1352         $primary = civicrm_api3($entity, 'get', [
1353           'return' => 'location_type_id',
1354           'contact_id' => $contactID,
1355           'is_primary' => 1,
1356           'sequential' => 1,
1357         ]);
1358       }
1359       $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
1360       $params['location_type_id'] = (int) (isset($primary) && $primary['count']) ? $primary['values'][0]['location_type_id'] : $defaultLocationType->id;
1361       $params['is_primary'] = 1;
1362     }
1363   }
1364
1365 }