sasrlocke / geocoderlaravel

Geocoder service provider for Laravel 4 & 5

Geocoder for Lavarel 5

If you still use Lavarel 4, please check out the 0.4.x branch here.

This package allows you to use Geocoder in Laravel 5.

Installation

It can be found on Packagist. The recommended way is through composer.

Edit composer.json and add:

{
    "require": {
        "toin0u/geocoder-laravel": "@stable"
    }
}

Protip: you should browse the toin0u/geocoder-laravel page to choose a stable version to use, avoid the @stable meta constraint.

And install dependencies:

$ composer update

If you do not have Composer installed, run these two commands:

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install

Usage

Find the providers array key in config/app.php and register the Geocoder Service Provider.

'providers' => array(
    // ...

    'Toin0u\Geocoder\GeocoderServiceProvider',
)

Find the aliases array key in config/app.php and register the Geocoder Facade.

'aliases' => array(
    // ...

    'Geocoder' => 'Toin0u\Geocoder\Facade\Geocoder',
)

Configuration

Publish and edit the configuration file

$ php artisan vendor:publish --provider="toin0u/geocoder-laravel"

The service provider creates the following services:

• geocoder: the Geocoder instance.
• geocoder.chain: the chain provider used by Geocoder.
• geocoder.adapter: the HTTP adapter used to get data from remotes APIs.

By default, the geocoder.chain service contains GoogleMapsProvider and FreeGeoIpProvider. The geocoder.adapter service uses the cURL adapter. Override these services to use the adapter/providers you want by editing config/geocoder.php:

return array(
    'providers' => array(
        'Geocoder\Provider\GoogleMapsProvider' => array('my-locale', 'my-region', $ssl = true, 'my-api-key'),
        'Geocoder\Provider\GoogleMapsBusinessProvider' => array(
            'my-client-id', 'my-api-key', 'my-locale', 'my-region', $ssl = true
        ),
        'Geocoder\Provider\CloudMadeProvider'  => array('my-api-key'),
        'Geocoder\Provider\FreeGeoIpProvider'  => null, // or array()
        // ...
    ),
    'adapter'  => 'Geocoder\HttpAdapter\CurlHttpAdapter'
);

NB: As you can see the array value of the provider is the constructor arguments.

See the Geocoder documentation for a list of available adapters and providers.

Example with Facade

<?php

// ...
try {
    $geocode = Geocoder::geocode('10 rue Gambetta, Paris, France');
    // The GoogleMapsProvider will return a result
    var_dump($geocode);
} catch (\Exception $e) {
    // No exception will be thrown here
    echo $e->getMessage();
}

Changelog

See the CHANGELOG file

Support

Please open an issue on GitHub

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

GeocoderLaravel is released under the MIT License. See the bundled LICENSE file for details.