Skip to content

Commit 46d891d

Browse files
committed
wip
1 parent 8029a11 commit 46d891d

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

readme.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can install the package via composer:
1717
composer require matanyadaev/laravel-eloquent-spatial
1818
```
1919

20-
## Usage
20+
## Quickstart
2121
Generate a new model with a migration file:
2222
```bash
2323
php artisan make:model --migration
@@ -90,7 +90,7 @@ class Place extends Model
9090
}
9191
```
9292

93-
Store a record with spatial data:
93+
Access spatial data:
9494

9595
```php
9696
use App\Models\Place;
@@ -127,10 +127,22 @@ Retrieve a record with spatial data:
127127
```php
128128
echo $londonEye->location->latitude; // 51.5032973
129129
echo $londonEye->location->longitude; // -0.1195537
130+
131+
echo $vacationCity->area->toJson(); // {"type":"Polygon","coordinates":[[[41.90746728266806,12.455363273620605],[41.906636872349075,12.450309991836548],[41.90197359839437,12.445632219314575],[41.90027269624499,12.447413206100464],[41.90000118654431,12.457906007766724],[41.90281205461268,12.458517551422117],[41.903107507989986,12.457584142684937],[41.905918239316286,12.457734346389769],[41.90637337450963,12.45572805404663],[41.90746728266806,12.455363273620605]]]}
130132
```
131133

132134
## Geometry classes
133135

136+
| MatanYadaev\LaravelEloquentSpatial\Objects | OpenGIS Class |
137+
| ------------------------------------------------------------ | --------------- |
138+
| `Point(float $latitude, float $longitude)` | [Point](https://dev.mysql.com/doc/refman/8.0/en/gis-class-point.html) |
139+
| `MultiPoint(Point[] \| Collection<Point>)` | [MultiPoint](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipoint.html) |
140+
| `LineString(Point[] \| Collection<Point>)` | [LineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-linestring.html) |
141+
| `MultiLineString(LineString[] \| Collection<LineString>)` | [MultiLineString](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multilinestring.html) |
142+
| `Polygon(LineString[] \| Collection<LineString>)` | [Polygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-polygon.html) |
143+
| `MultiPolygon(Polygon[] \| Collection<Polygon>)` | [MultiPolygon](https://dev.mysql.com/doc/refman/8.0/en/gis-class-multipolygon.html) |
144+
| `GeometryCollection(Geometry[] \| Collection<Geometry>)` | [GeometryCollection](https://dev.mysql.com/doc/refman/8.0/en/gis-class-geometrycollection.html) |
145+
134146
## Available functions
135147

136148
## Tests

0 commit comments

Comments
 (0)