1. class
  2. PhpMyAdmin
  3. \
  4. Gis
  5. \
  6. GisPolygon

GisPolygon

class GisPolygon extends GisGeometry (View source)

Handles actions related to GIS POLYGON objects

Methods

string
prepareRowAsSvg(string $spatial, string $label, string $fill_color, array $scale_data)

Prepares and returns the code related to a row in the GIS dataset as SVG.

ImageWrapper
prepareRowAsPng(string $spatial, string|null $label, string $fill_color, array $scale_data, ImageWrapper $image)

Adds to the PNG image object, the data related to a row in the GIS dataset.

TCPDF
prepareRowAsPdf(string $spatial, string|null $label, string $fill_color, array $scale_data, TCPDF $pdf)

Adds to the TCPDF instance, the data related to a row in the GIS dataset.

string
prepareRowAsOl(string $spatial, int $srid, string $label, array $fill_color, array $scale_data)

Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.

array
scaleRow(string $spatial)

Scales each row.

string
generateWkt(array $gis_data, int $index, string|null $empty = '')

Generate the WKT with the set of parameters passed by the GIS editor.

string
getBoundsForOl(int $srid, array $scale_data)

Returns OpenLayers.Bounds object that correspond to the bounds of GIS data.

from  GisGeometry
array
setMinMax(string $point_set, array $min_max)

Updates the min, max values with the given point set.

from  GisGeometry
array
generateParams(string $value, int $index = -1)

Generate parameters for the GIS data editor from the value of the GIS column.

array
extractPoints(string $point_set, array|null $scale_data, bool $linear = false)

Extracts points, scales and returns them as an array.

from  GisGeometry
string
getPolygonArrayForOpenLayers(array $polygons, int $srid)

Generates JavaScript for adding an array of polygons to OpenLayers.

from  GisGeometry
string
getPolygonForOpenLayers(array $polygon, int $srid)

Generates JavaScript for adding points for OpenLayers polygon.

from  GisGeometry
string
getLineArrayForOpenLayers(array $lines, int $srid, bool $is_line_string = true)

Generates JavaScript for adding an array of LineString or LineRing to OpenLayers.

from  GisGeometry
string
getLineForOpenLayers(array $points_arr, int $srid, bool $is_line_string = true)

Generates JavaScript for adding a LineString or LineRing to OpenLayers.

from  GisGeometry
string
getPointsArrayForOpenLayers(array $points_arr, int $srid)

Generates JavaScript for adding an array of points to OpenLayers.

from  GisGeometry
string
getPointForOpenLayers(array $point, int $srid)

Generates JavaScript for adding a point to OpenLayers.

from  GisGeometry
int
getRandomId()

No description

from  GisGeometry
static GisPolygon
singleton()

Returns the singleton.

static float
area(array $ring)

Calculates the area of a closed simple polygon.

static bool
isOuterRing(array $ring)

Determines whether a set of points represents an outer ring.

static bool
isPointInsidePolygon(array $point, array $polygon)

Determines whether a given point is inside a given polygon.

static array|false
getPointOnSurface(array $ring)

Returns a point that is guaranteed to be on the surface of the ring.

Details

at line 211
string prepareRowAsSvg(string $spatial, string $label, string $fill_color, array $scale_data)

Prepares and returns the code related to a row in the GIS dataset as SVG.

Parameters

string $spatial

GIS data object
string $label

label for the GIS data object
string $fill_color

Color for the GIS POLYGON object
array $scale_data

data related to scaling

Return Value

string

the code related to a row in the GIS dataset

at line 88
ImageWrapper prepareRowAsPng(string $spatial, string|null $label, string $fill_color, array $scale_data, ImageWrapper $image)

Adds to the PNG image object, the data related to a row in the GIS dataset.

Parameters

string $spatial

GIS POLYGON object
string|null $label

Label for the GIS POLYGON object
string $fill_color

Color for the GIS POLYGON object
array $scale_data

Array containing data related to scaling
ImageWrapper $image

Return Value

ImageWrapper

at line 153
TCPDF prepareRowAsPdf(string $spatial, string|null $label, string $fill_color, array $scale_data, TCPDF $pdf)

Adds to the TCPDF instance, the data related to a row in the GIS dataset.

Parameters

string $spatial

GIS data object
string|null $label

label for the GIS data object
string $fill_color

Color for the GIS POLYGON object
array $scale_data

array containing data related to scaling
TCPDF $pdf

TCPDF instance

Return Value

TCPDF

the modified TCPDF instance

at line 267
string prepareRowAsOl(string $spatial, int $srid, string $label, array $fill_color, array $scale_data)

Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.

Parameters

string $spatial

GIS data object
int $srid

spatial reference ID
string $label

label for the GIS data object
array $fill_color

Color for the GIS POLYGON object
array $scale_data

array containing data related to scaling

Return Value

string

