gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better doc comments

Browse Source
This commit is contained in:
Madhura Jayaratne 2011-06-16 08:39:23 +05:30
parent 92f4d21456
commit 7a232336f7
8 changed files with 72 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
libraries/gis/pma_gis_geometry.php
View File

@ -21,16 +21,42 @@ abstract class PMA_GIS_Geometry
/**
* Adds to the PNG image object, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS GEOMETRYCOLLECTION object
* @param string $label Label for the GIS GEOMETRYCOLLECTION object
* @param string $color Color for the GIS GEOMETRYCOLLECTION object
* @param string $spatial GIS data object
* @param string $label Label for the GIS data object
* @param string $color Color for the GIS data object
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public abstract function prepareRowAsPng($spatial, $label, $color, $scale_data, $image);
/**
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS data object
* @param string $label Label for the GIS data object
* @param string $line_color Color for the GIS data object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf TCPDF instance
*
* @return the modified TCPDF instance
*/
public abstract function prepareRowAsPdf($spatial, $label, $line_color, $scale_data, $pdf);
/**
* Prepares the JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS data object
* @param int $srid Spatial reference ID
* @param string $label Label for the GIS data object
* @param string $point_color Color for the GIS data object
* @param array $scale_data Array containing data related to scaling
*
* @return the JavaScript related to a row in the GIS dataset
*/
public abstract function prepareRowAsOl($spatial, $srid, $label, $point_color, $scale_data);
/**
* Scales each row.
*

12
libraries/gis/pma_gis_geometrycollection.php
View File

@ -88,7 +88,7 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $color, $scale_data, $image)
{
@ -108,15 +108,15 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS GEOMETRYCOLLECTION object
* @param string $label Label for the GIS GEOMETRYCOLLECTION object
* @param string $color Color for the GIS GEOMETRYCOLLECTION object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $color, $scale_data, $pdf)
{
@ -165,7 +165,7 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS GEOMETRYCOLLECTION object
* @param int $srid Spatial reference ID
@ -173,7 +173,7 @@ class PMA_GIS_Geometrycollection extends PMA_GIS_Geometry
* @param string $color Color for the GIS GEOMETRYCOLLECTION object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $color, $scale_data)
{

12
libraries/gis/pma_gis_linestring.php
View File

@ -54,7 +54,7 @@ class PMA_GIS_Linestring extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $line_color, $scale_data, $image)
{
@ -81,15 +81,15 @@ class PMA_GIS_Linestring extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS LINESTRING object
* @param string $label Label for the GIS LINESTRING object
* @param string $line_color Color for the GIS LINESTRING object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $line_color, $scale_data, $pdf)
{
@ -154,7 +154,7 @@ class PMA_GIS_Linestring extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS LINESTRING object
* @param int $srid Spatial reference ID
@ -162,7 +162,7 @@ class PMA_GIS_Linestring extends PMA_GIS_Geometry
* @param string $line_color Color for the GIS LINESTRING object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $line_color, $scale_data)
{

12
libraries/gis/pma_gis_multilinestring.php
View File

@ -63,7 +63,7 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $line_color, $scale_data, $image)
{
@ -95,15 +95,15 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS MULTILINESTRING object
* @param string $label Label for the GIS MULTILINESTRING object
* @param string $line_color Color for the GIS MULTILINESTRING object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $line_color, $scale_data, $pdf)
{
@ -179,7 +179,7 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS MULTILINESTRING object
* @param int $srid Spatial reference ID
@ -187,7 +187,7 @@ class PMA_GIS_Multilinestring extends PMA_GIS_Geometry
* @param string $line_color Color for the GIS MULTILINESTRING object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $line_color, $scale_data)
{

12
libraries/gis/pma_gis_multipoint.php
View File

@ -54,7 +54,7 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $line_color, $scale_data, $image)
{
@ -76,15 +76,15 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS MULTIPOINT object
* @param string $label Label for the GIS MULTIPOINT object
* @param string $line_color Color for the GIS MULTIPOINT object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $line_color, $scale_data, $pdf)
{
@ -143,7 +143,7 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS MULTIPOINT object
* @param int $srid Spatial reference ID
@ -151,7 +151,7 @@ class PMA_GIS_Multipoint extends PMA_GIS_Geometry
* @param string $point_color Color for the GIS MULTIPOINT object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $point_color, $scale_data)
{

12
libraries/gis/pma_gis_multipolygon.php
View File

@ -77,7 +77,7 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $fill_color, $scale_data, $image)
{
@ -117,15 +117,15 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS MULTIPOLYGON object
* @param string $label Label for the GIS MULTIPOLYGON object
* @param string $fill_color Color for the GIS MULTIPOLYGON object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $fill_color, $scale_data, $pdf)
{
@ -223,7 +223,7 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS MULTIPOLYGON object
* @param int $srid Spatial reference ID
@ -231,7 +231,7 @@ class PMA_GIS_Multipolygon extends PMA_GIS_Geometry
* @param string $fill_color Color for the GIS MULTIPOLYGON object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $fill_color, $scale_data)
{

12
libraries/gis/pma_gis_point.php
View File

@ -54,7 +54,7 @@ class PMA_GIS_Point extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $line_color, $scale_data, $image)
{
@ -74,15 +74,15 @@ class PMA_GIS_Point extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS POINT object
* @param string $label Label for the GIS POINT object
* @param string $line_color Color for the GIS POINT object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $line_color, $scale_data, $pdf)
{
@ -136,7 +136,7 @@ class PMA_GIS_Point extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS POINT object
* @param int $srid Spatial reference ID
@ -144,7 +144,7 @@ class PMA_GIS_Point extends PMA_GIS_Geometry
* @param string $point_color Color for the GIS POINT object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $point_color, $scale_data)
{

12
libraries/gis/pma_gis_polygon.php
View File

@ -72,7 +72,7 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
* @param array $scale_data Array containing data related to scaling
* @param image $image Image object
*
* @return the code related to a row in the GIS dataset
* @return the modified image object
*/
public function prepareRowAsPng($spatial, $label, $fill_color, $scale_data, $image)
{
@ -109,15 +109,15 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
}
/**
* Adds to the PDF object, the data related to a row in the GIS dataset.
* Adds to the TCPDF instance, the data related to a row in the GIS dataset.
*
* @param string $spatial GIS POLYGON object
* @param string $label Label for the GIS POLYGON object
* @param string $fill_color Color for the GIS POLYGON object
* @param array $scale_data Array containing data related to scaling
* @param image $pdf Pdf object
* @param image $pdf TCPDF instance
*
* @return the code related to a row in the GIS dataset
* @return the modified TCPDF instance
*/
public function prepareRowAsPdf($spatial, $label, $fill_color, $scale_data, $pdf)
{
@ -206,7 +206,7 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
}
/**
* Prepares the code related to a row in the GIS dataset to visualize it with OpenLayers.
* Prepares JavaScript related to a row in the GIS dataset to visualize it with OpenLayers.
*
* @param string $spatial GIS POLYGON object
* @param int $srid Spatial reference ID
@ -214,7 +214,7 @@ class PMA_GIS_Polygon extends PMA_GIS_Geometry
* @param string $fill_color Color for the GIS POLYGON object
* @param array $scale_data Array containing data related to scaling
*
* @return the code related to a row in the GIS dataset
* @return JavaScript related to a row in the GIS dataset
*/
public function prepareRowAsOl($spatial, $srid, $label, $fill_color, $scale_data)
{