GoogleStoreLocator

Proximity search of Stores based on the Google API.

The "Google Store Locator" enables a proximity search for your stores/locations on your MODX-Site. Find and filter Stores/Locations by distance and provide users to find the closest store of their current position or address. GoogleStoreLocator can be easily integrated into your website and is fully customizable by chunks and styles. Just install it via the Package-Manager and place the snippet-call in your "Store-Finder" Site-Template. Place the Placeholders for the Store-List, Map and Search-Form wherever you want them to appear.

To add a store, simply add the GoogleStoreLocator TVs to your Store-Template or define custom TVs for the address and add a new Resource as a new store. Create the Store-Resources as childs of your Stores-Search-Site or set the Parent-IDs with the "&parents" property.

API-KEY

Since the latest version of Google-API: API-KEY(s) are required! Create a API-KEY and set it in Systemsettings: https://console.developers.google.com/

System Settings

Properties

Template Properties

Map Properties

Placeholders

Store Template Placeholders

Examples

A simple Example of the minimum SnippetCall

[[!GoogleStoreLocator]]
[[!+gsl.form]]
[[!+gsl.map]]
[[!+gsl.message]]
[[!+gsl.stores]]

A simple Example of changing the default TVs for the Adresss:

[[!GoogleStoreLocator?
    &tvNameZipcode=`yourTvName`
    &tvNameCity=`yourTvName`
    &tvNameStreet=`yourTvName`
    &tvNameHousenumber=`yourTvName`
    &tvNameState=`yourTvName`
    &tvNameCountry=`yourTvName`
]]
[[!+gsl.form]]
[[!+gsl.map]]
[[!+gsl.stores]]

Using the extra getPage for pagination:

[[!getPage?
    &element=`GoogleStoreLocator`
    &totalVar=`gsl.totalResult`
]]

Preordering the stores by the location "Berlin" and show only stores inside the radius of 100km. Also filtering all stores by the TV "storeType" set to "flagstore".

[[!GoogleStoreLocator?
    &location=`Berlin, Germany`
    &radius=`100`
    &where=`{"storeType:=":"flagstore"}`
]]

Issues

If you have more than 50 stores the initail rendering of all stores will take a long time. Because the Google-API can only handle single addresses, the initial rendering will probably cause some server timeouts. The best way to handle this is just to wait a about 1 Minut and refresh the browser. After this refresh all stores should be rendert and stored inside the cache. I tested the extra with about 1500 stores. The first rendering took about 4 refreshes and 1 Minute in between every refresh. After that: everything runs smooth. Change a store/resource in the manager will delete this store from the cache and will be rewritten after the next request of the StoreLocation snippet. This won't take long, because it is just rendering the new added or changed stores. If you manually clear the complete site-cache it also clears the GoogleStoreLocator cache and it needs a new rendering of all stores.

Upgrading from Version 1.x to 2.x

Upgrading from Version 1.x to 2.x needs some little Changes in the propertie-setup.

1. the propertie &tvNameZip changed to &tvNameZipcode
2. the tv gslZip changed to gslZipcode. If you used the default tv's, just add the propertie &tvNameZipcode="gslZip" to the snippetcall. That way you can still use the old tv.
3. The gslHousenumber tv is added in 2.x. IN 1.x you just write the housenumber in the gslStreet tv. You still can do that. So just ignore the housenumber-tv and leave it blank or better just disable it from your store-template. Now everything should work as before.