phpmyadmin/libraries/gis/GIS_Geometry.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Base class for all GIS data type classes
   5  *
   6  * @package PhpMyAdmin-GIS
   7  */
   8
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * Base class for all GIS data type classes.
  15  *
  16  * @package PhpMyAdmin-GIS
  17  */
  18 abstract class PMA_GIS_Geometry
  19 {
  20     /**
  21      * Prepares and returns the code related to a row in the GIS dataset as SVG.
  22      *
  23      * @param string $spatial    GIS data object
  24      * @param string $label      label for the GIS data object
  25      * @param string $color      color for the GIS data object
  26      * @param array  $scale_data data related to scaling
  27      *
  28      * @return string the code related to a row in the GIS dataset
  29      * @access public
  30      */
  31     public abstract function prepareRowAsSvg($spatial, $label, $color, $scale_data);
  32
  33     /**
  34      * Adds to the PNG image object, the data related to a row in the GIS dataset.
  35      *
  36      * @param string $spatial    GIS data object
  37      * @param string $label      label for the GIS data object
  38      * @param string $color      color for the GIS data object
  39      * @param array  $scale_data array containing data related to scaling
  40      * @param object $image      image object
  41      *
  42      * @return object the modified image object
  43      * @access public
  44      */
  45     public abstract function prepareRowAsPng($spatial, $label, $color,
  46         $scale_data, $image
  47     );
  48
  49     /**
  50      * Adds to the TCPDF instance, the data related to a row in the GIS dataset.
  51      *
  52      * @param string $spatial    GIS data object
  53      * @param string $label      label for the GIS data object
  54      * @param string $color      color for the GIS data object
  55      * @param array  $scale_data array containing data related to scaling
  56      * @param TCPDF  $pdf        TCPDF instance
  57      *
  58      * @return TCPDF the modified TCPDF instance
  59      * @access public
  60      */
  61     public abstract function prepareRowAsPdf($spatial, $label, $color,
  62         $scale_data, $pdf
  63     );
  64
  65     /**
  66      * Prepares the JavaScript related to a row in the GIS dataset
  67      * to visualize it with OpenLayers.
  68      *
  69      * @param string $spatial    GIS data object
  70      * @param int    $srid       spatial reference ID
  71      * @param string $label      label for the GIS data object
  72      * @param string $color      color for the GIS data object
  73      * @param array  $scale_data array containing data related to scaling
  74      *
  75      * @return string the JavaScript related to a row in the GIS dataset
  76      * @access public
  77      */
  78     public abstract function prepareRowAsOl($spatial, $srid, $label,
  79         $color, $scale_data
  80     );
  81
  82     /**
  83      * Scales each row.
  84      *
  85      * @param string $spatial spatial data of a row
  86      *
  87      * @return array array containing the min, max values for x and y coordinates
  88      * @access public
  89      */
  90     public abstract function scaleRow($spatial);
  91
  92     /**
  93      * Generates the WKT with the set of parameters passed by the GIS editor.
  94      *
  95      * @param array  $gis_data GIS data
  96      * @param int    $index    index into the parameter object
  97      * @param string $empty    value for empty points
  98      *
  99      * @return string WKT with the set of parameters passed by the GIS editor
 100      * @access public
 101      */
 102     public abstract function generateWkt($gis_data, $index, $empty = '');
 103
 104     /**
 105      * Returns OpenLayers.Bounds object that correspond to the bounds of GIS data.
 106      *
 107      * @param string $srid       spatial reference ID
 108      * @param array  $scale_data data related to scaling
 109      *
 110      * @return string OpenLayers.Bounds object that
 111      *                correspond to the bounds of GIS data
 112      * @access protected
 113      */
 114     protected function getBoundsForOl($srid, $scale_data)
 115     {
 116         return 'bound = new OpenLayers.Bounds(); '
 117             . 'bound.extend(new OpenLayers.LonLat('
 118             . $scale_data['minX'] . ', ' . $scale_data['minY']
 119             . ').transform(new OpenLayers.Projection("EPSG:'
 120             . $srid . '"), map.getProjectionObject())); '
 121             . 'bound.extend(new OpenLayers.LonLat('
 122             . $scale_data['maxX'] . ', ' . $scale_data['maxY']
 123             . ').transform(new OpenLayers.Projection("EPSG:'
 124             . $srid . '"), map.getProjectionObject()));';
 125     }
 126
 127     /**
 128      * Updates the min, max values with the given point set.
 129      *
 130      * @param string $point_set point set
 131      * @param array  $min_max   existing min, max values
 132      *
 133      * @return array the updated min, max values
 134      * @access protected
 135      */
 136     protected function setMinMax($point_set, $min_max)
 137     {
 138         // Separate each point
 139         $points = explode(",", $point_set);
 140
 141         foreach ($points as $point) {
 142             // Extract coordinates of the point
 143             $cordinates = explode(" ", $point);
 144
 145             $x = (float) $cordinates[0];
 146             if (! isset($min_max['maxX']) || $x > $min_max['maxX']) {
 147                 $min_max['maxX'] = $x;
 148             }
 149             if (! isset($min_max['minX']) || $x < $min_max['minX']) {
 150                 $min_max['minX'] = $x;
 151             }
 152             $y = (float) $cordinates[1];
 153             if (! isset($min_max['maxY']) || $y > $min_max['maxY']) {
 154                 $min_max['maxY'] = $y;
 155             }
 156             if (! isset($min_max['minY']) || $y < $min_max['minY']) {
 157                 $min_max['minY'] = $y;
 158             }
 159         }
 160         return $min_max;
 161     }
 162
 163     /**
 164      * Generates parameters for the GIS data editor from the value of the GIS column.
 165      * This method performs common work.
 166      * More specific work is performed by each of the geom classes.
 167      *
 168      * @param string $value value of the GIS column
 169      *
 170      * @return array parameters for the GIS editor from the value of the GIS column
 171      * @access protected
 172      */
 173     protected function generateParams($value)
 174     {
 175         $geom_types = '(POINT|MULTIPOINT|LINESTRING|MULTILINESTRING'
 176             . '|POLYGON|MULTIPOLYGON|GEOMETRYCOLLECTION)';
 177         $srid = 0;
 178         $wkt = '';
 179
 180         if (preg_match("/^'" . $geom_types . "\(.*\)',[0-9]*$/i", $value)) {
 181             $last_comma = /*overload*/mb_strripos($value, ",");
 182             $srid = trim(/*overload*/mb_substr($value, $last_comma + 1));
 183             $wkt = trim(/*overload*/mb_substr($value, 1, $last_comma - 2));
 184         } elseif (preg_match("/^" . $geom_types . "\(.*\)$/i", $value)) {
 185             $wkt = $value;
 186         }
 187         return array('srid' => $srid, 'wkt' => $wkt);
 188     }
 189
 190     /**
 191      * Extracts points, scales and returns them as an array.
 192      *
 193      * @param string  $point_set  string of comma separated points
 194      * @param array   $scale_data data related to scaling
 195      * @param boolean $linear     if true, as a 1D array, else as a 2D array
 196      *
 197      * @return array scaled points
 198      * @access protected
 199      */
 200     protected function extractPoints($point_set, $scale_data, $linear = false)
 201     {
 202         $points_arr = array();
 203
 204         // Separate each point
 205         $points = explode(",", $point_set);
 206
 207         foreach ($points as $point) {
 208             // Extract coordinates of the point
 209             $cordinates = explode(" ", $point);
 210
 211             if (isset($cordinates[0]) && trim($cordinates[0]) != ''
 212                 && isset($cordinates[1]) && trim($cordinates[1]) != ''
 213             ) {
 214                 if ($scale_data != null) {
 215                     $x = ($cordinates[0] - $scale_data['x']) * $scale_data['scale'];
 216                     $y = $scale_data['height']
 217                         - ($cordinates[1] - $scale_data['y']) * $scale_data['scale'];
 218                 } else {
 219                     $x = trim($cordinates[0]);
 220                     $y = trim($cordinates[1]);
 221                 }
 222             } else {
 223                 $x = '';
 224                 $y = '';
 225             }
 226
 227             if (! $linear) {
 228                 $points_arr[] = array($x, $y);
 229             } else {
 230                 $points_arr[] = $x;
 231                 $points_arr[] = $y;
 232             }
 233         }
 234
 235         return $points_arr;
 236     }
 237
 238     /**
 239      * Generates JavaScript for adding an array of polygons to OpenLayers.
 240      *
 241      * @param array  $polygons x and y coordinates for each polygon
 242      * @param string $srid     spatial reference id
 243      *
 244      * @return string JavaScript for adding an array of polygons to OpenLayers
 245      * @access protected
 246      */
 247     protected function getPolygonArrayForOpenLayers($polygons, $srid)
 248     {
 249         $ol_array = 'new Array(';
 250         foreach ($polygons as $polygon) {
 251             $rings = explode("),(", $polygon);
 252             $ol_array .= $this->getPolygonForOpenLayers($rings, $srid) . ', ';
 253         }
 254
 255         $ol_array = /*overload*/mb_substr(
 256             $ol_array,
 257             0,
 258             /*overload*/mb_strlen($ol_array) - 2
 259         );
 260         $ol_array .= ')';
 261
 262         return $ol_array;
 263     }
 264
 265     /**
 266      * Generates JavaScript for adding points for OpenLayers polygon.
 267      *
 268      * @param array  $polygon x and y coordinates for each line
 269      * @param string $srid    spatial reference id
 270      *
 271      * @return string JavaScript for adding points for OpenLayers polygon
 272      * @access protected
 273      */
 274     protected function getPolygonForOpenLayers($polygon, $srid)
 275     {
 276         return 'new OpenLayers.Geometry.Polygon('
 277             . $this->getLineArrayForOpenLayers($polygon, $srid, false)
 278             . ')';
 279     }
 280
 281     /**
 282      * Generates JavaScript for adding an array of LineString
 283      * or LineRing to OpenLayers.
 284      *
 285      * @param array  $lines          x and y coordinates for each line
 286      * @param string $srid           spatial reference id
 287      * @param bool   $is_line_string whether it's an array of LineString
 288      *
 289      * @return string JavaScript for adding an array of LineString
 290      *                or LineRing to OpenLayers
 291      * @access protected
 292      */
 293     protected function getLineArrayForOpenLayers($lines, $srid,
 294         $is_line_string = true
 295     ) {
 296         $ol_array = 'new Array(';
 297         foreach ($lines as $line) {
 298             $points_arr = $this->extractPoints($line, null);
 299             $ol_array .= $this->getLineForOpenLayers(
 300                 $points_arr, $srid, $is_line_string
 301             );
 302             $ol_array .= ', ';
 303         }
 304
 305         $ol_array = /*overload*/mb_substr(
 306             $ol_array,
 307             0,
 308             /*overload*/mb_strlen($ol_array) - 2
 309         );
 310         $ol_array .= ')';
 311
 312         return $ol_array;
 313     }
 314
 315     /**
 316      * Generates JavaScript for adding a LineString or LineRing to OpenLayers.
 317      *
 318      * @param array  $points_arr     x and y coordinates for each point
 319      * @param string $srid           spatial reference id
 320      * @param bool   $is_line_string whether it's a LineString
 321      *
 322      * @return string JavaScript for adding a LineString or LineRing to OpenLayers
 323      * @access protected
 324      */
 325     protected function getLineForOpenLayers($points_arr, $srid,
 326         $is_line_string = true
 327     ) {
 328         return 'new OpenLayers.Geometry.'
 329             . ($is_line_string ? 'LineString' : 'LinearRing') . '('
 330             . $this->getPointsArrayForOpenLayers($points_arr, $srid)
 331             . ')';
 332     }
 333
 334     /**
 335      * Generates JavaScript for adding an array of points to OpenLayers.
 336      *
 337      * @param array  $points_arr x and y coordinates for each point
 338      * @param string $srid       spatial reference id
 339      *
 340      * @return string JavaScript for adding an array of points to OpenLayers
 341      * @access protected
 342      */
 343     protected function getPointsArrayForOpenLayers($points_arr, $srid)
 344     {
 345         $ol_array = 'new Array(';
 346         foreach ($points_arr as $point) {
 347             $ol_array .= $this->getPointForOpenLayers($point, $srid) . ', ';
 348         }
 349
 350         $ol_array = /*overload*/mb_substr(
 351             $ol_array,
 352             0,
 353             /*overload*/mb_strlen($ol_array) - 2
 354         );
 355         $ol_array .= ')';
 356
 357         return $ol_array;
 358     }
 359
 360     /**
 361      * Generates JavaScript for adding a point to OpenLayers.
 362      *
 363      * @param array  $point array containing the x and y coordinates of the point
 364      * @param string $srid  spatial reference id
 365      *
 366      * @return string JavaScript for adding points to OpenLayers
 367      * @access protected
 368      */
 369     protected function getPointForOpenLayers($point, $srid)
 370     {
 371         return '(new OpenLayers.Geometry.Point(' . $point[0] . ',' . $point[1] . '))'
 372             . '.transform(new OpenLayers.Projection("EPSG:'
 373             . $srid . '"), map.getProjectionObject())';
 374     }
 375 }