The most featured Geocoder library written in PHP.

Last update: Aug 9, 2022

Geocoder

Build Status Software License

Important: You are browsing the documentation of Geocoder 4.x.

Documentation for version 3.x is available here: Geocoder 3.x documentation.

Documentation for version 2.x is available here: Geocoder 2.x documentation.


Geocoder is a PHP library which helps you build geo-aware applications by providing a powerful abstraction layer for geocoding manipulations.

Installation

To install a Geocoder there are two things you need to know:

  1. What Geocoder provider you want to use
  2. What HTTP client/adapter you want to use.

Geocoder providers

Since 4.0 we do not include providers by default. You need to select a geocoder provider. You will see a list of providers at Packagist

HTTP Clients

In order to talk to geocoding APIs, you need HTTP adapters. While it was part of the library in Geocoder before, Geocoder 4.x and upper now relies on HTTPlug which defines how HTTP message should be sent and received. You can use any library to send HTTP messages that implements php-http/client-implementation.

Here is a list of all officially supported clients and adapters by HTTPlug: http://docs.php-http.org/en/latest/clients.html

Read more about HTTPlug in their docs.

Summary (Just give me the command)

To install Google Maps geocoder with Guzzle 6 you may run the following command:

$ composer require geocoder-php/google-maps-provider php-http/guzzle6-adapter

