malhal/laravel-geographical

Easily add longitude and latitude columns to your records and use inherited functionality for calculating distances

1.0.4 2020-09-14 16:59 UTC

This package is not auto-updated.

Last update: 2020-10-26 17:31:51 UTC


README

Easily add longitude and latitude columns to your records and use inherited functionality for calculating distances.

First either update your database or add this to a migration for each model:

$table->double('longitude');
$table->double('latitude');

Finally in your model use:

use Geographical;

1. Distance

Find the distance to all the entries in your table from a particular location.

$query = Model::distance($latitude, $longitude);
$asc = $query->orderBy('distance', 'ASC')->get();

2. Geofence

Find all the entries in your table inside a circular geo-fence.

$query = Model::geofence($latitude, $longitude, $inner_radius, $outer_radius);
$all = $query->get();

Units

The default unit of distance is miles. You can change it to kilometers by putting this in your model

protected static $kilometers = true;

Notes

  1. The method returns a Eloquent\Builder object so that you can add optional conditions if you want.
  2. If you require to select only a certain columns, it can be achieved by using select().
    Model::select('id', 'name')->distance($latitude, $longitude);
    (select() should precede the distance()/geofence())
  3. You can use distance as an aggregate column in the result. (Aggregate columns cannot be used in WHERE, use HAVING to execute any condition.)
  4. If you use different column names for latitude and longitude, mention them in the Model.php
    const LATITUDE  = 'lat';
    const LONGITUDE = 'lng';

Installation

PHP 5.6.4+ and Laravel 5+ are required.

To get the latest version of Laravel Geographical, simply require the project using Composer:

$ composer require malhal/laravel-geographical