jguittard/zf-geocoder

Geocoder Service module for Zend Framework

Geocoder for Zend Framework

This package allows you to use Geocoder in Zend Framework., _(*1)

It is still compatible with Zend Framework 2 and 3 Service Manager., _(*2)

Requirements

Please see the composer.json file., _(*3)

Installation

Run the following composer command:, _(*4)

$ composer require "jguittard/zf-geocoder:~1.0"

Alternately, manually add the following to your composer.json, in the require section:, _(*5)

"require": {
    "jguittard/zf-geocoder": "~1.0"
}

And then run composer update to ensure the module is installed., _(*6)

Finally, add the module name to your project's config/application.config.php under the modules key:, _(*7)

return array(
    /* ... */
    'modules' => array(
        /* ... */
        'ZF\Geocoder',
    ),
    /* ... */
);

Or rely on Zend Component Installer to inject this module automatically, _(*8)

composer require zendframework/zend-composer-installer:^0.4

Configuration

Copy the config/zf.geocoder.local.php.dist to the config/autoload directory and remove the dist extension to jump start configuration., _(*9)

Usage

You can retrieve Geocoder documentation, _(*10)

The following will handle setup and service management within this Zend Framework module., _(*11)

First, make sure you have set up your configuration file by commenting out the provider(s) you'd like to use., _(*12)

For example, in config/autoload/zf.geocoder.local.php:, _(*13)

return [
    'geocoder' => [
        'httpAdapter' => '<SERVICE_KEY_OF_HTTP_ADAPTER>',
        'providers' => [
            'google_maps' => [
                'locale' => 'fr_FR',
                'region' => 'Île-de-France',
                'useSsl' => false,
            ],
        ],
    ],
];

Every provider is exposed as a service in the main Service Manager following the convention: Geocoder\<PROVIDER_NAME_IN_CAMELCASE> Such service will be an instance of corresponding Geocoder\Provider\<PROVIDER_NAME_IN_CAMELCASE> with appropriate configuration passed to its constructor, _(*14)

For example, in your controller:, _(*15)

public function localeAction()
{
    /* ... */
    $geocoder = $this->getServiceLocator()->get('Geocoder\GoogleMaps');
    $addressCollection = $geocoder->geocode('10 avenue Gambetta, Paris, France');
    /* ... */
}

Obviously, such a call is bad practice. You should consider injecting your Geocoder service in a dedicated service, not call it from a controller, _(*16)

Unit tests

Make sure dev dependencies are installed, _(*17)

composer install --dev

Run the unit tests, _(*18)

composer test

Code styling check, _(*19)

composer cs-check

Check both, _(*20)

composer check