CRM/Contact/Form/Contact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class generates form components generic to all the contact types.
  20  *
  21  * It delegates the work to lower level subclasses and integrates the changes
  22  * back in. It also uses a lot of functionality with the CRM API's, so any change
  23  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  24  *
  25  */
  26 class CRM_Contact_Form_Contact extends CRM_Core_Form {
  27
  28   /**
  29    * The contact type of the form.
  30    *
  31    * @var string
  32    */
  33   public $_contactType;
  34
  35   /**
  36    * The contact type of the form.
  37    *
  38    * @var string
  39    */
  40   public $_contactSubType;
  41
  42   /**
  43    * The contact id, used when editing the form
  44    *
  45    * @var int
  46    */
  47   public $_contactId;
  48
  49   /**
  50    * The default group id passed in via the url.
  51    *
  52    * @var int
  53    */
  54   public $_gid;
  55
  56   /**
  57    * The default tag id passed in via the url.
  58    *
  59    * @var int
  60    */
  61   public $_tid;
  62
  63   /**
  64    * Name of de-dupe button
  65    *
  66    * @var string
  67    */
  68   protected $_dedupeButtonName;
  69
  70   /**
  71    * Name of optional save duplicate button.
  72    *
  73    * @var string
  74    */
  75   protected $_duplicateButtonName;
  76
  77   protected $_editOptions = [];
  78
  79   protected $_oldSubtypes = [];
  80
  81   public $_blocks;
  82
  83   public $_values = [];
  84
  85   public $_action;
  86
  87   public $_customValueCount;
  88   /**
  89    * The array of greetings with option group and filed names.
  90    *
  91    * @var array
  92    */
  93   public $_greetings;
  94
  95   /**
  96    * Do we want to parse street address.
  97    * @var bool
  98    */
  99   public $_parseStreetAddress;
 100
 101   /**
 102    * Check contact has a subtype or not.
 103    * @var bool
 104    */
 105   public $_isContactSubType;
 106
 107   /**
 108    * Lets keep a cache of all the values that we retrieved.
 109    * THis is an attempt to avoid the number of update statements
 110    * during the write phase
 111    * @var array
 112    */
 113   public $_preEditValues;
 114
 115   /**
 116    * Explicitly declare the entity api name.
 117    */
 118   public function getDefaultEntity() {
 119     return 'Contact';
 120   }
 121
 122   /**
 123    * Explicitly declare the form context.
 124    */
 125   public function getDefaultContext() {
 126     return 'create';
 127   }
 128
 129   /**
 130    * Build all the data structures needed to build the form.
 131    */
 132   public function preProcess() {
 133     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 134
 135     $this->_dedupeButtonName = $this->getButtonName('refresh', 'dedupe');
 136     $this->_duplicateButtonName = $this->getButtonName('upload', 'duplicate');
 137
 138     CRM_Core_Resources::singleton()
 139       ->addStyleFile('civicrm', 'css/contactSummary.css', 2, 'html-header');
 140
 141     $session = CRM_Core_Session::singleton();
 142     if ($this->_action == CRM_Core_Action::ADD) {
 143       // check for add contacts permissions
 144       if (!CRM_Core_Permission::check('add contacts')) {
 145         CRM_Utils_System::permissionDenied();
 146         CRM_Utils_System::civiExit();
 147       }
 148       $this->_contactType = CRM_Utils_Request::retrieve('ct', 'String',
 149         $this, TRUE, NULL, 'REQUEST'
 150       );
 151       if (!in_array($this->_contactType,
 152         ['Individual', 'Household', 'Organization']
 153       )
 154       ) {
 155         CRM_Core_Error::statusBounce(ts('Could not get a contact id and/or contact type'));
 156       }
 157
 158       $this->_isContactSubType = FALSE;
 159       if ($this->_contactSubType = CRM_Utils_Request::retrieve('cst', 'String', $this)) {
 160         $this->_isContactSubType = TRUE;
 161       }
 162
 163       if (
 164         $this->_contactSubType &&
 165         !(CRM_Contact_BAO_ContactType::isExtendsContactType($this->_contactSubType, $this->_contactType, TRUE))
 166       ) {
 167         CRM_Core_Error::statusBounce(ts("Could not get a valid contact subtype for contact type '%1'", [1 => $this->_contactType]));
 168       }
 169
 170       $this->_gid = CRM_Utils_Request::retrieve('gid', 'Integer',
 171         CRM_Core_DAO::$_nullObject,
 172         FALSE, NULL, 'GET'
 173       );
 174       $this->_tid = CRM_Utils_Request::retrieve('tid', 'Integer',
 175         CRM_Core_DAO::$_nullObject,
 176         FALSE, NULL, 'GET'
 177       );
 178       $typeLabel = CRM_Contact_BAO_ContactType::contactTypePairs(TRUE, $this->_contactSubType ?
 179           $this->_contactSubType : $this->_contactType
 180       );
 181       $typeLabel = implode(' / ', $typeLabel);
 182
 183       CRM_Utils_System::setTitle(ts('New %1', [1 => $typeLabel]));
 184       $session->pushUserContext(CRM_Utils_System::url('civicrm/dashboard', 'reset=1'));
 185       $this->_contactId = NULL;
 186     }
 187     else {
 188       //update mode
 189       if (!$this->_contactId) {
 190         $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
 191       }
 192
 193       if ($this->_contactId) {
 194         $defaults = [];
 195         $params = ['id' => $this->_contactId];
 196         $returnProperities = ['id', 'contact_type', 'contact_sub_type', 'modified_date', 'is_deceased'];
 197         CRM_Core_DAO::commonRetrieve('CRM_Contact_DAO_Contact', $params, $defaults, $returnProperities);
 198
 199         if (empty($defaults['id'])) {
 200           CRM_Core_Error::statusBounce(ts('A Contact with that ID does not exist: %1', [1 => $this->_contactId]));
 201         }
 202
 203         $this->_contactType = $defaults['contact_type'] ?? NULL;
 204         $this->_contactSubType = $defaults['contact_sub_type'] ?? NULL;
 205
 206         // check for permissions
 207         $session = CRM_Core_Session::singleton();
 208         if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
 209           CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
 210         }
 211
 212         $displayName = CRM_Contact_BAO_Contact::displayName($this->_contactId);
 213         if ($defaults['is_deceased']) {
 214           $displayName .= '  <span class="crm-contact-deceased">(' . ts('deceased') . ')</span>';
 215         }
 216         $displayName = ts('Edit %1', [1 => $displayName]);
 217
 218         // Check if this is default domain contact CRM-10482
 219         if (CRM_Contact_BAO_Contact::checkDomainContact($this->_contactId)) {
 220           $displayName .= ' (' . ts('default organization') . ')';
 221         }
 222
 223         // omitting contactImage from title for now since the summary overlay css doesn't work outside of our crm-container
 224         CRM_Utils_System::setTitle($displayName);
 225         $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
 226         $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
 227
 228         $urlParams = 'reset=1&cid=' . $this->_contactId;
 229         if ($context) {
 230           $urlParams .= "&context=$context";
 231         }
 232
 233         if (CRM_Utils_Rule::qfKey($qfKey)) {
 234
 235           $urlParams .= "&key=$qfKey";
 236
 237         }
 238         $session->pushUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
 239
 240         $values = $this->get('values');
 241         // get contact values.
 242         if (!empty($values)) {
 243           $this->_values = $values;
 244         }
 245         else {
 246           $params = [
 247             'id' => $this->_contactId,
 248             'contact_id' => $this->_contactId,
 249             'noRelationships' => TRUE,
 250             'noNotes' => TRUE,
 251             'noGroups' => TRUE,
 252           ];
 253
 254           $contact = CRM_Contact_BAO_Contact::retrieve($params, $this->_values, TRUE);
 255           $this->set('values', $this->_values);
 256         }
 257       }
 258       else {
 259         CRM_Core_Error::statusBounce(ts('Could not get a contact_id and/or contact_type'));
 260       }
 261     }
 262
 263     // parse street address, CRM-5450
 264     $this->_parseStreetAddress = $this->get('parseStreetAddress');
 265     if (!isset($this->_parseStreetAddress)) {
 266       $addressOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 267         'address_options'
 268       );
 269       $this->_parseStreetAddress = FALSE;
 270       if (!empty($addressOptions['street_address']) && !empty($addressOptions['street_address_parsing'])) {
 271         $this->_parseStreetAddress = TRUE;
 272       }
 273       $this->set('parseStreetAddress', $this->_parseStreetAddress);
 274     }
 275     $this->assign('parseStreetAddress', $this->_parseStreetAddress);
 276
 277     $this->_editOptions = $this->get('contactEditOptions');
 278     if (CRM_Utils_System::isNull($this->_editOptions)) {
 279       $this->_editOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 280         'contact_edit_options', TRUE, NULL,
 281         FALSE, 'name', TRUE, 'AND v.filter = 0'
 282       );
 283       $this->set('contactEditOptions', $this->_editOptions);
 284     }
 285
 286     // build demographics only for Individual contact type
 287     if ($this->_contactType != 'Individual' &&
 288       array_key_exists('Demographics', $this->_editOptions)
 289     ) {
 290       unset($this->_editOptions['Demographics']);
 291     }
 292
 293     // in update mode don't show notes
 294     if ($this->_contactId && array_key_exists('Notes', $this->_editOptions)) {
 295       unset($this->_editOptions['Notes']);
 296     }
 297
 298     $this->assign('editOptions', $this->_editOptions);
 299     $this->assign('contactType', $this->_contactType);
 300     $this->assign('contactSubType', $this->_contactSubType);
 301
 302     // get the location blocks.
 303     $this->_blocks = $this->get('blocks');
 304     if (CRM_Utils_System::isNull($this->_blocks)) {
 305       $this->_blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 306         'contact_edit_options', TRUE, NULL,
 307         FALSE, 'name', TRUE, 'AND v.filter = 1'
 308       );
 309       $this->set('blocks', $this->_blocks);
 310     }
 311     $this->assign('blocks', $this->_blocks);
 312
 313     // this is needed for custom data.
 314     $this->assign('entityID', $this->_contactId);
 315
 316     // also keep the convention.
 317     $this->assign('contactId', $this->_contactId);
 318
 319     // location blocks.
 320     CRM_Contact_Form_Location::preProcess($this);
 321
 322     // retain the multiple count custom fields value
 323     if (!empty($_POST['hidden_custom'])) {
 324       $customGroupCount = $_POST['hidden_custom_group_count'] ?? NULL;
 325
 326       if ($contactSubType = CRM_Utils_Array::value('contact_sub_type', $_POST)) {
 327         $paramSubType = implode(',', $contactSubType);
 328       }
 329
 330       $this->_getCachedTree = FALSE;
 331       unset($customGroupCount[0]);
 332       foreach ($customGroupCount as $groupID => $groupCount) {
 333         if ($groupCount > 1) {
 334           $this->set('groupID', $groupID);
 335           //loop the group
 336           for ($i = 0; $i <= $groupCount; $i++) {
 337             CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 338               $i, $this->_contactType, $this->_contactId
 339             );
 340             CRM_Contact_Form_Edit_CustomData::buildQuickForm($this);
 341           }
 342         }
 343       }
 344
 345       //reset all the ajax stuff, for normal processing
 346       if (isset($this->_groupTree)) {
 347         $this->_groupTree = NULL;
 348       }
 349       $this->set('groupID', NULL);
 350       $this->_getCachedTree = TRUE;
 351     }
 352
 353     // execute preProcess dynamically by js else execute normal preProcess
 354     if (array_key_exists('CustomData', $this->_editOptions)) {
 355       //assign a parameter to pass for sub type multivalue
 356       //custom field to load
 357       if ($this->_contactSubType || isset($paramSubType)) {
 358         $paramSubType = (isset($paramSubType)) ? $paramSubType :
 359           str_replace(CRM_Core_DAO::VALUE_SEPARATOR, ',', trim($this->_contactSubType, CRM_Core_DAO::VALUE_SEPARATOR));
 360
 361         $this->assign('paramSubType', $paramSubType);
 362       }
 363
 364       if (CRM_Utils_Request::retrieve('type', 'String')) {
 365         CRM_Contact_Form_Edit_CustomData::preProcess($this);
 366       }
 367       else {
 368         $contactSubType = $this->_contactSubType;
 369         // need contact sub type to build related grouptree array during post process
 370         if (!empty($_POST['contact_sub_type'])) {
 371           $contactSubType = $_POST['contact_sub_type'];
 372         }
 373         //only custom data has preprocess hence directly call it
 374         CRM_Custom_Form_CustomData::preProcess($this, NULL, $contactSubType,
 375           1, $this->_contactType, $this->_contactId
 376         );
 377         $this->assign('customValueCount', $this->_customValueCount);
 378       }
 379     }
 380   }
 381
 382   /**
 383    * Set default values for the form.
 384    *
 385    * Note that in edit/view mode the default values are retrieved from the database
 386    */
 387   public function setDefaultValues() {
 388     $defaults = $this->_values;
 389
 390     if ($this->_action & CRM_Core_Action::ADD) {
 391       if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
 392         // set group and tag defaults if any
 393         if ($this->_gid) {
 394           $defaults['group'][] = $this->_gid;
 395         }
 396         if ($this->_tid) {
 397           $defaults['tag'][$this->_tid] = 1;
 398         }
 399       }
 400       if ($this->_contactSubType) {
 401         $defaults['contact_sub_type'] = $this->_contactSubType;
 402       }
 403     }
 404     else {
 405       foreach ($defaults['email'] as $dontCare => & $val) {
 406         if (isset($val['signature_text'])) {
 407           $val['signature_text_hidden'] = $val['signature_text'];
 408         }
 409         if (isset($val['signature_html'])) {
 410           $val['signature_html_hidden'] = $val['signature_html'];
 411         }
 412       }
 413
 414       if (!empty($defaults['contact_sub_type'])) {
 415         $defaults['contact_sub_type'] = $this->_oldSubtypes;
 416       }
 417     }
 418     // set defaults for blocks ( custom data, address, communication preference, notes, tags and groups )
 419     foreach ($this->_editOptions as $name => $label) {
 420       if (!in_array($name, ['Address', 'Notes'])) {
 421         $className = 'CRM_Contact_Form_Edit_' . $name;
 422         $className::setDefaultValues($this, $defaults);
 423       }
 424     }
 425
 426     //set address block defaults
 427     CRM_Contact_Form_Edit_Address::setDefaultValues($defaults, $this);
 428
 429     if (!empty($defaults['image_URL'])) {
 430       $this->assign("imageURL", CRM_Utils_File::getImageURL($defaults['image_URL']));
 431     }
 432
 433     //set location type and country to default for each block
 434     $this->blockSetDefaults($defaults);
 435
 436     $this->_preEditValues = $defaults;
 437     return $defaults;
 438   }
 439
 440   /**
 441    * Do the set default related to location type id, primary location,  default country.
 442    *
 443    * @param array $defaults
 444    */
 445   public function blockSetDefaults(&$defaults) {
 446     $locationTypeKeys = array_filter(array_keys(CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id')), 'is_int');
 447     sort($locationTypeKeys);
 448
 449     // get the default location type
 450     $locationType = CRM_Core_BAO_LocationType::getDefault();
 451
 452     // unset primary location type
 453     $primaryLocationTypeIdKey = CRM_Utils_Array::key($locationType->id, $locationTypeKeys);
 454     unset($locationTypeKeys[$primaryLocationTypeIdKey]);
 455
 456     // reset the array sequence
 457     $locationTypeKeys = array_values($locationTypeKeys);
 458
 459     // get default phone and im provider id.
 460     $defPhoneTypeId = key(CRM_Core_OptionGroup::values('phone_type', FALSE, FALSE, FALSE, ' AND is_default = 1'));
 461     $defIMProviderId = key(CRM_Core_OptionGroup::values('instant_messenger_service',
 462       FALSE, FALSE, FALSE, ' AND is_default = 1'
 463     ));
 464     $defWebsiteTypeId = key(CRM_Core_OptionGroup::values('website_type',
 465       FALSE, FALSE, FALSE, ' AND is_default = 1'
 466     ));
 467
 468     $allBlocks = $this->_blocks;
 469     if (array_key_exists('Address', $this->_editOptions)) {
 470       $allBlocks['Address'] = $this->_editOptions['Address'];
 471     }
 472
 473     $config = CRM_Core_Config::singleton();
 474     foreach ($allBlocks as $blockName => $label) {
 475       $name = strtolower($blockName);
 476       $hasPrimary = $updateMode = FALSE;
 477
 478       // user is in update mode.
 479       if (array_key_exists($name, $defaults) &&
 480         !CRM_Utils_System::isNull($defaults[$name])
 481       ) {
 482         $updateMode = TRUE;
 483       }
 484
 485       for ($instance = 1; $instance <= $this->get($blockName . '_Block_Count'); $instance++) {
 486         // make we require one primary block, CRM-5505
 487         if ($updateMode) {
 488           if (!$hasPrimary) {
 489             $hasPrimary = CRM_Utils_Array::value(
 490               'is_primary',
 491               CRM_Utils_Array::value($instance, $defaults[$name])
 492             );
 493           }
 494           continue;
 495         }
 496
 497         //set location to primary for first one.
 498         if ($instance == 1) {
 499           $hasPrimary = TRUE;
 500           $defaults[$name][$instance]['is_primary'] = TRUE;
 501           $defaults[$name][$instance]['location_type_id'] = $locationType->id;
 502         }
 503         else {
 504           $locTypeId = $locationTypeKeys[$instance - 1] ?? $locationType->id;
 505           $defaults[$name][$instance]['location_type_id'] = $locTypeId;
 506         }
 507
 508         //set default country
 509         if ($name == 'address' && $config->defaultContactCountry) {
 510           $defaults[$name][$instance]['country_id'] = $config->defaultContactCountry;
 511         }
 512
 513         //set default state/province
 514         if ($name == 'address' && $config->defaultContactStateProvince) {
 515           $defaults[$name][$instance]['state_province_id'] = $config->defaultContactStateProvince;
 516         }
 517
 518         //set default phone type.
 519         if ($name == 'phone' && $defPhoneTypeId) {
 520           $defaults[$name][$instance]['phone_type_id'] = $defPhoneTypeId;
 521         }
 522         //set default website type.
 523         if ($name == 'website' && $defWebsiteTypeId) {
 524           $defaults[$name][$instance]['website_type_id'] = $defWebsiteTypeId;
 525         }
 526
 527         //set default im provider.
 528         if ($name == 'im' && $defIMProviderId) {
 529           $defaults[$name][$instance]['provider_id'] = $defIMProviderId;
 530         }
 531       }
 532
 533       if (!$hasPrimary) {
 534         $defaults[$name][1]['is_primary'] = TRUE;
 535       }
 536     }
 537   }
 538
 539   /**
 540    * add the rules (mainly global rules) for form.
 541    * All local rules are added near the element
 542    *
 543    * @see valid_date
 544    */
 545   public function addRules() {
 546     // skip adding formRules when custom data is build
 547     if ($this->_addBlockName || ($this->_action & CRM_Core_Action::DELETE)) {
 548       return;
 549     }
 550
 551     $this->addFormRule(['CRM_Contact_Form_Edit_' . $this->_contactType, 'formRule'], $this->_contactId);
 552
 553     // Call Locking check if editing existing contact
 554     if ($this->_contactId) {
 555       $this->addFormRule(['CRM_Contact_Form_Edit_Lock', 'formRule'], $this->_contactId);
 556     }
 557
 558     if (array_key_exists('Address', $this->_editOptions)) {
 559       $this->addFormRule(['CRM_Contact_Form_Edit_Address', 'formRule'], $this);
 560     }
 561
 562     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 563       $this->addFormRule(['CRM_Contact_Form_Edit_CommunicationPreferences', 'formRule'], $this);
 564     }
 565   }
 566
 567   /**
 568    * Global validation rules for the form.
 569    *
 570    * @param array $fields
 571    *   Posted values of the form.
 572    * @param array $errors
 573    *   List of errors to be posted back to the form.
 574    * @param int $contactId
 575    *   Contact id if doing update.
 576    * @param string $contactType
 577    *
 578    * @return bool
 579    *   email/openId
 580    */
 581   public static function formRule($fields, &$errors, $contactId, $contactType) {
 582     $config = CRM_Core_Config::singleton();
 583
 584     // validations.
 585     //1. for each block only single value can be marked as is_primary = true.
 586     //2. location type id should be present if block data present.
 587     //3. check open id across db and other each block for duplicate.
 588     //4. at least one location should be primary.
 589     //5. also get primaryID from email or open id block.
 590
 591     // take the location blocks.
 592     $blocks = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 593       'contact_edit_options', TRUE, NULL,
 594       FALSE, 'name', TRUE, 'AND v.filter = 1'
 595     );
 596
 597     $otherEditOptions = CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 598       'contact_edit_options', TRUE, NULL,
 599       FALSE, 'name', TRUE, 'AND v.filter = 0'
 600     );
 601     //get address block inside.
 602     if (array_key_exists('Address', $otherEditOptions)) {
 603       $blocks['Address'] = $otherEditOptions['Address'];
 604     }
 605
 606     $website_types = [];
 607     $openIds = [];
 608     $primaryID = FALSE;
 609     foreach ($blocks as $name => $label) {
 610       $hasData = $hasPrimary = [];
 611       $name = strtolower($name);
 612       if (!empty($fields[$name]) && is_array($fields[$name])) {
 613         foreach ($fields[$name] as $instance => $blockValues) {
 614           $dataExists = self::blockDataExists($blockValues);
 615
 616           if (!$dataExists && $name == 'address') {
 617             $dataExists = $fields['address'][$instance]['use_shared_address'] ?? NULL;
 618           }
 619
 620           if ($dataExists) {
 621             if ($name == 'website') {
 622               if (!empty($blockValues['website_type_id'])) {
 623                 if (empty($website_types[$blockValues['website_type_id']])) {
 624                   $website_types[$blockValues['website_type_id']] = $blockValues['website_type_id'];
 625                 }
 626                 else {
 627                   $errors["{$name}[1][website_type_id]"] = ts('Contacts may only have one website of each type at most.');
 628                 }
 629               }
 630
 631               // skip remaining checks for website
 632               continue;
 633             }
 634
 635             $hasData[] = $instance;
 636             if (!empty($blockValues['is_primary'])) {
 637               $hasPrimary[] = $instance;
 638               if (!$primaryID &&
 639                 in_array($name, [
 640                   'email',
 641                   'openid',
 642                 ]) && !empty($blockValues[$name])
 643               ) {
 644                 $primaryID = $blockValues[$name];
 645               }
 646             }
 647
 648             if (empty($blockValues['location_type_id'])) {
 649               $errors["{$name}[$instance][location_type_id]"] = ts('The Location Type should be set if there is  %1 information.', [1 => $label]);
 650             }
 651           }
 652
 653           if ($name == 'openid' && !empty($blockValues[$name])) {
 654             $oid = new CRM_Core_DAO_OpenID();
 655             $oid->openid = $openIds[$instance] = $blockValues[$name];
 656             $cid = $contactId ?? 0;
 657             if ($oid->find(TRUE) && ($oid->contact_id != $cid)) {
 658               $errors["{$name}[$instance][openid]"] = ts('%1 already exist.', [1 => $blocks['OpenID']]);
 659             }
 660           }
 661         }
 662
 663         if (empty($hasPrimary) && !empty($hasData)) {
 664           $errors["{$name}[1][is_primary]"] = ts('One %1 should be marked as primary.', [1 => $label]);
 665         }
 666
 667         if (count($hasPrimary) > 1) {
 668           $errors["{$name}[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one %1 can be marked as primary.',
 669             [1 => $label]
 670           );
 671         }
 672       }
 673     }
 674
 675     //do validations for all opend ids they should be distinct.
 676     if (!empty($openIds) && (count(array_unique($openIds)) != count($openIds))) {
 677       foreach ($openIds as $instance => $value) {
 678         if (!array_key_exists($instance, array_unique($openIds))) {
 679           $errors["openid[$instance][openid]"] = ts('%1 already used.', [1 => $blocks['OpenID']]);
 680         }
 681       }
 682     }
 683
 684     // street number should be digit + suffix, CRM-5450
 685     $parseStreetAddress = CRM_Utils_Array::value('street_address_parsing',
 686       CRM_Core_BAO_Setting::valueOptions(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
 687         'address_options'
 688       )
 689     );
 690     if ($parseStreetAddress) {
 691       if (isset($fields['address']) &&
 692         is_array($fields['address'])
 693       ) {
 694         $invalidStreetNumbers = [];
 695         foreach ($fields['address'] as $cnt => $address) {
 696           if ($streetNumber = CRM_Utils_Array::value('street_number', $address)) {
 697             $parsedAddress = CRM_Core_BAO_Address::parseStreetAddress($address['street_number']);
 698             if (empty($parsedAddress['street_number'])) {
 699               $invalidStreetNumbers[] = $cnt;
 700             }
 701           }
 702         }
 703
 704         if (!empty($invalidStreetNumbers)) {
 705           $first = $invalidStreetNumbers[0];
 706           foreach ($invalidStreetNumbers as & $num) {
 707             $num = CRM_Contact_Form_Contact::ordinalNumber($num);
 708           }
 709           $errors["address[$first][street_number]"] = ts('The street number you entered for the %1 address block(s) is not in an expected format. Street numbers may include numeric digit(s) followed by other characters. You can still enter the complete street address (unparsed) by clicking "Edit Complete Street Address".', [1 => implode(', ', $invalidStreetNumbers)]);
 710         }
 711       }
 712     }
 713
 714     // Check for duplicate contact if it wasn't already handled by ajax or disabled
 715     if (!Civi::settings()->get('contact_ajax_check_similar') || !empty($fields['_qf_Contact_refresh_dedupe'])) {
 716       self::checkDuplicateContacts($fields, $errors, $contactId, $contactType);
 717     }
 718
 719     return $primaryID;
 720   }
 721
 722   /**
 723    * Build the form object.
 724    */
 725   public function buildQuickForm() {
 726     //load form for child blocks
 727     if ($this->_addBlockName) {
 728       $className = 'CRM_Contact_Form_Edit_' . $this->_addBlockName;
 729       return $className::buildQuickForm($this);
 730     }
 731
 732     if ($this->_action == CRM_Core_Action::UPDATE) {
 733       $deleteExtra = json_encode(ts('Are you sure you want to delete contact image.'));
 734       $deleteURL = [
 735         CRM_Core_Action::DELETE => [
 736           'name' => ts('Delete Contact Image'),
 737           'url' => 'civicrm/contact/image',
 738           'qs' => 'reset=1&cid=%%id%%&action=delete',
 739           'extra' => 'onclick = "' . htmlspecialchars("if (confirm($deleteExtra)) this.href+='&confirmed=1'; else return false;") . '"',
 740         ],
 741       ];
 742       $deleteURL = CRM_Core_Action::formLink($deleteURL,
 743         CRM_Core_Action::DELETE,
 744         [
 745           'id' => $this->_contactId,
 746         ],
 747         ts('more'),
 748         FALSE,
 749         'contact.image.delete',
 750         'Contact',
 751         $this->_contactId
 752       );
 753       $this->assign('deleteURL', $deleteURL);
 754     }
 755
 756     //build contact type specific fields
 757     $className = 'CRM_Contact_Form_Edit_' . $this->_contactType;
 758     $className::buildQuickForm($this);
 759
 760     // Ajax duplicate checking
 761     $checkSimilar = Civi::settings()->get('contact_ajax_check_similar');
 762     $this->assign('checkSimilar', $checkSimilar);
 763     if ($checkSimilar == 1) {
 764       $ruleParams = ['used' => 'Supervised', 'contact_type' => $this->_contactType];
 765       $this->assign('ruleFields', CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams));
 766     }
 767
 768     // build Custom data if Custom data present in edit option
 769     $buildCustomData = 'noCustomDataPresent';
 770     if (array_key_exists('CustomData', $this->_editOptions)) {
 771       $buildCustomData = "customDataPresent";
 772     }
 773
 774     // subtype is a common field. lets keep it here
 775     $subtypes = CRM_Contact_BAO_Contact::buildOptions('contact_sub_type', 'create', ['contact_type' => $this->_contactType]);
 776     if (!empty($subtypes)) {
 777       $this->addField('contact_sub_type', [
 778         'label' => ts('Contact Type'),
 779         'options' => $subtypes,
 780         'class' => $buildCustomData,
 781         'multiple' => 'multiple',
 782         'option_url' => NULL,
 783       ]);
 784     }
 785
 786     // build edit blocks ( custom data, demographics, communication preference, notes, tags and groups )
 787     foreach ($this->_editOptions as $name => $label) {
 788       if ($name == 'Address') {
 789         $this->_blocks['Address'] = $this->_editOptions['Address'];
 790         continue;
 791       }
 792       if ($name == 'TagsAndGroups') {
 793         continue;
 794       }
 795       $className = 'CRM_Contact_Form_Edit_' . $name;
 796       $className::buildQuickForm($this);
 797     }
 798
 799     // build tags and groups
 800     CRM_Contact_Form_Edit_TagsAndGroups::buildQuickForm($this, 0, CRM_Contact_Form_Edit_TagsAndGroups::ALL,
 801       FALSE, NULL, 'Group(s)', 'Tag(s)', NULL, 'select');
 802
 803     // build location blocks.
 804     CRM_Contact_Form_Edit_Lock::buildQuickForm($this);
 805     CRM_Contact_Form_Location::buildQuickForm($this);
 806
 807     // add attachment
 808     $this->addField('image_URL', ['maxlength' => '255', 'label' => ts('Browse/Upload Image')]);
 809
 810     // add the dedupe button
 811     $this->addElement('submit',
 812       $this->_dedupeButtonName,
 813       ts('Check for Matching Contact(s)')
 814     );
 815     $this->addElement('submit',
 816       $this->_duplicateButtonName,
 817       ts('Save Matching Contact')
 818     );
 819     $this->addElement('submit',
 820       $this->getButtonName('next', 'sharedHouseholdDuplicate'),
 821       ts('Save With Duplicate Household')
 822     );
 823
 824     $buttons = [
 825       [
 826         'type' => 'upload',
 827         'name' => ts('Save'),
 828         'subName' => 'view',
 829         'isDefault' => TRUE,
 830       ],
 831     ];
 832     if (CRM_Core_Permission::check('add contacts')) {
 833       $buttons[] = [
 834         'type' => 'upload',
 835         'name' => ts('Save and New'),
 836         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 837         'subName' => 'new',
 838       ];
 839     }
 840     $buttons[] = [
 841       'type' => 'cancel',
 842       'name' => ts('Cancel'),
 843     ];
 844
 845     if (!empty($this->_values['contact_sub_type'])) {
 846       $this->_oldSubtypes = explode(CRM_Core_DAO::VALUE_SEPARATOR,
 847         trim($this->_values['contact_sub_type'], CRM_Core_DAO::VALUE_SEPARATOR)
 848       );
 849     }
 850     $this->assign('oldSubtypes', json_encode($this->_oldSubtypes));
 851
 852     $this->addButtons($buttons);
 853   }
 854
 855   /**
 856    * Form submission of new/edit contact is processed.
 857    */
 858   public function postProcess() {
 859     // check if dedupe button, if so return.
 860     $buttonName = $this->controller->getButtonName();
 861     if ($buttonName == $this->_dedupeButtonName) {
 862       return;
 863     }
 864
 865     //get the submitted values in an array
 866     $params = $this->controller->exportValues($this->_name);
 867     if (!isset($params['preferred_communication_method'])) {
 868       // If this field is empty QF will trim it so we have to add it in.
 869       $params['preferred_communication_method'] = 'null';
 870     }
 871
 872     $group = $params['group'] ?? NULL;
 873     if (!empty($group) && is_array($group)) {
 874       unset($params['group']);
 875       foreach ($group as $key => $value) {
 876         $params['group'][$value] = 1;
 877       }
 878     }
 879
 880     if (!empty($params['image_URL'])) {
 881       CRM_Contact_BAO_Contact::processImageParams($params);
 882     }
 883
 884     if (is_numeric(CRM_Utils_Array::value('current_employer_id', $params)) && !empty($params['current_employer'])) {
 885       $params['current_employer'] = $params['current_employer_id'];
 886     }
 887
 888     // don't carry current_employer_id field,
 889     // since we don't want to directly update DAO object without
 890     // handling related business logic ( eg related membership )
 891     if (isset($params['current_employer_id'])) {
 892       unset($params['current_employer_id']);
 893     }
 894
 895     $params['contact_type'] = $this->_contactType;
 896     if (empty($params['contact_sub_type']) && $this->_isContactSubType) {
 897       $params['contact_sub_type'] = [$this->_contactSubType];
 898     }
 899
 900     if ($this->_contactId) {
 901       $params['contact_id'] = $this->_contactId;
 902     }
 903
 904     //make deceased date null when is_deceased = false
 905     if ($this->_contactType == 'Individual' && !empty($this->_editOptions['Demographics']) && empty($params['is_deceased'])) {
 906       $params['is_deceased'] = FALSE;
 907       $params['deceased_date'] = NULL;
 908     }
 909
 910     // action is taken depending upon the mode
 911     if ($this->_action & CRM_Core_Action::UPDATE) {
 912       CRM_Utils_Hook::pre('edit', $params['contact_type'], $params['contact_id'], $params);
 913     }
 914     else {
 915       CRM_Utils_Hook::pre('create', $params['contact_type'], NULL, $params);
 916     }
 917
 918     //CRM-5143
 919     //if subtype is set, send subtype as extend to validate subtype customfield
 920     $customFieldExtends = (CRM_Utils_Array::value('contact_sub_type', $params)) ? $params['contact_sub_type'] : $params['contact_type'];
 921
 922     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 923       $this->_contactId,
 924       $customFieldExtends,
 925       TRUE
 926     );
 927     if ($this->_contactId && !empty($this->_oldSubtypes)) {
 928       CRM_Contact_BAO_ContactType::deleteCustomSetForSubtypeMigration($this->_contactId,
 929         $params['contact_type'],
 930         $this->_oldSubtypes,
 931         $params['contact_sub_type']
 932       );
 933     }
 934
 935     if (array_key_exists('CommunicationPreferences', $this->_editOptions)) {
 936       // this is a chekbox, so mark false if we dont get a POST value
 937       $params['is_opt_out'] = CRM_Utils_Array::value('is_opt_out', $params, FALSE);
 938     }
 939
 940     // process shared contact address.
 941     CRM_Contact_BAO_Contact_Utils::processSharedAddress($params['address']);
 942
 943     if (!array_key_exists('TagsAndGroups', $this->_editOptions)) {
 944       unset($params['group']);
 945     }
 946     elseif (!empty($params['contact_id']) && ($this->_action & CRM_Core_Action::UPDATE)) {
 947       // figure out which all groups are intended to be removed
 948       $contactGroupList = CRM_Contact_BAO_GroupContact::getContactGroup($params['contact_id'], 'Added');
 949       if (is_array($contactGroupList)) {
 950         foreach ($contactGroupList as $key) {
 951           if ((!array_key_exists($key['group_id'], $params['group']) || $params['group'][$key['group_id']] != 1) && empty($key['is_hidden'])) {
 952             $params['group'][$key['group_id']] = -1;
 953           }
 954         }
 955       }
 956     }
 957
 958     // parse street address, CRM-5450
 959     $parseStatusMsg = NULL;
 960     if ($this->_parseStreetAddress) {
 961       $parseResult = self::parseAddress($params);
 962       $parseStatusMsg = self::parseAddressStatusMsg($parseResult);
 963     }
 964
 965     $blocks = ['email', 'phone', 'im', 'openid', 'address', 'website'];
 966     foreach ($blocks as $block) {
 967       if (!empty($this->_preEditValues[$block]) && is_array($this->_preEditValues[$block])) {
 968         foreach ($this->_preEditValues[$block] as $count => $value) {
 969           if (!empty($value['id'])) {
 970             $params[$block][$count]['id'] = $value['id'];
 971             $params[$block]['isIdSet'] = TRUE;
 972           }
 973         }
 974       }
 975     }
 976
 977     // Allow un-setting of location info, CRM-5969
 978     $params['updateBlankLocInfo'] = TRUE;
 979
 980     $contact = CRM_Contact_BAO_Contact::create($params, TRUE, FALSE, TRUE);
 981
 982     // status message
 983     if ($this->_contactId) {
 984       $message = ts('%1 has been updated.', [1 => $contact->display_name]);
 985     }
 986     else {
 987       $message = ts('%1 has been created.', [1 => $contact->display_name]);
 988     }
 989
 990     // set the contact ID
 991     $this->_contactId = $contact->id;
 992
 993     if (array_key_exists('TagsAndGroups', $this->_editOptions)) {
 994       //add contact to tags
 995       if (isset($params['tag'])) {
 996         $params['tag'] = array_flip(explode(',', $params['tag']));
 997         CRM_Core_BAO_EntityTag::create($params['tag'], 'civicrm_contact', $params['contact_id']);
 998       }
 999       //save free tags
1000       if (isset($params['contact_taglist']) && !empty($params['contact_taglist'])) {
1001         CRM_Core_Form_Tag::postProcess($params['contact_taglist'], $params['contact_id'], 'civicrm_contact', $this);
1002       }
1003     }
1004
1005     if (!empty($parseStatusMsg)) {
1006       $message .= "<br />$parseStatusMsg";
1007     }
1008
1009     $session = CRM_Core_Session::singleton();
1010     $session->setStatus($message, ts('Contact Saved'), 'success');
1011
1012     // add the recently viewed contact
1013     $recentOther = [];
1014     if (($session->get('userID') == $contact->id) ||
1015       CRM_Contact_BAO_Contact_Permission::allow($contact->id, CRM_Core_Permission::EDIT)
1016     ) {
1017       $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/add', 'reset=1&action=update&cid=' . $contact->id);
1018     }
1019
1020     if (($session->get('userID') != $this->_contactId) && CRM_Core_Permission::check('delete contacts')) {
1021       $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/delete', 'reset=1&delete=1&cid=' . $contact->id);
1022     }
1023
1024     CRM_Utils_Recent::add($contact->display_name,
1025       CRM_Utils_System::url('civicrm/contact/view', 'reset=1&cid=' . $contact->id),
1026       $contact->id,
1027       $this->_contactType,
1028       $contact->id,
1029       $contact->display_name,
1030       $recentOther
1031     );
1032
1033     // here we replace the user context with the url to view this contact
1034     $buttonName = $this->controller->getButtonName();
1035     if ($buttonName == $this->getButtonName('upload', 'new')) {
1036       $contactSubTypes = array_filter(explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_contactSubType));
1037       $resetStr = "reset=1&ct={$contact->contact_type}";
1038       $resetStr .= (count($contactSubTypes) == 1) ? "&cst=" . array_pop($contactSubTypes) : '';
1039       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/add', $resetStr));
1040     }
1041     else {
1042       $context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
1043       $qfKey = CRM_Utils_Request::retrieve('key', 'String', $this);
1044       //validate the qfKey
1045       $urlParams = 'reset=1&cid=' . $contact->id;
1046       if ($context) {
1047         $urlParams .= "&context=$context";
1048       }
1049       if (CRM_Utils_Rule::qfKey($qfKey)) {
1050         $urlParams .= "&key=$qfKey";
1051       }
1052
1053       $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view', $urlParams));
1054     }
1055
1056     // now invoke the post hook
1057     if ($this->_action & CRM_Core_Action::UPDATE) {
1058       CRM_Utils_Hook::post('edit', $params['contact_type'], $contact->id, $contact);
1059     }
1060     else {
1061       CRM_Utils_Hook::post('create', $params['contact_type'], $contact->id, $contact);
1062     }
1063   }
1064
1065   /**
1066    * Is there any real significant data in the hierarchical location array.
1067    *
1068    * @param array $fields
1069    *   The hierarchical value representation of this location.
1070    *
1071    * @return bool
1072    *   true if data exists, false otherwise
1073    */
1074   public static function blockDataExists(&$fields) {
1075     if (!is_array($fields)) {
1076       return FALSE;
1077     }
1078
1079     static $skipFields = [
1080       'location_type_id',
1081       'is_primary',
1082       'phone_type_id',
1083       'provider_id',
1084       'country_id',
1085       'website_type_id',
1086       'master_id',
1087     ];
1088     foreach ($fields as $name => $value) {
1089       $skipField = FALSE;
1090       foreach ($skipFields as $skip) {
1091         if (strpos("[$skip]", $name) !== FALSE) {
1092           if ($name == 'phone') {
1093             continue;
1094           }
1095           $skipField = TRUE;
1096           break;
1097         }
1098       }
1099       if ($skipField) {
1100         continue;
1101       }
1102       if (is_array($value)) {
1103         if (self::blockDataExists($value)) {
1104           return TRUE;
1105         }
1106       }
1107       else {
1108         if (!empty($value)) {
1109           return TRUE;
1110         }
1111       }
1112     }
1113
1114     return FALSE;
1115   }
1116
1117   /**
1118    * That checks for duplicate contacts.
1119    *
1120    * @param array $fields
1121    *   Fields array which are submitted.
1122    * @param $errors
1123    * @param int $contactID
1124    *   Contact id.
1125    * @param string $contactType
1126    *   Contact type.
1127    */
1128   public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
1129     // if this is a forced save, ignore find duplicate rule
1130     if (empty($fields['_qf_Contact_upload_duplicate'])) {
1131
1132       $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($fields, $contactType, 'Supervised', [$contactID]);
1133       if ($ids) {
1134
1135         $contactLinks = CRM_Contact_BAO_Contact_Utils::formatContactIDSToLinks($ids, TRUE, TRUE, $contactID);
1136
1137         $duplicateContactsLinks = '<div class="matching-contacts-found">';
1138         $duplicateContactsLinks .= ts('One matching contact was found. ', [
1139           'count' => count($contactLinks['rows']),
1140           'plural' => '%count matching contacts were found.<br />',
1141         ]);
1142         if ($contactLinks['msg'] == 'view') {
1143           $duplicateContactsLinks .= ts('You can View the existing contact', [
1144             'count' => count($contactLinks['rows']),
1145             'plural' => 'You can View the existing contacts',
1146           ]);
1147         }
1148         else {
1149           $duplicateContactsLinks .= ts('You can View or Edit the existing contact', [
1150             'count' => count($contactLinks['rows']),
1151             'plural' => 'You can View or Edit the existing contacts',
1152           ]);
1153         }
1154         if ($contactLinks['msg'] == 'merge') {
1155           // We should also get a merge link if this is for an existing contact
1156           $duplicateContactsLinks .= ts(', or Merge this contact with an existing contact');
1157         }
1158         $duplicateContactsLinks .= '.';
1159         $duplicateContactsLinks .= '</div>';
1160         $duplicateContactsLinks .= '<table class="matching-contacts-actions">';
1161         $row = '';
1162         for ($i = 0; $i < count($contactLinks['rows']); $i++) {
1163           $row .= '  <tr>   ';
1164           $row .= '    <td class="matching-contacts-name"> ';
1165           $row .= CRM_Utils_Array::value('display_name', $contactLinks['rows'][$i]);
1166           $row .= '    </td>';
1167           $row .= '    <td class="matching-contacts-email"> ';
1168           $row .= CRM_Utils_Array::value('primary_email', $contactLinks['rows'][$i]);
1169           $row .= '    </td>';
1170           $row .= '    <td class="action-items"> ';
1171           $row .= CRM_Utils_Array::value('view', $contactLinks['rows'][$i]);
1172           $row .= CRM_Utils_Array::value('edit', $contactLinks['rows'][$i]);
1173           $row .= CRM_Utils_Array::value('merge', $contactLinks['rows'][$i]);
1174           $row .= '    </td>';
1175           $row .= '  </tr>   ';
1176         }
1177
1178         $duplicateContactsLinks .= $row . '</table>';
1179         $duplicateContactsLinks .= ts("If you're sure this record is not a duplicate, click the 'Save Matching Contact' button below.");
1180
1181         $errors['_qf_default'] = $duplicateContactsLinks;
1182
1183         // let smarty know that there are duplicates
1184         $template = CRM_Core_Smarty::singleton();
1185         $template->assign('isDuplicate', 1);
1186       }
1187       elseif (!empty($fields['_qf_Contact_refresh_dedupe'])) {
1188         // add a session message for no matching contacts
1189         CRM_Core_Session::setStatus(ts('No matching contact found.'), ts('None Found'), 'info');
1190       }
1191     }
1192   }
1193
1194   /**
1195    * Use the form name to create the tpl file name.
1196    *
1197    * @return string
1198    */
1199   public function getTemplateFileName() {
1200     if ($this->_contactSubType) {
1201       $templateFile = "CRM/Contact/Form/Edit/SubType/{$this->_contactSubType}.tpl";
1202       $template = CRM_Core_Form::getTemplate();
1203       if ($template->template_exists($templateFile)) {
1204         return $templateFile;
1205       }
1206     }
1207     return parent::getTemplateFileName();
1208   }
1209
1210   /**
1211    * Parse all address blocks present in given params
1212    * and return parse result for all address blocks,
1213    * This function either parse street address in to child
1214    * elements or build street address from child elements.
1215    *
1216    * @param array $params
1217    *   of key value consist of address blocks.
1218    *
1219    * @return array
1220    *   as array of success/fails for each address block
1221    */
1222   public function parseAddress(&$params) {
1223     $parseSuccess = $parsedFields = [];
1224     if (!is_array($params['address']) ||
1225       CRM_Utils_System::isNull($params['address'])
1226     ) {
1227       return $parseSuccess;
1228     }
1229
1230     foreach ($params['address'] as $instance => & $address) {
1231       $buildStreetAddress = FALSE;
1232       $parseFieldName = 'street_address';
1233       foreach ([
1234         'street_number',
1235         'street_name',
1236         'street_unit',
1237       ] as $fld) {
1238         if (!empty($address[$fld])) {
1239           $parseFieldName = 'street_number';
1240           $buildStreetAddress = TRUE;
1241           break;
1242         }
1243       }
1244
1245       // main parse string.
1246       $parseString = $address[$parseFieldName] ?? NULL;
1247
1248       // parse address field.
1249       $parsedFields = CRM_Core_BAO_Address::parseStreetAddress($parseString);
1250
1251       if ($buildStreetAddress) {
1252         //hack to ignore spaces between number and suffix.
1253         //here user gives input as street_number so it has to
1254         //be street_number and street_number_suffix, but
1255         //due to spaces though preg detect string as street_name
1256         //consider it as 'street_number_suffix'.
1257         $suffix = $parsedFields['street_number_suffix'];
1258         if (!$suffix) {
1259           $suffix = $parsedFields['street_name'];
1260         }
1261         $address['street_number_suffix'] = $suffix;
1262         $address['street_number'] = $parsedFields['street_number'];
1263
1264         $streetAddress = NULL;
1265         foreach ([
1266           'street_number',
1267           'street_number_suffix',
1268           'street_name',
1269           'street_unit',
1270         ] as $fld) {
1271           if (in_array($fld, [
1272             'street_name',
1273             'street_unit',
1274           ])) {
1275             $streetAddress .= ' ';
1276           }
1277           // CRM-17619 - if the street number suffix begins with a number, add a space
1278           $thesuffix = $address['street_number_suffix'] ?? NULL;
1279           if ($fld === 'street_number_suffix' && $thesuffix) {
1280             if (ctype_digit(substr($thesuffix, 0, 1))) {
1281               $streetAddress .= ' ';
1282             }
1283           }
1284           $streetAddress .= CRM_Utils_Array::value($fld, $address);
1285         }
1286         $address['street_address'] = trim($streetAddress);
1287         $parseSuccess[$instance] = TRUE;
1288       }
1289       else {
1290         $success = TRUE;
1291         // consider address is automatically parseable,
1292         // when we should found street_number and street_name
1293         if (empty($parsedFields['street_name']) || empty($parsedFields['street_number'])) {
1294           $success = FALSE;
1295         }
1296
1297         // check for original street address string.
1298         if (empty($parseString)) {
1299           $success = TRUE;
1300         }
1301
1302         $parseSuccess[$instance] = $success;
1303
1304         // we do not reset element values, but keep what we've parsed
1305         // in case of partial matches: CRM-8378
1306
1307         // merge parse address in to main address block.
1308         $address = array_merge($address, $parsedFields);
1309       }
1310     }
1311
1312     return $parseSuccess;
1313   }
1314
1315   /**
1316    * Check parse result and if some address block fails then this
1317    * function return the status message for all address blocks.
1318    *
1319    * @param array $parseResult
1320    *   An array of address blk instance and its status.
1321    *
1322    * @return null|string
1323    *   $statusMsg   string status message for all address blocks.
1324    */
1325   public static function parseAddressStatusMsg($parseResult) {
1326     $statusMsg = NULL;
1327     if (!is_array($parseResult) || empty($parseResult)) {
1328       return $statusMsg;
1329     }
1330
1331     $parseFails = [];
1332     foreach ($parseResult as $instance => $success) {
1333       if (!$success) {
1334         $parseFails[] = self::ordinalNumber($instance);
1335       }
1336     }
1337
1338     if (!empty($parseFails)) {
1339       $statusMsg = ts("Complete street address(es) have been saved. However we were unable to split the address in the %1 address block(s) into address elements (street number, street name, street unit) due to an unrecognized address format. You can set the address elements manually by clicking 'Edit Address Elements' next to the Street Address field while in edit mode.",
1340         [1 => implode(', ', $parseFails)]
1341       );
1342     }
1343
1344     return $statusMsg;
1345   }
1346
1347   /**
1348    * Convert normal number to ordinal number format.
1349    * like 1 => 1st, 2 => 2nd and so on...
1350    *
1351    * @param int $number
1352    *   number to convert in to ordinal number.
1353    *
1354    * @return string
1355    *   ordinal number for given number.
1356    */
1357   public static function ordinalNumber($number) {
1358     if (empty($number)) {
1359       return NULL;
1360     }
1361
1362     $str = 'th';
1363     switch (floor($number / 10) % 10) {
1364       case 1:
1365       default:
1366         switch ($number % 10) {
1367           case 1:
1368             $str = 'st';
1369             break;
1370
1371           case 2:
1372             $str = 'nd';
1373             break;
1374
1375           case 3:
1376             $str = 'rd';
1377             break;
1378         }
1379     }
1380
1381     return "$number$str";
1382   }
1383
1384 }