cartograf/geocoder

Barebones geocoder class using cUrl. Not a replacement for willdurand/geocoder

cartograf/geocoder

![Software License][ico-license] ![Total Downloads][ico-downloads], _(*1)

This is a bare-bones geocoding framework using cUrl to make http requests. I wrote it for myself as a utility class, mainly for geocoding from the command line., _(*2)

It's intended to be easily extensible for custom geocoding APIs and to get out of the way as much as possible. willdurand/geocoder might be a better framework for you if you want something more robust or complex., _(*3)

Install

Via Composer, _(*4)

``` bash $ composer require cartograf/geocoder, <sub>(*5)</sub>

## Usage

You'll need a class which extends the abstract `Geocoder` base class and defines the following methods:

* `getQueryString(Address $address)` converts an `Address` into the portion of the query string which follows the `baseUrl`. Note that for now this needs to specify JSON output as well.
* `getBaseUrl()` - defaults to `$this->baseUrl` if that is set via `setBaseUrl()`
* `getLatLngFromResult(\stdClass $result)` consumes the json-decoded result object and returns an object with `latitude` and `longitude` properties. Note that this is the final return value so you could add other properties as well if you need them.

Classes implementing MapQuest Nominatim (just set API key) and geocoding via an AWS EC2 instance of [Geolytica's geocoder](https://aws.amazon.com/marketplace/pp/B013CW6HOA) are included.

``` php
$ch = curl_init() or die("curl_init failed");
$geocoder = new Cartograf\Geocoder($ch);
echo $geocoder->geoCode($address);
curl_close($ch);

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*6)</sub>

Testing

Not yet implemented., <sub>(*7)</sub>

bash $ composer test, <sub>(*8)</sub>

Contributing

Feel free to extend this and submit PRs! I welcome contributions., <sub>(*9)</sub>

Credits

• Tim Stallmann

License

The MIT License (MIT). Please see License File for more information., <sub>(*10)</sub>