tarfin-labs / laravel-spatial
Laravel package to work with geospatial data types and functions.
Installs: 5 456
Dependents: 0
Suggesters: 0
Security: 0
Stars: 49
Watchers: 5
Forks: 6
Open Issues: 6
Requires
- php: ^8.0|^8.1
- illuminate/support: ^8.0|^9.0|^10.0
Requires (Dev)
- doctrine/dbal: ^3.3
- orchestra/testbench: ^6.0|^7.0
- phpunit/phpunit: ^9.0
- dev-main
- v1.5.0
- v1.4.1
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.0
- dev-wkt-options-and-bulk-operations
- dev-readme-explanation-for-default-point-value
- dev-dev
- dev-laravel-10-support
- dev-doctrine-type-error-fix
- dev-filtering-zero-points
- dev-optimizations
- dev-laravel-9-support
- dev-linestring-spatial-data-type
- dev-master
This package is auto-updated.
Last update: 2023-03-26 13:14:35 UTC
README
This is a Laravel package to work with geospatial data types and functions.
It supports only MySQL Spatial Data Types and Functions, other RDBMS is on the roadmap.
Supported data types:
Point
Available Scopes:
withinDistanceTo($column, $coordinates, $distance)
selectDistanceTo($column, $coordinates)
orderByDistanceTo($column, $coordinates, 'asc')
Installation
You can install the package via composer:
composer require tarfin-labs/laravel-spatial
Usage
Generate a new model with a migration file:
php artisan make:model Address --migration
1- Migrations:
To add a spatial data field, you need to extend the migration from TarfinLabs\LaravelSpatial\Migrations\SpatialMigration
.
It is a simple abstract class that adds point
spatial data type to Doctrine mapped types in the constructor.
use TarfinLabs\LaravelSpatial\Migrations\SpatialMigration; use Illuminate\Database\Schema\Blueprint; use Illuminate\Support\Facades\Schema; return new class extends SpatialMigration { public function up(): void { Schema::create('addresses', function (Blueprint $table) { $table->point('location'); }) } }
The migration above creates an addresses
table with a location
spatial column.
Spatial columns with no SRID attribute are not SRID-restricted and accept values with any SRID. However, the optimizer cannot use SPATIAL indexes on them until the column definition is modified to include an SRID attribute, which may require that the column contents first be modified so that all values have the same SRID.
So you should give an SRID attribute to use spatial indexes in the migrations and indexed columns must be NOT NULL:
Schema::create('addresses', function (Blueprint $table) { $table->point(column: 'location', srid: 4326); $table->spatialIndex('location'); })
2- Models:
Fill the $fillable
, $casts
arrays in the model:
use Illuminate\Database\Eloquent\Model; use TarfinLabs\LaravelSpatial\Casts\LocationCast; use TarfinLabs\LaravelSpatial\Traits\HasSpatial; class Address extends Model { use HasSpatial; protected $fillable = [ 'id', 'name', 'address', 'location', ]; protected array $casts = [ 'location' => LocationCast::class ]; }
3- Spatial Data Types:
Point:
Point
represents the coordinates of a location and contains latitude
, longitude
, and srid
properties.
At this point, it is crucial to understand what SRID is. Each spatial instance has a spatial reference identifier (SRID). The SRID corresponds to a spatial reference system based on the specific ellipsoid used for either flat-earth mapping or round-earth mapping. A spatial column can contain objects with different SRIDs.
For details about SRID you can follow the link: https://en.wikipedia.org/wiki/Spatial_reference_system
- Default value of
latitude
,longitude
parameters is0.0
. - Default value of
srid
parameter is0
.
use TarfinLabs\LaravelSpatial\Types\Point; $location = new Point(lat: 28.123456, lng: 39.123456, srid: 4326); $location->getLat(); // 28.123456 $location->getLng(); // 39.123456 $location->getSrid(); // 4326
You can override the default SRID via the laravel-spatial
config file. To do that, you should publish the config file using vendor:publish
artisan command:
php artisan vendor:publish --provider="TarfinLabs\LaravelSpatial\LaravelSpatialServiceProvider"
After that, you can change the value of default_srid
in config/laravel-spatial.php
return [ 'default_srid' => 4326, ];
4- Scopes:
withinDistanceTo()
You can use the withinDistanceTo()
scope to filter locations by given distance:
To filter addresses within the range of 10 km from the given coordinate:
use TarfinLabs\LaravelSpatial\Types\Point; use App\Models\Address; Address::query() ->withinDistanceTo('location', new Point(lat: 25.45634, lng: 35.54331), 10000) ->get();
selectDistanceTo()
You can get the distance between two points by using selectDistanceTo()
scope. The distance will be in meters:
use TarfinLabs\LaravelSpatial\Types\Point; use App\Models\Address; Address::query() ->selectDistanceTo('location', new Point(lat: 25.45634, lng: 35.54331)) ->get();
orderByDistanceTo()
You can order your models by distance to given coordinates:
use TarfinLabs\LaravelSpatial\Types\Point; use App\Models\Address; // ASC Address::query() ->orderByDistanceTo('location', new Point(lat: 25.45634, lng: 35.54331)) ->get(); // DESC Address::query() ->orderByDistanceTo('location', new Point(lat: 25.45634, lng: 35.54331), 'desc') ->get();
Get latitude and longitude of the location:
use App\Models\Address; $address = Address::find(1); $address->location; // TarfinLabs\LaravelSpatial\Types\Point $address->location->getLat(); $address->location->getLng();
Create a new address with location:
use App\Models\Address; Address::create([ 'name' => 'Bag End', 'address' => '1 Bagshot Row, Hobbiton, Shire', 'location' => new Point(lat: 25.45634, lng: 35.54331), ]);
Usage in Resource:
To get an array representation of a location-casted field from a resource, you can return parent::toArray($request)
.
If you need to return a custom array from a resource, you can use the toArray()
method of the Point
object.
class LocationResource extends JsonResource { public function toArray($request) { return [ 'location' => $this->location->toArray(), ]; } }
Either way, you will get the following output for the location casted field:
{ "lat": 25.45634, "lng": 35.54331, "srid": 4326 }
Testing
composer test
Road Map
- MultiPoint
- LineString
- MultiLineString
- Polygon
- MultiPolygon
- GeometryCollection
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email development@tarfin.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.