The almost missing Geocoder PHP library!

View the Project on GitHub geocoder-php/BazingaGeocoderBundle

BazingaGeocoderBundle

Build Status

Integration of the Geocoder library into Symfony2.

Installation

Require willdurand/geocoder-bundle to your composer.json file:

{
    "require": {
        "willdurand/geocoder-bundle": "@stable"
    }
}

Register the bundle in app/AppKernel.php:

// app/AppKernel.php
public function registerBundles()
{
    return array(
        // ...
        new Bazinga\Bundle\GeocoderBundle\BazingaGeocoderBundle(),
    );
}

Enable the bundle's configuration in app/config/config.yml:

# app/config/config.yml
bazinga_geocoder: ~

Usage

This bundle registers a bazinga_geocoder.geocoder service which is an instance of Geocoder. You'll be able to do whatever you want with it but be sure to configure at least one provider first.

NOTE: When using Request::getClientIp() with Symfony 2.1+, ensure you have a trusted proxy set in your config.yml:

# app/config/config.yml
framework:
    trusted_proxies: ['127.0.0.1']
    # ...

Killer Feature

You can fake the REMOTE_ADDR HTTP parameter through this bundle in order to get information in your development environment, for instance:

<?php

// ...

    /**
     * @Template()
     */
    public function indexAction(Request $request)
    {
        // Retrieve information from the current user (by its IP address)
        $result = $this->container
            ->get('bazinga_geocoder.geocoder')
            ->using('google_maps')
            ->geocode($request->server->get('REMOTE_ADDR'));

        // Find the 5 nearest objects (15km) from the current user.
        $objects = ObjectQuery::create()
            ->filterByDistanceFrom($result->getLatitude(), $result->getLongitude(), 15)
            ->limit(5)
            ->find();

        return array(
            'geocoded'        => $result,
            'nearest_objects' => $objects
        );
    }

In the example, we'll retrieve information from the user's IP address, and 5 objects nears him. But it won't work on your local environment, that's why this bundle provides an easy way to fake this behavior by using a fake_ip configuration.

# app/config/config_dev.yml
bazinga_geocoder:
    fake_ip:    123.345.643.133

If set, the parameter will replace the REMOTE_ADDR value by the given one.

Additionally if it interferes with your current listeners, You can set up different fake ip listener priority.

# app/config/config_dev.yml
bazinga_geocoder:
    fake_ip:
        ip: 123.345.643.133
        priority: 128

Dumpers

If you need to dump your geocoded data to a specific format, you can use the Dumper component. The following dumper's are supported:

Here is an example:

<?php

public function geocodeAction(Request $request)
{
    $result = $this->container
        ->get('bazinga_geocoder.geocoder')
        ->geocode($request->server->get('REMOTE_ADDR'));

    $body = $this->container
        ->get('bazinga_geocoder.dumper_manager')
        ->get('geojson')
        ->dump($result);

    $response = new Response();
    $response->setContent($body);

    return $response;
}

To register a new dumper, you must tag it with geocoder.dumper. Geocoder detect and register it automatically.

A little example:

<service id="some.dumper" class="%some.dumper.class">
    <tag name="geocoder.dumper" alias="custom" />
</service>

Cache Provider

Sometimes you have to cache the results from a provider. For this case the bundle provides a cache provider. The cache provider wraps another provider and delegate all calls to this provider and cache the return value.

Configuration example:

# app/config/config*.yml
services:
    acme_cache_adapter:
        class: "Doctrine\\Common\\Cache\\ApcCache"

bazinga_geocoder:
    providers:
        cache:
            adapter:  acme_cache_adapter
            provider: google_maps
        google_maps: ~

Tip: If you want to configure the cache adapter, we recommend the liip/doctrine-cache-bundle.

Symfony2 Profiler Integration

Geocoder bundle additionally integrates with Symfony2 profiler. You can check number of queries executed by each provider, total execution time and geocoding results.

Example Toolbar

Reference Configuration

You MUST define the providers you want to use in your configuration. Some of them need information (API key for instance).

You'll find the reference configuration below:

# app/config/config*.yml
bazinga_geocoder:
    fake_ip:
        enabled:              true
        ip:                   ~
        priority:             0
    adapter:
        class:                ~
    providers:
        bing_maps:
            api_key:              ~ # Required
            locale:               ~
        cache:
            adapter:              ~ # Required
            provider:             ~ # Required
            locale:               ~
            lifetime:             86400
        ip_info_db:
            api_key:              ~ # Required
        cloudmade:
            api_key:              ~ # Required
        google_maps:
            locale:               ~
            region:               ~
            use_ssl:              false
        google_maps_business:
            client_id:            ~ # Required
            api_key:              ~
            region:               ~
            use_ssl:              false
        openstreetmap:
            locale:               ~
        host_ip:              []
        geoip:                []
        free_geo_ip:          []
        mapquest:
            api_key:              ~ # Required
        oiorest:              []
        geocoder_ca:          []
        geocoder_us:          []
        ign_openls:
            api_key:              ~ # Required
        data_science_toolkit:  []
        yandex:
            locale:               ~
            toponym:              ~
        geo_ips:
            api_key:              ~
        geo_plugin:           []
        maxmind:
            api_key:              ~ # Required
        maxmind_binary:
            binary_file:          ~ # Required
            open_flag:            ~
        chain:
            providers:            []

Testing

Setup the test suite using Composer:

$ composer install --dev

Run it using PHPUnit:

$ phpunit

Credits

License

This bundle is released under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE