3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
37 * This is class to handle address related functions
39 class CRM_Core_BAO_Address
extends CRM_Core_DAO_Address
{
42 * Takes an associative array and creates a address.
44 * @param array $params
45 * (reference ) an assoc array of name/value pairs.
46 * @param bool $fixAddress
47 * True if you need to fix (format) address values.
48 * before inserting in db
53 * array of created address
55 public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
56 if (!isset($params['address']) ||
!is_array($params['address'])) {
59 CRM_Core_BAO_Block
::sortPrimaryFirst($params['address']);
63 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
65 $contactId = $params['contact_id'];
66 //get all the addresses for this contact
67 $addresses = self
::allAddress($contactId, $updateBlankLocInfo);
70 // get all address from location block
71 $entityElements = array(
72 'entity_table' => $params['entity_table'],
73 'entity_id' => $params['entity_id'],
75 $addresses = self
::allEntityAddress($entityElements);
78 $isPrimary = $isBilling = TRUE;
80 foreach ($params['address'] as $key => $value) {
81 if (!is_array($value)) {
85 $addressExists = self
::dataExists($value);
86 if (empty($value['id'])) {
87 if ($updateBlankLocInfo) {
88 if ((!empty($addresses) ||
!$addressExists) && array_key_exists($key, $addresses)) {
89 $value['id'] = $addresses[$key];
93 if (!empty($addresses) && array_key_exists(CRM_Utils_Array
::value('location_type_id', $value), $addresses)) {
94 $value['id'] = $addresses[CRM_Utils_Array
::value('location_type_id', $value)];
99 // Note there could be cases when address info already exist ($value[id] is set) for a contact/entity
100 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
101 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
102 if (isset($value['id']) && !$addressExists && $updateBlankLocInfo) {
103 //delete the existing record
104 CRM_Core_BAO_Block
::blockDelete('Address', array('id' => $value['id']));
107 elseif (!$addressExists) {
111 if ($isPrimary && !empty($value['is_primary'])) {
115 $value['is_primary'] = 0;
118 if ($isBilling && !empty($value['is_billing'])) {
122 $value['is_billing'] = 0;
125 if (empty($value['manual_geo_code'])) {
126 $value['manual_geo_code'] = 0;
128 $value['contact_id'] = $contactId;
129 $blocks[] = self
::add($value, $fixAddress);
136 * Takes an associative array and adds address.
138 * @param array $params
139 * (reference ) an assoc array of name/value pairs.
140 * @param bool $fixAddress
141 * True if you need to fix (format) address values.
142 * before inserting in db
144 * @return CRM_Core_BAO_Address|null
146 public static function add(&$params, $fixAddress) {
147 static $customFields = NULL;
148 $address = new CRM_Core_DAO_Address();
150 // fixAddress mode to be done
152 CRM_Core_BAO_Address
::fixAddress($params);
155 $hook = empty($params['id']) ?
'create' : 'edit';
156 CRM_Utils_Hook
::pre($hook, 'Address', CRM_Utils_Array
::value('id', $params), $params);
158 // if id is set & is_primary isn't we can assume no change
159 if (is_numeric(CRM_Utils_Array
::value('is_primary', $params)) ||
empty($params['id'])) {
160 CRM_Core_BAO_Block
::handlePrimary($params, get_class());
162 $config = CRM_Core_Config
::singleton();
163 $address->copyValues($params);
168 if (!$customFields) {
169 $customFields = CRM_Core_BAO_CustomField
::getFields('Address', FALSE, TRUE);
171 if (!empty($customFields)) {
172 $addressCustom = CRM_Core_BAO_CustomField
::postProcess($params,
178 if (!empty($addressCustom)) {
179 CRM_Core_BAO_CustomValueTable
::store($addressCustom, 'civicrm_address', $address->id
);
182 //call the function to sync shared address
183 self
::processSharedAddress($address->id
, $params);
185 // call the function to create shared relationships
186 // we only create create relationship if address is shared by Individual
187 if (!CRM_Utils_System
::isNull($address->master_id
)) {
188 self
::processSharedAddressRelationship($address->master_id
, $params);
191 // lets call the post hook only after we've done all the follow on processing
192 CRM_Utils_Hook
::post($hook, 'Address', $address->id
, $address);
199 * Format the address params to have reasonable values.
201 * @param array $params
202 * (reference ) an assoc array of name/value pairs.
206 public static function fixAddress(&$params) {
207 if (!empty($params['billing_street_address'])) {
208 //Check address is coming from online contribution / registration page
211 'street_address' => 'billing_street_address',
212 'city' => 'billing_city',
213 'postal_code' => 'billing_postal_code',
214 'state_province' => 'billing_state_province',
215 'state_province_id' => 'billing_state_province_id',
216 'country' => 'billing_country',
217 'country_id' => 'billing_country_id',
220 foreach ($billing as $key => $val) {
221 if ($value = CRM_Utils_Array
::value($val, $params)) {
222 if (!empty($params[$key])) {
223 unset($params[$val]);
226 //add new key and removed old
227 $params[$key] = $value;
228 unset($params[$val]);
234 /* Split the zip and +4, if it's in US format */
235 if (!empty($params['postal_code']) &&
236 preg_match('/^(\d{4,5})[+-](\d{4})$/',
237 $params['postal_code'],
241 $params['postal_code'] = $match[1];
242 $params['postal_code_suffix'] = $match[2];
245 // add country id if not set
246 if ((!isset($params['country_id']) ||
!is_numeric($params['country_id'])) &&
247 isset($params['country'])
249 $country = new CRM_Core_DAO_Country();
250 $country->name
= $params['country'];
251 if (!$country->find(TRUE)) {
252 $country->name
= NULL;
253 $country->iso_code
= $params['country'];
254 $country->find(TRUE);
256 $params['country_id'] = $country->id
;
259 // add state_id if state is set
260 if ((!isset($params['state_province_id']) ||
!is_numeric($params['state_province_id']))
261 && isset($params['state_province'])
263 if (!empty($params['state_province'])) {
264 $state_province = new CRM_Core_DAO_StateProvince();
265 $state_province->name
= $params['state_province'];
267 // add country id if present
268 if (!empty($params['country_id'])) {
269 $state_province->country_id
= $params['country_id'];
272 if (!$state_province->find(TRUE)) {
273 unset($state_province->name
);
274 $state_province->abbreviation
= $params['state_province'];
275 $state_province->find(TRUE);
277 $params['state_province_id'] = $state_province->id
;
278 if (empty($params['country_id'])) {
279 // set this here since we have it
280 $params['country_id'] = $state_province->country_id
;
284 $params['state_province_id'] = 'null';
288 // add county id if county is set
290 if ((!isset($params['county_id']) ||
!is_numeric($params['county_id']))
291 && isset($params['county']) && !empty($params['county'])
293 $county = new CRM_Core_DAO_County();
294 $county->name
= $params['county'];
296 if (isset($params['state_province_id'])) {
297 $county->state_province_id
= $params['state_province_id'];
300 if ($county->find(TRUE)) {
301 $params['county_id'] = $county->id
;
305 // currently copy values populates empty fields with the string "null"
306 // and hence need to check for the string null
307 if (isset($params['state_province_id']) &&
308 is_numeric($params['state_province_id']) &&
309 (!isset($params['country_id']) ||
empty($params['country_id']))
311 // since state id present and country id not present, hence lets populate it
312 // jira issue http://issues.civicrm.org/jira/browse/CRM-56
313 $params['country_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince',
314 $params['state_province_id'],
319 //special check to ignore non numeric values if they are not
320 //detected by formRule(sometimes happens due to internet latency), also allow user to unselect state/country
321 if (isset($params['state_province_id'])) {
322 if (empty($params['state_province_id'])) {
323 $params['state_province_id'] = 'null';
325 elseif (!is_numeric($params['state_province_id']) ||
326 ((int ) $params['state_province_id'] < 1000)
328 // CRM-3393 ( the hacky 1000 check)
329 $params['state_province_id'] = 'null';
333 if (isset($params['country_id'])) {
334 if (empty($params['country_id'])) {
335 $params['country_id'] = 'null';
337 elseif (!is_numeric($params['country_id']) ||
338 ((int ) $params['country_id'] < 1000)
340 // CRM-3393 ( the hacky 1000 check)
341 $params['country_id'] = 'null';
345 // add state and country names from the ids
346 if (isset($params['state_province_id']) && is_numeric($params['state_province_id'])) {
347 $params['state_province'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params['state_province_id']);
350 if (isset($params['country_id']) && is_numeric($params['country_id'])) {
351 $params['country'] = CRM_Core_PseudoConstant
::country($params['country_id']);
354 $config = CRM_Core_Config
::singleton();
356 $asp = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::ADDRESS_STANDARDIZATION_PREFERENCES_NAME
,
357 'address_standardization_provider'
359 // clean up the address via USPS web services if enabled
360 if ($asp === 'USPS' &&
361 $params['country_id'] == 1228
363 CRM_Utils_Address_USPS
::checkAddress($params);
365 // do street parsing again if enabled, since street address might have changed
366 $parseStreetAddress = CRM_Utils_Array
::value(
367 'street_address_parsing',
368 CRM_Core_BAO_Setting
::valueOptions(
369 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
375 if ($parseStreetAddress && !empty($params['street_address'])) {
380 'street_number_suffix',
382 unset($params[$fld]);
384 // main parse string.
385 $parseString = CRM_Utils_Array
::value('street_address', $params);
386 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
388 // merge parse address in to main address block.
389 $params = array_merge($params, $parsedFields);
393 // add latitude and longitude and format address if needed
394 if (!empty($config->geocodeMethod
) && ($config->geocodeMethod
!= 'CRM_Utils_Geocode_OpenStreetMaps') && empty($params['manual_geo_code'])) {
395 $class = $config->geocodeMethod
;
396 $class::format($params);
401 * Check if there is data to create the object.
403 * @param array $params
404 * (reference ) an assoc array of name/value pairs.
408 public static function dataExists(&$params) {
409 //check if location type is set if not return false
410 if (!isset($params['location_type_id'])) {
414 $config = CRM_Core_Config
::singleton();
415 foreach ($params as $name => $value) {
416 if (in_array($name, array(
427 elseif (!CRM_Utils_System
::isNull($value)) {
428 // name could be country or country id
429 if (substr($name, 0, 7) == 'country') {
430 // make sure its different from the default country
432 $defaultCountry = $config->defaultContactCountry();
434 $defaultCountryName = $config->defaultContactCountryName();
436 if ($defaultCountry) {
437 if ($value == $defaultCountry ||
438 $value == $defaultCountryName ||
439 $value == $config->defaultContactCountry
448 // return if null default
462 * Given the list of params in the params array, fetch the object
463 * and store the values in the values array
465 * @param array $entityBlock
466 * Associated array of fields.
467 * @param bool $microformat
468 * If microformat output is required.
469 * @param int|string $fieldName conditional field name
472 * array with address fields
474 public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
475 if (empty($entityBlock)) {
478 $addresses = array();
479 $address = new CRM_Core_BAO_Address();
481 if (empty($entityBlock['entity_table'])) {
482 $address->$fieldName = CRM_Utils_Array
::value($fieldName, $entityBlock);
485 $addressIds = array();
486 $addressIds = self
::allEntityAddress($entityBlock);
488 if (!empty($addressIds[1])) {
489 $address->id
= $addressIds[1];
495 //get primary address as a first block.
496 $address->orderBy('is_primary desc, id');
500 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
502 while ($address->fetch()) {
503 // deprecate reference.
511 if (isset($address->$fld)) {
512 unset($address->$fld);
516 $stree = $address->street_address
;
518 CRM_Core_DAO
::storeValues($address, $values);
520 // add state and country information: CRM-369
521 if (!empty($address->location_type_id
)) {
522 $values['location_type'] = CRM_Utils_Array
::value($address->location_type_id
, $locationTypes);
524 if (!empty($address->state_province_id
)) {
525 $address->state
= CRM_Core_PseudoConstant
::stateProvinceAbbreviation($address->state_province_id
, FALSE);
526 $address->state_name
= CRM_Core_PseudoConstant
::stateProvince($address->state_province_id
, FALSE);
529 if (!empty($address->country_id
)) {
530 $address->country
= CRM_Core_PseudoConstant
::country($address->country_id
);
533 $regionId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Country', $address->country_id
, 'region_id');
535 $address->world_region
= CRM_Core_PseudoConstant
::worldregion($regionId);
538 $address->addDisplay($microformat);
540 $values['display'] = $address->display
;
541 $values['display_text'] = $address->display_text
;
543 if (is_numeric($address->master_id
)) {
544 $values['use_shared_address'] = 1;
547 $addresses[$count] = $values;
549 //unset is_primary after first block. Due to some bug in earlier version
550 //there might be more than one primary blocks, hence unset is_primary other than first
552 unset($addresses[$count]['is_primary']);
562 * Add the formatted address to $this-> display
564 * @param bool $microformat
568 public function addDisplay($microformat = FALSE) {
570 // added this for CRM 1200
571 'address_id' => $this->id
,
573 'address_name' => str_replace('\ 1', ' ', $this->name
),
574 'street_address' => $this->street_address
,
575 'supplemental_address_1' => $this->supplemental_address_1
,
576 'supplemental_address_2' => $this->supplemental_address_2
,
577 'city' => $this->city
,
578 'state_province_name' => isset($this->state_name
) ?
$this->state_name
: "",
579 'state_province' => isset($this->state
) ?
$this->state
: "",
580 'postal_code' => isset($this->postal_code
) ?
$this->postal_code
: "",
581 'postal_code_suffix' => isset($this->postal_code_suffix
) ?
$this->postal_code_suffix
: "",
582 'country' => isset($this->country
) ?
$this->country
: "",
583 'world_region' => isset($this->world_region
) ?
$this->world_region
: "",
586 if (isset($this->county_id
) && $this->county_id
) {
587 $fields['county'] = CRM_Core_PseudoConstant
::county($this->county_id
);
590 $fields['county'] = NULL;
593 $this->display
= CRM_Utils_Address
::format($fields, NULL, $microformat);
594 $this->display_text
= CRM_Utils_Address
::format($fields);
598 * Get all the addresses for a specified contact_id, with the primary address being first
603 * @param bool $updateBlankLocInfo
606 * the array of adrress data
608 public static function allAddress($id, $updateBlankLocInfo = FALSE) {
614 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
615 FROM civicrm_contact, civicrm_address
616 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
617 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
618 $params = array(1 => array($id, 'Integer'));
620 $addresses = array();
621 $dao = CRM_Core_DAO
::executeQuery($query, $params);
623 while ($dao->fetch()) {
624 if ($updateBlankLocInfo) {
625 $addresses[$count++
] = $dao->address_id
;
628 $addresses[$dao->location_type_id
] = $dao->address_id
;
635 * Get all the addresses for a specified location_block id, with the primary address being first
637 * @param array $entityElements
638 * The array containing entity_id and.
642 * the array of adrress data
644 public static function allEntityAddress(&$entityElements) {
645 $addresses = array();
646 if (empty($entityElements)) {
650 $entityId = $entityElements['entity_id'];
651 $entityTable = $entityElements['entity_table'];
654 SELECT civicrm_address.id as address_id
655 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
657 AND loc.id = ev.loc_block_id
658 AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
659 AND ltype.id = civicrm_address.location_type_id
660 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
662 $params = array(1 => array($entityId, 'Integer'));
663 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
665 while ($dao->fetch()) {
666 $addresses[$locationCount] = $dao->address_id
;
673 * Get address sequence.
676 * Array of address sequence.
678 public static function addressSequence() {
679 $config = CRM_Core_Config
::singleton();
680 $addressSequence = $config->addressSequence();
682 $countryState = $cityPostal = FALSE;
683 foreach ($addressSequence as $key => $field) {
685 in_array($field, array('country', 'state_province')) &&
688 $countryState = TRUE;
689 $addressSequence[$key] = 'country_state_province';
692 in_array($field, array('city', 'postal_code')) &&
696 $addressSequence[$key] = 'city_postal_code';
699 in_array($field, array('country', 'state_province', 'city', 'postal_code'))
701 unset($addressSequence[$key]);
705 return $addressSequence;
709 * Parse given street address string in to street_name,
710 * street_unit, street_number and street_number_suffix
711 * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
713 * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
714 * otherwise en_US format is default action
716 * @param string $streetAddress
717 * Street address including number and apt.
718 * @param string $locale
719 * Locale used to parse address.
722 * parsed fields values.
724 public static function parseStreetAddress($streetAddress, $locale = NULL) {
725 $config = CRM_Core_Config
::singleton();
727 /* locales supported include:
728 * en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
729 * en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
730 * fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
731 * NB: common use of comma after street number also supported
735 $supportedLocalesForParsing = array('en_US', 'en_CA', 'fr_CA');
737 $locale = $config->lcMessages
;
739 // as different locale explicitly requested but is not available, display warning message and set $locale = 'en_US'
740 if (!in_array($locale, $supportedLocalesForParsing)) {
741 CRM_Core_Session
::setStatus(ts('Unsupported locale specified to parseStreetAddress: %1. Proceeding with en_US locale.', array(1 => $locale)), ts('Unsupported Locale'), 'alert');
744 $emptyParseFields = $parseFields = array(
747 'street_number' => '',
748 'street_number_suffix' => '',
751 if (empty($streetAddress)) {
755 $streetAddress = trim($streetAddress);
758 if (in_array($locale, array(
761 )) && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)
763 $parseFields['street_unit'] = $matches[1];
764 // unset from rest of street address
765 $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
768 // get street number and suffix.
770 //alter street number/suffix handling so that we accept -digit
771 if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
772 // check that $matches[0] is numeric, else assume no street number
773 if (preg_match('/^(\d+)/', $matches[0])) {
774 $streetNumAndSuffix = $matches[0];
776 // get street number.
778 if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
779 $parseFields['street_number'] = $matches[0];
780 $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
781 $parseFields['street_number_suffix'] = trim($suffix);
784 // unset from main street address.
785 $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
786 $streetAddress = trim($streetAddress);
789 elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
790 $parseFields['street_number'] = $matches[0];
791 // unset from main street address.
792 $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
793 $streetAddress = trim($streetAddress);
796 // suffix might be like 1/2
798 if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
799 $parseFields['street_number_suffix'] .= $matches[0];
801 // unset from main street address.
802 $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
803 $streetAddress = trim($streetAddress);
806 // now get the street unit.
807 // supportable street unit formats.
808 $streetUnitFormats = array(
851 // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
852 if (in_array($locale, array(
856 $streetUnitFormats = array('APT', 'APP', 'SUITE', 'BUREAU', 'UNIT');
858 //@todo per CRM-14459 this regex picks up words with the string in them - e.g APT picks up
859 //Captain - presuming fixing regex (& adding test) to ensure a-z does not preced string will fix
860 $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
862 if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
863 $parseFields['street_unit'] = trim($matches[0]);
864 $streetAddress = str_replace($matches[0], '', $streetAddress);
865 $streetAddress = trim($streetAddress);
868 // consider remaining string as street name.
869 $parseFields['street_name'] = $streetAddress;
871 //run parsed fields through stripSpaces to clean
872 foreach ($parseFields as $parseField => $value) {
873 $parseFields[$parseField] = CRM_Utils_String
::stripSpaces($value);
875 //CRM-14459 if the field is too long we should assume it didn't get it right & skip rather than allow
877 $fields = CRM_Core_BAO_Address
::fields();
878 foreach ($fields as $fieldname => $field) {
879 if (!empty($field['maxlength']) && strlen(CRM_Utils_Array
::value($fieldname, $parseFields)) > $field['maxlength']) {
880 return $emptyParseFields;
888 * Validate the address fields based on the address options enabled.
889 * in the Address Settings
891 * @param array $fields
892 * An array of importable/exportable contact fields.
895 * an array of contact fields and only the enabled address options
897 public static function validateAddressOptions($fields) {
898 static $addressOptions = NULL;
899 if (!$addressOptions) {
900 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(
901 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
906 if (is_array($fields) && !empty($fields)) {
907 foreach ($addressOptions as $key => $value) {
908 if (!$value && isset($fields[$key])) {
909 unset($fields[$key]);
917 * Check if current address is used by any other contacts.
919 * @param int $addressId
923 * count of contacts that use this shared address
925 public static function checkContactSharedAddress($addressId) {
926 $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
927 return CRM_Core_DAO
::singleValueQuery($query, array(1 => array($addressId, 'Integer')));
931 * Check if current address fields are shared with any other address.
933 * @param array $fields
934 * Address fields in profile.
935 * @param int $contactId
939 public static function checkContactSharedAddressFields(&$fields, $contactId) {
940 if (!$contactId ||
!is_array($fields) ||
empty($fields)) {
944 $sharedLocations = array();
950 WHERE contact_id = %1
951 AND master_id IS NOT NULL";
953 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Positive')));
954 while ($dao->fetch()) {
955 $sharedLocations[$dao->location_type_id
] = $dao->location_type_id
;
956 if ($dao->is_primary
) {
957 $sharedLocations['Primary'] = 'Primary';
961 //no need to process further.
962 if (empty($sharedLocations)) {
966 $addressFields = array(
976 'postal_code_suffix',
977 'supplemental_address_1',
978 'supplemental_address_2',
981 foreach ($fields as $name => & $values) {
982 if (!is_array($values) ||
empty($values)) {
986 $nameVal = explode('-', $values['name']);
987 $fldName = CRM_Utils_Array
::value(0, $nameVal);
988 $locType = CRM_Utils_Array
::value(1, $nameVal);
989 if (!empty($values['location_type_id'])) {
990 $locType = $values['location_type_id'];
993 if (in_array($fldName, $addressFields) &&
994 in_array($locType, $sharedLocations)
996 $values['is_shared'] = TRUE;
1002 * Update the shared addresses if master address is modified.
1004 * @param int $addressId
1006 * @param array $params
1007 * Associated array of address params.
1011 public static function processSharedAddress($addressId, $params) {
1012 $query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
1013 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($addressId, 'Integer')));
1016 $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id', 'contact_id');
1017 foreach ($skipFields as $value) {
1018 unset($params[$value]);
1021 $addressDAO = new CRM_Core_DAO_Address();
1022 while ($dao->fetch()) {
1023 $addressDAO->copyValues($params);
1024 $addressDAO->id
= $dao->id
;
1025 $addressDAO->save();
1026 $addressDAO->free();
1031 * Merge contacts with the Same address to get one shared label.
1032 * @param array $rows
1033 * Array[contact_id][contactDetails].
1035 public static function mergeSameAddress(&$rows) {
1036 $uniqueAddress = array();
1037 foreach (array_keys($rows) as $rowID) {
1038 // load complete address as array key
1039 $address = trim($rows[$rowID]['street_address'])
1040 . trim($rows[$rowID]['city'])
1041 . trim($rows[$rowID]['state_province'])
1042 . trim($rows[$rowID]['postal_code'])
1043 . trim($rows[$rowID]['country']);
1044 if (isset($rows[$rowID]['last_name'])) {
1045 $name = $rows[$rowID]['last_name'];
1048 $name = $rows[$rowID]['display_name'];
1053 'first_name' => $rows[$rowID]['first_name'],
1054 'individual_prefix' => $rows[$rowID]['individual_prefix'],
1056 $format = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
, 'display_name_format');
1057 $firstNameWithPrefix = CRM_Utils_Address
::format($formatted, $format, FALSE, FALSE, TRUE);
1058 $firstNameWithPrefix = trim($firstNameWithPrefix);
1060 // fill uniqueAddress array with last/first name tree
1061 if (isset($uniqueAddress[$address])) {
1062 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1063 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1064 // drop unnecessary rows
1065 unset($rows[$rowID]);
1066 // this is the first listing at this address
1069 $uniqueAddress[$address]['ID'] = $rowID;
1070 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1071 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1074 foreach ($uniqueAddress as $address => $data) {
1075 // copy data back to $rows
1077 // one last name list per row
1078 foreach ($data['names'] as $last_name => $first_names) {
1083 if (count($first_names) == 1) {
1084 $family = $first_names[current(array_keys($first_names))]['addressee_display'];
1087 // collapse the tree to summarize
1088 $family = trim(implode(" & ", array_keys($first_names)) . " " . $last_name);
1091 $processedNames .= "\n" . $family;
1094 // build display_name string
1095 $processedNames = $family;
1099 $rows[$data['ID']]['addressee'] = $rows[$data['ID']]['addressee_display'] = $rows[$data['ID']]['display_name'] = $processedNames;
1104 * Create relationship between contacts who share an address.
1106 * Note that currently we create relationship only for Individual contacts
1107 * Individual + Household and Individual + Orgnization
1109 * @param int $masterAddressId
1110 * Master address id.
1111 * @param array $params
1112 * Associated array of submitted values.
1116 public static function processSharedAddressRelationship($masterAddressId, $params) {
1117 // get the contact type of contact being edited / created
1118 $currentContactType = CRM_Contact_BAO_Contact
::getContactType($params['contact_id']);
1119 $currentContactId = $params['contact_id'];
1121 // if current contact is not of type individual return
1122 if ($currentContactType != 'Individual') {
1126 // get the contact id and contact type of shared contact
1127 // check the contact type of shared contact, return if it is of type Individual
1128 $query = 'SELECT cc.id, cc.contact_type
1129 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1132 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($masterAddressId, 'Integer')));
1135 // if current contact is not of type individual return, since we don't create relationship between
1137 if ($dao->contact_type
== 'Individual') {
1140 $sharedContactType = $dao->contact_type
;
1141 $sharedContactId = $dao->id
;
1143 // create relationship between ontacts who share an address
1144 if ($sharedContactType == 'Organization') {
1145 return CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1148 // get the relationship type id of "Household Member of"
1149 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Household Member of', 'id', 'name_a_b');
1152 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Household Member of'"));
1156 'is_active' => TRUE,
1157 'relationship_type_id' => $relTypeId,
1158 'contact_id_a' => $currentContactId,
1159 'contact_id_b' => $sharedContactId,
1162 // If already there is a relationship record of $relParam criteria, avoid creating relationship again or else
1163 // it will casue CRM-16588 as the Duplicate Relationship Exception will revert other contact field values on update
1164 if (CRM_Contact_BAO_Relationship
::checkDuplicateRelationship($relParam, $currentContactId, $sharedContactId)) {
1169 // create relationship
1170 civicrm_api3('relationship', 'create', $relParam);
1172 catch (CiviCRM_API3_Exception
$e) {
1173 // We catch and ignore here because this has historically been a best-effort relationship create call.
1174 // presumably it could refuse due to duplication or similar and we would ignore that.
1179 * Check and set the status for shared address delete.
1181 * @param int $addressId
1183 * @param int $contactId
1185 * @param bool $returnStatus
1190 public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1191 // check if address that is being deleted has any shared
1193 $entityId = $addressId;
1194 $query = 'SELECT cc.id, cc.display_name
1195 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1196 WHERE ca.master_id = %1';
1199 $entityId = $contactId;
1200 $query = 'SELECT cc.id, cc.display_name
1201 FROM civicrm_address ca1
1202 INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1203 INNER JOIN civicrm_contact cc ON ca2.contact_id = cc.id
1204 WHERE ca1.contact_id = %1';
1207 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($entityId, 'Integer')));
1209 $deleteStatus = array();
1210 $sharedContactList = array();
1211 $statusMessage = NULL;
1213 while ($dao->fetch()) {
1214 if (empty($deleteStatus)) {
1215 $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.');
1218 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1219 $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1220 $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1225 if (!empty($deleteStatus)) {
1226 $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1229 if (!$returnStatus) {
1230 CRM_Core_Session
::setStatus($statusMessage, '', 'info');
1234 'contactList' => $sharedContactList,
1235 'count' => $addressCount,
1241 * Call common delete function.
1243 public static function del($id) {
1244 return CRM_Contact_BAO_Contact
::deleteObjectWithPrimary('Address', $id);
1248 * Get options for a given address field.
1249 * @see CRM_Core_DAO::buildOptions
1251 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
1252 * TODO: In context of chainselect, what to return if e.g. a country has no states?
1254 * @param string $fieldName
1255 * @param string $context
1256 * @see CRM_Core_DAO::buildOptionsContext
1257 * @param array $props
1258 * whatever is known about this dao object.
1260 * @return array|bool
1262 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
1264 // Special logic for fields whose options depend on context or properties
1265 switch ($fieldName) {
1266 // Filter state_province list based on chosen country or site defaults
1267 case 'state_province_id':
1268 if (empty($props['country_id'])) {
1269 $config = CRM_Core_Config
::singleton();
1270 if (!empty($config->provinceLimit
)) {
1271 $props['country_id'] = $config->provinceLimit
;
1274 $props['country_id'] = $config->defaultContactCountry
;
1277 if (!empty($props['country_id']) && $context !== 'validate') {
1278 $params['condition'] = 'country_id IN (' . implode(',', (array) $props['country_id']) . ')';
1282 // Filter country list based on site defaults
1284 if ($context != 'get' && $context != 'validate') {
1285 $config = CRM_Core_Config
::singleton();
1286 if (!empty($config->countryLimit
) && is_array($config->countryLimit
)) {
1287 $params['condition'] = 'id IN (' . implode(',', $config->countryLimit
) . ')';
1292 // Filter county list based on chosen state
1294 if (!empty($props['state_province_id'])) {
1295 $params['condition'] = 'state_province_id IN (' . implode(',', (array) $props['state_province_id']) . ')';
1299 // Not a real field in this entity
1300 case 'world_region':
1301 return CRM_Core_PseudoConstant
::worldRegion();
1303 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);