A PHP library for calculating distance between two or more latitude and longitude coordinates.
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src
tests
.gitignore
.scrutinizer.yml
.travis.yml
LICENSE
README.md
composer.json
composer.lock
phpunit.php
phpunit.xml

README.md

Distical

Build Status Code Coverage Scrutinizer Code Quality Code Climate Latest Stable Version Latest Unstable Version License

Distical is a PHP distance calculator library of which, amongst other things is developed to calculate the distance between two or more lat/long coordinates.

License

This client library is released under the MIT license.

Requirements

This library is developed and tested for PHP 5.3+

This library is unit tested against PHP 5.3, 5.4, 5.5, 5.6, 7.0, 7.1 and HHVM!

Setup

I highly recommend the use of Composer when installing and using this library, it is not mandatory however and you can use a provided 'include' script to load in this library if required.

Composer

To add this library to your project, edit your composer.json file and add the following lines (or update your existing require section with the library like so):

"require": {
        "ballen/distical": "~2.0"
}

Then install the package like so:

composer install ballen/distical --no-dev

Standalone

You can use the library "standalone" by downloading it from the GitHub releases section, extracting the files to a place on your server and then adding the "include" into your code like so:

require_once 'path/to/Distical/Distical.inc.php';

Examples


use Ballen\Distical\Calculator as DistanceCalculator;
use Ballen\Distical\Entities\LatLong;

// Set our Lat/Long coordinates
$ipswich = new LatLong(52.057941, 1.147172);
$london = new LatLong(51.507608, -0.127822);

// Get the distance between these two Lat/Long coordinates...
$distance = new DistanceCalculator($ipswich, $london);

// Get the distance as Miles (asMiles()), you could also use asKilometres() or asNauticalMiles() distance conversions too!
echo 'Distance in miles between Central Ipswich and Central London is: ' . $distance->asMiles();

A set of working examples can be found in the /examples directory, feel free to browse or run them!

Tests and coverage

This library is fully unit tested using PHPUnit.

I use TravisCI for continuous integration, which triggers tests for PHP 5.3, 5.4, 5.5, 5.6, 7.0, 7.1 and HHVM everytime a commit is pushed.

If you wish to run the tests yourself you should run the following:

# Install the Distical Library with the 'development' packages this then including PHPUnit!
composer install

# Now we run the unit tests (from the root of the project) like so:
./vendor/bin/phpunit

Code coverage can also be ran but requires XDebug installed...

./vendor/bin/phpunit --coverage-html ./report

Support

I am happy to provide support via. my personal email address, so if you need a hand drop me an email at: ballen@bobbyallen.me.