geocoder-php/algolia-places-provider

Geocoder AlgoliaPlaces adapter

0.4.0 2022-07-30 12:09 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• geocoder-php/common-http: ^4.1
• willdurand/geocoder: ^4.0

Requires (Dev)

• geocoder-php/provider-integration-tests: ^1.1
• php-http/curl-client: ^2.2
• php-http/message: ^1.0
• phpunit/phpunit: ^9.5

Provides

• geocoder-php/provider-implementation: 1.0

MIT

• Fabien Lalanne

README

This is the Algolia Places provider from the PHP Geocoder. This is a READ ONLY repository. See the main repo for information and documentation.

Install

composer require geocoder-php/algolia-places-provider

Usage

The Algolia Places API allows up to 1000 free requests per day (per IP) without authentication.

By signing up for an account you can make 100,000 requests per month (~3000 a day).

See: https://community.algolia.com/places/pricing.html

Locales

You should set a locale on the query. If it is missing, results may not be as complete for non english speaking countries.

use Geocoder\Query\GeocodeQuery;
use Geocoder\Query\ReverseQuery;

$httpClient = new \Http\Discovery\Psr18Client();

// Unauthenticated
$provider = new \Geocoder\Provider\AlgoliaPlaces\AlgoliaPlaces($httpClient);
// Authenticated
$provider = new \Geocoder\Provider\AlgoliaPlaces\AlgoliaPlaces($httpClient, '<your-key>', '<your-app-id>');

$geocoder = new \Geocoder\StatefulGeocoder($provider, 'en');

$result = $geocoder->geocodeQuery(GeocodeQuery::create('Paris')->withLocale('fr-FR'));

Contribute

Contributions are very welcome! Send a pull request to the main repository or report any issues you find on the issue tracker.