Maps2 API 

Maps2 comes with some public methods which we have marked with @api. Use them to simplify your life within your extensions when working with maps2.

GeoCodeService 

getFirstFoundPositionByAddress 

Give it an address (string) as first argument and you will get first found address as Position object. If the geocoding service has nothing found or an error occurs this method will return null. There is no need to :php:rawurlencode the address as we will do it for you.

getPositionsByAddress 

Give it an address (string) as first argument and you will get all found results from geocoding service as Position object in an ObjectStorage.

MapService 

createNewPoiCollection 

Use it, if you have some location records in your extension and want to create a new PoiCollection relation automatically while saving your location record.

assignPoiCollectionToForeignRecord 

We have over 5 extensions working together with maps2 and we always have to implement a part to save the PoiCollection UID to our other extensions. Wouldn't it be better to have a centralized method doing that?

addForeignRecordsToPoiCollection 

This method is NOT public API. It will be called automatically, if you call getForeignRecords of a PoiCollection. It contains a SignalSlot where you can remove or modify foreignRecords before adding them to PoiCollection.

Example 

Here we have a working example out of our extension events2:

// create new map-record and set it in relation
$position = $this->googleMapsService->getFirstFoundPositionByAddress($this->getAddress($eventLocation));
if ($position instanceof Position) {
    $tsConfig = $this->getTsConfig($eventLocation);
    $this->googleMapsService->assignPoiCollectionToForeignRecord(
        $this->googleMapsService->createNewPoiCollection(
            (int)$tsConfig['pid'],
            $position,
            array(
                'title' => $eventLocation['location']
            )
        ),
        $eventLocation,
        'tx_events2_domain_model_location',
        'tx_maps2_uid'
    );
}
Copied!

MapRegistry 

getColumnRegistry 

Get the Maps2 registry as ColumnRegistrationStorage object for all tables, columns and its configuration.

We have added a service maps2.columnRegistry to Services.yaml which you can use for your extensions:

MyVendor\MyExtension\Service\MyService:
  arguments:
    $columnRegistry: '@maps2.columnRegistry'
Copied!