BazingaGeocoderBundle

Integration of the Geocoder library into Symfony2.

Installation

Using Composer, just add the following configuration to your composer.json:

{
    "require": {
        "willdurand/geocoder-bundle": "*"
    }
}

Register the bundle in app/AppKernel.php:

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

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.

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()
    {
        // Retrieve information from the current user (by its IP address)
        $result = $this->geocoder
            ->using('yahoo')
            ->geocode($this->getRequest()->server->get('REMOTE_ADDR'));

        // Find the 5 nearest objects 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 parameter.

# 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.

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:

• Geojson
• GPX
• KMP
• WKB
• WKT

Here is an example:

<?php

public function geocodeAction()
{
    $result = $this->container->get('bazinga_geocoder.geocoder')
        ->geocode($this->container->get('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 automaticly.

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:

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.

Reference Configuration

You have to 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:    999.999.999.999
    adapter:
        class:  \Your\CustomAdapter
    providers:
        bing_maps:
            api_key:    XXXXXXXXX
            locale:     xx_XX
        google_maps:
            locale:     xx_XX
            region:     xx_XX
        ip_info_db:
            api_key:    XXXXXXXXX
        yahoo:
            api_key:    XXXXXXXXX
            locale:     xx_XX
        cloudmade:
            api_key:    XXXXXXXXX
        free_geo_ip: ~
        openstreetmaps:
            locale:     xx_XX
        host_ip: ~
        geoip: ~
        mapquest: ~
        oiorest: ~
        geocoder_ca: ~
        geocoder_us: ~
        ign_openls:
            api_key:    XXXXXXXXX
        data_science_toolkit: ~
        yandex:
            locale:     xx-XX
            toponym:    XXXXXXXXX
        geo_ips: 
            api_key:    XXXXXXXXX
        geo_plugin: ~
        maxmind:
            api_key:    XXXXXXXXX
        # Caching Layer
        cache:
            provider: openstreetmaps
            adapter:  some_service_id
            lifetime: 86400
            locale:   %locale%
        chain:
            providers: [free_geo_ip, host_ip]

Credits

• William Durand william.durand1@gmail.com
• All contributors

License

See Resources/meta/LICENSE.