Skip to content

Latest commit

 

History

History
98 lines (77 loc) · 2.47 KB

advanced-usage.md

File metadata and controls

98 lines (77 loc) · 2.47 KB
Raw

Advanced Configuration

Configure Geocodable Service

For now, there are two implementations for GeocodeServiceInterface:

  • GoogleGeocodeService (default)
  • MapboxGeocodeService

To change the service use your local config:

---
Name: your-local-addressable-config
After:
  - 'addressable'
---

SilverStripe\Core\Injector\Injector:
  Symbiote\Addressable\GeocodeServiceInterface:
    class: Symbiote\Addressable\MapboxGeocodeService

Then configure your service related settings:

# For using Google Maps
Symbiote\Addressable\GoogleGeocodeService:
  google_api_url: 'https://maps.googleapis.com/maps/api/geocode/xml' # This is already defined as the default value.
  google_api_key: 'API_KEY_HERE' # Recommended! You will hit quota limit issues in production without this!

# For using Mapbox
Symbiote\Addressable\MapboxGeocodeService:
  mapbox_api_url: 'https://api.mapbox.com/geocoding/v5/mapbox.places/' # This is already defined as the default value.
  mapbox_api_key: 'API_KEY_HERE' # Recommended! You will hit quota limit issues in production without this!

Change regex to validate postcode

Symbiote\Addressable\Addressable:
  postcode_regex: '/^[0-9A-Za-z]+$/'

Lock to 1 country or state

You can lock down Addressable to only use 1 country or 1 state by configuring it as shown below. When you only have 1 country or 1 state, the Country or State field will be automatically populated when a new record is created. (Before it's even written)

Global setting (affects all DataObjects using Addressable)

Symbiote\Addressable\Addressable:
  allowed_countries:
    au: 'Australia'
  allowed_states:
    vic: 'Victoria'

Local setting (affects the targetted DataObjects)

You can also change what countries and states are available on a per-DataObject level like so:

Page:
  extensions:
    - Symbiote\Addressable\Addressable
  allowed_countries:
    au: 'Australia'
  allowed_states:
    vic: 'Victoria'

Configure multiple countries or states

Global setting (affects all DataObjects using Addressable)

Symbiote\Addressable\Addressable:
  allowed_countries:
    au: 'Australia'
    nz: 'New Zealand'
  allowed_states:
    vic: 'Victoria'
    nsw: 'New South Wales'

Local setting (affects the targetted DataObjects)

Page:
  extensions:
    - Symbiote\Addressable\Addressable
  allowed_countries:
    au: 'Australia'
    nz: 'New Zealand'
  allowed_states:
    vic: 'Victoria'
    nsw: 'New South Wales'