the JavaScript related to a row in the GIS dataset

at line 63
array scaleRow(string $spatial)

Scales each row.

Parameters

string $spatial

spatial data of a row

Return Value

array

array containing the min, max values for x and y coordinates

at line 335
string generateWkt(array $gis_data, int $index, string|null $empty = '')

Generate the WKT with the set of parameters passed by the GIS editor.

Parameters

array $gis_data

GIS data
int $index

index into the parameter object
string|null $empty

value for empty points

Return Value

string

WKT with the set of parameters passed by the GIS editor

in GisGeometry at line 125
protected string getBoundsForOl(int $srid, array $scale_data)

Returns OpenLayers.Bounds object that correspond to the bounds of GIS data.

Parameters

int $srid

spatial reference ID
array $scale_data

data related to scaling

Return Value

string

OpenLayers.Bounds object that correspond to the bounds of GIS data

in GisGeometry at line 149
protected array setMinMax(string $point_set, array $min_max)

Updates the min, max values with the given point set.

Parameters

string $point_set

point set
array $min_max

existing min, max values

Return Value

array

the updated min, max values

at line 546
array generateParams(string $value, int $index = -1)

Generate parameters for the GIS data editor from the value of the GIS column.

Parameters

string $value

value of the GIS column
int $index

Index of the geometry

Return Value

array

parameters for the GIS editor from the value of the GIS column

in GisGeometry at line 220
protected array extractPoints(string $point_set, array|null $scale_data, bool $linear = false)

Extracts points, scales and returns them as an array.

Parameters

string $point_set

string of comma separated points
array|null $scale_data

data related to scaling
bool $linear

if true, as a 1D array, else as a 2D array

Return Value

array

scaled points

in GisGeometry at line 268
protected string getPolygonArrayForOpenLayers(array $polygons, int $srid)

Generates JavaScript for adding an array of polygons to OpenLayers.

Parameters

array $polygons

x and y coordinates for each polygon
int $srid

spatial reference id

Return Value

string

JavaScript for adding an array of polygons to OpenLayers

in GisGeometry at line 288
protected string getPolygonForOpenLayers(array $polygon, int $srid)

Generates JavaScript for adding points for OpenLayers polygon.

Parameters

array $polygon

x and y coordinates for each line
int $srid

spatial reference id

Return Value

string

JavaScript for adding points for OpenLayers polygon

in GisGeometry at line 305
protected string getLineArrayForOpenLayers(array $lines, int $srid, bool $is_line_string = true)

Generates JavaScript for adding an array of LineString or LineRing to OpenLayers.

Parameters

array $lines

x and y coordinates for each line
int $srid

spatial reference id
bool $is_line_string

whether it's an array of LineString

Return Value

string

JavaScript for adding an array of LineString or LineRing to OpenLayers

in GisGeometry at line 332
protected string getLineForOpenLayers(array $points_arr, int $srid, bool $is_line_string = true)

Generates JavaScript for adding a LineString or LineRing to OpenLayers.

Parameters

array $points_arr

x and y coordinates for each point
int $srid

spatial reference id
bool $is_line_string

whether it's a LineString

Return Value

string

JavaScript for adding a LineString or LineRing to OpenLayers

in GisGeometry at line 351
protected string getPointsArrayForOpenLayers(array $points_arr, int $srid)

Generates JavaScript for adding an array of points to OpenLayers.

Parameters

array $points_arr

x and y coordinates for each point
int $srid

spatial reference id

Return Value

string

JavaScript for adding an array of points to OpenLayers

in GisGeometry at line 371
protected string getPointForOpenLayers(array $point, int $srid)

Generates JavaScript for adding a point to OpenLayers.

Parameters

array $point

array containing the x and y coordinates of the point
int $srid

spatial reference id

Return Value

string

JavaScript for adding points to OpenLayers

in GisGeometry at line 378
protected int getRandomId()

No description

Return Value

int

at line 47
static GisPolygon singleton()

Returns the singleton.

Return Value

GisPolygon

the singleton

at line 377
static float area(array $ring)

Calculates the area of a closed simple polygon.

Parameters

array $ring

array of points forming the ring

Return Value

float

the area of a closed simple polygon

at line 411
static bool isOuterRing(array $ring)

Determines whether a set of points represents an outer ring.

If points are in clockwise orientation then, they form an outer ring.

Parameters

array $ring

array of points forming the ring

Return Value

bool

at line 426
static bool isPointInsidePolygon(array $point, array $polygon)

Determines whether a given point is inside a given polygon.

Parameters

array $point

x, y coordinates of the point
array $polygon

array of points forming the ring

Return Value

bool

at line 479
static array|false getPointOnSurface(array $ring)

Returns a point that is guaranteed to be on the surface of the ring.

(for simple closed rings)

Parameters

array $ring

array of points forming the ring

Return Value

array|false

a point on the surface of the ring