BazingaGeocoderBundle

BazingaGeocoderBundle is a Symfony bundle that integrates the Geocoder library into the Symfony framework. It provides seamless integration with the Symfony profiler, allowing developers to monitor geocoding activities. Through the profiler, you can inspect:

• The number of queries executed by each provider.
• Total execution time for geocoding requests.
• The actual geocoding results returned by providers.

You can pass a request through multiple providers sequentially using the ChainFactory. This is useful for fallback mechanisms. In the options for the ChainFactory, provide a services array containing the service IDs (using Symfony's @ syntax) or the aliases defined for your individual providers.

bazinga_geocoder:
    providers:
        acme:
            aliases:
                - my_geocoder
            factory: Bazinga\GeocoderBundle\ProviderFactory\GoogleMapsFactory
            options:
                api_key: 'xxxx'
        acme_ii:
            factory: Bazinga\GeocoderBundle\ProviderFactory\TomTomFactory
            options:
                api_key: 'xxyy'
        chain:
            factory: Bazinga\GeocoderBundle\ProviderFactory\ChainFactory
            options:
                services: ['@my_geocoder', '@bazinga_geocoder.provider.acme_ii']

When developing locally, geocoding requests based on REMOTE_ADDR (like 127.0.0.1) often fail to return location data. You can use the fake_ip configuration to replace local IPs with a specific address.

• Simple usage: Set fake_ip to a string to replace 127.0.0.1.
• Advanced usage: Use local_ip to specify which IP should be replaced (default is 127.0.0.1) and ip for the replacement value.
• Faker integration: Set use_faker: true to have Faker generate a random IP.

# config/packages/bazinga_geocoder.yaml

when@dev:
    bazinga_geocoder:
        fake_ip: 123.123.123.123

# OR

when@dev:
    bazinga_geocoder:
        fake_ip:
            local_ip: 192.168.99.1
            ip: 123.123.123.123

# OR

when@dev:
    bazinga_geocoder:
        fake_ip:
            use_faker: true

The bundle supports any PSR-18 compatible HTTP client. While symfony/http-client is recommended for Symfony applications, you can use others like Guzzle by passing the service ID via the options.http_client key in your provider configuration.

services:
    guzzle.client:
        class: GuzzleHttp\Client

bazinga_geocoder:
    providers:
        acme:
            factory: ...
            options:
                http_client: '@guzzle.client'

To use a custom provider in your application, define it as a service in your Symfony configuration and tag it with bazinga_geocoder.provider. The bundle will automatically add this service to the Geocoder\ProviderAggregator service.

Note: Providers registered this way will function correctly in your code, but they will not appear in the Symfony Web Profiler.

<service id="acme_demo.geocoder.my_provider" class="Acme\Demo\Geocoder\Provider\MyProvider">
    <argument type="service" id="foo_service" />
    <tag name="bazinga_geocoder.provider" />
</service>

To install the bundle, first ensure you have installed the core Geocoder library and your desired providers. Then, install the bundle via Composer:

composer require willdurand/geocoder-bundle:^5.0

If you are not using Symfony Flex, you must manually register the bundle in your application configuration (e.g., config/bundles.php or app/AppKernel.php).

For older Symfony versions that do not natively support SimpleCache, you can install the cache/simple-cache-bridge to bridge PSR-6 and PSR-16.

1. Install the bridge: composer require cache/simple-cache-bridge

2. Use Cache\Bridge\SimpleCache\SimpleCacheBridge in your service definitions to wrap your PSR-6 cache.

If you prefer not to use the built-in CachePlugin, you can manually wrap your existing provider using the geocoder-php/cache-provider package. This follows the Decorator pattern, where you create a new service that wraps your original provider and a PSR-16 cache service.

1. Install the package: composer require geocoder-php/cache-provider

2. Define the cached service in your services.yaml, passing the original provider service ID, the cache service ID, and the lifetime as arguments.

composer require geocoder-php/cache-provider

# config/services.yaml
services:
    my_cached_geocoder:
        class: Geocoder\Provider\Cache\ProviderCache
        arguments: ['@bazinga_geocoder.provider.acme', '@any.psr16.service', 3600]