Or using the curl client (you'll need to provide a PSR7 implementation such as nyholm/psr7 if not using guzzle)

$ composer require geocoder-php/google-maps-provider php-http/curl-client nyholm/psr7

Framework integration

If you are using a framework then you may be interested in our excellent framework integrations.

Framework Package Stats
Laravel geocoder-php/GeocoderLaravel GitHub release Packagist
Symfony geocoder-php/BazingaGeocoderBundle Latest Stable Version Total Downloads

Cookbook

We have a small cookbook where you can find examples on common use cases:

Usage

In the code snippet below we use GoogleMaps and Guzzle6.

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

$httpClient = new \Http\Adapter\Guzzle6\Client();
$provider = new \Geocoder\Provider\GoogleMaps\GoogleMaps($httpClient, null, 'your-api-key');
$geocoder = new \Geocoder\StatefulGeocoder($provider, 'en');

$result = $geocoder->geocodeQuery(GeocodeQuery::create('Buckingham Palace, London'));
$result = $geocoder->reverseQuery(ReverseQuery::fromCoordinates(...));

The Provider interface has three methods:

  • geocodeQuery(GeocodeQuery $query):AddressCollection
  • reverseQuery(ReverseQuery $query):AddressCollection
  • getName():string

The Geocoder interface extends the Provider interface and exposes two additional methods. They will make migration from 3.x smoother.

  • geocode($streetOrIpAddress)
  • reverse($latitude, $longitude)

Providers

Providers perform the geocoding black magic for you (talking to the APIs, fetching results, dealing with errors, etc.) and are highly configurable.

Special providers

Provider Package Features Stats
Cache geocoder-php/cache-provider Wraps a provider and cached the results Latest Stable Version
Total Downloads
Chain geocoder-php/chain-provider Iterates over multiple providers Latest Stable Version
Total Downloads

Address

World

Provider Package Features Stats
Algolia Places geocoder-php/algolia-places-provider address
Website
Latest Stable Version
Total Downloads
ArcGIS Online geocoder-php/arcgis-online-provider address, reverse
Website
Latest Stable Version
Total Downloads
Azure Maps geocoder-php/azure-maps-provider address, reverse
Website
Latest Stable Version
Total Downloads
Bing Maps geocoder-php/bing-maps-provider address, reverse
Website
Latest Stable Version
Total Downloads
Geocode Earth geocoder-php/geocode-earth-provider address, reverse
Website
Latest Stable Version
Total Downloads
Geonames geocoder-php/geonames-provider address, reverse
Website
Latest Stable Version
Total Downloads
Google Maps
Google Maps for business
geocoder-php/google-maps-provider address, reverse
Website
Latest Stable Version
Total Downloads
Google Maps Places geocoder-php/google-maps-places-provider address, reverse
Website
Latest Stable Version
Total Downloads
GraphHopper geocoder-php/graphhopper-provider address, reverse
Website
Latest Stable Version
Total Downloads
Here geocoder-php/here-provider address, reverse
Website
Latest Stable Version
Total Downloads
LocationIQ geocoder-php/locationiq-provider address, reverse
Website
Latest Stable Version
Total Downloads
Mapbox geocoder-php/mapbox-provider address, reverse
Website
Latest Stable Version
Total Downloads
MapQuest geocoder-php/mapquest-provider address, reverse
Website
Latest Stable Version
Total Downloads
Nominatim
(OpenStreetMap)
geocoder-php/nominatim-provider address, reverse
Website
Latest Stable Version
Total Downloads
OpenCage geocoder-php/open-cage-provider address, reverse
Website
Latest Stable Version
Total Downloads
OpenRouteService geocoder-php/openrouteservice-provider address, reverse
Website
Latest Stable Version
Total Downloads
Pelias geocoder-php/pelias-provider address, reverse
Website
Latest Stable Version
Total Downloads
Photon geocoder-php/photon-provider address, reverse
Website
Latest Stable Version
Total Downloads
PickPoint geocoder-php/pickpoint-provider address, reverse
Website
Latest Stable Version
Total Downloads
TomTom geocoder-php/tomtom-provider address, reverse
Website
Latest Stable Version
Total Downloads
Yandex geocoder-php/yandex-provider address, reverse
Website
Latest Stable Version
Total Downloads

Local

Region Provider Package Features Stats
πŸ‡§πŸ‡ͺ bpost (third-party package*) geo6/geocoder-php-bpost-provider address
Website
Latest Stable Version
Total Downloads
πŸ‡§πŸ‡ͺ GeoPunt (third-party package*) geo6/geocoder-php-geopunt-provider address, reverse
Website
Latest Stable Version
Total Downloads
πŸ‡§πŸ‡ͺ Service Public de Wallonie (third-party package*) geo6/geocoder-php-spw-provider address, reverse
Website
Latest Stable Version
Total Downloads
πŸ‡§πŸ‡ͺ UrbIS (third-party package*) geo6/geocoder-php-urbis-provider address, reverse
Website
Latest Stable Version
Total Downloads
πŸ‡«πŸ‡· Addok (third-party package*) geo6/geocoder-php-addok-provider address, reverse
Website
Latest Stable Version
Total Downloads
πŸ‡±πŸ‡Ί Geoportail.lu (third-party package*) frantzmicccoli/geocoder-php-geoportail-lu address, reverse
Website
Latest Stable Version
Total Downloads
πŸ‡³πŸ‡± Nationaal Georegister (third-party package*) swisnl/geocoder-php-nationaal-georegister-provider address, reverse
Website
Latest Stable Version
Total Downloads

* Third-party package: Those providers are not official, i.e. not from the Geocoder core team.

IP

Provider Package Features Stats
FreeGeoIp geocoder-php/free-geoip-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
GeoIP geocoder-php/geoip-provider IPv4, local
Website
Latest Stable Version
Total Downloads
GeoIP2 geocoder-php/geoip2-provider IPv4
Website
Latest Stable Version
Total Downloads
GeoPlugin geocoder-php/geo-plugin-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
HostIp geocoder-php/host-ip-provider IPv4
Website
Latest Stable Version
Total Downloads
IP2Location geocoder-php/ip2location-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
IP2Location Binary geocoder-php/ip2location-binary-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
IpInfo geocoder-php/ip-info-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
IpInfoDB geocoder-php/ip-info-db-provider IPv4
Website
Latest Stable Version
Total Downloads
ipstack geocoder-php/ipstack-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
MaxMind geocoder-php/maxmind-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads
MaxMind Binary geocoder-php/maxmind-binary-provider IPv4, IPv6
Website
Latest Stable Version
Total Downloads

Other packages

There are two "abstract" or "base" packages that most providers depend on.

Name Package Features Stats
PHP common willdurand/geocoder Models, interfaces, exceptions etc Latest Stable Version
Total Downloads
HTTP common geocoder-php/common-http AbstractHttpProvider, HTTPlug Latest Stable Version
Total Downloads
Plugin geocoder-php/plugin Plugin provider Latest Stable Version
Total Downloads

Special Geocoders and Providers

The Chain Provider

The Chain provider is a special provider that takes a list of providers and iterates over this list to get information. Note that it stops its iteration when a provider returns a result. The result is returned by GoogleMaps because FreeGeoIp and HostIp cannot geocode street addresses. BingMaps is ignored.

use Geocoder\Query\GeocodeQuery;

$geocoder = new \Geocoder\ProviderAggregator();
$adapter  = new \Http\Adapter\Guzzle6\Client();

$chain = new \Geocoder\Provider\Chain\Chain([
    new \Geocoder\Provider\FreeGeoIp\FreeGeoIp($adapter),
    new \Geocoder\Provider\HostIp\HostIp($adapter),
    new \Geocoder\Provider\GoogleMaps\GoogleMaps($adapter, 'France'),
    new \Geocoder\Provider\BingMaps\BingMaps($adapter, '<API_KEY>'),
    // ...
]);

$geocoder->registerProvider($chain);

$result = $geocoder->geocodeQuery(GeocodeQuery::create('10 rue Gambetta, Paris, France'));
var_export($result);

Everything is ok, enjoy!

The ProviderAggregator

The ProviderAggregator is used to register several providers so that you can decide which provider to use later on.

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

$adapter  = new \Http\Adapter\Guzzle6\Client();
$geocoder = new \Geocoder\ProviderAggregator();

$geocoder->registerProviders([
    new \Geocoder\Provider\GoogleMaps\GoogleMaps($adapter),
    new \Geocoder\Provider\GoogleMaps\GoogleMapsBusiness($adapter, '<CLIENT_ID>'),
    new \Geocoder\Provider\Yandex\Yandex($adapter),
    new \Geocoder\Provider\MaxMind\MaxMind($adapter, '<MAXMIND_API_KEY>'),
    new \Geocoder\Provider\ArcGISOnline\ArcGISOnline($adapter),
]);

$geocoder->registerProvider(new \Geocoder\Provider\Nominatim\Nominatim($adapter, 'https://your.nominatim.server'));

$geocoder
    ->using('google_maps')
    ->geocodeQuery(GeocodeQuery::create( ... ));

$geocoder
    ->limit(10)
    ->reverseQuery(ReverseQuery::fromCoordinates($lat, $lng));

The ProviderAggregator's API is fluent, meaning you can write:

use Geocoder\Query\GeocodeQuery;

$locations = $geocoder
    ->registerProvider(new \My\Provider\Custom($adapter))
    ->using('custom')
    ->limit(10)
    ->geocodeQuery(GeocodeQuery::create( ... ));

The using() method allows you to choose the provider to use by its name. When you deal with multiple providers, you may want to choose one of them. The default behavior is to use the first one but it can be annoying.

The limit() method allows you to configure the maximum number of results being returned. Depending on the provider you may not get as many results as expected, it is a maximum limit, not the expected number of results.

TimedGeocoder

The TimedGeocoder class profiles each geocode and reverse call. So you can easily figure out how many time/memory was spent for each geocoder/reverse call.

use Geocoder\Query\GeocodeQuery;

// configure your provider
$provider = // ...

$stopwatch = new \Symfony\Component\Stopwatch\Stopwatch();
$geocoder = new \Geocoder\TimedGeocoder($provider, $stopwatch);

$geocoder->geocodeQuery(GeocodeQuery::create('Paris, France'));

// Now you can debug your application

We use the symfony/stopwatch component under the hood. Which means, if you use the Symfony framework the geocoder calls will appear in your timeline section in the Web Profiler.

StatefulGeocoder

The StatefulGeocoder class is great when you want your Geocoder to hold state. Say you want to configure locale, limit or bounds in runtime. The StatefulGeocoder will append these values on each query.

use Geocoder\Query\GeocodeQuery;

// configure your provider
$provider = // ...
$geocoder = new \Geocoder\StatefulGeocoder($provider);

$geocoder->setLocale('en');
$results = $geocoder->geocodeQuery(GeocodeQuery::create('London'));
echo $results->first()->getLocality(); // London

$geocoder->setLocale('es');
$results = $geocoder->geocodeQuery(GeocodeQuery::create('London'));
echo $results->first()->getLocality(); // Londres

Dumpers

Geocoder provides dumpers that aim to transform a Location object in standard formats.

GPS eXchange Format (GPX)

The GPS eXchange format is designed to share geolocated data like point of interests, tracks, ways, but also coordinates. Geocoder provides a dumper to convert a Location object in an GPX compliant format.

Assuming we got a $location object as seen previously:

$dumper = new \Geocoder\Dumper\Gpx();
$strGpx = $dumper->dump($location);

echo $strGpx;

It will display:

<gpx
    version="1.0"
    creator="Geocoder" version="1.0.1-dev"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.topografix.com/GPX/1/0"
    xsi:schemaLocation="http://www.topografix.com/GPX/1/0 http://www.topografix.com/GPX/1/0/gpx.xsd">
    <bounds minlat="2.388911" minlon="48.863151" maxlat="2.388911" maxlon="48.863151"/>
    <wpt lat="48.8631507" lon="2.3889114">
        <name><![CDATA[Paris]]></name>
        <type><![CDATA[Address]]></type>
    </wpt>
</gpx>

GeoJSON

GeoJSON is a format for encoding a variety of geographic data structures.

GeoArray

Simple PHP array format for using with your own encoders.

Keyhole Markup Language (KML)

Keyhole Markup Language is an XML notation for expressing geographic annotation and visualization within Internet-based, two-dimensional maps and three-dimensional Earth browsers.

Well-Known Binary (WKB)

The Well-Known Binary (WKB) representation for geometric values is defined by the OpenGIS specification.

Well-Known Text (WKT)

Well-known text (WKT) is a text markup language for representing vector geometry objects on a map, spatial reference systems of spatial objects and transformations between spatial reference systems.

Formatters

A common use case is to print geocoded data. Thanks to the StringFormatter class, it's simple to format a Location object as a string:

// $location is an instance of Location
$formatter = new \Geocoder\Formatter\StringFormatter();

$formatter->format($location, '%S %n, %z %L');
// 'Badenerstrasse 120, 8001 Zuerich'

$formatter->format($location, '<p>%S %n, %z %L</p>');
// '<p>Badenerstrasse 120, 8001 Zuerich</p>'

Here is the mapping:

  • Street Number: %n
  • Street Name: %S
  • City (Locality): %L
  • City District (Sub-Locality): %D
  • Zipcode (Postal Code): %z
  • Admin Level Name: %A1, %A2, %A3, %A4, %A5
  • Admin Level Code: %a1, %a2, %a3, %a4, %a5
  • Country: %C
  • Country Code: %c
  • Timezone: %T

Versioning

Geocoder follows Semantic Versioning.

End Of Life

1.x

As of December 2014, branch 1.7 is not officially supported anymore, meaning major version 1 reached end of life. Last version is: 1.7.1.

2.x

As of December 2014, version 2.x is in a feature frozen state. All new features should be contributed to version 3.0 and upper. Last version is: 2.8.1.

Major version 2 will reach end of life on December 2015.

3.x

As of January 2017, version 3.x is in a feature frozen state. All new features should be contributed to version 4.0 and upper. Last version is: 3.3.2.

Major version 3 will reach end of life on October 2017.

Stable Version

Version 4.x is the current major stable version of Geocoder.

Next version

There is no new major version planned at this time.

Contributing

See CONTRIBUTING file.

Unit Tests

In order to run the test suite, install the development dependencies:

$ composer install --dev

Then, run the following command:

$ composer test

You'll obtain some skipped unit tests due to the need of API keys.

Rename the phpunit.xml.dist file to phpunit.xml, then uncomment the following lines and add your own API keys:

<php>
    <!-- <server name="IPINFODB_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="BINGMAPS_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="GEOIPS_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="MAXMIND_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="GEONAMES_USERNAME" value="YOUR_USERNAME" /> -->
    <!-- <server name="TOMTOM_MAP_KEY" value="YOUR_MAP_KEY" /> -->
    <!-- <server name="GOOGLE_GEOCODING_KEY" value="YOUR_GEOCODING_KEY" /> -->
    <!-- <server name="OPENCAGE_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="PICKPOINT_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="LOCATIONIQ_API_KEY" value="YOUR_API_KEY" /> -->
    <!-- <server name="IPSTACK_API_KEY" value="YOUR_API_KEY" /> -->
</php>

You're done.

Credits

License

Geocoder is released under the MIT License. See the bundled LICENSE file for details.

GitHub

https://github.com/geocoder-php/Geocoder
Comments
  • 1. Refactor providers to leverage ResultFactories - fix #232

    • [x] FreeGeoIpProvider
    • [x] HostIpProvider
    • [x] IpInfoDbProvider
    • [x] YahooProvider (REMOVED)
    • [x] GoogleMapsProvider
    • [x] GoogleMapsBusinessProvider
    • [x] BingMapsProvider
    • [x] OpenStreetMapsProvider
    • [x] CloudMadeProvider
    • [x] GeoipProvider
    • [x] MapQuestProvider
    • [x] OIORestProvider
    • [x] GeocoderCaProvider
    • [x] GeocoderUsProvider
    • [x] IGNOpenLSProvider
    • [x] DataScienceToolkitProvider
    • [x] YandexProvider
    • [x] GeoPluginProvider
    • [x] GeoIPsProvider
    • [x] MaxMindProvider
    • [x] MaxMindBinaryProvider
    • [x] GeonamesProvider
    • [x] IpGeoBaseProvider
    • [x] BaiduProvider
    • [x] TomTomProvider
    • [x] ArcGISOnlineProvider

    @willdurand @Baachi What do you think ?

    Reviewed by toin0u at 2013-05-14 21:46
  • 2. Website documentation is out of date

    The website is still showing the documentation for the 3.x major version, as well as a very outdated provider list.

    http://geocoder-php.org/Geocoder/

    I think we should either update the site (and have it automatically be re-built/deployed using CI on merge to master) or direct users to the github repo.

    I'll to look into it and create a PR when I have a chance.

    Reviewed by atymic at 2019-08-15 06:11
  • 3. Creating interfaces to be more SOLID

    This PR relates to #523

    To be more SOLID our value objects should have interfaces. This will allow others to write providers that may return more data than we have defined in our models.

    This is WIP because Im not happy with the *Interface suffix. We need to come up with better names. Or, are we happy with names like AddressInterface?

    This PR also removes the toString function in favor for __toString

    TODO

    • [x] Be confident with the interface names
    • [x] Update changelog
    Reviewed by Nyholm at 2016-09-08 14:57
  • 4. MapQuest improvement

    This is an improvment to the MapQuest provider, that we talked about in #839

    I have tried to stay away from the code in the Common directory, but I could not avoid some small minor changes there to make it all fit together. Hope this will be ok.

    Reviewed by TerjeBr at 2018-04-03 15:52
  • 5. [provider] MaxMind binary provider.

    This providers would allow to geolocation info from MaxMind`s .dat files. A developer should install MaxMind's php lib himself and include it.

    I want to know Is it really possiblt to add such provider to a lib? If so we can discuss what should be added (tests\docs for example).

    UPDATED

    tests and doc is updated, The PR is ready to merge.

    Reviewed by makasim at 2013-05-06 10:45
  • 6. Use numbered administrative level instead of named one

    PR for for ticket #392. To sum up: replace every occurrence of region and county (no "r"), with a generic admin level array.

    TODOs:

    • [x] delete Region and County from Model namespace;
    • [x] add Admin to Model namespace;
    • [x] update failing test for Providers;
    • [x] fix all providers code;
    • [x] update string formatter;
    • [x] update documentation;
    • [x] squash all commit :)
    • [x] update all tests (USE_CACHED_RESPONSES=false)

    I'll like to hear you feedback about:

    1. [minor] In AbstractProvider::getDefaults the admins value defaults to [] to simplify a bit the code. Is it ok?
    2. Is Admin a clear class name or it is better to call it AdminLevel (as in #392)?
    3. I'm using a simple array for admin levels, where the index is the "depth" in the hierarchy. Is this enough for you?
    4. string formatter is now using %R and %P for Region and County, but this no longer make sense. What should be used? %A1, %A2,%A3,%A4? %A0, %A1, %A2,%A3 (as the array index, not the admin level)? %X, %Y,%Z,%W (as in math :)? Something else?
    Reviewed by giosh94mhz at 2015-01-12 10:33
  • 7. Add support for different MaxMind Services

    I'm not sure when MaxMind made the change, but they've split out their web services in to different service offerings, with different credits required for each and different result orders.

    http://dev.maxmind.com/geoip/web-services

    I added an additional parameter to the MaxMindProvider that indicates the service, and then properly parsed and validated the different results.

    I've been able to test the 'City/ISP/Org' API and the 'Omni' API, but I don't have credits for the rest.

    Additionally, they added support for IPv6.

    Reviewed by lox at 2013-01-15 23:51
  • 8. Implement first idea of the cache provider

    Hey guys,

    PSR6 has been released weeks ago and so we have a standard for caching. The feature has been wished thousand times so i started to work on it. Currently this is only a proof of concept and i will finished it if we all fine with the idea.

    My intention is currently: We provide multple strategies and the user can decide how he wants to cache the response. Currently i wrote the stale-if-error strategy and the expire strategy, because i think these are the most common behaviours.

    Please provide feedback :smile:

    Reviewed by Baachi at 2016-01-18 22:38
  • 9. CacheProvider

    Hey William,

    The library is really popular (971 Stars on GitHub and 37063 Downloads on Packagist), which is really :cool: . But i think geocoder has a missing feature, caching.

    I created already a CacheProvider in the BazingaGeocoderBundle, so i would suggest to move this provider to the core library.

    What do you think about this change?

    Reviewed by Baachi at 2013-08-08 12:11
  • 10. NoResultException thrown with supplied example

    Hi,

    This project is just great, I'm looking forward to use the propel behavior. But first, a simple try does not work, i did this:

    <?php
                                                    $geocoder = new \Geocoder\Geocoder();
                                                    $adapter = new \Geocoder\HttpAdapter\SocketHttpAdapter();
    
                                                    $geocoder->registerProviders(array(
                                                        new \Geocoder\Provider\GoogleMapsProvider($adapter, 'API_KEY'),
                                                    )); // yes i changed API_KEY by mine
    
    // IP based
                                                    // Street address based
    $result = $geocoder->geocode('10 rue Gambetta, Paris, France');
                                                    var_dump($result);
                                                    ?>
    

    I have this result:

    Geocoder\Exception\NoResultException
    
    Could not execute query http://maps.googleapis.com/maps/api/geocode/json?address=10%20rue%20Gambetta%2C%20Paris%2C%20France&sensor=false&language=API_KEY
    

    But if, i type this link in my browser, I do have a result. Is that normal?

    Reviewed by ghost at 2013-01-09 19:35
  • 11. [GoogleMapsBusinessProvider] client id should be client_id

    I see where there have been previous issues with this. But as it stands with 2.4.1 the current use of "client=" is incorrect.

    For me, if I change it to client_id it works:

    http://maps.googleapis.com/maps/api/geocode/json?address=31.4789%20-97.0926&sensor=false&client_id=<my_client_id>

    Reviewed by JordanDalton at 2013-12-17 04:51
  • 12. How do I change the OpenRouteService::API_URL for "On-Premise" install of software

    I noticed the OpenRouteService::API_URL is being hard-coded into file Geocoder\Provider\OpenRouteService (vendor\geocoder-php\openrouteservice-provide\OpenRouteService.php)

    Could someone please push the following code into the next version of OpenRouteService (updating Pelias would do the trick)

    vendor\geocoder-php\pelias-provider\Pelias.php

    /**
     * @param HttpClient $client  an HTTP adapter
     * @param string     $root    url of Pelias API
     * @param int        $version version of Pelias API
     */
    public function __construct(HttpClient $client, string $root, int $version = 1)
    {
        $this->_setPeliasApiRoot($root, $version);
        parent::__construct($client);
    }
    
    /**
     * Set the API root and version, see "_setPeliasApiRoot"
     * @param string     $root    url of Pelias API
     * @param int        $version version of Pelias API
     */
    public function set_Pelias_ApiRoot(string $root, int $version = 1)
    {
        return $this->_setPeliasApiRoot($root, $version);
    }
    
    /**
     * Set the API root and version
     * @param string     $root    url of Pelias API
     * @param int        $version version of Pelias API
     */
    protected function _setPeliasApiRoot(string $root, int $version = 1)
    {
        $this->root    = sprintf('%s/v%d', rtrim($root, '/'), $version);
        $this->version = $version;
    }
    

    vendor\geocoder-php\openrouteservice-provider

    const API_URL = 'https://api.openrouteservice.org/geocode';
    const API_VERSION = 1;
    
    /**
     * @var string
     */
    private $apiKey;
    
    /**
     * @param HttpClient $client an HTTP adapter
     * @param string     $apiKey an API key
     */
    public function __construct(HttpClient $client, string $apiKey)
    {
        if (empty($apiKey)) {
            throw new InvalidCredentials('No API key provided.');
        }
        
        $this->apiKey = $apiKey;
        parent::__construct($client, self::API_URL, self::API_VERSION);
        $this->_set_ORS_API_Root(self::API_URL, self::API_VERSION, TRUE);
    }
    
    /**
     * Set the Openrouteservice URL
     * @param string $root
     * @param integer $version
     * @param boolean $check_version
     * @return void
     */
    public function set_ORS_API_Root(string $root, $version, $check_version = false)
    {
        return $this->_set_ORS_API_Root($root, $version, $check_version);
    }
    
    /**
     * Set the Openrouteservice URL
     * @param string $root
     * @param integer $version
     * @param boolean $check_version
     * @return void
     */
    protected function _set_ORS_API_Root(string $root, $version, $check_version = false)
    {
        parent::_setPeliasApiRoot($root, $version);
        if (filter_var($check_version, FILTER_VALIDATE_BOOLEAN)) {
            $this->_check_ORS_API_Root_Version($root, $root, $version);
        }
    }
    
    /**
     * Openrouteservice does not use /v1 in first version, but plan to add
     *  /v2 in next version.
     *
     * @see https://ask.openrouteservice.org/t/pelias-version-in-api-url/1021
     * @param string $root
     * @param string $new_root
     * @param string $version
     * @return void
     */
    protected function _check_ORS_API_Root_Version(string &$root, string $new_root, $version)
    {
        $version_ok = true;
        $version_ok = ($version_ok && is_numeric($version));
        $version_ok = ($version_ok && ($version === self::API_VERSION));
        $version_ok = ($version_ok && is_string($new_root));
        $version_ok = ($version_ok && !empty($new_root));
        $version_ok = (bool) $version_ok;
        
        if ($version_ok) {
            $root = $new_root;
        }
    }
    
    Reviewed by killrawr at 2022-06-30 22:01
  • 13. [Nominatim] Municipality not in list of 'localityFields'

    I came across some reverse geocoding results where Nominatim.php didn't return a 'locality'. In my opinion, this latlng query should have 'Purmerend' as its locality, as it's the municipal boundary:

    https://nominatim.openstreetmap.org/ui/reverse.html?lat=52.50741&lon=4.93279&zoom=18 https://nominatim.openstreetmap.org/ui/details.html?osmtype=W&osmid=6593763&class=highway

    Upon debugging, I noticed that inside jsonResultToLocation(), on line 209, 'municipality' was not considered a 'locality'.

    $localityFields = ['city', 'town', 'village', 'hamlet'];

    Is this a matter of definition?

    Adding 'municipality' fixes my issue:

    $localityFields = ['city', 'town', 'village', 'hamlet', 'municipality'];

    Reviewed by uwbas at 2022-05-14 20:43
  • 14. Localization issue

    I've set the locale to english but still getting result in arabic. $adapter_client = new Client(); $provider = new GoogleMaps($adapter_client, null, $api_key); $geocoder = new StatefulGeocoder($provider); $geocoder->setLocale('en');

    Here's my output

    "Ψ§Ω„Ψ£Ω†Ψ―Ω„Ψ³ΨŒ"

    Reviewed by shashankj99 at 2021-11-22 03:27
  • 15. [GoogleMapsPlaces] Add missing fields in model

    The current model for the GoogleMapsPlaces provider has some missing fields. This PR allows usage of all fields provided by Google Maps Places returned when mode=search.

    Added fields:

    • business_status
    • icon_background_color
    • icon_mask_base_uri
    • user_ratings_total
    • reference
    Reviewed by comxd at 2021-09-26 11:29
Related tags
ESRI ShapeFile library for PHP

shapefile ShapeFile library for PHP Features Currently the 2D and 3D variants except MultiPatch of the ShapeFile format as defined in https://www.esri

Jun 29, 2022
Simple Yet Powerful Geo Library for PHP

phpgeo - A Simple Geo Library for PHP phpgeo provides abstractions to geographical coordinates (including support for different ellipsoids) and allows

Jul 29, 2022
PHP library to access the OpenCage geocoding API
PHP library to access the OpenCage geocoding API

OpenCage Geocoding API Library for PHP A PHP library to use the OpenCage geocoding API. Build Status / Code Quality Overview This library attempts to

Jun 20, 2022
PHP library for determining the physical location of binaries

Bin Locator Library for searching binary files in the operating system. Requirements PHP >= 7.4 Installation Library is available as composer reposito

Jul 27, 2022
PHP library to easily get static image from French Cadastral Government map with markers and lines.
PHP library to easily get static image from French Cadastral Government map with markers and lines.

PHP French Cadastral Map Static API PHP library to easily get static image from French Cadastral Government map with markers and lines. Map source : c

May 24, 2022
PHP library to easily get static image from OpenStreetMap (OSM) with markers and lines.
PHP library to easily get static image from OpenStreetMap (OSM) with markers and lines.

PHP OpenStreetMap Static API PHP library to easily get static image from OpenStreetMap with markers and lines. ✨ Supporting ⭐ Star this repository to

Jul 28, 2022
Official PHP library for IPinfo (IP geolocation and other types of IP data)

This is the official PHP client library for the IPinfo.io IP address API, allowing you to lookup your own IP address,

Aug 14, 2022
PHP extension for geospatial rendering with Mapnik
PHP extension for geospatial rendering with Mapnik

PHP7 Mapnik Introduction This project is an extension for PHP 7 that enables geospatial rendering with Mapnik. Create tile generation scripts, dynamic

Dec 17, 2021
PHP Extension to handle common geospatial functions.

geospatial - PHP Geospatial Extension PHP Extension to handle common geospatial functions. The extension currently has implementations of the Haversin

Aug 11, 2022
GeoJSON implementation for PHP

GeoJson PHP Library This library implements the GeoJSON format specification. The GeoJson namespace includes classes for each data structure defined i

Aug 4, 2022
YCOM Impersonate. Login as selected YCOM user πŸ§™β€β™‚οΈin frontend.

YCOM Impersonate Login as selected YCOM user in frontend. Features: Backend users with admin rights or YCOM[] rights, can be automatically logged in v

Jan 19, 2022
Geo-related tools PHP 5.4+ library built atop Geocoder and React libraries

Geotools Geotools is a PHP geo-related library, built atop Geocoder and React libraries. Features Batch geocode & reverse geocoding request(s) in seri

Aug 7, 2022
Geo-related tools PHP 7.3+ library built atop Geocoder and React libraries

Geotools Geotools is a PHP geo-related library, built atop Geocoder and React libraries. Features Batch geocode & reverse geocoding request(s) in seri

Aug 7, 2022
A fully featured full text search engine written in PHP
A fully featured full text search engine written in PHP

TNTSearch TNTSearch is a full-text search (FTS) engine written entirely in PHP. A simple configuration allows you to add an amazing search experience

Aug 9, 2022
A full-featured blog using Laravel 7.* & VueJS. Minimum library used
A full-featured blog using Laravel 7.* & VueJS. Minimum library used

Blog Using Laravel 8 Let's keep it as simple as possible. Configure anything you want A full-featured blogging system for personal use.

Jul 17, 2022
πŸ’Ž Flexible, compiled and full-featured Dependency Injection Container with perfectly usable autowiring and support for all new PHP 7 features.

Nette Dependency Injection (DI) Introduction Purpose of the Dependecy Injection (DI) is to free classes from the responsibility for obtaining objects

Aug 4, 2022
Full-featured e-commerce platform with multi-domain and multi-language support for PHP 8

Surikata.io Full-featured e-commerce platform with multi-domain and multi-language support for PHP 8. Free to use for both commercial and personal pro

Apr 5, 2022
PHPMailer – A full-featured email creation and transfer class for PHP
 PHPMailer – A full-featured email creation and transfer class for PHP

PHPMailer – A full-featured email creation and transfer class for PHP Features Probably the world's most popular code for sending email from PHP! Used

Aug 16, 2022
A high performance full-featured project management system

Interested in managed hosting? Take a brief survey to help us know what to build! Phproject A high-performance project management system in PHP Instal

Aug 8, 2022
Build a full-featured administrative interface in ten minutes
Build a full-featured administrative interface in ten minutes

β›΅ laravel-admin is administrative interface builder for laravel which can help you build CRUD backends just with few lines of code. Documentation | δΈ­ζ–‡

Aug 12, 2022