3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
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
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 // add latitude and longitude and format address if needed
382 if (!empty($config->geocodeMethod
) && ($config->geocodeMethod
!= 'CRM_Utils_Geocode_OpenStreetMaps') && empty($params['manual_geo_code'])) {
383 $class = $config->geocodeMethod
;
384 $class::format($params);
389 * Check if there is data to create the object.
391 * @param array $params
392 * (reference ) an assoc array of name/value pairs.
396 public static function dataExists(&$params) {
397 //check if location type is set if not return false
398 if (!isset($params['location_type_id'])) {
402 $config = CRM_Core_Config
::singleton();
403 foreach ($params as $name => $value) {
404 if (in_array($name, array(
415 elseif (!CRM_Utils_System
::isNull($value)) {
416 // name could be country or country id
417 if (substr($name, 0, 7) == 'country') {
418 // make sure its different from the default country
420 $defaultCountry = $config->defaultContactCountry();
422 $defaultCountryName = $config->defaultContactCountryName();
424 if ($defaultCountry) {
425 if ($value == $defaultCountry ||
426 $value == $defaultCountryName ||
427 $value == $config->defaultContactCountry
436 // return if null default
450 * Given the list of params in the params array, fetch the object
451 * and store the values in the values array
453 * @param array $entityBlock
454 * Associated array of fields.
455 * @param bool $microformat
456 * If microformat output is required.
457 * @param int|string $fieldName conditional field name
460 * array with address fields
462 public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
463 if (empty($entityBlock)) {
466 $addresses = array();
467 $address = new CRM_Core_BAO_Address();
469 if (empty($entityBlock['entity_table'])) {
470 $address->$fieldName = CRM_Utils_Array
::value($fieldName, $entityBlock);
473 $addressIds = array();
474 $addressIds = self
::allEntityAddress($entityBlock);
476 if (!empty($addressIds[1])) {
477 $address->id
= $addressIds[1];
483 //get primary address as a first block.
484 $address->orderBy('is_primary desc, id');
488 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
490 while ($address->fetch()) {
491 // deprecate reference.
499 if (isset($address->$fld)) {
500 unset($address->$fld);
504 $stree = $address->street_address
;
506 CRM_Core_DAO
::storeValues($address, $values);
508 // add state and country information: CRM-369
509 if (!empty($address->location_type_id
)) {
510 $values['location_type'] = CRM_Utils_Array
::value($address->location_type_id
, $locationTypes);
512 if (!empty($address->state_province_id
)) {
513 $address->state
= CRM_Core_PseudoConstant
::stateProvinceAbbreviation($address->state_province_id
, FALSE);
514 $address->state_name
= CRM_Core_PseudoConstant
::stateProvince($address->state_province_id
, FALSE);
517 if (!empty($address->country_id
)) {
518 $address->country
= CRM_Core_PseudoConstant
::country($address->country_id
);
521 $regionId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Country', $address->country_id
, 'region_id');
523 $address->world_region
= CRM_Core_PseudoConstant
::worldregion($regionId);
526 $address->addDisplay($microformat);
528 $values['display'] = $address->display
;
529 $values['display_text'] = $address->display_text
;
531 if (is_numeric($address->master_id
)) {
532 $values['use_shared_address'] = 1;
535 $addresses[$count] = $values;
537 //unset is_primary after first block. Due to some bug in earlier version
538 //there might be more than one primary blocks, hence unset is_primary other than first
540 unset($addresses[$count]['is_primary']);
550 * Add the formatted address to $this-> display.
552 * @param bool $microformat
553 * Unexplained parameter that I've always wondered about.
555 public function addDisplay($microformat = FALSE) {
557 // added this for CRM 1200
558 'address_id' => $this->id
,
560 'address_name' => str_replace('\ 1', ' ', $this->name
),
561 'street_address' => $this->street_address
,
562 'supplemental_address_1' => $this->supplemental_address_1
,
563 'supplemental_address_2' => $this->supplemental_address_2
,
564 'city' => $this->city
,
565 'state_province_name' => isset($this->state_name
) ?
$this->state_name
: "",
566 'state_province' => isset($this->state
) ?
$this->state
: "",
567 'postal_code' => isset($this->postal_code
) ?
$this->postal_code
: "",
568 'postal_code_suffix' => isset($this->postal_code_suffix
) ?
$this->postal_code_suffix
: "",
569 'country' => isset($this->country
) ?
$this->country
: "",
570 'world_region' => isset($this->world_region
) ?
$this->world_region
: "",
573 if (isset($this->county_id
) && $this->county_id
) {
574 $fields['county'] = CRM_Core_PseudoConstant
::county($this->county_id
);
577 $fields['county'] = NULL;
580 $this->display
= CRM_Utils_Address
::format($fields, NULL, $microformat);
581 $this->display_text
= CRM_Utils_Address
::format($fields);
585 * Get all the addresses for a specified contact_id, with the primary address being first
590 * @param bool $updateBlankLocInfo
593 * the array of adrress data
595 public static function allAddress($id, $updateBlankLocInfo = FALSE) {
601 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
602 FROM civicrm_contact, civicrm_address
603 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
604 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
605 $params = array(1 => array($id, 'Integer'));
607 $addresses = array();
608 $dao = CRM_Core_DAO
::executeQuery($query, $params);
610 while ($dao->fetch()) {
611 if ($updateBlankLocInfo) {
612 $addresses[$count++
] = $dao->address_id
;
615 $addresses[$dao->location_type_id
] = $dao->address_id
;
622 * Get all the addresses for a specified location_block id, with the primary address being first
624 * @param array $entityElements
625 * The array containing entity_id and.
629 * the array of adrress data
631 public static function allEntityAddress(&$entityElements) {
632 $addresses = array();
633 if (empty($entityElements)) {
637 $entityId = $entityElements['entity_id'];
638 $entityTable = $entityElements['entity_table'];
641 SELECT civicrm_address.id as address_id
642 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
644 AND loc.id = ev.loc_block_id
645 AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
646 AND ltype.id = civicrm_address.location_type_id
647 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
649 $params = array(1 => array($entityId, 'Integer'));
650 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
652 while ($dao->fetch()) {
653 $addresses[$locationCount] = $dao->address_id
;
660 * Get address sequence.
663 * Array of address sequence.
665 public static function addressSequence() {
666 $config = CRM_Core_Config
::singleton();
667 $addressSequence = $config->addressSequence();
669 $countryState = $cityPostal = FALSE;
670 foreach ($addressSequence as $key => $field) {
672 in_array($field, array('country', 'state_province')) &&
675 $countryState = TRUE;
676 $addressSequence[$key] = 'country_state_province';
679 in_array($field, array('city', 'postal_code')) &&
683 $addressSequence[$key] = 'city_postal_code';
686 in_array($field, array('country', 'state_province', 'city', 'postal_code'))
688 unset($addressSequence[$key]);
692 return $addressSequence;
696 * Parse given street address string in to street_name,
697 * street_unit, street_number and street_number_suffix
698 * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
700 * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
701 * otherwise en_US format is default action
703 * @param string $streetAddress
704 * Street address including number and apt.
705 * @param string $locale
706 * Locale used to parse address.
709 * parsed fields values.
711 public static function parseStreetAddress($streetAddress, $locale = NULL) {
712 $config = CRM_Core_Config
::singleton();
714 /* locales supported include:
715 * en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
716 * en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
717 * fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
718 * NB: common use of comma after street number also supported
722 $supportedLocalesForParsing = array('en_US', 'en_CA', 'fr_CA');
724 $locale = $config->lcMessages
;
726 // as different locale explicitly requested but is not available, display warning message and set $locale = 'en_US'
727 if (!in_array($locale, $supportedLocalesForParsing)) {
728 CRM_Core_Session
::setStatus(ts('Unsupported locale specified to parseStreetAddress: %1. Proceeding with en_US locale.', array(1 => $locale)), ts('Unsupported Locale'), 'alert');
731 $emptyParseFields = $parseFields = array(
734 'street_number' => '',
735 'street_number_suffix' => '',
738 if (empty($streetAddress)) {
742 $streetAddress = trim($streetAddress);
745 if (in_array($locale, array(
748 )) && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)
750 $parseFields['street_unit'] = $matches[1];
751 // unset from rest of street address
752 $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
755 // get street number and suffix.
757 //alter street number/suffix handling so that we accept -digit
758 if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
759 // check that $matches[0] is numeric, else assume no street number
760 if (preg_match('/^(\d+)/', $matches[0])) {
761 $streetNumAndSuffix = $matches[0];
763 // get street number.
765 if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
766 $parseFields['street_number'] = $matches[0];
767 $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
768 $parseFields['street_number_suffix'] = trim($suffix);
771 // unset from main street address.
772 $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
773 $streetAddress = trim($streetAddress);
776 elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
777 $parseFields['street_number'] = $matches[0];
778 // unset from main street address.
779 $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
780 $streetAddress = trim($streetAddress);
783 // suffix might be like 1/2
785 if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
786 $parseFields['street_number_suffix'] .= $matches[0];
788 // unset from main street address.
789 $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
790 $streetAddress = trim($streetAddress);
793 // now get the street unit.
794 // supportable street unit formats.
795 $streetUnitFormats = array(
838 // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
839 if (in_array($locale, array(
843 $streetUnitFormats = array('APT', 'APP', 'SUITE', 'BUREAU', 'UNIT');
845 //@todo per CRM-14459 this regex picks up words with the string in them - e.g APT picks up
846 //Captain - presuming fixing regex (& adding test) to ensure a-z does not preced string will fix
847 $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
849 if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
850 $parseFields['street_unit'] = trim($matches[0]);
851 $streetAddress = str_replace($matches[0], '', $streetAddress);
852 $streetAddress = trim($streetAddress);
855 // consider remaining string as street name.
856 $parseFields['street_name'] = $streetAddress;
858 //run parsed fields through stripSpaces to clean
859 foreach ($parseFields as $parseField => $value) {
860 $parseFields[$parseField] = CRM_Utils_String
::stripSpaces($value);
862 //CRM-14459 if the field is too long we should assume it didn't get it right & skip rather than allow
864 $fields = CRM_Core_BAO_Address
::fields();
865 foreach ($fields as $fieldname => $field) {
866 if (!empty($field['maxlength']) && strlen(CRM_Utils_Array
::value($fieldname, $parseFields)) > $field['maxlength']) {
867 return $emptyParseFields;
875 * Validate the address fields based on the address options enabled.
876 * in the Address Settings
878 * @param array $fields
879 * An array of importable/exportable contact fields.
882 * an array of contact fields and only the enabled address options
884 public static function validateAddressOptions($fields) {
885 static $addressOptions = NULL;
886 if (!$addressOptions) {
887 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(
888 CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
893 if (is_array($fields) && !empty($fields)) {
894 foreach ($addressOptions as $key => $value) {
895 if (!$value && isset($fields[$key])) {
896 unset($fields[$key]);
904 * Check if current address is used by any other contacts.
906 * @param int $addressId
910 * count of contacts that use this shared address
912 public static function checkContactSharedAddress($addressId) {
913 $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
914 return CRM_Core_DAO
::singleValueQuery($query, array(1 => array($addressId, 'Integer')));
918 * Check if current address fields are shared with any other address.
920 * @param array $fields
921 * Address fields in profile.
922 * @param int $contactId
926 public static function checkContactSharedAddressFields(&$fields, $contactId) {
927 if (!$contactId ||
!is_array($fields) ||
empty($fields)) {
931 $sharedLocations = array();
937 WHERE contact_id = %1
938 AND master_id IS NOT NULL";
940 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Positive')));
941 while ($dao->fetch()) {
942 $sharedLocations[$dao->location_type_id
] = $dao->location_type_id
;
943 if ($dao->is_primary
) {
944 $sharedLocations['Primary'] = 'Primary';
948 //no need to process further.
949 if (empty($sharedLocations)) {
953 $addressFields = array(
963 'postal_code_suffix',
964 'supplemental_address_1',
965 'supplemental_address_2',
968 foreach ($fields as $name => & $values) {
969 if (!is_array($values) ||
empty($values)) {
973 $nameVal = explode('-', $values['name']);
974 $fldName = CRM_Utils_Array
::value(0, $nameVal);
975 $locType = CRM_Utils_Array
::value(1, $nameVal);
976 if (!empty($values['location_type_id'])) {
977 $locType = $values['location_type_id'];
980 if (in_array($fldName, $addressFields) &&
981 in_array($locType, $sharedLocations)
983 $values['is_shared'] = TRUE;
989 * Update the shared addresses if master address is modified.
991 * @param int $addressId
993 * @param array $params
994 * Associated array of address params.
996 public static function processSharedAddress($addressId, $params) {
997 $query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
998 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($addressId, 'Integer')));
1001 $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id', 'contact_id');
1002 foreach ($skipFields as $value) {
1003 unset($params[$value]);
1006 $addressDAO = new CRM_Core_DAO_Address();
1007 while ($dao->fetch()) {
1008 $addressDAO->copyValues($params);
1009 $addressDAO->id
= $dao->id
;
1010 $addressDAO->save();
1011 $addressDAO->free();
1016 * Merge contacts with the Same address to get one shared label.
1017 * @param array $rows
1018 * Array[contact_id][contactDetails].
1020 public static function mergeSameAddress(&$rows) {
1021 $uniqueAddress = array();
1022 foreach (array_keys($rows) as $rowID) {
1023 // load complete address as array key
1024 $address = trim($rows[$rowID]['street_address'])
1025 . trim($rows[$rowID]['city'])
1026 . trim($rows[$rowID]['state_province'])
1027 . trim($rows[$rowID]['postal_code'])
1028 . trim($rows[$rowID]['country']);
1029 if (isset($rows[$rowID]['last_name'])) {
1030 $name = $rows[$rowID]['last_name'];
1033 $name = $rows[$rowID]['display_name'];
1038 'first_name' => $rows[$rowID]['first_name'],
1039 'individual_prefix' => $rows[$rowID]['individual_prefix'],
1041 $format = Civi
::settings()->get('display_name_format');
1042 $firstNameWithPrefix = CRM_Utils_Address
::format($formatted, $format, FALSE, FALSE, TRUE);
1043 $firstNameWithPrefix = trim($firstNameWithPrefix);
1045 // fill uniqueAddress array with last/first name tree
1046 if (isset($uniqueAddress[$address])) {
1047 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1048 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1049 // drop unnecessary rows
1050 unset($rows[$rowID]);
1051 // this is the first listing at this address
1054 $uniqueAddress[$address]['ID'] = $rowID;
1055 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['first_name'] = $rows[$rowID]['first_name'];
1056 $uniqueAddress[$address]['names'][$name][$firstNameWithPrefix]['addressee_display'] = $rows[$rowID]['addressee_display'];
1059 foreach ($uniqueAddress as $address => $data) {
1060 // copy data back to $rows
1062 // one last name list per row
1063 foreach ($data['names'] as $last_name => $first_names) {
1068 if (count($first_names) == 1) {
1069 $family = $first_names[current(array_keys($first_names))]['addressee_display'];
1072 // collapse the tree to summarize
1073 $family = trim(implode(" & ", array_keys($first_names)) . " " . $last_name);
1076 $processedNames .= "\n" . $family;
1079 // build display_name string
1080 $processedNames = $family;
1084 $rows[$data['ID']]['addressee'] = $rows[$data['ID']]['addressee_display'] = $rows[$data['ID']]['display_name'] = $processedNames;
1089 * Create relationship between contacts who share an address.
1091 * Note that currently we create relationship only for Individual contacts
1092 * Individual + Household and Individual + Orgnization
1094 * @param int $masterAddressId
1095 * Master address id.
1096 * @param array $params
1097 * Associated array of submitted values.
1099 public static function processSharedAddressRelationship($masterAddressId, $params) {
1100 // get the contact type of contact being edited / created
1101 $currentContactType = CRM_Contact_BAO_Contact
::getContactType($params['contact_id']);
1102 $currentContactId = $params['contact_id'];
1104 // if current contact is not of type individual return
1105 if ($currentContactType != 'Individual') {
1109 // get the contact id and contact type of shared contact
1110 // check the contact type of shared contact, return if it is of type Individual
1111 $query = 'SELECT cc.id, cc.contact_type
1112 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1115 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($masterAddressId, 'Integer')));
1118 // if current contact is not of type individual return, since we don't create relationship between
1120 if ($dao->contact_type
== 'Individual') {
1123 $sharedContactType = $dao->contact_type
;
1124 $sharedContactId = $dao->id
;
1126 // create relationship between ontacts who share an address
1127 if ($sharedContactType == 'Organization') {
1128 return CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1131 // get the relationship type id of "Household Member of"
1132 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Household Member of', 'id', 'name_a_b');
1135 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type 'Household Member of'"));
1139 'is_active' => TRUE,
1140 'relationship_type_id' => $relTypeId,
1141 'contact_id_a' => $currentContactId,
1142 'contact_id_b' => $sharedContactId,
1145 // If already there is a relationship record of $relParam criteria, avoid creating relationship again or else
1146 // it will casue CRM-16588 as the Duplicate Relationship Exception will revert other contact field values on update
1147 if (CRM_Contact_BAO_Relationship
::checkDuplicateRelationship($relParam, $currentContactId, $sharedContactId)) {
1152 // create relationship
1153 civicrm_api3('relationship', 'create', $relParam);
1155 catch (CiviCRM_API3_Exception
$e) {
1156 // We catch and ignore here because this has historically been a best-effort relationship create call.
1157 // presumably it could refuse due to duplication or similar and we would ignore that.
1162 * Check and set the status for shared address delete.
1164 * @param int $addressId
1166 * @param int $contactId
1168 * @param bool $returnStatus
1173 public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1174 // check if address that is being deleted has any shared
1176 $entityId = $addressId;
1177 $query = 'SELECT cc.id, cc.display_name
1178 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1179 WHERE ca.master_id = %1';
1182 $entityId = $contactId;
1183 $query = 'SELECT cc.id, cc.display_name
1184 FROM civicrm_address ca1
1185 INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1186 INNER JOIN civicrm_contact cc ON ca2.contact_id = cc.id
1187 WHERE ca1.contact_id = %1';
1190 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($entityId, 'Integer')));
1192 $deleteStatus = array();
1193 $sharedContactList = array();
1194 $statusMessage = NULL;
1196 while ($dao->fetch()) {
1197 if (empty($deleteStatus)) {
1198 $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.');
1201 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1202 $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1203 $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1208 if (!empty($deleteStatus)) {
1209 $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1212 if (!$returnStatus) {
1213 CRM_Core_Session
::setStatus($statusMessage, '', 'info');
1217 'contactList' => $sharedContactList,
1218 'count' => $addressCount,
1224 * Call common delete function.
1230 public static function del($id) {
1231 return CRM_Contact_BAO_Contact
::deleteObjectWithPrimary('Address', $id);
1235 * Get options for a given address field.
1236 * @see CRM_Core_DAO::buildOptions
1238 * TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
1239 * TODO: In context of chainselect, what to return if e.g. a country has no states?
1241 * @param string $fieldName
1242 * @param string $context
1243 * @see CRM_Core_DAO::buildOptionsContext
1244 * @param array $props
1245 * whatever is known about this dao object.
1247 * @return array|bool
1249 public static function buildOptions($fieldName, $context = NULL, $props = array()) {
1251 // Special logic for fields whose options depend on context or properties
1252 switch ($fieldName) {
1253 // Filter state_province list based on chosen country or site defaults
1254 case 'state_province_id':
1255 case 'state_province_name':
1256 case 'state_province':
1257 // change $fieldName to DB specific names.
1258 $fieldName = 'state_province_id';
1259 if (empty($props['country_id'])) {
1260 $config = CRM_Core_Config
::singleton();
1261 if (!empty($config->provinceLimit
)) {
1262 $props['country_id'] = $config->provinceLimit
;
1265 $props['country_id'] = $config->defaultContactCountry
;
1268 if (!empty($props['country_id']) && $context !== 'validate') {
1269 $params['condition'] = 'country_id IN (' . implode(',', (array) $props['country_id']) . ')';
1273 // Filter country list based on site defaults
1276 // change $fieldName to DB specific names.
1277 $fieldName = 'country_id';
1278 if ($context != 'get' && $context != 'validate') {
1279 $config = CRM_Core_Config
::singleton();
1280 if (!empty($config->countryLimit
) && is_array($config->countryLimit
)) {
1281 $params['condition'] = 'id IN (' . implode(',', $config->countryLimit
) . ')';
1286 // Filter county list based on chosen state
1288 if (!empty($props['state_province_id'])) {
1289 $params['condition'] = 'state_province_id IN (' . implode(',', (array) $props['state_province_id']) . ')';
1293 // Not a real field in this entity
1294 case 'world_region':
1296 case 'worldregion_id':
1297 return CRM_Core_PseudoConstant
::worldRegion();
1299 return CRM_Core_PseudoConstant
::get(__CLASS__
, $fieldName, $params, $context);