README

Geo Laravel

This is a fork from elevenlab/laravel-geo with some modifications for compatibility with Laravel 5.4+

Note: In this version you can use either geometry or geography column type for PostGIS with SRID.

Features

GeoSpatial integration on Laravel 5.4+:
- Create geospatial columns using Schema and migrations
- Save and retrieve geospatial attributes using directly OpenGeoConsortium Spatial Objects (this package depends from PHP-OGC)
- Build spatial query directly with the laravel fluent query builder
- Supported types: Point, MultiPoint, Linestring, MultiLinestring, Polygon, MultiPolygon, GeometryCollection
Supported drivers:
- Postgres: Posgis extension Extensions (geometry types)
- MySql: Extension for Spatial Data (geometry types)

Thanks to laravel-postgis for its original work.

Installation & Configuration

Install using composer

$ composer require karomap/laravel-geo

Replace under the Service Providers section ('providers' array) in config/app.php this line

Illuminate\Database\DatabaseServiceProvider::class,

with this one:

Karomap\GeoLaravel\DatabaseServiceProvider::class

If you need it, under the Alias section ('aliases' array) in config/app.php add this line:

'GeoModel'      => Karomap\GeoLaravel\Eloquent\Model::class,

Quick Documentation

Create table with spatial references

To add a geospatial field to your migration you can use these methods:

point, multipoint linestring, multilinestring, polygon, multipolygon, geometrycollection

Example (NB: the schema is over-simplified):

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Migrations\Migration;
use Karomap\GeoLaravel\Database\Schema\Blueprint; // Replace "Illuminate\Database\Schema\Blueprint"

class CreateNationsTable extends Migration {
    public function up() {
        Schema::create('nations', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->polygon('national_bounds');
            $table->point('capital');
            $table->multipolygon('regions_bounds');
            $table->multipoint('regions_capitals');
            $table->linestring('highway');
        });
    }
}

Add spatial attributes to a Model

In order to handle dynamically geospatial attributes during CRUD operations, you need to:

substitute the Eloquent Model abstract object with a custom Model
define which attribute belongs to which geospatial type, defining the $geometries attribute (you can find here the available types)

<?php namespace App;

use Karomap\GeoLaravel\Eloquent\Model as GeoModel;

class Country extends GeoModel
{
    protected $table = "countries";

    protected $geometries = [
        "polygons" =>   ['national_bounds'],
        "points" => ['capital'],
        "multipolygons" => ['regions_bounds'],
        "multipoints" => ['regions_capitals'],
        "linestrings" => ['highway']
    ];
}

Manipulate spatial attributes of a Model

<?php
use Karomap\PHPOGC\DataTypes\Point as Point;
use Karomap\PHPOGC\DataTypes\Linestring as Linestring;
use Karomap\PHPOGC\DataTypes\Polygon as Polygon;

$rome = new Point(41.9102415,12.3959149);
$milan = new Point(45.4628328,9.1076927);
$naples = new Point(40.8540943,14.1765626);
$regions_capital = new MultiPoint([$rome, $milan, $naples, ....]);
$italy_bounds = new Polygon([new LineString(getPointArrayOfItalianBounds())]);
$lazio = new LineString(getPointArrayOfLazioBounds());
$campania = new LineString(getPointArrayOfCampaniaBounds());
$lombardia = new LineString(getPointArrayOfLombardiaBounds());
$molise = new LineString(getPointArrayOfMoliseBounds()); # raise MoliseNotFoundException
$regions_bounds = new MultiPolygon([$lazio, $campania, $lombardia, ....]);
$a1 = new LineString(getPointArrayOfA1());

$italy = Country::create([
    'name' => 'Italy',
    'capital' => $rome,
    'national_bounds' => $italy_bounds,
    'regions_bounds' => $regions_bounds,
    'regions_capitals' => $regions_capital,
    'highway' => $a1
]);

$italy = Country::whereName('Italy')->first();
echo get_class($italy->capital); // Karomap\PHPOGC\DataTypes\Point
echo get_class($italy->national_bounds); // Karomap\PHPOGC\DataTypes\Polygon
echo get_class($italy->regions_bounds); // Karomap\PHPOGC\DataTypes\Polygon
echo get_class($italy->regions_capitals); // Karomap\PHPOGC\DataTypes\MultiPoint
echo get_class($italy->highway); // Karomap\PHPOGC\DataTypes\LineString

Builds queries

There are two different groups of methods that are available, one to use the underlying database engine to perform spatial operations on existing objects, and another to build fluent queries and perform operations on database-resident data.

Given two OGCObjects, you can perform those operations:

intersection
difference
contains
intersects
touches
overlaps
centroid
distance
equals

Given an illuminate Query Builder object, you can use:

whereEquals
whereNotEquals
orWhereEquals
orWhereNotEquals
whereContains
whereNotContains
orWhereContains
orWhereNotContains
whereIntersects
whereNotIntersects
orWhereIntersects
orWhereNotIntersects
whereTouches
whereNotTouches
orWhereTouches
orWhereNotTouches
whereOverlaps
whereNotOverlaps
orWhereOverlaps
orWhereNotOverlaps

ToDo

improve documentation
- add examples for "Build queries" section
- add manual installation guide
add missing ST_functions

karomap / laravel-geo

Maintainers

Details