3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This is class to handle address related functions.
21 class CRM_Core_BAO_Address
extends CRM_Core_DAO_Address
{
24 * Takes an associative array and creates a address.
26 * @param array $params
27 * (reference ) an assoc array of name/value pairs.
28 * @param bool $fixAddress
29 * True if you need to fix (format) address values.
30 * before inserting in db
35 * array of created address
37 public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
38 if (!isset($params['address']) ||
!is_array($params['address'])) {
41 CRM_Core_BAO_Block
::sortPrimaryFirst($params['address']);
45 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
47 $contactId = $params['contact_id'];
48 //get all the addresses for this contact
49 $addresses = self
::allAddress($contactId);
52 // get all address from location block
54 'entity_table' => $params['entity_table'],
55 'entity_id' => $params['entity_id'],
57 $addresses = self
::allEntityAddress($entityElements);
60 $isPrimary = $isBilling = TRUE;
62 foreach ($params['address'] as $key => $value) {
63 if (!is_array($value)) {
67 $addressExists = self
::dataExists($value);
68 if (empty($value['id'])) {
69 if (!empty($addresses) && array_key_exists(CRM_Utils_Array
::value('location_type_id', $value), $addresses)) {
70 $value['id'] = $addresses[CRM_Utils_Array
::value('location_type_id', $value)];
74 // Note there could be cases when address info already exist ($value[id] is set) for a contact/entity
75 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
76 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
77 if (isset($value['id']) && !$addressExists && $updateBlankLocInfo) {
78 //delete the existing record
79 CRM_Core_BAO_Block
::blockDelete('Address', ['id' => $value['id']]);
82 elseif (!$addressExists) {
86 if ($isPrimary && !empty($value['is_primary'])) {
90 $value['is_primary'] = 0;
93 if ($isBilling && !empty($value['is_billing'])) {
97 $value['is_billing'] = 0;
100 if (empty($value['manual_geo_code'])) {
101 $value['manual_geo_code'] = 0;
103 $value['contact_id'] = $contactId;
104 $blocks[] = self
::add($value, $fixAddress);
111 * Takes an associative array and adds address.
113 * @param array $params
114 * (reference ) an assoc array of name/value pairs.
115 * @param bool $fixAddress
116 * True if you need to fix (format) address values.
117 * before inserting in db
119 * @return CRM_Core_BAO_Address|null
121 public static function add(&$params, $fixAddress = FALSE) {
123 $address = new CRM_Core_DAO_Address();
124 $checkPermissions = isset($params['check_permissions']) ?
$params['check_permissions'] : TRUE;
126 // fixAddress mode to be done
128 CRM_Core_BAO_Address
::fixAddress($params);
131 $hook = empty($params['id']) ?
'create' : 'edit';
132 CRM_Utils_Hook
::pre($hook, 'Address', CRM_Utils_Array
::value('id', $params), $params);
134 // if id is set & is_primary isn't we can assume no change
135 if (is_numeric(CRM_Utils_Array
::value('is_primary', $params)) ||
empty($params['id'])) {
136 CRM_Core_BAO_Block
::handlePrimary($params, get_class());
139 // (prevent chaining 1 and 3) CRM-21214
140 if (isset($params['master_id']) && !CRM_Utils_System
::isNull($params['master_id'])) {
141 self
::fixSharedAddress($params);
144 $address->copyValues($params);
149 if (isset($params['custom'])) {
150 $addressCustom = $params['custom'];
153 $customFields = CRM_Core_BAO_CustomField
::getFields('Address', FALSE, TRUE, NULL, NULL, FALSE, FALSE, $checkPermissions);
155 if (!empty($customFields)) {
156 $addressCustom = CRM_Core_BAO_CustomField
::postProcess($params,
164 if (!empty($addressCustom)) {
165 CRM_Core_BAO_CustomValueTable
::store($addressCustom, 'civicrm_address', $address->id
);
168 // call the function to sync shared address and create relationships
169 // if address is already shared, share master_id with all children and update relationships accordingly
170 // (prevent chaining 2) CRM-21214
171 self
::processSharedAddress($address->id
, $params);
173 // lets call the post hook only after we've done all the follow on processing
174 CRM_Utils_Hook
::post($hook, 'Address', $address->id
, $address);
181 * Format the address params to have reasonable values.
183 * @param array $params
184 * (reference ) an assoc array of name/value pairs.
186 public static function fixAddress(&$params) {
187 if (!empty($params['billing_street_address'])) {
188 //Check address is coming from online contribution / registration page
191 'street_address' => 'billing_street_address',
192 'city' => 'billing_city',
193 'postal_code' => 'billing_postal_code',
194 'state_province' => 'billing_state_province',
195 'state_province_id' => 'billing_state_province_id',
196 'country' => 'billing_country',
197 'country_id' => 'billing_country_id',
200 foreach ($billing as $key => $val) {
201 if ($value = CRM_Utils_Array
::value($val, $params)) {
202 if (!empty($params[$key])) {
203 unset($params[$val]);
206 //add new key and removed old
207 $params[$key] = $value;
208 unset($params[$val]);
214 /* Split the zip and +4, if it's in US format */
215 if (!empty($params['postal_code']) &&
216 preg_match('/^(\d{4,5})[+-](\d{4})$/',
217 $params['postal_code'],
221 $params['postal_code'] = $match[1];
222 $params['postal_code_suffix'] = $match[2];
225 // add country id if not set
226 if ((!isset($params['country_id']) ||
!is_numeric($params['country_id'])) &&
227 isset($params['country'])
229 $country = new CRM_Core_DAO_Country();
230 $country->name
= $params['country'];
231 if (!$country->find(TRUE)) {
232 $country->name
= NULL;
233 $country->iso_code
= $params['country'];
234 $country->find(TRUE);
236 $params['country_id'] = $country->id
;
239 // add state_id if state is set
240 if ((!isset($params['state_province_id']) ||
!is_numeric($params['state_province_id']))
241 && isset($params['state_province'])
243 if (!empty($params['state_province'])) {
244 $state_province = new CRM_Core_DAO_StateProvince();
245 $state_province->name
= $params['state_province'];
247 // add country id if present
248 if (!empty($params['country_id'])) {
249 $state_province->country_id
= $params['country_id'];
252 if (!$state_province->find(TRUE)) {
253 unset($state_province->name
);
254 $state_province->abbreviation
= $params['state_province'];
255 $state_province->find(TRUE);
257 $params['state_province_id'] = $state_province->id
;
258 if (empty($params['country_id'])) {
259 // set this here since we have it
260 $params['country_id'] = $state_province->country_id
;
264 $params['state_province_id'] = 'null';
268 // add county id if county is set
270 if ((!isset($params['county_id']) ||
!is_numeric($params['county_id']))
271 && isset($params['county']) && !empty($params['county'])
273 $county = new CRM_Core_DAO_County();
274 $county->name
= $params['county'];
276 if (isset($params['state_province_id'])) {
277 $county->state_province_id
= $params['state_province_id'];
280 if ($county->find(TRUE)) {
281 $params['county_id'] = $county->id
;
285 // currently copy values populates empty fields with the string "null"
286 // and hence need to check for the string null
287 if (isset($params['state_province_id']) &&
288 is_numeric($params['state_province_id']) &&
289 (!isset($params['country_id']) ||
empty($params['country_id']))
291 // since state id present and country id not present, hence lets populate it
292 // jira issue http://issues.civicrm.org/jira/browse/CRM-56
293 $params['country_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince',
294 $params['state_province_id'],
299 //special check to ignore non numeric values if they are not
300 //detected by formRule(sometimes happens due to internet latency), also allow user to unselect state/country
301 if (isset($params['state_province_id'])) {
302 if (empty($params['state_province_id'])) {
303 $params['state_province_id'] = 'null';
305 elseif (!is_numeric($params['state_province_id']) ||
306 ((int ) $params['state_province_id'] < 1000)
308 // CRM-3393 ( the hacky 1000 check)
309 $params['state_province_id'] = 'null';
313 if (isset($params['country_id'])) {
314 if (empty($params['country_id'])) {
315 $params['country_id'] = 'null';
317 elseif (!is_numeric($params['country_id']) ||
318 ((int ) $params['country_id'] < 1000)
320 // CRM-3393 ( the hacky 1000 check)
321 $params['country_id'] = 'null';
325 // add state and country names from the ids
326 if (isset($params['state_province_id']) && is_numeric($params['state_province_id'])) {
327 $params['state_province'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params['state_province_id']);
330 if (isset($params['country_id']) && is_numeric($params['country_id'])) {
331 $params['country'] = CRM_Core_PseudoConstant
::country($params['country_id']);
334 $asp = Civi
::settings()->get('address_standardization_provider');
335 // clean up the address via USPS web services if enabled
336 if ($asp === 'USPS' &&
337 $params['country_id'] == 1228
339 CRM_Utils_Address_USPS
::checkAddress($params);
341 // do street parsing again if enabled, since street address might have changed
342 $parseStreetAddress = CRM_Utils_Array
::value(
343 'street_address_parsing',
344 CRM_Core_BAO_Setting
::valueOptions(
345 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
351 if ($parseStreetAddress && !empty($params['street_address'])) {
352 foreach (['street_number', 'street_name', 'street_unit', 'street_number_suffix'] as $fld) {
353 unset($params[$fld]);
355 // main parse string.
356 $parseString = CRM_Utils_Array
::value('street_address', $params);
357 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
359 // merge parse address in to main address block.
360 $params = array_merge($params, $parsedFields);
363 // skip_geocode is an optional parameter through the api.
364 // manual_geo_code is on the contact edit form. They do the same thing....
365 if (empty($params['skip_geocode']) && empty($params['manual_geo_code'])) {
366 self
::addGeocoderData($params);
372 * Check if there is data to create the object.
374 * @param array $params
375 * (reference ) an assoc array of name/value pairs.
379 public static function dataExists(&$params) {
380 //check if location type is set if not return false
381 if (!isset($params['location_type_id'])) {
385 $config = CRM_Core_Config
::singleton();
386 foreach ($params as $name => $value) {
387 if (in_array($name, [
398 elseif (!CRM_Utils_System
::isNull($value)) {
399 // name could be country or country id
400 if (substr($name, 0, 7) == 'country') {
401 // make sure its different from the default country
403 $defaultCountry = CRM_Core_BAO_Country
::defaultContactCountry();
405 $defaultCountryName = CRM_Core_BAO_Country
::defaultContactCountryName();
407 if ($defaultCountry) {
408 if ($value == $defaultCountry ||
409 $value == $defaultCountryName ||
410 $value == $config->defaultContactCountry
419 // return if null default
433 * Given the list of params in the params array, fetch the object
434 * and store the values in the values array
436 * @param array $entityBlock
437 * Associated array of fields.
438 * @param bool $microformat
439 * If microformat output is required.
440 * @param int|string $fieldName conditional field name
443 * array with address fields
445 public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
446 if (empty($entityBlock)) {
450 $address = new CRM_Core_BAO_Address();
452 if (empty($entityBlock['entity_table'])) {
453 $address->$fieldName = CRM_Utils_Array
::value($fieldName, $entityBlock);
457 $addressIds = self
::allEntityAddress($entityBlock);
459 if (!empty($addressIds[1])) {
460 $address->id
= $addressIds[1];
466 if (isset($entityBlock['is_billing']) && $entityBlock['is_billing'] == 1) {
467 $address->orderBy('is_billing desc, id');
470 //get primary address as a first block.
471 $address->orderBy('is_primary desc, id');
476 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
478 while ($address->fetch()) {
479 // deprecate reference.
481 foreach (['state', 'state_name', 'country', 'world_region'] as $fld) {
482 if (isset($address->$fld)) {
483 unset($address->$fld);
487 $stree = $address->street_address
;
489 CRM_Core_DAO
::storeValues($address, $values);
491 // add state and country information: CRM-369
492 if (!empty($address->location_type_id
)) {
493 $values['location_type'] = CRM_Utils_Array
::value($address->location_type_id
, $locationTypes);
495 if (!empty($address->state_province_id
)) {
496 $address->state
= CRM_Core_PseudoConstant
::stateProvinceAbbreviation($address->state_province_id
, FALSE);
497 $address->state_name
= CRM_Core_PseudoConstant
::stateProvince($address->state_province_id
, FALSE);
500 if (!empty($address->country_id
)) {
501 $address->country
= CRM_Core_PseudoConstant
::country($address->country_id
);
504 $regionId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Country', $address->country_id
, 'region_id');
506 $address->world_region
= CRM_Core_PseudoConstant
::worldregion($regionId);
509 $address->addDisplay($microformat);
511 $values['display'] = $address->display
;
512 $values['display_text'] = $address->display_text
;
514 if (isset($address->master_id
) && !CRM_Utils_System
::isNull($address->master_id
)) {
515 $values['use_shared_address'] = 1;
518 $addresses[$count] = $values;
520 //There should never be more than one primary blocks, hence set is_primary = 0 other than first
521 // Calling functions expect the key is_primary to be set, so do not unset it here!
523 $addresses[$count]['is_primary'] = 0;
533 * Add the formatted address to $this-> display.
535 * @param bool $microformat
536 * Unexplained parameter that I've always wondered about.
538 public function addDisplay($microformat = FALSE) {
540 // added this for CRM 1200
541 'address_id' => $this->id
,
543 'address_name' => str_replace('\ 1', ' ', $this->name
),
544 'street_address' => $this->street_address
,
545 'supplemental_address_1' => $this->supplemental_address_1
,
546 'supplemental_address_2' => $this->supplemental_address_2
,
547 'supplemental_address_3' => $this->supplemental_address_3
,
548 'city' => $this->city
,
549 'state_province_name' => isset($this->state_name
) ?
$this->state_name
: "",
550 'state_province' => isset($this->state
) ?
$this->state
: "",
551 'postal_code' => isset($this->postal_code
) ?
$this->postal_code
: "",
552 'postal_code_suffix' => isset($this->postal_code_suffix
) ?
$this->postal_code_suffix
: "",
553 'country' => isset($this->country
) ?
$this->country
: "",
554 'world_region' => isset($this->world_region
) ?
$this->world_region
: "",
557 if (isset($this->county_id
) && $this->county_id
) {
558 $fields['county'] = CRM_Core_PseudoConstant
::county($this->county_id
);
561 $fields['county'] = NULL;
564 $this->display
= CRM_Utils_Address
::format($fields, NULL, $microformat);
565 $this->display_text
= CRM_Utils_Address
::format($fields);
569 * Get all the addresses for a specified contact_id, with the primary address being first
574 * @param bool $updateBlankLocInfo
577 * the array of adrress data
579 public static function allAddress($id, $updateBlankLocInfo = FALSE) {
585 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
586 FROM civicrm_contact, civicrm_address
587 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
588 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
589 $params = [1 => [$id, 'Integer']];
592 $dao = CRM_Core_DAO
::executeQuery($query, $params);
594 while ($dao->fetch()) {
595 if ($updateBlankLocInfo) {
596 $addresses[$count++
] = $dao->address_id
;
599 $addresses[$dao->location_type_id
] = $dao->address_id
;
606 * Get all the addresses for a specified location_block id, with the primary address being first
608 * @param array $entityElements
609 * The array containing entity_id and.
613 * the array of adrress data
615 public static function allEntityAddress(&$entityElements) {
617 if (empty($entityElements)) {
621 $entityId = $entityElements['entity_id'];
622 $entityTable = $entityElements['entity_table'];
625 SELECT civicrm_address.id as address_id
626 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
628 AND loc.id = ev.loc_block_id
629 AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
630 AND ltype.id = civicrm_address.location_type_id
631 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
633 $params = [1 => [$entityId, 'Integer']];
634 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
636 while ($dao->fetch()) {
637 $addresses[$locationCount] = $dao->address_id
;
644 * Get address sequence.
647 * Array of address sequence.
649 public static function addressSequence() {
650 $addressSequence = CRM_Utils_Address
::sequence(\Civi
::settings()->get('address_format'));
652 $countryState = $cityPostal = FALSE;
653 foreach ($addressSequence as $key => $field) {
655 in_array($field, ['country', 'state_province']) &&
658 $countryState = TRUE;
659 $addressSequence[$key] = 'country_state_province';
662 in_array($field, ['city', 'postal_code']) &&
666 $addressSequence[$key] = 'city_postal_code';
669 in_array($field, ['country', 'state_province', 'city', 'postal_code'])
671 unset($addressSequence[$key]);
675 return $addressSequence;
679 * Parse given street address string in to street_name,
680 * street_unit, street_number and street_number_suffix
681 * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
683 * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
684 * otherwise en_US format is default action
686 * @param string $streetAddress
687 * Street address including number and apt.
688 * @param string $locale
689 * Locale used to parse address.
692 * parsed fields values.
694 public static function parseStreetAddress($streetAddress, $locale = NULL) {
695 // use 'en_US' for address parsing if the requested locale is not supported.
696 if (!self
::isSupportedParsingLocale($locale)) {
700 $emptyParseFields = $parseFields = [
703 'street_number' => '',
704 'street_number_suffix' => '',
707 if (empty($streetAddress)) {
711 $streetAddress = trim($streetAddress);
714 if (in_array($locale, ['en_CA', 'fr_CA'])
715 && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)
717 $parseFields['street_unit'] = $matches[1];
718 // unset from rest of street address
719 $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
722 // get street number and suffix.
724 //alter street number/suffix handling so that we accept -digit
725 if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
726 // check that $matches[0] is numeric, else assume no street number
727 if (preg_match('/^(\d+)/', $matches[0])) {
728 $streetNumAndSuffix = $matches[0];
730 // get street number.
732 if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
733 $parseFields['street_number'] = $matches[0];
734 $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
735 $parseFields['street_number_suffix'] = trim($suffix);
738 // unset from main street address.
739 $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
740 $streetAddress = trim($streetAddress);
743 elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
744 $parseFields['street_number'] = $matches[0];
745 // unset from main street address.
746 $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
747 $streetAddress = trim($streetAddress);
750 // If street number is too large, we cannot store it.
751 if ($parseFields['street_number'] > CRM_Utils_Type
::INT_MAX
) {
752 return $emptyParseFields;
755 // suffix might be like 1/2
757 if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
758 $parseFields['street_number_suffix'] .= $matches[0];
760 // unset from main street address.
761 $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
762 $streetAddress = trim($streetAddress);
765 // now get the street unit.
766 // supportable street unit formats.
767 $streetUnitFormats = [
810 // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
811 if (in_array($locale, [
815 $streetUnitFormats = ['APT', 'APP', 'SUITE', 'BUREAU', 'UNIT'];
817 //@todo per CRM-14459 this regex picks up words with the string in them - e.g APT picks up
818 //Captain - presuming fixing regex (& adding test) to ensure a-z does not preced string will fix
819 $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
821 if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
822 $parseFields['street_unit'] = trim($matches[0]);
823 $streetAddress = str_replace($matches[0], '', $streetAddress);
824 $streetAddress = trim($streetAddress);
827 // consider remaining string as street name.
828 $parseFields['street_name'] = $streetAddress;
830 //run parsed fields through stripSpaces to clean
831 foreach ($parseFields as $parseField => $value) {
832 $parseFields[$parseField] = CRM_Utils_String
::stripSpaces($value);
834 //CRM-14459 if the field is too long we should assume it didn't get it right & skip rather than allow
836 $fields = CRM_Core_BAO_Address
::fields();
837 foreach ($fields as $fieldname => $field) {
838 if (!empty($field['maxlength']) && strlen(CRM_Utils_Array
::value($fieldname, $parseFields)) > $field['maxlength']) {
839 return $emptyParseFields;
847 * Determines if the specified locale is
848 * supported by address parsing.
849 * If no locale is specified then it
850 * will check the default configured locale.
852 * locales supported include:
853 * en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
854 * en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
855 * fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
856 * NB: common use of comma after street number also supported
858 * @param string $locale
859 * The locale to be checked
863 public static function isSupportedParsingLocale($locale = NULL) {
865 $config = CRM_Core_Config
::singleton();
866 $locale = $config->lcMessages
;
869 $parsingSupportedLocales = ['en_US', 'en_CA', 'fr_CA'];
871 if (in_array($locale, $parsingSupportedLocales)) {
879 * Validate the address fields based on the address options enabled.
880 * in the Address Settings
882 * @param array $fields
883 * An array of importable/exportable contact fields.
886 * an array of contact fields and only the enabled address options
888 public static function validateAddressOptions($fields) {
889 static $addressOptions = NULL;
890 if (!$addressOptions) {
891 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(
892 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
897 if (is_array($fields) && !empty($fields)) {
898 foreach ($addressOptions as $key => $value) {
899 if (!$value && isset($fields[$key])) {
900 unset($fields[$key]);
908 * Check if current address is used by any other contacts.
910 * @param int $addressId
914 * count of contacts that use this shared address
916 public static function checkContactSharedAddress($addressId) {
917 $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
918 return CRM_Core_DAO
::singleValueQuery($query, [1 => [$addressId, 'Integer']]);
922 * Check if current address fields are shared with any other address.
924 * @param array $fields
925 * Address fields in profile.
926 * @param int $contactId
930 public static function checkContactSharedAddressFields(&$fields, $contactId) {
931 if (!$contactId ||
!is_array($fields) ||
empty($fields)) {
935 $sharedLocations = [];
941 WHERE contact_id = %1
942 AND master_id IS NOT NULL";
944 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$contactId, 'Positive']]);
945 while ($dao->fetch()) {
946 $sharedLocations[$dao->location_type_id
] = $dao->location_type_id
;
947 if ($dao->is_primary
) {
948 $sharedLocations['Primary'] = 'Primary';
952 //no need to process further.
953 if (empty($sharedLocations)) {
967 'postal_code_suffix',
968 'supplemental_address_1',
969 'supplemental_address_2',
970 'supplemental_address_3',
973 foreach ($fields as $name => & $values) {
974 if (!is_array($values) ||
empty($values)) {
978 $nameVal = explode('-', $values['name']);
979 $fldName = CRM_Utils_Array
::value(0, $nameVal);
980 $locType = CRM_Utils_Array
::value(1, $nameVal);
981 if (!empty($values['location_type_id'])) {
982 $locType = $values['location_type_id'];
985 if (in_array($fldName, $addressFields) &&
986 in_array($locType, $sharedLocations)
988 $values['is_shared'] = TRUE;
994 * Fix the shared address if address is already shared
995 * or if address will be shared with itself.
997 * @param array $params
998 * Associated array of address params.
1000 public static function fixSharedAddress(&$params) {
1001 // if address master address is shared, use its master (prevent chaining 1) CRM-21214
1002 $masterMasterId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Address', $params['master_id'], 'master_id');
1003 if ($masterMasterId > 0) {
1004 $params['master_id'] = $masterMasterId;
1007 // prevent an endless chain between two shared addresses (prevent chaining 3) CRM-21214
1008 if (CRM_Utils_Array
::value('id', $params) == $params['master_id']) {
1009 $params['master_id'] = NULL;
1010 CRM_Core_Session
::setStatus(ts("You can't connect an address to itself"), '', 'warning');
1015 * Update the shared addresses if master address is modified.
1017 * @param int $addressId
1019 * @param array $params
1020 * Associated array of address params.
1022 public static function processSharedAddress($addressId, $params) {
1023 $query = 'SELECT id, contact_id FROM civicrm_address WHERE master_id = %1';
1024 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$addressId, 'Integer']]);
1026 // Default to TRUE if not set to maintain api backward compatibility.
1027 $createRelationship = isset($params['update_current_employer']) ?
$params['update_current_employer'] : TRUE;
1030 $skipFields = ['is_primary', 'location_type_id', 'is_billing', 'contact_id'];
1031 if (isset($params['master_id']) && !CRM_Utils_System
::isNull($params['master_id'])) {
1032 if ($createRelationship) {
1033 // call the function to create a relationship for the new shared address
1034 self
::processSharedAddressRelationship($params['master_id'], $params['contact_id']);
1038 // else no new shares will be created, only update shared addresses
1039 $skipFields[] = 'master_id';
1041 foreach ($skipFields as $value) {
1042 unset($params[$value]);
1045 $addressDAO = new CRM_Core_DAO_Address();
1046 while ($dao->fetch()) {
1047 // call the function to update the relationship
1048 if ($createRelationship && isset($params['master_id']) && !CRM_Utils_System
::isNull($params['master_id'])) {
1049 self
::processSharedAddressRelationship($params['master_id'], $dao->contact_id
);
1051 $addressDAO->copyValues($params);
1052 $addressDAO->id
= $dao->id
;
1053 $addressDAO->save();
1058 * Merge contacts with the Same address to get one shared label.
1059 * @param array $rows
1060 * Array[contact_id][contactDetails].
1062 public static function mergeSameAddress(&$rows) {
1063 $uniqueAddress = [];
1064 foreach (array_keys($rows) as $rowID) {
1065 // load complete address as array key
1066 $address = trim($rows[$rowID]['street_address'])
1067 . trim($rows[$rowID]['city'])
1068 . trim($rows[$rowID]['state_province'])
1069 . trim($rows[$rowID]['postal_code'])
1070 . trim($rows[$rowID]['country']);
1071 if (isset($rows[$rowID]['last_name'])) {
1072 $name = $rows[$rowID]['last_name'];
1075 $name = $rows[$rowID]['display_name'];
1080 'first_name' => $rows[$rowID]['first_name'],
1081 'individual_prefix' => $rows[$rowID]['individual_prefix'],
1083 $format = Civi
::settings()->get('display_name_format');
1084 $firstNameWithPrefix = CRM_Utils_Address
::format($formatted, $format, FALSE, FALSE);
1085 $firstNameWithPrefix = trim($firstNameWithPrefix);
1087 // fill uniqueAddress array with last/first name tree
1088 if (isset($uniqueAddress[$address])) {
1089 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1090 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1091 // drop unnecessary rows
1092 unset($rows[$rowID]);
1093 // this is the first listing at this address
1096 $uniqueAddress[$address]['ID'] = $rowID;
1097 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1098 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1101 foreach ($uniqueAddress as $address => $data) {
1102 // copy data back to $rows
1104 // one last name list per row
1105 foreach ($data['names'] as $last_name => $first_names) {
1110 if (count($first_names) == 1) {
1111 $family = $first_names[current(array_keys($first_names))]['addressee_display'];
1114 // collapse the tree to summarize
1115 $family = trim(implode(" & ", array_keys($first_names)) . " " . $last_name);
1118 $processedNames .= "\n" . $family;
1121 // build display_name string
1122 $processedNames = $family;
1126 $rows[$data['ID']]['addressee'] = $rows[$data['ID']]['addressee_display'] = $rows[$data['ID']]['display_name'] = $processedNames;
1131 * Create relationship between contacts who share an address.
1133 * Note that currently we create relationship between
1134 * Individual + Household and Individual + Organization
1136 * @param int $masterAddressId
1137 * Master address id.
1138 * @param int $currentContactId
1139 * Current contact id.
1141 public static function processSharedAddressRelationship($masterAddressId, $currentContactId) {
1142 // get the contact type of contact being edited / created
1143 $currentContactType = CRM_Contact_BAO_Contact
::getContactType($currentContactId);
1145 // if current contact is not of type individual return
1146 if ($currentContactType != 'Individual') {
1150 // get the contact id and contact type of shared contact
1151 // check the contact type of shared contact, return if it is of type Individual
1152 $query = 'SELECT cc.id, cc.contact_type
1153 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1156 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$masterAddressId, 'Integer']]);
1159 // master address contact needs to be Household or Organization, otherwise return
1160 if ($dao->contact_type
== 'Individual') {
1163 $sharedContactType = $dao->contact_type
;
1164 $sharedContactId = $dao->id
;
1166 // create relationship between ontacts who share an address
1167 if ($sharedContactType == 'Organization') {
1168 return CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1171 // get the relationship type id of "Household Member of"
1172 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Household Member of', 'id', 'name_a_b');
1175 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Household Member of'"));
1179 'is_active' => TRUE,
1180 'relationship_type_id' => $relTypeId,
1181 'contact_id_a' => $currentContactId,
1182 'contact_id_b' => $sharedContactId,
1185 // If already there is a relationship record of $relParam criteria, avoid creating relationship again or else
1186 // it will casue CRM-16588 as the Duplicate Relationship Exception will revert other contact field values on update
1187 if (CRM_Contact_BAO_Relationship
::checkDuplicateRelationship($relParam, $currentContactId, $sharedContactId)) {
1192 // create relationship
1193 civicrm_api3('relationship', 'create', $relParam);
1195 catch (CiviCRM_API3_Exception
$e) {
1196 // We catch and ignore here because this has historically been a best-effort relationship create call.
1197 // presumably it could refuse due to duplication or similar and we would ignore that.
1202 * Check and set the status for shared address delete.
1204 * @param int $addressId
1206 * @param int $contactId
1208 * @param bool $returnStatus
1213 public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1214 // check if address that is being deleted has any shared
1216 $entityId = $addressId;
1217 $query = 'SELECT cc.id, cc.display_name
1218 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1219 WHERE ca.master_id = %1';
1222 $entityId = $contactId;
1223 $query = 'SELECT cc.id, cc.display_name
1224 FROM civicrm_address ca1
1225 INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1226 INNER JOIN civicrm_contact cc ON ca2.contact_id = cc.id
1227 WHERE ca1.contact_id = %1';
1230 $dao = CRM_Core_DAO
::executeQuery($query, [1 => [$entityId, 'Integer']]);
1233 $sharedContactList = [];
1234 $statusMessage = NULL;
1236 while ($dao->fetch()) {
1237 if (empty($deleteStatus)) {
1238 $deleteStatus[] = ts('The following contact(s) have address records which were shared with the address you removed from this contact. These address records are no longer shared - but they have not been removed or altered.');
1241 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1242 $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1243 $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1248 if (!empty($deleteStatus)) {
1249 $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1252 if (!$returnStatus) {
1253 CRM_Core_Session
::setStatus($statusMessage, '', 'info');
1257 'contactList' => $sharedContactList,
1258 'count' => $addressCount,
1264 * Call common delete function.
1270 public static function del($id) {
1271 return CRM_Contact_BAO_Contact
::deleteObjectWithPrimary('Address', $id);
1275 * Get options for a given address field.
1276 * @see CRM_Core_DAO::buildOptions
1278 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
1279 * TODO: In context of chainselect, what to return if e.g. a country has no states?
1281 * @param string $fieldName
1282 * @param string $context
1283 * @see CRM_Core_DAO::buildOptionsContext
1284 * @param array $props
1285 * whatever is known about this dao object.
1287 * @return array|bool
1289 public static function buildOptions($fieldName, $context = NULL, $props = []) {
1291 // Special logic for fields whose options depend on context or properties
1292 switch ($fieldName) {
1293 // Filter state_province list based on chosen country or site defaults
1294 case 'state_province_id':
1295 case 'state_province_name':
1296 case 'state_province':
1297 // change $fieldName to DB specific names.
1298 $fieldName = 'state_province_id';
1299 if (empty($props['country_id']) && $context !== 'validate') {
1300 $config = CRM_Core_Config
::singleton();
1301 if (!empty($config->provinceLimit
)) {
1302 $props['country_id'] = $config->provinceLimit
;
1305 $props['country_id'] = $config->defaultContactCountry
;
1308 if (!empty($props['country_id'])) {
1309 if (!CRM_Utils_Rule
::commaSeparatedIntegers(implode(',', (array) $props['country_id']))) {
1310 throw new CRM_Core_Exception(ts('Province limit or default country setting is incorrect'));
1312 $params['condition'] = 'country_id IN (' . implode(',', (array) $props['country_id']) . ')';
1316 // Filter country list based on site defaults
1319 // change $fieldName to DB specific names.
1320 $fieldName = 'country_id';
1321 if ($context != 'get' && $context != 'validate') {
1322 $config = CRM_Core_Config
::singleton();
1323 if (!empty($config->countryLimit
) && is_array($config->countryLimit
)) {
1324 if (!CRM_Utils_Rule
::commaSeparatedIntegers(implode(',', $config->countryLimit
))) {
1325 throw new CRM_Core_Exception(ts('Available Country setting is incorrect'));
1327 $params['condition'] = 'id IN (' . implode(',', $config->countryLimit
) . ')';
1332 // Filter county list based on chosen state
1334 if (!empty($props['state_province_id'])) {
1335 if (!CRM_Utils_Rule
::commaSeparatedIntegers(implode(',', (array) $props['state_province_id']))) {
1336 throw new CRM_Core_Exception(ts('Can only accept Integers for state_province_id filtering'));
1338 $params['condition'] = 'state_province_id IN (' . implode(',', (array) $props['state_province_id']) . ')';
1342 // Not a real field in this entity
1343 case 'world_region':
1345 case 'worldregion_id':
1346 return CRM_Core_BAO_Country
::buildOptions('region_id', $context, $props);
1348 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);
1352 * Add data from the configured geocoding provider.
1354 * Generally this means latitude & longitude data.
1356 * @param array $params
1358 * TRUE if params could be passed to a provider, else FALSE.
1360 public static function addGeocoderData(&$params) {
1362 $provider = CRM_Utils_GeocodeProvider
::getConfiguredProvider();
1364 catch (CRM_Core_Exception
$e) {
1367 $provider::format($params);