5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
33 * @copyright CiviCRM LLC (c) 2004-2013
39 * This is class to handle address related functions
41 class CRM_Core_BAO_Address
extends CRM_Core_DAO_Address
{
44 * takes an associative array and creates a address
46 * @param array $params (reference ) an assoc array of name/value pairs
47 * @param boolean $fixAddress true if you need to fix (format) address values
48 * before inserting in db
50 * @return array $blocks array of created address
54 static function create(&$params, $fixAddress, $entity = NULL) {
55 if (!isset($params['address']) ||
!is_array($params['address'])) {
58 CRM_Core_BAO_Block
::sortPrimaryFirst($params['address']);
62 $updateBlankLocInfo = CRM_Utils_Array
::value('updateBlankLocInfo', $params, FALSE);
64 $contactId = $params['contact_id'];
65 //get all the addresses for this contact
66 $addresses = self
::allAddress($contactId, $updateBlankLocInfo);
69 // get all address from location block
70 $entityElements = array(
71 'entity_table' => $params['entity_table'],
72 'entity_id' => $params['entity_id'],
74 $addresses = self
::allEntityAddress($entityElements);
77 $isPrimary = $isBilling = TRUE;
79 foreach ($params['address'] as $key => $value) {
80 if (!is_array($value)) {
84 $addressExists = self
::dataExists($value);
85 if ( !CRM_Utils_Array
::value('id', $value) ) {
86 if ($updateBlankLocInfo) {
87 if ((!empty($addresses) ||
!$addressExists) && array_key_exists($key, $addresses)) {
88 $value['id'] = $addresses[$key];
92 if (!empty($addresses) && array_key_exists(CRM_Utils_Array
::value('location_type_id', $value), $addresses)) {
93 $value['id'] = $addresses[CRM_Utils_Array
::value('location_type_id', $value)];
98 // Note there could be cases when address info already exist ($value[id] is set) for a contact/entity
99 // BUT info is not present at this time, and therefore we should be really careful when deleting the block.
100 // $updateBlankLocInfo will help take appropriate decision. CRM-5969
101 if (isset($value['id']) && !$addressExists && $updateBlankLocInfo) {
102 //delete the existing record
103 CRM_Core_BAO_Block
::blockDelete('Address', array('id' => $value['id']));
106 elseif (!$addressExists) {
110 if ($isPrimary && CRM_Utils_Array
::value('is_primary', $value)) {
114 $value['is_primary'] = 0;
117 if ($isBilling && CRM_Utils_Array
::value('is_billing', $value)) {
121 $value['is_billing'] = 0;
124 if (!CRM_Utils_Array
::value('manual_geo_code', $value)) {
125 $value['manual_geo_code'] = 0;
127 $value['contact_id'] = $contactId;
128 $blocks[] = self
::add($value, $fixAddress);
135 * takes an associative array and adds address
137 * @param array $params (reference ) an assoc array of name/value pairs
138 * @param boolean $fixAddress true if you need to fix (format) address values
139 * before inserting in db
141 * @return object CRM_Core_BAO_Address object on success, null otherwise
145 static function add(&$params, $fixAddress) {
146 static $customFields = NULL;
147 $address = new CRM_Core_DAO_Address();
149 // fixAddress mode to be done
151 CRM_Core_BAO_Address
::fixAddress($params);
154 $hook = empty($params['id']) ?
'create' : 'edit';
155 CRM_Utils_Hook
::pre($hook, 'Address', CRM_Utils_Array
::value('id', $params), $params);
157 // if id is set & is_primary isn't we can assume no change
158 if (is_numeric(CRM_Utils_Array
::value('is_primary', $params)) ||
empty($params['id'])) {
159 CRM_Core_BAO_Block
::handlePrimary($params, get_class());
161 $config = CRM_Core_Config
::singleton();
162 $address->copyValues($params);
167 if (!$customFields) {
168 $customFields = CRM_Core_BAO_CustomField
::getFields('Address', FALSE, TRUE);
170 if (!empty($customFields)) {
171 $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 ($address->master_id
!= 'null') {
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 (reference ) an assoc array of name/value pairs
207 static function fixAddress(&$params) {
208 if (CRM_Utils_Array
::value('billing_street_address', $params)) {
209 //Check address is comming from online contribution / registration page
212 'street_address' => 'billing_street_address',
213 'city' => 'billing_city',
214 'postal_code' => 'billing_postal_code',
215 'state_province' => 'billing_state_province',
216 'state_province_id' => 'billing_state_province_id',
217 'country' => 'billing_country',
218 'country_id' => 'billing_country_id',
221 foreach ($billing as $key => $val) {
222 if ($value = CRM_Utils_Array
::value($val, $params)) {
223 if (CRM_Utils_Array
::value($key, $params)) {
224 unset($params[$val]);
227 //add new key and removed old
228 $params[$key] = $value;
229 unset($params[$val]);
235 /* Split the zip and +4, if it's in US format */
236 if (CRM_Utils_Array
::value('postal_code', $params) &&
237 preg_match('/^(\d{4,5})[+-](\d{4})$/',
238 $params['postal_code'],
242 $params['postal_code'] = $match[1];
243 $params['postal_code_suffix'] = $match[2];
246 // add country id if not set
247 if ((!isset($params['country_id']) ||
!is_numeric($params['country_id'])) &&
248 isset($params['country'])
250 $country = new CRM_Core_DAO_Country();
251 $country->name
= $params['country'];
252 if (!$country->find(TRUE)) {
253 $country->name
= NULL;
254 $country->iso_code
= $params['country'];
255 $country->find(TRUE);
257 $params['country_id'] = $country->id
;
260 // add state_id if state is set
261 if ((!isset($params['state_province_id']) ||
!is_numeric($params['state_province_id']))
262 && isset($params['state_province'])
264 if (!empty($params['state_province'])) {
265 $state_province = new CRM_Core_DAO_StateProvince();
266 $state_province->name
= $params['state_province'];
268 // add country id if present
269 if (!empty($params['country_id'])) {
270 $state_province->country_id
= $params['country_id'];
273 if (!$state_province->find(TRUE)) {
274 unset($state_province->name
);
275 $state_province->abbreviation
= $params['state_province'];
276 $state_province->find(TRUE);
278 $params['state_province_id'] = $state_province->id
;
279 if (empty($params['country_id'])) {
280 // set this here since we have it
281 $params['country_id'] = $state_province->country_id
;
285 $params['state_province_id'] = 'null';
289 // add county id if county is set
291 if ((!isset($params['county_id']) ||
!is_numeric($params['county_id']))
292 && isset($params['county']) && !empty($params['county'])
294 $county = new CRM_Core_DAO_County();
295 $county->name
= $params['county'];
297 if (isset($params['state_province_id'])) {
298 $county->state_province_id
= $params['state_province_id'];
301 if ($county->find(TRUE)) {
302 $params['county_id'] = $county->id
;
306 // currently copy values populates empty fields with the string "null"
307 // and hence need to check for the string null
308 if (isset($params['state_province_id']) &&
309 is_numeric($params['state_province_id']) &&
310 (!isset($params['country_id']) ||
empty($params['country_id']))
312 // since state id present and country id not present, hence lets populate it
313 // jira issue http://issues.civicrm.org/jira/browse/CRM-56
314 $params['country_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince',
315 $params['state_province_id'],
320 //special check to ignore non numeric values if they are not
321 //detected by formRule(sometimes happens due to internet latency), also allow user to unselect state/country
322 if (isset($params['state_province_id'])) {
323 if (empty($params['state_province_id'])) {
324 $params['state_province_id'] = 'null';
326 elseif (!is_numeric($params['state_province_id']) ||
327 ((int ) $params['state_province_id'] < 1000)
329 // CRM-3393 ( the hacky 1000 check)
330 $params['state_province_id'] = 'null';
334 if (isset($params['country_id'])) {
335 if (empty($params['country_id'])) {
336 $params['country_id'] = 'null';
338 elseif (!is_numeric($params['country_id']) ||
339 ((int ) $params['country_id'] < 1000)
341 // CRM-3393 ( the hacky 1000 check)
342 $params['country_id'] = 'null';
346 // add state and country names from the ids
347 if (isset($params['state_province_id']) && is_numeric($params['state_province_id'])) {
348 $params['state_province'] = CRM_Core_PseudoConstant
::stateProvinceAbbreviation($params['state_province_id']);
351 if (isset($params['country_id']) && is_numeric($params['country_id'])) {
352 $params['country'] = CRM_Core_PseudoConstant
::country($params['country_id']);
355 $config = CRM_Core_Config
::singleton();
357 $asp = CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::ADDRESS_STANDARDIZATION_PREFERENCES_NAME
,
358 'address_standardization_provider'
360 // clean up the address via USPS web services if enabled
361 if ($asp === 'USPS' &&
362 $params['country_id'] == 1228
364 CRM_Utils_Address_USPS
::checkAddress($params);
366 // do street parsing again if enabled, since street address might have changed
367 $parseStreetAddress = CRM_Utils_Array
::value('street_address_parsing',
368 CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
374 if ($parseStreetAddress && !empty($params['street_address'])) {
376 'street_number', 'street_name', 'street_unit', 'street_number_suffix') as $fld) {
377 unset($params[$fld]);
379 // main parse string.
380 $parseString = CRM_Utils_Array
::value('street_address', $params);
381 $parsedFields = CRM_Core_BAO_Address
::parseStreetAddress($parseString);
383 // merge parse address in to main address block.
384 $params = array_merge($params, $parsedFields);
388 // add latitude and longitude and format address if needed
389 if (!empty($config->geocodeMethod
) && ($config->geocodeMethod
!= 'CRM_Utils_Geocode_OpenStreetMaps') && empty($params['manual_geo_code'])) {
390 $class = $config->geocodeMethod
;
391 $class::format($params);
396 * Check if there is data to create the object
398 * @param array $params (reference ) an assoc array of name/value pairs
405 static function dataExists(&$params) {
406 //check if location type is set if not return false
407 if (!isset($params['location_type_id'])) {
411 $config = CRM_Core_Config
::singleton();
412 foreach ($params as $name => $value) {
413 if (in_array($name, array(
414 'is_primary', 'location_type_id', 'id', 'contact_id', 'is_billing', 'display', 'master_id'))) {
417 elseif (!CRM_Utils_System
::isNull($value)) {
418 // name could be country or country id
419 if (substr($name, 0, 7) == 'country') {
420 // make sure its different from the default country
422 $defaultCountry = $config->defaultContactCountry();
424 $defaultCountryName = $config->defaultContactCountryName();
426 if ($defaultCountry) {
427 if ($value == $defaultCountry ||
428 $value == $defaultCountryName ||
429 $value == $config->defaultContactCountry
438 // return if null default
452 * Given the list of params in the params array, fetch the object
453 * and store the values in the values array
455 * @param array $entityBlock associated array of fields
456 * @param boolean $microformat if microformat output is required
457 * @param int $fieldName conditional field name
459 * @return array $addresses array with address fields
463 static function &getValues(&$entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
464 if (empty($entityBlock)) {
467 $addresses = array();
468 $address = new CRM_Core_BAO_Address();
470 if (!CRM_Utils_Array
::value('entity_table', $entityBlock)) {
471 $address->$fieldName = CRM_Utils_Array
::value($fieldName, $entityBlock);
474 $addressIds = array();
475 $addressIds = self
::allEntityAddress($entityBlock);
477 if (!empty($addressIds[1])) {
478 $address->id
= $addressIds[1];
484 //get primary address as a first block.
485 $address->orderBy('is_primary desc, id');
490 while ($address->fetch()) {
491 // deprecate reference.
494 'state', 'state_name', 'country', 'world_region') as $fld) {
495 if (isset($address->$fld))unset($address->$fld);
498 $stree = $address->street_address
;
500 CRM_Core_DAO
::storeValues($address, $values);
502 // add state and country information: CRM-369
503 if (!empty($address->state_province_id
)) {
504 $address->state
= CRM_Core_PseudoConstant
::stateProvinceAbbreviation($address->state_province_id
, FALSE);
505 $address->state_name
= CRM_Core_PseudoConstant
::stateProvince($address->state_province_id
, FALSE);
508 if (!empty($address->country_id
)) {
509 $address->country
= CRM_Core_PseudoConstant
::country($address->country_id
);
512 $regionId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Country', $address->country_id
, 'region_id');
514 $address->world_region
= CRM_Core_PseudoConstant
::worldregion($regionId);
517 $address->addDisplay($microformat);
519 $values['display'] = $address->display
;
520 $values['display_text'] = $address->display_text
;
522 if (is_numeric($address->master_id
)) {
523 $values['use_shared_address'] = 1;
526 $addresses[$count] = $values;
528 //unset is_primary after first block. Due to some bug in earlier version
529 //there might be more than one primary blocks, hence unset is_primary other than first
531 unset($addresses[$count]['is_primary']);
541 * Add the formatted address to $this-> display
550 function addDisplay($microformat = FALSE) {
552 // added this for CRM 1200
553 'address_id' => $this->id
,
555 'address_name' => str_replace('\ 1', ' ', $this->name
),
556 'street_address' => $this->street_address
,
557 'supplemental_address_1' => $this->supplemental_address_1
,
558 'supplemental_address_2' => $this->supplemental_address_2
,
559 'city' => $this->city
,
560 'state_province_name' => isset($this->state_name
) ?
$this->state_name
: "",
561 'state_province' => isset($this->state
) ?
$this->state
: "",
562 'postal_code' => isset($this->postal_code
) ?
$this->postal_code
: "",
563 'postal_code_suffix' => isset($this->postal_code_suffix
) ?
$this->postal_code_suffix
: "",
564 'country' => isset($this->country
) ?
$this->country
: "",
565 'world_region' => isset($this->world_region
) ?
$this->world_region
: "",
568 if (isset($this->county_id
) && $this->county_id
) {
569 $fields['county'] = CRM_Core_PseudoConstant
::county($this->county_id
);
572 $fields['county'] = NULL;
575 $this->display
= CRM_Utils_Address
::format($fields, NULL, $microformat);
576 $this->display_text
= CRM_Utils_Address
::format($fields);
580 * Get all the addresses for a specified contact_id, with the primary address being first
582 * @param int $id the contact id
584 * @return array the array of adrress data
588 static function allAddress($id, $updateBlankLocInfo = FALSE) {
594 SELECT civicrm_address.id as address_id, civicrm_address.location_type_id as location_type_id
595 FROM civicrm_contact, civicrm_address
596 WHERE civicrm_address.contact_id = civicrm_contact.id AND civicrm_contact.id = %1
597 ORDER BY civicrm_address.is_primary DESC, address_id ASC";
598 $params = array(1 => array($id, 'Integer'));
600 $addresses = array();
601 $dao = CRM_Core_DAO
::executeQuery($query, $params);
603 while ($dao->fetch()) {
604 if ($updateBlankLocInfo) {
605 $addresses[$count++
] = $dao->address_id
;
608 $addresses[$dao->location_type_id
] = $dao->address_id
;
615 * Get all the addresses for a specified location_block id, with the primary address being first
617 * @param array $entityElements the array containing entity_id and
620 * @return array the array of adrress data
624 static function allEntityAddress(&$entityElements) {
625 if (empty($entityElements)) {
629 $entityId = $entityElements['entity_id'];
630 $entityTable = $entityElements['entity_table'];
633 SELECT civicrm_address.id as address_id
634 FROM civicrm_loc_block loc, civicrm_location_type ltype, civicrm_address, {$entityTable} ev
636 AND loc.id = ev.loc_block_id
637 AND civicrm_address.id IN (loc.address_id, loc.address_2_id)
638 AND ltype.id = civicrm_address.location_type_id
639 ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC, address_id ASC ";
641 $params = array(1 => array($entityId, 'Integer'));
642 $addresses = array();
643 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
645 while ($dao->fetch()) {
646 $addresses[$locationCount] = $dao->address_id
;
652 static function addStateCountryMap(&$stateCountryMap, $defaults = NULL) {
653 // first fix the statecountry map if needed
654 if (empty($stateCountryMap)) {
658 $config = CRM_Core_Config
::singleton();
659 if (!isset($config->stateCountryMap
)) {
660 $config->stateCountryMap
= array();
663 $config->stateCountryMap
= array_merge($config->stateCountryMap
, $stateCountryMap);
666 static function fixAllStateSelects(&$form, &$defaults) {
667 $config = CRM_Core_Config
::singleton();
669 if (!empty($config->stateCountryMap
)) {
670 foreach ($config->stateCountryMap
as $index => $match) {
672 array_key_exists('state_province', $match) &&
673 array_key_exists('country', $match)
675 CRM_Contact_Form_Edit_Address
::fixStateSelect(
678 $match['state_province'],
679 CRM_Utils_Array
::value('county', $match),
680 CRM_Utils_Array
::value($match['country'], $defaults),
681 CRM_Utils_Array
::value($match['state_province'], $defaults)
685 unset($config->stateCountryMap
[$index]);
692 * Function to get address sequence
694 * @return array of address sequence.
696 static function addressSequence() {
697 $config = CRM_Core_Config
::singleton();
698 $addressSequence = $config->addressSequence();
700 $countryState = $cityPostal = FALSE;
701 foreach ($addressSequence as $key => $field) {
703 in_array($field, array('country', 'state_province')) &&
706 $countryState = TRUE;
707 $addressSequence[$key] = 'country_state_province';
710 in_array($field, array('city', 'postal_code')) &&
714 $addressSequence[$key] = 'city_postal_code';
717 in_array($field, array('country', 'state_province', 'city', 'postal_code'))
719 unset($addressSequence[$key]);
723 return $addressSequence;
727 * Parse given street address string in to street_name,
728 * street_unit, street_number and street_number_suffix
729 * eg "54A Excelsior Ave. Apt 1C", or "917 1/2 Elm Street"
731 * NB: civic street formats for en_CA and fr_CA used by default if those locales are active
732 * otherwise en_US format is default action
734 * @param string Street address including number and apt
735 * @param string Locale - to set locale used to parse address
737 * @return array $parseFields parsed fields values.
741 static function parseStreetAddress($streetAddress, $locale = NULL) {
742 $config = CRM_Core_Config
::singleton();
744 /* locales supported include:
745 * en_US - http://pe.usps.com/cpim/ftp/pubs/pub28/pub28.pdf
746 * en_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-e.asp
747 * fr_CA - http://www.canadapost.ca/tools/pg/manual/PGaddress-f.asp
748 * NB: common use of comma after street number also supported
752 $supportedLocalesForParsing = array('en_US', 'en_CA', 'fr_CA');
754 $locale = $config->lcMessages
;
756 // as different locale explicitly requested but is not available, display warning message and set $locale = 'en_US'
757 if (!in_array($locale, $supportedLocalesForParsing)) {
758 CRM_Core_Session
::setStatus(ts('Unsupported locale specified to parseStreetAddress: %1. Proceeding with en_US locale.', array(1 => $locale)), ts('Unsupported Locale'), 'alert');
761 $parseFields = array(
764 'street_number' => '',
765 'street_number_suffix' => '',
768 if (empty($streetAddress)) {
772 $streetAddress = trim($streetAddress);
775 if (in_array($locale, array(
776 'en_CA', 'fr_CA')) && preg_match('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', $streetAddress, $matches)) {
777 $parseFields['street_unit'] = $matches[1];
778 // unset from rest of street address
779 $streetAddress = preg_replace('/^([A-Za-z0-9]+)[ ]*\-[ ]*/', '', $streetAddress);
782 // get street number and suffix.
784 //alter street number/suffix handling so that we accept -digit
785 if (preg_match('/^[A-Za-z0-9]+([\S]+)/', $streetAddress, $matches)) {
786 // check that $matches[0] is numeric, else assume no street number
787 if (preg_match('/^(\d+)/', $matches[0])) {
788 $streetNumAndSuffix = $matches[0];
790 // get street number.
792 if (preg_match('/^(\d+)/', $streetNumAndSuffix, $matches)) {
793 $parseFields['street_number'] = $matches[0];
794 $suffix = preg_replace('/^(\d+)/', '', $streetNumAndSuffix);
795 $parseFields['street_number_suffix'] = trim($suffix);
798 // unset from main street address.
799 $streetAddress = preg_replace('/^[A-Za-z0-9]+([\S]+)/', '', $streetAddress);
800 $streetAddress = trim($streetAddress);
803 elseif (preg_match('/^(\d+)/', $streetAddress, $matches)) {
804 $parseFields['street_number'] = $matches[0];
805 // unset from main street address.
806 $streetAddress = preg_replace('/^(\d+)/', '', $streetAddress);
807 $streetAddress = trim($streetAddress);
810 // suffix might be like 1/2
812 if (preg_match('/^\d\/\d/', $streetAddress, $matches)) {
813 $parseFields['street_number_suffix'] .= $matches[0];
815 // unset from main street address.
816 $streetAddress = preg_replace('/^\d+\/\d+/', '', $streetAddress);
817 $streetAddress = trim($streetAddress);
820 // now get the street unit.
821 // supportable street unit formats.
822 $streetUnitFormats = array(
823 'APT', 'APARTMENT', 'BSMT', 'BASEMENT', 'BLDG', 'BUILDING',
824 'DEPT', 'DEPARTMENT', 'FL', 'FLOOR', 'FRNT', 'FRONT',
825 'HNGR', 'HANGER', 'LBBY', 'LOBBY', 'LOWR', 'LOWER',
826 'OFC', 'OFFICE', 'PH', 'PENTHOUSE', 'TRLR', 'TRAILER',
827 'UPPR', 'RM', 'ROOM', 'SIDE', 'SLIP', 'KEY',
828 'LOT', 'PIER', 'REAR', 'SPC', 'SPACE',
829 'STOP', 'STE', 'SUITE', 'UNIT', '#',
832 // overwriting $streetUnitFormats for 'en_CA' and 'fr_CA' locale
833 if (in_array($locale, array(
834 'en_CA', 'fr_CA'))) {
835 $streetUnitFormats = array('APT', 'APP', 'SUITE', 'BUREAU', 'UNIT');
838 $streetUnitPreg = '/(' . implode('|\s', $streetUnitFormats) . ')(.+)?/i';
840 if (preg_match($streetUnitPreg, $streetAddress, $matches)) {
841 $parseFields['street_unit'] = trim($matches[0]);
842 $streetAddress = str_replace($matches[0], '', $streetAddress);
843 $streetAddress = trim($streetAddress);
846 // consider remaining string as street name.
847 $parseFields['street_name'] = $streetAddress;
849 //run parsed fields through stripSpaces to clean
850 foreach ($parseFields as $parseField => $value) {
851 $parseFields[$parseField] = CRM_Utils_String
::stripSpaces($value);
858 * Validate the address fields based on the address options enabled
859 * in the Address Settings
861 * @param array $fields an array of importable/exportable contact fields
863 * @return array $fields an array of contact fields and only the enabled address options
867 static function validateAddressOptions($fields) {
868 static $addressOptions = NULL;
869 if (!$addressOptions) {
870 $addressOptions = CRM_Core_BAO_Setting
::valueOptions(CRM_Core_BAO_Setting
::SYSTEM_PREFERENCES_NAME
,
871 'address_options', TRUE, NULL, TRUE
875 if (is_array($fields) && !empty($fields)) {
876 foreach ($addressOptions as $key => $value) {
877 if (!$value && isset($fields[$key])) {
878 unset($fields[$key]);
886 * Check if current address is used by any other contacts
888 * @param int $addressId address id
890 * @return count of contacts that use this shared address
894 static function checkContactSharedAddress($addressId) {
895 $query = 'SELECT count(id) FROM civicrm_address WHERE master_id = %1';
896 return CRM_Core_DAO
::singleValueQuery($query, array(1 => array($addressId, 'Integer')));
900 * Function to check if current address fields are shared with any other address
902 * @param array $fields address fields in profile
903 * @param int $contactId contact id
908 static function checkContactSharedAddressFields(&$fields, $contactId) {
909 if (!$contactId ||
!is_array($fields) ||
empty($fields)) {
913 $sharedLocations = array();
919 WHERE contact_id = %1
920 AND master_id IS NOT NULL";
922 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($contactId, 'Positive')));
923 while ($dao->fetch()) {
924 $sharedLocations[$dao->location_type_id
] = $dao->location_type_id
;
925 if ($dao->is_primary
) {
926 $sharedLocations['Primary'] = 'Primary';
930 //no need to process further.
931 if (empty($sharedLocations)) {
935 $addressFields = array(
945 'postal_code_suffix',
946 'supplemental_address_1',
947 'supplemental_address_2',
950 foreach ($fields as $name => & $values) {
951 if (!is_array($values) ||
empty($values)) {
955 $nameVal = explode('-', $values['name']);
956 $fldName = CRM_Utils_Array
::value(0, $nameVal);
957 $locType = CRM_Utils_Array
::value(1, $nameVal);
958 if (CRM_Utils_Array
::value('location_type_id', $values)) {
959 $locType = $values['location_type_id'];
962 if (in_array($fldName, $addressFields) &&
963 in_array($locType, $sharedLocations)
965 $values['is_shared'] = TRUE;
971 * Function to update the shared addresses if master address is modified
973 * @param int $addressId address id
974 * @param array $params associated array of address params
980 static function processSharedAddress($addressId, $params) {
981 $query = 'SELECT id FROM civicrm_address WHERE master_id = %1';
982 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($addressId, 'Integer')));
985 $skipFields = array('is_primary', 'location_type_id', 'is_billing', 'master_id', 'contact_id');
986 foreach ($skipFields as $value) {
987 unset($params[$value]);
990 $addressDAO = new CRM_Core_DAO_Address();
991 while ($dao->fetch()) {
992 $addressDAO->copyValues($params);
993 $addressDAO->id
= $dao->id
;
1000 * Function to create relationship between contacts who share an address
1002 * Note that currently we create relationship only for Individual contacts
1003 * Individual + Household and Individual + Orgnization
1005 * @param int $masterAddressId master address id
1006 * @param array $params associated array of submitted values
1012 static function processSharedAddressRelationship($masterAddressId, $params) {
1013 if (!$masterAddressId) {
1016 // get the contact type of contact being edited / created
1017 $currentContactType = CRM_Contact_BAO_Contact
::getContactType($params['contact_id']);
1018 $currentContactId = $params['contact_id'];
1020 // if current contact is not of type individual return
1021 if ($currentContactType != 'Individual') {
1025 // get the contact id and contact type of shared contact
1026 // check the contact type of shared contact, return if it is of type Individual
1028 $query = 'SELECT cc.id, cc.contact_type
1029 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1032 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($masterAddressId, 'Integer')));
1036 // if current contact is not of type individual return, since we don't create relationship between
1038 if ($dao->contact_type
== 'Individual') {
1041 $sharedContactType = $dao->contact_type
;
1042 $sharedContactId = $dao->id
;
1044 // create relationship between ontacts who share an address
1045 if ($sharedContactType == 'Organization') {
1046 return CRM_Contact_BAO_Contact_Utils
::createCurrentEmployerRelationship($currentContactId, $sharedContactId);
1049 // get the relationship type id of "Household Member of"
1050 $relationshipType = 'Household Member of';
1053 $cid = array('contact' => $currentContactId);
1055 $relTypeId = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_RelationshipType', $relationshipType, 'id', 'name_a_b');
1058 CRM_Core_Error
::fatal(ts("You seem to have deleted the relationship type '%1'", array(1 => $relationshipType)));
1061 // create relationship
1062 $relationshipParams = array(
1063 'is_active' => TRUE,
1064 'relationship_type_id' => $relTypeId . '_a_b',
1065 'contact_check' => array($sharedContactId => TRUE),
1068 list($valid, $invalid, $duplicate,
1069 $saved, $relationshipIds
1070 ) = CRM_Contact_BAO_Relationship
::create($relationshipParams, $cid);
1074 * Function to check and set the status for shared address delete
1076 * @param int $addressId address id
1077 * @param int $contactId contact id
1078 * @param boolean $returnStatus by default false
1080 * @return string $statusMessage
1084 static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
1085 // check if address that is being deleted has any shared
1087 $entityId = $addressId;
1088 $query = 'SELECT cc.id, cc.display_name
1089 FROM civicrm_contact cc INNER JOIN civicrm_address ca ON cc.id = ca.contact_id
1090 WHERE ca.master_id = %1';
1093 $entityId = $contactId;
1094 $query = 'SELECT cc.id, cc.display_name
1095 FROM civicrm_address ca1
1096 INNER JOIN civicrm_address ca2 ON ca1.id = ca2.master_id
1097 INNER JOIN civicrm_contact cc ON ca2.contact_id = cc.id
1098 WHERE ca1.contact_id = %1';
1101 $dao = CRM_Core_DAO
::executeQuery($query, array(1 => array($entityId, 'Integer')));
1103 $deleteStatus = array();
1104 $sharedContactList = array();
1105 $statusMessage = NULL;
1107 while ($dao->fetch()) {
1108 if (empty($deleteStatus)) {
1109 $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.');
1112 $contactViewUrl = CRM_Utils_System
::url('civicrm/contact/view', "reset=1&cid={$dao->id}");
1113 $sharedContactList[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1114 $deleteStatus[] = "<a href='{$contactViewUrl}'>{$dao->display_name}</a>";
1119 if (!empty($deleteStatus)) {
1120 $statusMessage = implode('<br/>', $deleteStatus) . '<br/>';
1123 if (!$returnStatus) {
1124 CRM_Core_Session
::setStatus($statusMessage, '', 'info');
1128 'contactList' => $sharedContactList,
1129 'count' => $addressCount,