b13/geocoding

Services for using geocoding from Google inside TYPO3 database records

v5.0.0 2024-05-16 10:20 UTC

Requires

• php: ^8.1
• typo3/cms-core: ^11.5 || ^12.4

GPL-2.0-or-later

• typo3
• TYPO3 CMS
• Google Geocoding

README

Provides services for querying Google Maps GeoCoding API v3 in your own extensions.

• Extension Key: geocoding
• Author: Benjamin Mack, b13 GmbH, 2012-2024
• Licensed under: GPLv2+
• Requires TYPO3 11+ and PHP 8.1 (see older versions of EXT:geocoding for support for previous TYPO3 versions)
• All code can be found and developed on github: https://github.com/b13/geocoding/

Introduction

This extension provides an abstract way to get geo coordinates of addresses around the world. "Geocoding" let you fetch information about an address and stores it in the DB, by using the TYPO3 Caching Framework.

Installation

Use composer req b13/geocoding or install it via TYPO3's Extension Manager from the TYPO3 Extension Repository using the extension key geocoding.

Configuration

Fetch a Google API key (https://code.google.com/apis/console) and add it to the extension configuration info in the Extension Manager. For more information see here: https://developers.google.com/maps/documentation/geocoding/?hl=en

How to use

Inject the class in your TYPO3 extension. In the rare case, that you cannot use dependency injection, GeneralUtility::makeInstance() works as well.

GeoService

The extension provides the GeoService, a PHP service class to fetch latitude and longitude for a specific address string.

GeoService->calculateCoordinatesForAllRecordsInTable

If you need to query user input, a JavaScript API is probably the best way to do so. However, it can be done via PHP as well, by calling GeoService->getCoordinatesForAddress($street, $zip, $city, $country)

$coordinates = $this->geoServiceObject->getCoordinatesForAddress('Breitscheidstr. 65', 70176, 'Stuttgart', 'Germany');

The method also caches the result of the query.

GeoService->calculateCoordinatesForAllRecordsInTable

The method GeoService->calculateCoordinatesForAllRecordsInTable($tableName, $latitudeField, $longitudeField, $streetField, $zipField, $cityField, $countryField, $addWhereClause) allows you to bulk-encode latitude and longitude fields for existing addresses. The call can easily be built inside a Scheduler Task (see example below).

This way you can fetch the information about an address of a DB record (e.g. tt_address) and store the data in the database table, given that you add two new fields latitude and longitude to that target table in your extension (no TCA information required for that).

Example: Using GeoService as a Scheduler Task for tt_address

Put this into EXT:my_extension/Classes/Task/GeocodingTask.php:

<?php
namespace MyVendor\MyExtension\Task;

/**
 * Class to be called by the scheduler to
 * find geocoding coordinates for all tt_address records
 */
class GeocodingTask extends \TYPO3\CMS\Scheduler\Task\AbstractTask
{
    /**
     * Function executed from the Scheduler.
     */
    public function execute()
    {
        /** @var \B13\Geocoding\Service\GeoService $geocodingService */
        $geocodingService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance(\B13\Geocoding\Service\GeoService::class);
        $geocodingService->calculateCoordinatesForAllRecordsInTable(
            'tt_address',
            'latitude',
            'longitude',
            'address',
            'zip',
            'city',
            'country'
        );
        return true;
    }
}

And also register this class within ext_localconf.php of your extension:

$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\MyVendor\MyExtension\Task\GeocodingTask::class] = [
    'extension'        => 'myextension',
    'title'            => 'Geocoding of address records',
    'description'      => 'Check all tt_address records for geocoding information and write them into the fields'
];

RadiusService

The other main service class is used for the calculating distances between two coordinates (RadiusService->getDistance(), and querying records from a DB table with latitude and longitude (works perfectly in conjunction with calculateCoordinatesForAllRecordsInTable()) given a certain radius and base coordinates.

Thanks / Contributions

Thanks go to

• The crew at b13, making use of these features
• Jesus Christ, who saved my life.

2013-07-05, Benni.