3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
35 * This is class to handle address related functions.
37 class CRM_Core_BAO_Address
extends CRM_Core_DAO_Address
{
40 * Takes an associative array and creates a address.
42 * @param array $params
43 * (reference ) an assoc array of name/value pairs.
44 * @param bool $fixAddress
45 * True if you need to fix (format) address values.
46 * before inserting in db
51 * array of created address
53 public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
54 if (!isset($params['address']) ||
!is_array($params['address'])) {
57 CRM_Core_BAO_Block
::sortPrimaryFirst($params['address']);
61 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
63 $contactId = $params['contact_id'];
64 //get all the addresses for this contact
65 $addresses = self
::allAddress($contactId);
68 // get all address from location block
69 $entityElements = array(
70 'entity_table' => $params['entity_table'],
71 'entity_id' => $params['entity_id'],
73 $addresses = self
::allEntityAddress($entityElements);
76 $isPrimary = $isBilling = TRUE;
78 foreach ($params['address'] as $key => $value) {
79 if (!is_array($value)) {
83 $addressExists = self
::dataExists($value);
84 if (empty($value['id'])) {
85 if (!empty($addresses) && array_key_exists(CRM_Utils_Array
::value('location_type_id', $value), $addresses)) {
86 $value['id'] = $addresses[CRM_Utils_Array
::value('location_type_id', $value)];
90 // Note there could be cases when address info already exist ($value[id] is set) for a contact/entity
91 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
92 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
93 if (isset($value['id']) && !$addressExists && $updateBlankLocInfo) {
94 //delete the existing record
95 CRM_Core_BAO_Block
::blockDelete('Address', array('id' => $value['id']));
98 elseif (!$addressExists) {
102 if ($isPrimary && !empty($value['is_primary'])) {
106 $value['is_primary'] = 0;
109 if ($isBilling && !empty($value['is_billing'])) {
113 $value['is_billing'] = 0;
116 if (empty($value['manual_geo_code'])) {
117 $value['manual_geo_code'] = 0;
119 $value['contact_id'] = $contactId;
120 $blocks[] = self
::add($value, $fixAddress);
127 * Takes an associative array and adds address.
129 * @param array $params
130 * (reference ) an assoc array of name/value pairs.
131 * @param bool $fixAddress
132 * True if you need to fix (format) address values.
133 * before inserting in db
135 * @return CRM_Core_BAO_Address|null
137 public static function add(&$params, $fixAddress) {
139 $address = new CRM_Core_DAO_Address();
140 $checkPermissions = isset($params['check_permissions']) ?
$params['check_permissions'] : TRUE;
142 // fixAddress mode to be done
144 CRM_Core_BAO_Address
::fixAddress($params);
147 $hook = empty($params['id']) ?
'create' : 'edit';
148 CRM_Utils_Hook
::pre($hook, 'Address', CRM_Utils_Array
::value('id', $params), $params);
150 // if id is set & is_primary isn't we can assume no change
151 if (is_numeric(CRM_Utils_Array
::value('is_primary', $params)) ||
empty($params['id'])) {
152 CRM_Core_BAO_Block
::handlePrimary($params, get_class());
155 $address->copyValues($params);
160 $customFields = CRM_Core_BAO_CustomField
::getFields('Address', FALSE, TRUE, NULL, NULL, FALSE, FALSE, $checkPermissions);
162 if (!empty($customFields)) {
163 $addressCustom = CRM_Core_BAO_CustomField
::postProcess($params,
170 if (!empty($addressCustom)) {
171 CRM_Core_BAO_CustomValueTable
::store($addressCustom, 'civicrm_address', $address->id
);
174 //call the function to sync shared address
175 self
::processSharedAddress($address->id
, $params);
177 // call the function to create shared relationships
178 // we only create create relationship if address is shared by Individual
179 if (!CRM_Utils_System
::isNull($address->master_id
)) {
180 self
::processSharedAddressRelationship($address->master_id
, $params);
183 // lets call the post hook only after we've done all the follow on processing
184 CRM_Utils_Hook
::post($hook, 'Address', $address->id
, $address);
191 * Format the address params to have reasonable values.
193 * @param array $params
194 * (reference ) an assoc array of name/value pairs.
196 public static function fixAddress(&$params) {
197 if (!empty($params['billing_street_address'])) {
198 //Check address is coming from online contribution / registration page
201 'street_address' => 'billing_street_address',
202 'city' => 'billing_city',
203 'postal_code' => 'billing_postal_code',
204 'state_province' => 'billing_state_province',
205 'state_province_id' => 'billing_state_province_id',
206 'country' => 'billing_country',
207 'country_id' => 'billing_country_id',
210 foreach ($billing as $key => $val) {
211 if ($value = CRM_Utils_Array
::value($val, $params)) {
212 if (!empty($params[$key])) {
213 unset($params[$val]);
216 //add new key and removed old
217 $params[$key] = $value;
218 unset($params[$val]);
224 /* Split the zip and +4, if it's in US format */
225 if (!empty($params['postal_code']) &&
226 preg_match('/^(\d{4,5})[+-](\d{4})$/',
227 $params['postal_code'],
231 $params['postal_code'] = $match[1];
232 $params['postal_code_suffix'] = $match[2];
235 // add country id if not set
236 if ((!isset($params['country_id']) ||
!is_numeric($params['country_id'])) &&
237 isset($params['country'])
239 $country = new CRM_Core_DAO_Country();
240 $country->name
= $params['country'];
241 if (!$country->find(TRUE)) {
242 $country->name
= NULL;
243 $country->iso_code
= $params['country'];
244 $country->find(TRUE);
246 $params['country_id'] = $country->id
;
249 // add state_id if state is set
250 if ((!isset($params['state_province_id']) ||
!is_numeric($params['state_province_id']))
251 && isset($params['state_province'])
253 if (!empty($params['state_province'])) {
254 $state_province = new CRM_Core_DAO_StateProvince();
255 $state_province->name
= $params['state_province'];
257 // add country id if present
258 if (!empty($params['country_id'])) {
259 $state_province->country_id
= $params['country_id'];
262 if (!$state_province->find(TRUE)) {
263 unset($state_province->name
);
264 $state_province->abbreviation
= $params['state_province'];
265 $state_province->find(TRUE);
267 $params['state_province_id'] = $state_province->id
;
268 if (empty($params['country_id'])) {
269 // set this here since we have it
270 $params['country_id'] = $state_province->country_id
;
274 $params['state_province_id'] = 'null';
278 // add county id if county is set
280 if ((!isset($params['county_id']) ||
!is_numeric($params['county_id']))
281 && isset($params['county']) && !empty($params['county'])
283 $county = new CRM_Core_DAO_County();
284 $county->name
= $params['county'];
286 if (isset($params['state_province_id'])) {
287 $county->state_province_id
= $params['state_province_id'];
290 if ($county->find(TRUE)) {
291 $params['county_id'] = $county->id
;
295 // currently copy values populates empty fields with the string "null"
296 // and hence need to check for the string null
297 if (isset($params['state_province_id']) &&
298 is_numeric($params['state_province_id']) &&
299 (!isset($params['country_id']) ||
empty($params['country_id']))
301 // since state id present and country id not present, hence lets populate it
302 // jira issue http://issues.civicrm.org/jira/browse/CRM-56
303 $params['country_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince',
304 $params['state_province_id'],
309 //special check to ignore non numeric values if they are not
310 //detected by formRule(sometimes happens due to internet latency), also allow user to unselect state/country
311 if (isset($params['state_province_id'])) {
312 if (empty($params['state_province_id'])) {
313 $params['state_province_id'] = 'null';
315 elseif (!is_numeric($params['state_province_id']) ||
316 ((int ) $params['state_province_id'] < 1000)
318 // CRM-3393 ( the hacky 1000 check)
319 $params['state_province_id'] = 'null';
323 if (isset($params['country_id'])) {
324 if (empty($params['country_id'])) {
325 $params['country_id'] = 'null';
327 elseif (!is_numeric($params['country_id']) ||
328 ((int ) $params['country_id'] < 1000)
330 // CRM-3393 ( the hacky 1000 check)
331 $params['country_id'] = 'null';
335 // add state and country names from the ids
336 if (isset($params['state_province_id']) && is_numeric($params['state_province_id'])) {
337 $params['state_province'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params['state_province_id']);
340 if (isset($params['country_id']) && is_numeric($params['country_id'])) {
341 $params['country'] = CRM_Core_PseudoConstant
::country($params['country_id']);
344 $config = CRM_Core_Config
::singleton();
346 $asp = Civi
::settings()->get('address_standardization_provider');
347 // clean up the address via USPS web services if enabled
348 if ($asp === 'USPS' &&
349 $params['country_id'] == 1228
351 CRM_Utils_Address_USPS
::checkAddress($params);
353 // do street parsing again if enabled, since street address might have changed
354 $parseStreetAddress = CRM_Utils_Array
::value(
355 'street_address_parsing',
356 CRM_Core_BAO_Setting
::valueOptions(
357 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
363 if ($parseStreetAddress && !empty($params['street_address'])) {
368 'street_number_suffix',
370 unset($params[$fld]);
372 // main parse string.
373 $parseString = CRM_Utils_Array
::value('street_address', $params);
374 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
376 // merge parse address in to main address block.
377 $params = array_merge($params, $parsedFields);
381 // check if geocode should be skipped (can be forced with an optional parameter through the api)
382 $skip_geocode = (isset($params['skip_geocode']) && $params['skip_geocode']) ?
TRUE : FALSE;
384 // add latitude and longitude and format address if needed
385 if (!$skip_geocode && !empty($config->geocodeMethod
) && ($config->geocodeMethod
!= 'CRM_Utils_Geocode_OpenStreetMaps') && empty($params['manual_geo_code'])) {
386 $class = $config->geocodeMethod
;
387 $class::format($params);
392 * Check if there is data to create the object.
394 * @param array $params
395 * (reference ) an assoc array of name/value pairs.
399 public static function dataExists(&$params) {
400 //check if location type is set if not return false
401 if (!isset($params['location_type_id'])) {
405 $config = CRM_Core_Config
::singleton();
406 foreach ($params as $name => $value) {
407 if (in_array($name, array(
418 elseif (!CRM_Utils_System
::isNull($value)) {
419 // name could be country or country id
420 if (substr($name, 0, 7) == 'country') {
421 // make sure its different from the default country
423 $defaultCountry = $config->defaultContactCountry();
425 $defaultCountryName = $config->defaultContactCountryName();
427 if ($defaultCountry) {
428 if ($value == $defaultCountry ||
429 $value == $defaultCountryName ||
430 $value == $config->defaultContactCountry
439 // return if null default
453 * Given the list of params in the params array, fetch the object
454 * and store the values in the values array
456 * @param array $entityBlock
457 * Associated array of fields.
458 * @param bool $microformat
459 * If microformat output is required.
460 * @param int|string $fieldName conditional field name
463 * array with address fields
465 public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
466 if (empty($entityBlock)) {
469 $addresses = array();
470 $address = new CRM_Core_BAO_Address();
472 if (empty($entityBlock['entity_table'])) {
473 $address->$fieldName = CRM_Utils_Array
::value($fieldName, $entityBlock);
476 $addressIds = array();
477 $addressIds = self
::allEntityAddress($entityBlock);
479 if (!empty($addressIds[1])) {
480 $address->id
= $addressIds[1];
486 if (isset($entityBlock['is_billing']) && $entityBlock['is_billing'] == 1) {
487 $address->orderBy('is_billing desc, id');
490 //get primary address as a first block.
491 $address->orderBy('is_primary desc, id');
496 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
498 while ($address->fetch()) {
499 // deprecate reference.
507 if (isset($address->$fld)) {
508 unset($address->$fld);
512 $stree = $address->street_address
;
514 CRM_Core_DAO
::storeValues($address, $values);
516 // add state and country information: CRM-369
517 if (!empty($address->location_type_id
)) {
518 $values['location_type'] = CRM_Utils_Array
::value($address->location_type_id
, $locationTypes);
520 if (!empty($address->state_province_id
)) {
521 $address->state
= CRM_Core_PseudoConstant
::stateProvinceAbbreviation($address->state_province_id
, FALSE);
522 $address->state_name
= CRM_Core_PseudoConstant
::stateProvince($address->state_province_id
, FALSE);
525 if (!empty($address->country_id
)) {
526 $address->country
= CRM_Core_PseudoConstant
::country($address->country_id
);
529 $regionId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Country', $address->country_id
, 'region_id');
531 $address->world_region
= CRM_Core_PseudoConstant
::worldregion($regionId);
534 $address->addDisplay($microformat);
536 $values['display'] = $address->display
;
537 $values['display_text'] = $address->display_text
;
539 if (is_numeric($address->master_id
)) {
540 $values['use_shared_address'] = 1;
543 $addresses[$count] = $values;
545 //unset is_primary after first block. Due to some bug in earlier version
546 //there might be more than one primary blocks, hence unset is_primary other than first
548 unset($addresses[$count]['is_primary']);
558 * Add the formatted address to $this-> display.
560 * @param bool $microformat
561 * Unexplained parameter that I've always wondered about.
563 public function addDisplay($microformat = FALSE) {
565 // added this for CRM 1200
566 'address_id' => $this->id
,
568 'address_name' => str_replace('\ 1', ' ', $this->name
),
569 'street_address' => $this->street_address
,
570 'supplemental_address_1' => $this->supplemental_address_1
,
571 'supplemental_address_2' => $this->supplemental_address_2
,
572 'supplemental_address_3' => $this->supplemental_address_3
,
573 'city' => $this->city
,
574 'state_province_name' => isset($this->state_name
) ?
$this->state_name
: "",
575 'state_province' => isset($this->state
) ?
$this->state
: "",
576 'postal_code' => isset($this->postal_code
) ?
$this->postal_code
: "",
577 'postal_code_suffix' => isset($this->postal_code_suffix
) ?
$this->postal_code_suffix
: "",
578 'country' => isset($this->country
) ?
$this->country
: "",
579 'world_region' => isset($this->world_region
) ?
$this->world_region
: "",
582 if (isset($this->county_id
) && $this->county_id
) {
583 $fields['county'] = CRM_Core_PseudoConstant
::county($this->county_id
);
586 $fields['county'] = NULL;
589 $this->display
= CRM_Utils_Address
::format($fields, NULL, $microformat);
590 $this->display_text
= CRM_Utils_Address
::format($fields);
594 * Get all the addresses for a specified contact_id, with the primary address being first
599 * @param bool $updateBlankLocInfo
602 * the array of adrress data
604 public static function allAddress($id, $updateBlankLocInfo = FALSE) {
610 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
611 FROM civicrm_contact, civicrm_address
612 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
613 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
614 $params = array(1 => array($id, 'Integer'));
616 $addresses = array();
617 $dao = CRM_Core_DAO
::executeQuery($query, $params);
619 while ($dao->fetch()) {
620 if ($updateBlankLocInfo) {
621 $addresses[$count++
] = $dao->address_id
;
624 $addresses[$dao->location_type_id
] = $dao->address_id
;
631 * Get all the addresses for a specified location_block id, with the primary address being first
633 * @param array $entityElements
634 * The array containing entity_id and.
638 * the array of adrress data
640 public static function allEntityAddress(&$entityElements) {
641 $addresses = array();
642 if (empty($entityElements)) {
646 $entityId = $entityElements['entity_id'];
647 $entityTable = $entityElements['entity_table'];
650 SELECT civicrm_address.id as address_id
651 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
653 AND loc.id = ev.loc_block_id
654 AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
655 AND ltype.id = civicrm_address.location_type_id
656 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
658 $params = array(1 => array($entityId, 'Integer'));
659 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
661 while ($dao->fetch()) {
662 $addresses[$locationCount] = $dao->address_id
;
669 * Get address sequence.
672 * Array of address sequence.
674 public static function addressSequence() {
675 $config = CRM_Core_Config
::singleton();
676 $addressSequence = $config->addressSequence();
678 $countryState = $cityPostal = FALSE;
679 foreach ($addressSequence as $key => $field) {
681 in_array($field, array('country', 'state_province')) &&
684 $countryState = TRUE;
685 $addressSequence[$key] = 'country_state_province';
688 in_array($field, array('city', 'postal_code')) &&
692 $addressSequence[$key] = 'city_postal_code';
695 in_array($field, array('country', 'state_province', 'city', 'postal_code'))
697 unset($addressSequence[$key]);
701 return $addressSequence;
705 * Parse given street address string in to street_name,
706 * street_unit, street_number and street_number_suffix
707 * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
709 * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
710 * otherwise en_US format is default action
712 * @param string $streetAddress
713 * Street address including number and apt.
714 * @param string $locale
715 * Locale used to parse address.
718 * parsed fields values.
720 public static function parseStreetAddress($streetAddress, $locale = NULL) {
721 $config = CRM_Core_Config
::singleton();
723 /* locales supported include:
724 * en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
725 * en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
726 * fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
727 * NB: common use of comma after street number also supported
731 $supportedLocalesForParsing = array('en_US', 'en_CA', 'fr_CA');
733 $locale = $config->lcMessages
;
735 // as different locale explicitly requested but is not available, display warning message and set $locale = 'en_US'
736 if (!in_array($locale, $supportedLocalesForParsing)) {
737 CRM_Core_Session
::setStatus(ts('Unsupported locale specified to parseStreetAddress: %1. Proceeding with en_US locale.', array(1 => $locale)), ts('Unsupported Locale'), 'alert');
740 $emptyParseFields = $parseFields = array(
743 'street_number' => '',
744 'street_number_suffix' => '',
747 if (empty($streetAddress)) {
751 $streetAddress = trim($streetAddress);
754 if (in_array($locale, array(
757 )) && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)
759 $parseFields['street_unit'] = $matches[1];
760 // unset from rest of street address
761 $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
764 // get street number and suffix.
766 //alter street number/suffix handling so that we accept -digit
767 if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
768 // check that $matches[0] is numeric, else assume no street number
769 if (preg_match('/^(\d+)/', $matches[0])) {
770 $streetNumAndSuffix = $matches[0];
772 // get street number.
774 if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
775 $parseFields['street_number'] = $matches[0];
776 $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
777 $parseFields['street_number_suffix'] = trim($suffix);
780 // unset from main street address.
781 $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
782 $streetAddress = trim($streetAddress);
785 elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
786 $parseFields['street_number'] = $matches[0];
787 // unset from main street address.
788 $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
789 $streetAddress = trim($streetAddress);
792 // suffix might be like 1/2
794 if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
795 $parseFields['street_number_suffix'] .= $matches[0];
797 // unset from main street address.
798 $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
799 $streetAddress = trim($streetAddress);
802 // now get the street unit.
803 // supportable street unit formats.
804 $streetUnitFormats = array(
847 // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
848 if (in_array($locale, array(
852 $streetUnitFormats = array('APT', 'APP', 'SUITE', 'BUREAU', 'UNIT');
854 //@todo per CRM-14459 this regex picks up words with the string in them - e.g APT picks up
855 //Captain - presuming fixing regex (& adding test) to ensure a-z does not preced string will fix
856 $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
858 if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
859 $parseFields['street_unit'] = trim($matches[0]);
860 $streetAddress = str_replace($matches[0], '', $streetAddress);
861 $streetAddress = trim($streetAddress);
864 // consider remaining string as street name.
865 $parseFields['street_name'] = $streetAddress;
867 //run parsed fields through stripSpaces to clean
868 foreach ($parseFields as $parseField => $value) {
869 $parseFields[$parseField] = CRM_Utils_String
::stripSpaces($value);
871 //CRM-14459 if the field is too long we should assume it didn't get it right & skip rather than allow
873 $fields = CRM_Core_BAO_Address
::fields();
874 foreach ($fields as $fieldname => $field) {
875 if (!empty($field['maxlength']) && strlen(CRM_Utils_Array
::value($fieldname, $parseFields)) > $field['maxlength']) {
876 return $emptyParseFields;
884 * Validate the address fields based on the address options enabled.
885 * in the Address Settings
887 * @param array $fields
888 * An array of importable/exportable contact fields.
891 * an array of contact fields and only the enabled address options
893 public static function validateAddressOptions($fields) {
894 static $addressOptions = NULL;
895 if (!$addressOptions) {
896 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(
897 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
902 if (is_array($fields) && !empty($fields)) {
903 foreach ($addressOptions as $key => $value) {
904 if (!$value && isset($fields[$key])) {
905 unset($fields[$key]);
913 * Check if current address is used by any other contacts.
915 * @param int $addressId
919 * count of contacts that use this shared address
921 public static function checkContactSharedAddress($addressId) {
922 $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
923 return CRM_Core_DAO
::singleValueQuery($query, array(1 => array($addressId, 'Integer')));
927 * Check if current address fields are shared with any other address.
929 * @param array $fields
930 * Address fields in profile.
931 * @param int $contactId
935 public static function checkContactSharedAddressFields(&$fields, $contactId) {
936 if (!$contactId ||
!is_array($fields) ||
empty($fields)) {
940 $sharedLocations = array();
946 WHERE contact_id = %1
947 AND master_id IS NOT NULL";
949 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Positive')));
950 while ($dao->fetch()) {
951 $sharedLocations[$dao->location_type_id
] = $dao->location_type_id
;
952 if ($dao->is_primary
) {
953 $sharedLocations['Primary'] = 'Primary';
957 //no need to process further.
958 if (empty($sharedLocations)) {
962 $addressFields = array(
972 'postal_code_suffix',
973 'supplemental_address_1',
974 'supplemental_address_2',
975 'supplemental_address_3',
978 foreach ($fields as $name => & $values) {
979 if (!is_array($values) ||
empty($values)) {
983 $nameVal = explode('-', $values['name']);
984 $fldName = CRM_Utils_Array
::value(0, $nameVal);
985 $locType = CRM_Utils_Array
::value(1, $nameVal);
986 if (!empty($values['location_type_id'])) {
987 $locType = $values['location_type_id'];
990 if (in_array($fldName, $addressFields) &&
991 in_array($locType, $sharedLocations)
993 $values['is_shared'] = TRUE;
999 * Update the shared addresses if master address is modified.
1001 * @param int $addressId
1003 * @param array $params
1004 * Associated array of address params.
1006 public static function processSharedAddress($addressId, $params) {
1007 $query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
1008 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($addressId, 'Integer')));
1011 $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id', 'contact_id');
1012 foreach ($skipFields as $value) {
1013 unset($params[$value]);
1016 $addressDAO = new CRM_Core_DAO_Address();
1017 while ($dao->fetch()) {
1018 $addressDAO->copyValues($params);
1019 $addressDAO->id
= $dao->id
;
1020 $addressDAO->save();
1021 $addressDAO->free();
1026 * Merge contacts with the Same address to get one shared label.
1027 * @param array $rows
1028 * Array[contact_id][contactDetails].
1030 public static function mergeSameAddress(&$rows) {
1031 $uniqueAddress = array();
1032 foreach (array_keys($rows) as $rowID) {
1033 // load complete address as array key
1034 $address = trim($rows[$rowID]['street_address'])
1035 . trim($rows[$rowID]['city'])
1036 . trim($rows[$rowID]['state_province'])
1037 . trim($rows[$rowID]['postal_code'])
1038 . trim($rows[$rowID]['country']);
1039 if (isset($rows[$rowID]['last_name'])) {
1040 $name = $rows[$rowID]['last_name'];
1043 $name = $rows[$rowID]['display_name'];
1048 'first_name' => $rows[$rowID]['first_name'],
1049 'individual_prefix' => $rows[$rowID]['individual_prefix'],
1051 $format = Civi
::settings()->get('display_name_format');
1052 $firstNameWithPrefix = CRM_Utils_Address
::format($formatted, $format, FALSE, FALSE, TRUE);
1053 $firstNameWithPrefix = trim($firstNameWithPrefix);
1055 // fill uniqueAddress array with last/first name tree
1056 if (isset($uniqueAddress[$address])) {
1057 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1058 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1059 // drop unnecessary rows
1060 unset($rows[$rowID]);
1061 // this is the first listing at this address
1064 $uniqueAddress[$address]['ID'] = $rowID;
1065 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1066 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1069 foreach ($uniqueAddress as $address => $data) {
1070 // copy data back to $rows
1072 // one last name list per row
1073 foreach ($data['names'] as $last_name => $first_names) {
1078 if (count($first_names) == 1) {
1079 $family = $first_names[current(array_keys($first_names))]['addressee_display'];
1082 // collapse the tree to summarize
1083 $family = trim(implode(" & ", array_keys($first_names)) . " " . $last_name);
1086 $processedNames .= "\n" . $family;
1089 // build display_name string
1090 $processedNames = $family;
1094 $rows[$data['ID']]['addressee'] = $rows[$data['ID']]['addressee_display'] = $rows[$data['ID']]['display_name'] = $processedNames;
1099 * Create relationship between contacts who share an address.
1101 * Note that currently we create relationship only for Individual contacts
1102 * Individual + Household and Individual + Orgnization
1104 * @param int $masterAddressId
1105 * Master address id.
1106 * @param array $params
1107 * Associated array of submitted values.
1109 public static function processSharedAddressRelationship($masterAddressId, $params) {
1110 // get the contact type of contact being edited / created
1111 $currentContactType = CRM_Contact_BAO_Contact
::getContactType($params['contact_id']);
1112 $currentContactId = $params['contact_id'];
1114 // if current contact is not of type individual return
1115 if ($currentContactType != 'Individual') {
1119 // get the contact id and contact type of shared contact
1120 // check the contact type of shared contact, return if it is of type Individual
1121 $query = 'SELECT cc.id, cc.contact_type
1122 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1125 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($masterAddressId, 'Integer')));
1128 // if current contact is not of type individual return, since we don't create relationship between
1130 if ($dao->contact_type
== 'Individual') {
1133 $sharedContactType = $dao->contact_type
;
1134 $sharedContactId = $dao->id
;
1136 // create relationship between ontacts who share an address
1137 if ($sharedContactType == 'Organization') {
1138 return CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1141 // get the relationship type id of "Household Member of"
1142 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Household Member of', 'id', 'name_a_b');
1145 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Household Member of'"));
1149 'is_active' => TRUE,
1150 'relationship_type_id' => $relTypeId,
1151 'contact_id_a' => $currentContactId,
1152 'contact_id_b' => $sharedContactId,
1155 // If already there is a relationship record of $relParam criteria, avoid creating relationship again or else
1156 // it will casue CRM-16588 as the Duplicate Relationship Exception will revert other contact field values on update
1157 if (CRM_Contact_BAO_Relationship
::checkDuplicateRelationship($relParam, $currentContactId, $sharedContactId)) {
1162 // create relationship
1163 civicrm_api3('relationship', 'create', $relParam);
1165 catch (CiviCRM_API3_Exception
$e) {
1166 // We catch and ignore here because this has historically been a best-effort relationship create call.
1167 // presumably it could refuse due to duplication or similar and we would ignore that.
1172 * Check and set the status for shared address delete.
1174 * @param int $addressId
1176 * @param int $contactId
1178 * @param bool $returnStatus
1183 public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1184 // check if address that is being deleted has any shared
1186 $entityId = $addressId;
1187 $query = 'SELECT cc.id, cc.display_name
1188 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1189 WHERE ca.master_id = %1';
1192 $entityId = $contactId;
1193 $query = 'SELECT cc.id, cc.display_name
1194 FROM civicrm_address ca1
1195 INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1196 INNER JOIN civicrm_contact cc ON ca2.contact_id = cc.id
1197 WHERE ca1.contact_id = %1';
1200 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($entityId, 'Integer')));
1202 $deleteStatus = array();
1203 $sharedContactList = array();
1204 $statusMessage = NULL;
1206 while ($dao->fetch()) {
1207 if (empty($deleteStatus)) {
1208 $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.');
1211 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1212 $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1213 $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1218 if (!empty($deleteStatus)) {
1219 $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1222 if (!$returnStatus) {
1223 CRM_Core_Session
::setStatus($statusMessage, '', 'info');
1227 'contactList' => $sharedContactList,
1228 'count' => $addressCount,
1234 * Call common delete function.
1240 public static function del($id) {
1241 return CRM_Contact_BAO_Contact
::deleteObjectWithPrimary('Address', $id);
1245 * Get options for a given address field.
1246 * @see CRM_Core_DAO::buildOptions
1248 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
1249 * TODO: In context of chainselect, what to return if e.g. a country has no states?
1251 * @param string $fieldName
1252 * @param string $context
1253 * @see CRM_Core_DAO::buildOptionsContext
1254 * @param array $props
1255 * whatever is known about this dao object.
1257 * @return array|bool
1259 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
1261 // Special logic for fields whose options depend on context or properties
1262 switch ($fieldName) {
1263 // Filter state_province list based on chosen country or site defaults
1264 case 'state_province_id':
1265 case 'state_province_name':
1266 case 'state_province':
1267 // change $fieldName to DB specific names.
1268 $fieldName = 'state_province_id';
1269 if (empty($props['country_id'])) {
1270 $config = CRM_Core_Config
::singleton();
1271 if (!empty($config->provinceLimit
)) {
1272 $props['country_id'] = $config->provinceLimit
;
1275 $props['country_id'] = $config->defaultContactCountry
;
1278 if (!empty($props['country_id']) && $context !== 'validate') {
1279 $params['condition'] = 'country_id IN (' . implode(',', (array) $props['country_id']) . ')';
1283 // Filter country list based on site defaults
1286 // change $fieldName to DB specific names.
1287 $fieldName = 'country_id';
1288 if ($context != 'get' && $context != 'validate') {
1289 $config = CRM_Core_Config
::singleton();
1290 if (!empty($config->countryLimit
) && is_array($config->countryLimit
)) {
1291 $params['condition'] = 'id IN (' . implode(',', $config->countryLimit
) . ')';
1296 // Filter county list based on chosen state
1298 if (!empty($props['state_province_id'])) {
1299 $params['condition'] = 'state_province_id IN (' . implode(',', (array) $props['state_province_id']) . ')';
1303 // Not a real field in this entity
1304 case 'world_region':
1306 case 'worldregion_id':
1307 return CRM_Core_PseudoConstant
::worldRegion();
1309 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);