madeitbelgium/geocode-by-address

Laravel Geocode by address library

1.3.0 2022-06-09 18:24 UTC

This package is auto-updated.

Last update: 2024-10-09 23:28:34 UTC


README

Build Status Coverage Status Latest Stable Version Latest Unstable Version Total Downloads License

With this PHP (Laravel) package you can lookup GEO data by a given address.

Installation

Require this package in your composer.json and update composer.

composer require madeitbelgium/geocode-by-address
"madeitbelgium/geocode-by-address": "^1.0"

After updating composer, add the ServiceProvider to the providers array in config/app.php

MadeITBelgium\Geocode\ServiceProvider\Geocode::class,

You can use the facade for shorter code. Add this to your aliases:

'Geocode' => MadeITBelgium\Geocode\Facade\Geocode::class,

Publish the configuration

php artisan vendor:publish --provider="MadeITBelgium\Geocode\ServiceProvider\Geocode"

Documentation

Usage

use MadeITBelgium\Geocode\Geocode;

$geocode = new Geocode($type = 'geocode.xyz', $apikey = null, $client = null);
$geodata = $geocode->lookup('Nieuwstraat, Brussel, Belgium');
if($geodata !== false) {
    $latitude = $geodata[0];
    $longitude = $geodata[1];
}

In laravel you can use the Facade

use MadeITBelgium\Geocode\Facade\Geocode;
$geodata = Geocode::lookup('Nieuwstraat, Brussel, Belgium');
if($geodata !== false) {
    $latitude = $geodata[0];
    $longitude = $geodata[1];
}

Or you can use structured data structuredLookup($streetName, $streetNumber, $municipality, $postalCode, $country)

use MadeITBelgium\Geocode\Facade\Geocode;
$geodata = Geocode::structuredLookup('Nieuwstraat', '1', 'Brussel', '1000', 'Belgium');
if($geodata !== false) {
    $latitude = $geodata[0];
    $longitude = $geodata[1];
}

Supported types

Currently supported GEO data providers: Google: 'google' Geocode.xyz: 'geocode.xyz' TomTom: 'tomtom' Atention! when using structuredLookup you need to provide 2 or 3 letter country code!

The complete documentation can be found at: http://www.madeit.be/

Support

Support github or mail: tjebbe.lievens@madeit.be

Contributing

Please try to follow the psr-2 coding style guide. http://www.php-fig.org/psr/psr-2/

License

This package is licensed under LGPL. You are free to use it in personal and commercial projects. The code can be forked and modified, but the original copyright author should always be included!