Geocoder is a library which helps you build geo-aware applications. It provides an abstraction layer for geocoding manipulations.
The library is splitted in two parts: HttpAdapter
and Provider
and is really extensible.
HttpAdapters are responsible to get data from remote APIs.
Currently, there are the following adapters:
BuzzHttpAdapter
for Buzz, a lightweight PHP 5.3 library for issuing HTTP requests;CurlHttpAdapter
for cURL;GuzzleHttpAdapter
for Guzzle, PHP 5.3+ HTTP client and framework for building RESTful web service clients;ZendHttpAdapter
for Zend Http Client.
Providers contain the logic to extract useful information.
Currently, there are many providers for the following APIs:
- FreeGeoIp as IP-Based geocoding provider;
- HostIp as IP-Based geocoding provider;
- IpInfoDB as IP-Based geocoding provider;
- Yahoo! PlaceFinder as Address-Based geocoding and reverse geocoding provider;
- Google Maps as Address-Based geocoding and reverse geocoding provider;
- Bing Maps as Address-Based geocoding and reverse geocoding provider;
- OpenStreetMaps as Address-Based geocoding and reverse geocoding provider;
- CloudMade as Address-Based geocoding and reverse geocoding provider;
- Geoip, the PHP extension, as IP-Based geocoding provider;
- ChainProvider is a special provider that takes a list of providers and iterates over this list to get information;
- MapQuest as Address-Based geocoding and reverse geocoding provider;
- OIORest as very accurate Address-Based geocoding provider (exclusively in Denmark).
The recommended way to install Geocoder is through composer.
Just create a composer.json
file for your project:
{
"require": {
"willdurand/geocoder": "*"
}
}
And run these two commands to install it:
$ wget http://getcomposer.org/composer.phar
$ php composer.phar install
Now you can add the autoloader, and you will have access to the library:
<?php
require 'vendor/autoload.php';
If you don't use neither Composer nor a ClassLoader in your application, just require the provided autoloader:
<?php
require_once 'src/autoload.php';
You're done.
First, you need an adapter
to query an API:
<?php
$adapter = new \Geocoder\HttpAdapter\BuzzHttpAdapter();
The BuzzHttpAdapter
is tweakable, actually you can pass a Browser
object to this adapter:
<?php
$buzz = new \Buzz\Browser(new \Buzz\Client\Curl());
$adapter = new \Geocoder\HttpAdapter\BuzzHttpAdapter($buzz);
Now, you have to choose a provider
which is closed to what you want to get.
The FreeGeoIpProvider
is able to geocode IPv4 and IPv6 addresses only.
The HostIpProvider
is able to geocode IPv4 addresses only.
The IpInfoDbProvider
is able to geocode IPv4 addresses only.
The YahooProvider
is able to geocode both IPv4 addresses and street addresses.
This provider can also reverse information based on coordinates (latitude, longitude).
The GoogleMapsProvider
is able to geocode and reverse geocode street addresses.
The BingMapsProvider
is able to geocode and reverse geocode street addresses.
The OpenStreetMapsProvider
is able to geocode and reverse geocode street addresses.
The CloudMadeProvider
is able to geocode and reverse geocode street addresses.
The GeoipProvider
is able to geocode IPv4 and IPv6 addresses only. No need to use an HttpAdapter
as it uses a local database.
See the MaxMind page for more information.
The ChainProvider
is a special provider that takes a list of providers and iterates over this list to get information.
The MapQuestProvider
is able to geocode and reverse geocode street addresses.
The OIORestProvider
is able to geocode street addresses only, exclusively in Denmark.
You can use one of them or write your own provider. You can also register all providers and decide later. That's we'll do:
<?php
$geocoder = new \Geocoder\Geocoder();
$geocoder->registerProviders(array(
new \Geocoder\Provider\YahooProvider(
$adapter, '<YAHOO_API_KEY>', $locale
),
new \Geocoder\Provider\IpInfoDbProvider(
$adapter, '<IPINFODB_API_KEY>'
),
new \Geocoder\Provider\HostIpProvider($adapter)
));
The $locale
parameter is available for the YahooProvider
.
Everything is ok, enjoy!
The main method is called geocode()
which receives a value to geocode. It can be an IP address or a street address (partial or not).
<?php
$result = $geocoder->geocode('88.188.221.14');
// Result is:
// "latitude" => string(9) "47.901428"
// "longitude" => string(8) "1.904960"
// "bounds" => array(4) {
// "south" => string(9) "47.813320"
// "west" => string(8) "1.809770"
// "north" => string(9) "47.960220"
// "east" => string(8) "1.993860"
// }
// "streetNumber" => string(0) ""
// "streetName" => string(0) ""
// "city" => string(7) "Orleans"
// "zipcode" => string(0) ""
// "county" => string(6) "Loiret"
// "region" => string(6) "Centre"
// "country" => string(6) "France"
// "timezone" => string(6) "Europe/Paris"
$result = $geocoder->geocode('10 rue Gambetta, Paris, France');
// Result is:
// "latitude" => string(9) "48.863217"
// "longitude" => string(8) "2.388821"
// "bounds" => array(4) {
// "south" => string(9) "48.863217"
// "west" => string(8) "2.388821"
// "north" => string(9) "48.863217"
// "east" => string(8) "2.388821"
// }
// "streetNumber" => string(2) "10"
// "streetName" => string(15) "Avenue Gambetta"
// "city" => string(5) "Paris"
// "county" => string(5) "Paris"
// "zipcode" => string(5) "75020"
// "region" => string(14) "Ile-de-France"
// "country" => string(6) "France"
// "timezone" => string(6) "Europe/Paris"
The geocode()
method returns a Geocoded
result object with the following API, this object also implements the ArrayAccess
interface:
getCoordinates()
will return an array withlatitude
andlongitude
values;getLatitude()
will return thelatitude
value;getLongitude()
will return thelongitude
value;getBounds()
will return an array withsouth
,west
,north
andeast
values;getStreetNumber()
will return thestreet number/house number
value;getStreetName()
will return thestreet name
value;getCity()
will return thecity
;getZipcode()
will return thezipcode
;getCityDistrict()
will return thecity district
, orsublocality
;getCounty()
will return thecounty
;getRegion()
will return theregion
;getRegionCode()
will return theregion
code (region short name);getCountry()
will return thecountry
;getCountryCode()
will return the ISO country code;getTimezone()
will return the timezone.
The Geocoder's API is fluent, you can write:
<?php
$result = $geocoder
->registerProvider(new \My\Provider\Custom($adapter))
->using('custom')
->geocode('68.145.37.34')
;
The using()
method allows you to choose the adapter
to use. When you deal with multiple adapters, you may want to
choose one of them. The default behavior is to use the first one but it can be annoying.
This library provides a reverse()
method to retrieve information from coordinates:
$result = $geocoder->reverse($latitude, $longitude);
Geocoder provides dumpers that aim to transform a ResultInterface
object in standard formats.
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 ResultInterface
object in an GPX compliant format.
Assuming we got a $result
object as seen previously:
<?php
$dumper = new \Geocoder\Dumper\GpxDumper();
$strGpx = $dumper->dump($result);
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 is a format for encoding a variety of geographic data structures.
Keyhole Markup Language is an XML notation for expressing geographic annotation and visualization within Internet-based, two-dimensional maps and three-dimensional Earth browsers.
The Well-Known Binary (WKB) representation for geometric values is defined by the OpenGIS specification.
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.
A common use case is to print geocoded data. Thanks to the Formatter
class,
it's really easy to format a ResultInterface
object as a string:
<?php
// $result is an instance of ResultInterface
$formatter = new \Geocoder\Formatter\Formatter($result);
$formatter->format('%S %n, %z %L');
// 'Badenerstrasse 120, 8001 Zuerich'
$formatter->format('<p>%S %n, %z %L</p>');
// '<p>Badenerstrasse 120, 8001 Zuerich</p>'
Here is the mapping:
-
Street Number:
%n
-
Street Name:
%S
-
City:
%L
-
Zipcode:
%z
-
County:
%P
-
Region:
%R
-
Region Code:
%r
-
Country:
%C
-
Country Code:
%c
-
Timezone:
%T
You can provide your own adapter
, you just need to create a new class which implements HttpAdapterInterface
.
You can also write your own provider
by implementing the ProviderInterface
.
Note, the AbstractProvider
class can help you by providing useful features.
You can provide your own dumper
by implementing the DumperInterface
.
Write your own formatter
by implementing the FormatterInterface
.
To run unit tests, you'll need a set of dependencies you can install using Composer:
php composer.phar install --dev
Once installed, just launch the following command:
phpunit
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="YAHOO_API_KEY" value="YOUR_API_KEY" /> -->
<!-- <server name="BINGMAPS_API_KEY" value="YOUR_API_KEY" /> -->
<!-- <server name="CLOUDMADE_API_KEY" value="YOUR_API_KEY" /> -->
</php>
You're done.
- William Durand william.durand1@gmail.com
- All contributors
Geocoder is released under the MIT License. See the bundled LICENSE file for details.