karam-mustafa / laravel-geographical-calculator

laravel package helps you to implement geographical calculation, with several algorithms that help you deal with coordinates and distances.
MIT License
416 stars 29 forks source link
geocoder geocoder-library geocoding geogra geographical-calculator geolocation geometry laravel laravel-geolocation laravel-package package php-geocoder

logo

Geographical Calculator

License PHP Composer Check & fix styling Run tests Code Quality

Geographical Calculator was developed for laravel 5.8+ to help you to implement geographical calculation, with With several algorithms that help you deal with coordinates.

Installation

1 - Dependency

The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:

composer require kmlaravel/laravel-geographical-calculator
2 - Copy the package providers to your local config with the publish command, this will publish the config:

php artisan geo:install

Features

config options

add your custom units,keys ..etc.


/*
|--------------------------------------------------------------------------
| units values
|--------------------------------------------------------------------------
| your custom units, the initial units its convert from a mile to any value
| (1.609344) is the conversion factor from a mile to a kilometer
*/
'units' => [
'mile' => 1,
'km' => 1.609344,
'm' => (1.609344 * 1000),
'cm' => (1.609344 * 100),
'mm' => (1.609344 * 1000 * 1000),
],
/*
|--------------------------------------------------------------------------
| distance_key_prefix
|--------------------------------------------------------------------------
| if you declared more than tow points to resolve their distance,
| you will see the result in the following format:
| "1-2" => ["km" => "some result"],
| "2-3" => ["km" => "some result"],
| "3-4" => ["km" => "some result"],
| and if you want to set any prefix before each index
| you must change the below value to any value you want.
|
*/
'distance_key_prefix' => '',


Changelog
---------
Please see the [CHANGELOG](https://github.com/kmlaravel/laravel-geographical-calculator/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.

Security
--------
If you discover any security related issues, please email them first to karam2mustafa@gmail.com, 
if we do not fix it within a short period of time please open a new issue describing your problem. 

Credits
-------
[karam mustafa](https://www.linkedin.com/in/karam2mustafa)