Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.6, 7.0, 7.1 , 7.2, 7.3 and 7.4!

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

Simply require this package as follows:

composer require ballen/distical

Alternatively, you can 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

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...
$distanceCalculator = new DistanceCalculator($ipswich, $london);

// You can then compute the distance...
$distance = $distanceCalculator->get();
// you can also chain these methods together eg. $distanceCalculator->get()->asMiles();

// We can now output the miles using the asMiles() method, you can also calculate and use asKilometres() or asNauticalMiles() as required!
echo 'Distance in miles between Central Ipswich and Central London is: ' . $distance->asMiles();

A set of working examples including multi-point calculations 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.6, 7.0, 7.1 , 7.2, 7.3 and 7.4 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.

You can’t perform that action at this time.