Added component filtering for geocoding to better restrict by area, added callbackGeocodeRestrictions callback that allows the componentRestrictions object to be overridden

Author: bjorn2404

callbacks.md

@@ -33,6 +33,7 @@ $('#bh-sl-map-container').storeLocator({
 | [callbackNotify](callbacks/callback-notification.md) | Notification callback |
 | [callbackRegion](callbacks/callback-region.md) | Region callback |
 | [callbackFormVals](callbacks/callback-formvals.md) | Form values callback |
+| [callbackGeocodeRestrictions](callbacks/callback-geocode-restrictions.md) | Geocoding component restrictions callback |
 | [callbackBeforeSend](callbacks/callback-beforesend.md) | Before location data request callback |
 | [callbackDirectionsRequest](callbacks/callback-directionsrequest.md) | Directions request callback |
 | [callbackCloseDirections](callbacks/callback-closedirections.md) | Close directions callback |

callbacks/callback-geocode-restrictions.md

@@ -0,0 +1,14 @@
+# callbackGeocodeRestrictions
+
+## Description
+
+Allows the geocoding restrictions object to be overridden. This object gets passed to the [componentRestrictions parameter](https://developers.google.com/maps/documentation/javascript/geocoding#ComponentFiltering)
+when geocoding.
+
+## Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| addressInput | string | User address input |
+| searchInput | string | User name search input when using nameSearch setting |
+| distance | string | User distance selection when using maxDistance setting |

dist/assets/js/plugins/storeLocator/jquery.storelocator.js

@@ -1,4 +1,4 @@
-/*! jQuery Google Maps Store Locator - v2.7.5 - 2018-02-11
+/*! jQuery Google Maps Store Locator - v2.7.5 - 2018-02-12
 * http://www.bjornblog.com/web/jquery-store-locator-plugin
 * Copyright (c) 2018 Bjorn Holine; Licensed MIT */
 
@@ -100,6 +100,7 @@
 		'callbackNotify'             : null,
 		'callbackRegion'             : null,
 		'callbackFormVals'           : null,
+		'callbackGeocodeRestrictions': null,
 		'callbackBeforeSend'         : null,
 		'callbackSuccess'            : null,
 		'callbackModalOpen'          : null,
@@ -1520,6 +1521,7 @@
 			this.writeDebug('processForm',arguments);
 			var _this = this,
 				distance = null,
+				geocodeRestrictions = {},
 				$addressInput = $('#' + this.settings.addressID),
 				$searchInput = $('#' + this.settings.searchID),
 				$distanceInput = $('#' + this.settings.maxDistanceID),
@@ -1586,6 +1588,19 @@
 				this.settings.callbackFormVals.call(this, addressInput, searchInput, distance, region);
 			}
 
+			// Add component restriction if the region has been set.
+			if (typeof region !== 'undefined') {
+				geocodeRestrictions = {
+					country: region
+				};
+			}
+
+			// Component restriction value via callback.
+			if (typeof this.settings.callbackGeocodeRestrictions === 'function') {
+				// Component restriction override callback
+				geocodeRestrictions = this.settings.callbackGeocodeRestrictions.call(this, addressInput, searchInput, distance);
+			}
+
 			if (addressInput === '' && searchInput === '' && this.settings.autoGeocode !== true) {
 				this._start();
 			}
@@ -1603,7 +1618,11 @@
 				}
 				else {
 					var g = new this.googleGeocode(this);
-					g.geocode({'address': addressInput, 'region': region}, function (data) {
+					g.geocode({
+						address: addressInput,
+						componentRestrictions: geocodeRestrictions,
+						region: region
+					}, function (data) {
 						if (data !== null) {
 							olat = data.latitude;
 							olng = data.longitude;

dist/assets/js/plugins/storeLocator/jquery.storelocator.min.js

@@ -39,7 +39,9 @@ filtering.
 
 * Added callbackAutoGeoSuccess callback that fires after the geolocation API returns a successful result.
 * Added callbackFormVals callback that fires after the form values have been processed from the form.
-* Added callbackNearestLoc that fires when the nearest location is triggered with the openNearest setting.
+* Added callbackGeocodeRestrictions callback that allows the componentRestrictions object to be overridden.
+* Added callbackNearestLoc callback that fires when the nearest location is triggered with the openNearest setting.
+* Added component filtering for geocoding to better restrict by area.
 * Added openNearest setting to open/select the nearest location after searching.
 * Fixed issue with featuredLocations setting where featured locations at far distances would trigger distance alert.
 * Fixed issue with filtering values containing ampersands, which would not display any results - updated filtering regex.

readme.md

@@ -96,6 +96,7 @@
 		'callbackNotify'             : null,
 		'callbackRegion'             : null,
 		'callbackFormVals'           : null,
+		'callbackGeocodeRestrictions': null,
 		'callbackBeforeSend'         : null,
 		'callbackSuccess'            : null,
 		'callbackModalOpen'          : null,
@@ -1516,6 +1517,7 @@
 			this.writeDebug('processForm',arguments);
 			var _this = this,
 				distance = null,
+				geocodeRestrictions = {},
 				$addressInput = $('#' + this.settings.addressID),
 				$searchInput = $('#' + this.settings.searchID),
 				$distanceInput = $('#' + this.settings.maxDistanceID),
@@ -1582,6 +1584,19 @@
 				this.settings.callbackFormVals.call(this, addressInput, searchInput, distance, region);
 			}
 
+			// Add component restriction if the region has been set.
+			if (typeof region !== 'undefined') {
+				geocodeRestrictions = {
+					country: region
+				};
+			}
+
+			// Component restriction value via callback.
+			if (typeof this.settings.callbackGeocodeRestrictions === 'function') {
+				// Component restriction override callback
+				geocodeRestrictions = this.settings.callbackGeocodeRestrictions.call(this, addressInput, searchInput, distance);
+			}
+
 			if (addressInput === '' && searchInput === '' && this.settings.autoGeocode !== true) {
 				this._start();
 			}
@@ -1599,7 +1614,11 @@
 				}
 				else {
 					var g = new this.googleGeocode(this);
-					g.geocode({'address': addressInput, 'region': region}, function (data) {
+					g.geocode({
+						address: addressInput,
+						componentRestrictions: geocodeRestrictions,
+						region: region
+					}, function (data) {
 						if (data !== null) {
 							olat = data.latitude;
 							olng = data.longitude;