Addons by Reinos

Appearance

CP Overview ​

On the CP page you can modify a couple of things.

Settings ​

Reverse Geocode latlng ​

Reverse geocoding on latlng objects. This can take a while before all addresses are processed and can take your daily quota.

When disabled (the default), a latlng coordinate is saved as is. The address data of that location is looked up later, when the warmup-cache URL runs; the search_result tag doesn't look up addresses. Either way, reverse geocoding replaces the saved coordinate with the coordinate of the found address, see How it works.

Cache settings ​

You can use this warmup-cache URL for your CRON job to geocode all addresses that are not geocoded yet, so latlng locations get their address data (city, street, country, ...) in the search results.

For example, you can use a cron job that will run every day at 02:00. 0 2 * * *

The URL contains a secret token (available from v4.0.0), so only your cron job can run it: a request without the right token is refused. Keep the URL private.

Locations for which no address was found are marked as failed and are skipped by later runs.

Warmup Cache Count ​

The number of locations that are geocoded in one run of the warmup-cache URL (default 10). It's better to use a lower number and run the URL more often than a high number and run it less often. This avoids hitting the limits of the geocoding service.

Search settings ​

Searches per minute ​

Available from v4.0.0

The number of searches a visitor (IP address) can do per minute with the search form (default 20). Every search can be a request to the geocoding service, so this protects your quota. A visitor that does more searches gets an error until the minute has passed. Use 0 for no limit. The limit uses the ExpressionEngine cache, so it doesn't work when caching is disabled.

Search statistics ​

Available from v4.0.0

Keep the searches of the visitors for the Search statistics page (default Yes). Only the searched place, the city and country found by the geocoder, the radius, the categories, the number of results and the date are stored: no IP address or member, and the coordinates are rounded to 2 decimals (about 1 km).

Keep search statistics (days) ​

Available from v4.0.0

The searches older than this number of days are removed (default 365). Use 0 to keep them.

Logging Settings ​

Set what should be logged: only errors (default), Everything or Nothing. Geocoding errors are logged by the Maps module, in the Maps log.

Locations ​

An overview of the saved locations of the current site: the entry (the title linked to the entry, with its status, ID, channel and field), the address (with the country and coordinates) and the geocoding state (Geocoded, Failed, Not geocoded yet or Without coordinates). From here you can edit the entry or remove a single location.

Filter the locations on:

  • channel, status and field (the Maps Locator or Maps Fieldtype field, or the Grid field),
  • country,
  • geocoding: Failed (no address found), Not geocoded yet (waiting for the warmup cache), Without coordinates or Without country,
  • a keyword in the entry ID, title, city, street, postal code or searched location,

and choose the number of rows per page. Select locations to delete them at once, or choose Geocode again to look up their address again (e.g. filter on Failed first): a coordinate is reverse geocoded, an address geocoded. A location that is found again is replaced, the others stay marked as failed.

The page also has the following buttons:

  • Remove all locations: delete all saved locations of the current site.
  • Reindex All: rebuild the locations from all Maps Locator and Maps Fieldtype channel fields of your entries, and from Maps fields in a Grid or a Fluid field. The locations are replaced entry by entry, and at the end the locations of entries that no longer have a location are removed. The entries are reindexed in batches of 10, with a progress bar: keep the page open until it is done. When a batch fails (e.g. a timeout), the reindex stops with a Try again button that continues where it stopped; the entries it didn't reach keep their old locations.
  • Reindex missing entries: only add the locations that are missing, and look up the address of locations that don't have one yet (latlng locations only when Reverse Geocode latlng is enabled). Existing locations are kept.

Both reindex buttons ask for a confirmation first.

Search statistics ​

Available from v4.0.0

Where do visitors search, and where do they find nothing? The page shows the searches of the locator tag, the search_result tag and the JSON endpoint, with the number of searches, the searches without results and the places that were not found at the top.

  • Places (default): the searched places, the most searched first. A search with Use my location or Search this area has no text: it is shown as the area of its coordinate (Near 52.1, 5.1). Sort on Without results to see where visitors look for a location you don't have: a good place for a new store.
  • All searches: every search with the date, the searched place, the result (Found, Nearest shown, No results or Place not found), the number of results, the radius, the categories and the source. Select searches to delete them.

Nearest shown counts as a search without results: nothing was within the radius, the visitor saw the nearest locations instead.

Filter on the view, the result (Without results, Place not found or Found), the source (search form, locator tag or JSON endpoint), a period and a keyword in the searched place or city. Export downloads the filtered view as CSV, Delete all statistics deletes the statistics of the current site.

The same search of the same visitor is counted once in 10 minutes, so paging and reloading the result page don't count again. Searches are only kept when Search statistics is on in the settings.

Logging ​

The Logging page shows the log messages of the add-on. What is logged depends on the Logging Settings.

Filters, bulk delete and export ​

Available from v4.0.0

Filter the logs on the severity (error or notice), a period (e.g. the last 30 days or a custom date) or a keyword in the message, and choose how many logs are shown per page. The filters are kept when you sort or go to another page.

Delete logs one by one, select them with the checkboxes to delete them at once, or use Delete all logs to delete all logs of the current site. Export logs downloads the filtered logs as a CSV file (separated by ;).