LineString
class LineString extends OGCObject implements Countable (View source)
OGC LineString type.
Properties
| protected string | $type | OGC type. | |
| int | $srid | Spatial Reference System Identifier (SRID). | from OGCObject |
| Point[] | $points | Point collection. |
Methods
Create an OGCObject instance from parsed WKB/WKT.
Create an OGCObject instance from WKT.
Create an OGCObject instance from WKB.
Array representation of instance coordinates.
String representation of the instance.
LineString constructor.
A Linestring could be constructed with an array of points-array.
A Linestring could be instantiated using a string where points are divided by a "," and coordinates are divided by " ". Separators must be different.
Check if the LineString is circular, that is the first and the last Point are the same.
Return the lenght of the linestring expressed in meters.
Countable interface implementation.
Details
static OGCObject
buildOGCObject(array $parsed)
Create an OGCObject instance from parsed WKB/WKT.
static OGCObject
fromWKT(string $wkt, int|null $srid = null)
Create an OGCObject instance from WKT.
static OGCObject
fromWKB($wkb, int|null $srid = null)
Create an OGCObject instance from WKB.
at line 106
protected array
toValueArray()
Array representation of instance coordinates.
at line 113
string
__toString()
String representation of the instance.
at line 38
void
__construct(array $points, int|null $srid = null)
LineString constructor.
A LineString must be instantiate with a Points array es. [new Point(lon, lat), new Point(lon, lat)]
at line 64
static LineString
fromArray(array $points)
A Linestring could be constructed with an array of points-array.
es. [[lon, lat], [lon, lat], [lon, lat], ..]
at line 88
static LineString
fromString(string $points, string $points_separator = ',', string $coords_separator = ' ')
A Linestring could be instantiated using a string where points are divided by a "," and coordinates are divided by " ". Separators must be different.
es. "lon lat, lon lat".
at line 125
bool
isCircular()
Check if the LineString is circular, that is the first and the last Point are the same.
at line 136
int
lenght(string $provider = 'haversine')
Return the lenght of the linestring expressed in meters.
at line 220
array
split(Point $split)
Split the LineString object on the given Point, if present, and returns a tuple (array with two object) composed by Points, LineStrings or null.
.
If the given Point is the first of the LineString, it returns the Point as first element of the tuple, and the remaining LineString as second element of the tuple. Same behavior if the Point is the last, but the returned tuple is reversed.
If the LineString is composed by two Points and the given Point is one of those, we get a tuple of two Points.
If the Point is not present, we get a tuple composed by the LineString itself and a null element in the second position of the tuple.
es. given the LineString(Point(1,1), Point(2,2), Point(3,3), Point(4,4), Point(5,5)) split by Point(2,2) we obtain - an array with two LineString 1) LineString(Point(1,1), Point(2,2)) 2) LineString(Point(2,2), Point(3,3), Point(4,4), Point(5,5))
es. given the LineString(Point(1,1), Point(2,2), Point(3,3), Point(4,4), Point(5,5)) split by Point(1,1) we obtain - an array with a Point and a LineString 1) Point(1,1) 2) LineString(Point(1,1), Point(2,2), Point(3,3), Point(4,4), Point(5,5))
es. given the LineString(Point(1,1), Point(2,2), Point(3,3), Point(4,4), Point(5,5)) split by Point(5,5) we obtain - an array with a Point and a LineString 1) LineString(Point(1,1), Point(2,2), Point(3,3), Point(4,4), Point(5,5)) 2) Point(5,5)
es. given the LineString(Point(1,1), Point(2,2)) split by Point(1,1) we obtain - an array with a Point and a LineString 1) Point(1,1) 2) LineString(Point(1,1), Point(2,2))
es. given the LineString(Point(1,1), Point(2,2)) split by Point(5,5) we obtain - an array with a LineString and a null element 1) LineString(Point(1,1), Point(2,2)) 2) null
at line 251
static array
diff(LineString $l1, LineString $l2)
at line 267
int
count()
Countable interface implementation.