LocationBundle¶
The SuluLocationBundle provides services related to maps and geolocation.
Configuration¶
# Default configuration for extension with alias: "sulu_location"
sulu_location:
geolocator: ~ # One of "nominatim"; "google"
geolocators:
nominatim:
api_key: ''
endpoint: 'https://nominatim.openstreetmap.org/search'
google:
api_key: ''
Services¶
Geolocators¶
The Geolocator services in the map bundle provide a common API to geocoding services, in particular for obtaining address information from user searches.
Geolocators are PHP services and can be found in the Geolocator/Service
namespace.
Nominatim¶
Note
Nominatim (from the Latin, ‘by name’) is a tool to search OSM data by name and address and to generate synthetic addresses of OSM points (reverse geocoding)
There are several available Nominatim providers that can be configured via the endpoint
configuration.
Some of them might require an authentication token that can be configured via the api_key
configuration.
Have a look at the OpenStreetMap Wiki for an up-to-date list of providers.
Configuration:
endpoint
: The endpoint to use (eg.http://open.mapquestapi.com/nominatim/v1/search.php
for the Mapquest provider)api_key
: Authentication key for the configured Nominatim endpoint. (Can be created via Developer portal of Mapquest for the Mapquest provider).
Google Maps¶
Google geocoding API.
Configuration:
api_key
: Create the api-key in the Google Cloud Console