bagusindrayana/laravel-coordinate

get nearby location from eloquent laravel

0.0.3 2021-07-12 05:41 UTC

This package is auto-updated.

Last update: 2024-11-10 10:18:01 UTC


README

find data with the closest location based on its coordinates with eloquent laravel

Installation

composer require bagusindrayana/laravel-coordinate

  • In Model
#use trait
use Bagusindrayana\LaravelCoordinate\Traits\LaravelCoordinate;

class Toko extends Model
{
    use LaravelCoordinate;

    //optional
    public $_latitudeName = "latitude_column"; //default name is latitude
    public $_longitudeName = "longitude_column"; //default name is longitude

    //

}
  • Using trait
    //get data at a distance of 500 meters (0.5KM)
    $tokos = Toko::nearby([
        -0.497493,//latitude
        117.156480//longitude
    ],0.5)->get();


    //using order, remember that the order is always placed at the end of the query
    //get data with a distance of 1 kilometer and sort it from farthest
    $tokos = Toko::nearby([
        -0.497493,//latitude
        117.156480//longitude
    ],1)->farthest()->get();
    
    //get data with a distance of 1 kilometer and sort it from closest to closest
    $tokos = Toko::nearby([
        -0.497493,//latitude
        117.156480//longitude
    ],1)->closest()->get();
    
    //add a custom column containing the distance value of each record
    $tokos = Toko::nearby([
        -0.497493,//latitude
        117.156480//longitude
    ],0.5) //0.5 Km
    ->selectDistance(['id','nama_toko'],'_distance') //this function will add a custom column/alias with the name "_distance" which contains the distance value of each record
    ->get();

Formula

I haven't tried how much data it can handle and how fast the calculations are, so here are 3 different formulas you can try

formula paramter/arguments (int)

  • 0 = default
  • 1 = Spherical Law of Cosines
  • 2 = Haversine formula

example :

$tokos = Toko::nearby([
        -0.497493,//latitude
        117.156480//longitude
    ],
    0.5,
    1//using Spherical Law of Cosines
)
->get();

Scope

nearby(coordinate,radius/distance = 5,formula = 0)
closest(coordinate,formula = 0)
farthest(coordinate,formula = 0)
selectDistance(fieldName,aliasName,formula = 0)
insideBox(coorinate(2 coordinate))