Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karam-mustafa/laravel-geographical-calculator
laravel package helps you to implement geographical calculation, with several algorithms that help you deal with coordinates and distances.
https://github.com/karam-mustafa/laravel-geographical-calculator
geocoder geocoder-library geocoding geogra geographical-calculator geolocation geometry laravel laravel-geolocation laravel-package package php-geocoder
Last synced: 2 days ago
JSON representation
laravel package helps you to implement geographical calculation, with several algorithms that help you deal with coordinates and distances.
- Host: GitHub
- URL: https://github.com/karam-mustafa/laravel-geographical-calculator
- Owner: karam-mustafa
- License: mit
- Created: 2020-11-20T19:09:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-03T12:13:40.000Z (over 1 year ago)
- Last Synced: 2025-01-12T15:04:39.168Z (9 days ago)
- Topics: geocoder, geocoder-library, geocoding, geogra, geographical-calculator, geolocation, geometry, laravel, laravel-geolocation, laravel-package, package, php-geocoder
- Language: PHP
- Homepage:
- Size: 479 KB
- Stars: 417
- Watchers: 7
- Forks: 30
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Geographical Calculator
[](//packagist.org/packages/kmlaravel/laravel-geographical-calculator)
[](https://github.com/karam-mustafa/laravel-geographical-calculator/actions/workflows/php.yml)
[](https://github.com/karam-mustafa/laravel-geographical-calculator/actions/workflows/php-cs-fixer.yml)
[](https://github.com/karam-mustafa/laravel-geographical-calculator/actions/workflows/tests.yml)
[](https://api.codiga.io/project/30429/score/svg)
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:
```shell
composer require kmlaravel/laravel-geographical-calculator
```
##### 2 - Copy the package providers to your local config with the publish command, this will publish the config:
```shell
php artisan geo:install
```
Features
-----------
- [Get the distance between one or more of points](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/distances.md#basic-usage)
- [Get the center between set of points](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/areas.md#get-the-center-for-a-given-coordinates)
- [Get the closest point to the specific point](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/ordering.md#get-closest-point)
- [Get the farthest point to the specific point](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/ordering.md#get-farthest-point)
- [Check if a given point located in a given area](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/areas.md#check-if-a-given-point-located-in-a-given-area)
- [Get a ranking of points by the nearest neighbor algorithm](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/ordering.md#get-ordering-points-by-nearest-neighbor-algorithm)
- [Get all package features](https://github.com/karam-mustafa/laravel-geographical-calculator/blob/main/docs/all.md#all-features-in-one-function)
config options
----------------
> ## add your custom units,keys ..etc.
>
```php
/*
|--------------------------------------------------------------------------
| 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 [email protected],
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)