CRM-21674 allow lat & long to be pre-calculated for proximity query / search #11542
Conversation
eileenmcnaughton
force-pushed
the
prox
branch
from
41241cc to
6fcc91f
Compare
|
|
||
| if (!is_numeric(CRM_Utils_Array::value('geo_code_1', $this->_formValues)) || | ||
| !is_numeric(CRM_Utils_Array::value('geo_code_2', $this->_formValues)) || | ||
| !isset($this->_formValues['distance']) | ||
| ) { | ||
| CRM_Core_Error::fatal(ts('Could not geocode input')); | ||
| throw new CRM_Core_Exception(ts('Could not geocode input')); |
There was a problem hiding this comment.
@eileenmcnaughton should we be translating Exception text? ping @mlutfy
There was a problem hiding this comment.
No, we shouldn't. I grepped to spot-check, and none of the several examples I reviewed translated the text.
CRM/Core/BAO/Address.php
Outdated
| $class::format($params); | ||
| // skip_geocode is an optional parameter through the api. | ||
| // manual_geo_code is on the contact edit form. They do the same thing.... | ||
| if (empty($params['skip_geocode']) && empty($params['manual_geo_code'])) { |
There was a problem hiding this comment.
@eileenmcnaughton, is it expanding scope too much to remove the form-layer logic from this class? Seems like the form should use the skip_geocode parameter rather than invent its own.
There was a problem hiding this comment.
I agree with you about the form - could just rename the field to 'skip_geocode'. I could possibly expand to it since we are both quite engaged I'm a bit less worried about increasing scope than I normally would be
eileenmcnaughton
force-pushed
the
prox
branch
from
6fcc91f to
fe71901
Compare
eileenmcnaughton
force-pushed
the
prox
branch
from
fe71901 to
4b2d36d
Compare
eileenmcnaughton
changed the title
|
@monishdeb I've rebased this too now - I added a little to it on the form side |
|
Cool, will now review it 👍 |
|
test this please |
|
Tested on my local works fine. Nice improvement. Liked the idea to use dummy geoprovider Merging it now. |
Overview
Allow calling function to calculate the lat & long before calling proximity query and allow that to be entered in the proximity custom search
Before
civicrm_api3('Contact', 'get', ['prox_distance' => 4]);
required address fields like 'prox_city' to calculate the centre point
Proximity search:
After
'prox_geo_code_1' & 'prox_geo_code_2' can be passed in instead of address fields
If people know the geoco-ordinates they can self enter them.
Technical Details
The BAO (& by extension api) supports parameters in contact.get for proximity searching. prox_distance is a required param for this & if submitted the following parameters are used to calculate the centre point
'prox_street_address'
'prox_city'
'prox_postal_code'
'prox_state_province_id'
'prox_country_id'
'prox_state_province' ,
'prox_country'
'prox_distance_unit' ,
I wish to make it such that those parameters are optional & not used if 'prox_geo_code_1' & 'prox_geo_code_2' are supplied.
Comments
The immediate use case is to get a unit test added & allow people to search if their geocoder won't accurately find their co-ordinates
Later I also want this toimprove the code in the custom proximity search so that it can use the main group filter (currently smart groups don't work)
b) add the UI option of specifying lat & long rather than an address where preferred (not all coordinates have an address!)