artisanweblab/spatial

PostgreSQL spatial data types extension for Laravel

1.x-dev 2024-04-28 11:09 UTC

Requires

• php: ^8.3|^8.2|^8.1
• ext-json: *
• ext-pdo: *
• brick/geo: ^0.10.0
• laravel/framework: ^11.0|^10.0

Requires (Dev)

• fakerphp/faker: ^1.23
• mockery/mockery: ^1.6
• orchestra/testbench-core: ^9.0
• phpunit/phpunit: ^11.1

MIT

• Oleksandr Shapoval

• laravel

README

composer require artisanweblab/spatial

PostgreSQL and PostGIS

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

MySQL and MariaDB have built-in support for spatial data.

Integration with your project

Prepare your table

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();

Prepare your model

<?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,
    ];
}

Example of Input and Output spatial data

<?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

How to find records by Geometry

<?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();

Available Eloquent methods

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

Geometry Raw

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],
            //...
        ]
    ]
}