PHP Location Library

A library for geospatial calculations in PHP., _(*1)

Installation

Using composer, run composer require ricklab/location, _(*2)

Usage

A brief example of how this library can be used:, _(*3)

use Ricklab\Location\Calculator\VincentyCalculator;
use Ricklab\Location\Converter\DegreesMinutesSeconds;
use Ricklab\Location\Converter\Unit;
use Ricklab\Location\Geometry\GeometryCollection;
use Ricklab\Location\Geometry\Point;
use Ricklab\Location\Geometry\LineString;
use Ricklab\Location\Geometry\BoundingBox;

// Usage of Point
$point = new Point(-2.34323, 52.43343);

// Numeric-strings are also valid, to reduce floating-point errors
$point2 = new Point('-2.50002', '54.343211');

// Calculate the distance using the default calculator (Haversine) in meters
$distance = $point->distanceTo($point2);

// Calculate the distance between two points in miles using the Vincenty formula
$distance = $point->distanceTo($point2, Unit::MILES, new VincentyCalculator());

// Usage of LineString
$line = new LineString([$point, $point2]);

// Create a point from DMS strings
$point3 = Point::fromDms(
    DegreesMinutesSeconds::fromString('40° 26′ 46.2345″ S'),
    DegreesMinutesSeconds::fromString('79° 58′ 56.5543″ E'),
);
// A geometry collection example
$multiGeometry = new GeometryCollection([
    $line,
    $point3,
]);

// Usage of bounding box
$bbox = BoundingBox::fromCenter($point, 1000); // 1000 meters radius
$bbox2 = BoundingBox::fromGeometry($multiGeometry); // Bounding box of the line
$contains = $bbox2->contains($point2); // true if the point is within the bounding box

// A new GeometryCollection with the new bounding-box polygon
$newMultiGeometry = $multiGeometry->withGeometry($bbox->getPolygon());

Transformers

Transformers are used to convert geometries to and from various formats. This library includes a GeoJSON, WKT and WKB transformer., _(*4)

GeoJsonTransformer

The GeoJsonTransformer class converts geometries into GeoJSON format., _(*5)

Usage

Here is an example of how to use the GeoJsonTransformer class:, _(*6)

use Ricklab\Location\Transformer\GeoJsonTransformer;
use Ricklab\Location\Geometry\Point;

$geometry = new Point($longitude, $latitude);
$geoJsonString = GeoJsonTransformer::encode($geometry);

$secondGeometry = GeoJsonTransformer::decode($geoJsonString);

echo $geoJsonString;

WktTransformer/WkbTransformer

The WktTransformer and WkbTransformer class converts geometries into WKT format., _(*7)

Usage

Here is an example of how to use the WktTransformer class:, _(*8)

use Ricklab\Location\Transformer\WktTransformer;
use Ricklab\Location\Geometry\Point;

$geometry = new Point($longitude, $latitude);
$wktString = WktTransformer::encode($geometry);

echo $wktString;

WkbTransformer works in exactly the same way, but returns a binary string., _(*9)

Features

The Feature class represents a single geospatial feature from the GeoJSON spec., _(*10)

Usage

Here is an example of how to use the Feature class:, _(*11)

use Ricklab\Location\Feature\Feature;
use Ricklab\Location\Geometry\Point;

$geometry = new Point($longitude, $latitude);
$feature = new Feature(['property-name', 'property-value'], $geometry);

$geometry = $feature->getGeometry();
$properties = $feature->getProperties();

FeatureCollection

The FeatureCollection class represents a collection of geospatial features., _(*12)

Usage

Here is an example of how to use the FeatureCollection class:, _(*13)

use Ricklab\Location\Feature\Feature;
use Ricklab\Location\Feature\FeatureCollection;
use Ricklab\Location\Geometry\Point;
use Ricklab\Location\Transformer\GeoJsonTransformer;

$feature1 = new Feature(['name' => 'Feature 1'], new Point($longitude1, $latitude1));
$feature2 = new Feature(['name' => 'Feature 1'], new Point($longitude2, $latitude2));

$collection = new FeatureCollection([$feature1, $feature2], true);

$features = $collection->getFeatures();
$bbox = $collection->getBbox(); // Returns the bounding box of the collection
$featureGeoJson = GeoJsonTransformer::encode($features); // GeoJSON feature collection representation