Documentation

OpenStreetMap
in package

Configuration file: Config\Modules\OpenStreetMap.

Table of Contents

$coordinatesServer  : mixed
Name of connector to get coordinates.
$coordinatesServers  : mixed
List of available coordinate servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Search_engines Value: 'server name' => ['driverName' => 'Nominatim', 'apiUrl' => 'https://nominatim.openstreetmap.org', 'docUrl' => 'https://wiki.openstreetmap.org/wiki/Nominatim']
$cronMaxUpdatedAddresses  : int
Number of entries to be updated in one run of cron
$mapModules  : array<string|int, string>
Allow modules.
$mapPinFields  : array<string|int, mixed>
List of fields from which to show information in the map pin
$routingServer  : mixed
Name of connector to get routing.
$routingServers  : mixed
List of available routing servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Routing/online_routers Value: 'server name' => ['driverName' => 'xxx', 'apiUrl' => 'https://xxx.org', 'docUrl' => 'https://xxx', 'params' => []]
$tileLayerServer  : mixed
Tile layer url template, url used to load and display tile layers on the map.
$tileLayerServers  : mixed
List of available Tile layer servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Tile_servers Value: 'server name' => 'Tile layer url template'

Properties

$coordinatesServer

Name of connector to get coordinates.

public static mixed $coordinatesServer = 'Nominatim'

$coordinatesServers

List of available coordinate servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Search_engines Value: 'server name' => ['driverName' => 'Nominatim', 'apiUrl' => 'https://nominatim.openstreetmap.org', 'docUrl' => 'https://wiki.openstreetmap.org/wiki/Nominatim']

public static mixed $coordinatesServers = ['Nominatim' => ['driverName' => 'Nominatim', 'apiUrl' => 'https://nominatim.openstreetmap.org', 'docUrl' => 'https://wiki.openstreetmap.org/wiki/Nominatim']]

$cronMaxUpdatedAddresses

Number of entries to be updated in one run of cron

public static int $cronMaxUpdatedAddresses = 1000

$mapModules

Allow modules.

public static array<string|int, string> $mapModules = ['Accounts', 'Contacts', 'Competition', 'Vendors', 'Partners', 'Leads', 'Locations']

$mapPinFields

List of fields from which to show information in the map pin

public static array<string|int, mixed> $mapPinFields = ['Accounts' => ['accountname', 'email1', 'phone'], 'Leads' => ['company', 'firstname', 'lastname', 'email'], 'Partners' => ['subject', 'email'], 'Competition' => ['subject', 'email'], 'Vendors' => ['vendorname', 'email', 'website'], 'Contacts' => ['firstname', 'lastname', 'email', 'phone'], 'Locations' => ['subject', 'email']]

$routingServer

Name of connector to get routing.

public static mixed $routingServer = 'Osrm'

$routingServers

List of available routing servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Routing/online_routers Value: 'server name' => ['driverName' => 'xxx', 'apiUrl' => 'https://xxx.org', 'docUrl' => 'https://xxx', 'params' => []]

public static mixed $routingServers = ['Yours' => ['driverName' => 'Yours', 'apiUrl' => 'http://www.yournavigation.org/api/1.0/gosmore.php', 'params' => ['preference' => 'fastest', 'profile' => 'driving-car', 'units' => 'km']], 'Osrm' => ['driverName' => 'Osrm', 'apiUrl' => 'https://routing.openstreetmap.de/routed-car'], 'GraphHopper' => ['driverName' => 'GraphHopper', 'apiUrl' => 'https://graphhopper.com/api/1', 'params' => ['key' => 'b16b1d60-3c8c-4cd6-bae6-07493f23e589']]]

$tileLayerServer

Tile layer url template, url used to load and display tile layers on the map.

public static mixed $tileLayerServer = 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png'

$tileLayerServers

List of available Tile layer servers, free list of servers is available on page https://wiki.openstreetmap.org/wiki/Tile_servers Value: 'server name' => 'Tile layer url template'

public static mixed $tileLayerServers = ['OpenStreetMap Default' => 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png', 'OpenStreetMap HOT' => 'https://{s}.tile.openstreetmap.fr/hot/{z}/{x}/{y}.png', 'Esri WorldTopoMap' => 'https://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer/tile/{z}/{y}/{x}', 'Esri WorldImagery' => 'https://server.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer/tile/{z}/{y}/{x}']

        

Search results