https://github.com/ajthinking/laravel-postgis
https://github.com/ajthinking/laravel-postgis
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ajthinking/laravel-postgis
- Owner: ajthinking
- License: mit
- Created: 2022-02-12T13:19:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-25T09:06:40.000Z (almost 4 years ago)
- Last Synced: 2024-08-10T11:38:39.140Z (almost 2 years ago)
- Language: PHP
- Homepage:
- Size: 248 KB
- Stars: 15
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Laravel Wrapper for PostgreSQL's Geo-Extension Postgis
======================================================
For Laravel 9+, PHP 8+ only
## Features
* Work with geometry classes instead of arrays.
```php
$model->myPoint = new Point(1,2); //lat, long
```
* Adds helpers in migrations.
```php
$table->polygon('myColumn');
```
## Installation
```bash
composer require mstaack/laravel-postgis
```
## Usage
To start, ensure you have PostGIS enabled in your database - you can do this in a Laravel migration or manually via SQL.
### Enable PostGIS via a Laravel migration
You need to publish the migration to easily enable PostGIS:
```sh
php artisan vendor:publish --provider="Ajthinking\LaravelPostgis\DatabaseServiceProvider" --tag="migrations"
```
And then you run the migrations:
```sh
php artisan migrate
```
These methods are safe to use and will only enable / disable the PostGIS extension if relevant - they won't cause an error if PostGIS is / isn't already enabled.
If you prefer, you can use the `enablePostgis()` method which will throw an error if PostGIS is already enabled, and the `disablePostgis()` method twhich will throw an error if PostGIS isn't enabled.
### Enable PostGIS manually
Use an SQL client to connect to your database and run the following command:
CREATE EXTENSION postgis;
To verify that PostGIS is enabled you can run:
SELECT postgis_full_version();
### Migrations
Now create a model with a migration by running
php artisan make:model Location
If you don't want a model and just a migration run
php artisan make:migration create_locations_table
Open the created migrations with your editor.
```PHP
use Illuminate\Database\Migrations\Migration;
use Ajthinking\LaravelPostgis\Schema\Blueprint;
class CreateLocationsTable extends Migration {
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('locations', function(Blueprint $table)
{
$table->increments('id');
$table->string('name');
$table->string('address')->unique();
$table->point('location'); // GEOGRAPHY POINT column with SRID of 4326 (these are the default values).
$table->point('location2', 'GEOGRAPHY', 4326); // GEOGRAPHY POINT column with SRID of 4326 with optional parameters.
$table->point('location3', 'GEOMETRY', 27700); // GEOMETRY column with SRID of 27700.
$table->polygon('polygon'); // GEOGRAPHY POLYGON column with SRID of 4326.
$table->polygon('polygon2', 'GEOMETRY', 27700); // GEOMETRY POLYGON column with SRID of 27700.
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::drop('locations');
}
}
```
Available blueprint geometries:
* point
* multipoint
* linestring
* multilinestring
* polygon
* multipolygon
* geometrycollection
other methods:
* enablePostgis
* disablePostgis
### Models
All models which are to be PostGis enabled **must** use the *PostgisTrait*.
You must also define an array called `$postgisFields` which defines
what attributes/columns on your model are to be considered geometry objects. By default, all attributes are of type `geography`. If you want to use `geometry` with a custom SRID, you have to define an array called `$postgisTypes`. The keys of this assoc array must match the entries in `$postgisFields` (all missing keys default to `geography`), the values are assoc arrays, too. They must have two keys: `geomtype` which is either `geography` or `geometry` and `srid` which is the desired SRID. **Note**: Custom SRID is only supported for `geometry`, not `geography`.
```PHP
use Illuminate\Database\Eloquent\Model;
use Ajthinking\LaravelPostgis\Eloquent\PostgisTrait;
use Ajthinking\LaravelPostgis\Geometries\Point;
class Location extends Model
{
use PostgisTrait;
protected $fillable = [
'name',
'address'
];
protected $postgisFields = [
'location',
'location2',
'location3',
'polygon',
'polygon2'
];
protected $postgisTypes = [
'location' => [
'geomtype' => 'geography',
'srid' => 4326
],
'location2' => [
'geomtype' => 'geography',
'srid' => 4326
],
'location3' => [
'geomtype' => 'geometry',
'srid' => 27700
],
'polygon' => [
'geomtype' => 'geography',
'srid' => 4326
],
'polygon2' => [
'geomtype' => 'geometry',
'srid' => 27700
]
]
}
$linestring = new LineString(
[
new Point(0, 0),
new Point(0, 1),
new Point(1, 1),
new Point(1, 0),
new Point(0, 0)
]
);
$location1 = new Location();
$location1->name = 'Googleplex';
$location1->address = '1600 Amphitheatre Pkwy Mountain View, CA 94043';
$location1->location = new Point(37.422009, -122.084047);
$location1->location2 = new Point(37.422009, -122.084047);
$location1->location3 = new Point(37.422009, -122.084047);
$location1->polygon = new Polygon([$linestring]);
$location1->polygon2 = new Polygon([$linestring]);
$location1->save();
$location2 = Location::first();
$location2->location instanceof Point // true
```
Available geometry classes:
* Point
* MultiPoint
* LineString
* MultiLineString
* Polygon
* MultiPolygon
* GeometryCollection
### Achnowledgements
This is a [fork](https://github.com/mstaack/laravel-postgis) from the work of great people. Thanks to :
- https://github.com/njbarrett
- https://github.com/phaza
- https://github.com/mirzap