Spatial package (PostgreSQL, PostGIS, MySQL, MariaDB) for Laravel Framework
composer require artisanweblab/spatial
PostGIS is a spatial database extender for PostgreSQL object-relational database. It adds support for geographic objects allowing location queries to be run in SQL.
PostGIS Official Documentation
Install PostGIS to your Web server
Install PostGIS to your Docker container
MySQL and MariaDB have built-in support for spatial data.
Add fields with the required data type:
Laravel 10 and before:
$table->point('point')->isGeometry()->nullable();
Laravel 11 and after:
$table->geometry('point', 'point')->nullable();
<?php
namespace App\Models;
use ArtisanWebLab\Spatial\Eloquent\Casts\SpatialCast;
use ArtisanWebLab\Spatial\Traits\SpatialTrait;
use Brick\Geo\Point;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
/**
* @property integer $id
* @property string $name
* @property Point $point
*/
class User extends Model
{
use HasFactory, SpatialTrait;
protected $fillable = [
'name',
'address',
'point',
];
protected $casts = [
'point' => SpatialCast::class,
];
}
<?php
use App\Models\User;
use Brick\Geo\Point;
/** @var User $user */
$user = User::query()->first();
// Longitude, Latitude
$user->point = Point::xy(2.2945022, 48.8582687);
$user->save();
//...
$user = User::query()->first();
get_class($user->point); // Brick\Geo\Point
<?php
use App\Models\User;
use Brick\Geo\Point;
// Longitude, Latitude
$point = Point::xy(2.2945022, 48.8582687);
$users = User::query()
->withSpatialDistance('point', $point)
->whereSpatialDistanceSphere('point', $point, '<=', 1000) // 1000 meters
->get();
withSpatialDistance(string $column, Geometry $geometry, string $alias = null): Builder
whereSpatialDistance(string $column, Geometry $geometry, string $operator, int|float $distance, string $boolean = 'and'): Builder
orWhereSpatialDistance(string $column, Geometry $geometry, string $operator, int|float $distance): Builder
use Brick\Geo\IO\GeoJSONReader;
use Brick\Geo\IO\GeoJSONWriter;
use Brick\Geo\Point;
use Illuminate\Support\Facades\DB;
// Longitude, Latitude
$point = Point::xy(2.2945022, 48.8582687);
$query = sprintf(
"ST_AsGeoJSON(ST_Buffer(ST_GeomFromGeoJSON('%s'), 10)) as response",
(new GeoJSONWriter(false))->write($point)
);
$result = DB::query()->selectRaw($query)->first();
$geometry = $result ? (new GeoJSONReader(true))->read($result->response) : null;
{
"type":"Polygon",
"coordinates":[
[
[58.8582687,2.2945022],
[58.666121504,0.34359898],
//...
]
]
}