phpmyadmin/libraries/gis/pma_gis_multipoint.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Handles actions related to GIS MULTIPOINT objects
   5  *
   6  * @package PhpMyAdmin-GIS
   7  */
   8
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /**
  14  * Handles actions related to GIS MULTIPOINT objects
  15  *
  16  * @package PhpMyAdmin-GIS
  17  */
  18 class PMA_GIS_Multipoint extends PMA_GIS_Geometry
  19 {
  20     // Hold the singleton instance of the class
  21     private static $_instance;
  22
  23     /**
  24      * A private constructor; prevents direct creation of object.
  25      *
  26      * @access private
  27      */
  28     private function __construct()
  29     {
  30     }
  31
  32     /**
  33      * Returns the singleton.
  34      *
  35      * @return object the singleton
  36      * @access public
  37      */
  38     public static function singleton()
  39     {
  40         if (!isset(self::$_instance)) {
  41             $class = __CLASS__;
  42             self::$_instance = new $class;
  43         }
  44
  45         return self::$_instance;
  46     }
  47
  48     /**
  49      * Scales each row.
  50      *
  51      * @param string $spatial spatial data of a row
  52      *
  53      * @return array an array containing the min, max values for x and y cordinates
  54      * @access public
  55      */
  56     public function scaleRow($spatial)
  57     {
  58         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
  59         $multipoint = substr($spatial, 11, (strlen($spatial) - 12));
  60         return $this->setMinMax($multipoint, array());
  61     }
  62
  63     /**
  64      * Adds to the PNG image object, the data related to a row in the GIS dataset.
  65      *
  66      * @param string $spatial     GIS MULTIPOINT object
  67      * @param string $label       Label for the GIS MULTIPOINT object
  68      * @param string $point_color Color for the GIS MULTIPOINT object
  69      * @param array  $scale_data  Array containing data related to scaling
  70      * @param object $image       Image object
  71      *
  72      * @return object the modified image object
  73      * @access public
  74      */
  75     public function prepareRowAsPng($spatial, $label, $point_color,
  76         $scale_data, $image
  77     ) {
  78         // allocate colors
  79         $black = imagecolorallocate($image, 0, 0, 0);
  80         $red   = hexdec(substr($point_color, 1, 2));
  81         $green = hexdec(substr($point_color, 3, 2));
  82         $blue  = hexdec(substr($point_color, 4, 2));
  83         $color = imagecolorallocate($image, $red, $green, $blue);
  84
  85         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
  86         $multipoint = substr($spatial, 11, (strlen($spatial) - 12));
  87         $points_arr = $this->extractPoints($multipoint, $scale_data);
  88
  89         foreach ($points_arr as $point) {
  90             // draw a small circle to mark the point
  91             if ($point[0] != '' && $point[1] != '') {
  92                 imagearc($image, $point[0], $point[1], 7, 7, 0, 360, $color);
  93             }
  94         }
  95         // print label for each point
  96         if ((isset($label) && trim($label) != '')
  97             && ($points_arr[0][0] != '' && $points_arr[0][1] != '')
  98         ) {
  99             imagestring(
 100                 $image, 1, $points_arr[0][0], $points_arr[0][1], trim($label), $black
 101             );
 102         }
 103         return $image;
 104     }
 105
 106     /**
 107      * Adds to the TCPDF instance, the data related to a row in the GIS dataset.
 108      *
 109      * @param string $spatial     GIS MULTIPOINT object
 110      * @param string $label       Label for the GIS MULTIPOINT object
 111      * @param string $point_color Color for the GIS MULTIPOINT object
 112      * @param array  $scale_data  Array containing data related to scaling
 113      * @param object $pdf         TCPDF instance
 114      *
 115      * @return object the modified TCPDF instance
 116      * @access public
 117      */
 118     public function prepareRowAsPdf($spatial, $label, $point_color,
 119         $scale_data, $pdf
 120     ) {
 121         // allocate colors
 122         $red   = hexdec(substr($point_color, 1, 2));
 123         $green = hexdec(substr($point_color, 3, 2));
 124         $blue  = hexdec(substr($point_color, 4, 2));
 125         $line  = array('width' => 1.25, 'color' => array($red, $green, $blue));
 126
 127         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
 128         $multipoint = substr($spatial, 11, (strlen($spatial) - 12));
 129         $points_arr = $this->extractPoints($multipoint, $scale_data);
 130
 131         foreach ($points_arr as $point) {
 132             // draw a small circle to mark the point
 133             if ($point[0] != '' && $point[1] != '') {
 134                 $pdf->Circle($point[0], $point[1], 2, 0, 360, 'D', $line);
 135             }
 136         }
 137         // print label for each point
 138         if ((isset($label) && trim($label) != '')
 139             && ($points_arr[0][0] != '' && $points_arr[0][1] != '')
 140         ) {
 141             $pdf->SetXY($points_arr[0][0], $points_arr[0][1]);
 142             $pdf->SetFontSize(5);
 143             $pdf->Cell(0, 0, trim($label));
 144         }
 145         return $pdf;
 146     }
 147
 148     /**
 149      * Prepares and returns the code related to a row in the GIS dataset as SVG.
 150      *
 151      * @param string $spatial     GIS MULTIPOINT object
 152      * @param string $label       Label for the GIS MULTIPOINT object
 153      * @param string $point_color Color for the GIS MULTIPOINT object
 154      * @param array  $scale_data  Array containing data related to scaling
 155      *
 156      * @return string the code related to a row in the GIS dataset
 157      * @access public
 158      */
 159     public function prepareRowAsSvg($spatial, $label, $point_color, $scale_data)
 160     {
 161         $point_options = array(
 162             'name'        => $label,
 163             'class'       => 'multipoint vector',
 164             'fill'        => 'white',
 165             'stroke'      => $point_color,
 166             'stroke-width'=> 2,
 167         );
 168
 169         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
 170         $multipoint = substr($spatial, 11, (strlen($spatial) - 12));
 171         $points_arr = $this->extractPoints($multipoint, $scale_data);
 172
 173         $row = '';
 174         foreach ($points_arr as $point) {
 175             if ($point[0] != '' && $point[1] != '') {
 176                 $row .= '<circle cx="' . $point[0] . '" cy="'
 177                     . $point[1] . '" r="3"';
 178                 $point_options['id'] = $label . rand();
 179                 foreach ($point_options as $option => $val) {
 180                     $row .= ' ' . $option . '="' . trim($val) . '"';
 181                 }
 182                 $row .= '/>';
 183             }
 184         }
 185
 186         return $row;
 187     }
 188
 189     /**
 190      * Prepares JavaScript related to a row in the GIS dataset
 191      * to visualize it with OpenLayers.
 192      *
 193      * @param string $spatial     GIS MULTIPOINT object
 194      * @param int    $srid        Spatial reference ID
 195      * @param string $label       Label for the GIS MULTIPOINT object
 196      * @param string $point_color Color for the GIS MULTIPOINT object
 197      * @param array  $scale_data  Array containing data related to scaling
 198      *
 199      * @return string JavaScript related to a row in the GIS dataset
 200      * @access public
 201      */
 202     public function prepareRowAsOl($spatial, $srid, $label,
 203         $point_color, $scale_data
 204     ) {
 205         $style_options = array(
 206             'pointRadius'  => 3,
 207             'fillColor'    => '#ffffff',
 208             'strokeColor'  => $point_color,
 209             'strokeWidth'  => 2,
 210             'label'        => $label,
 211             'labelYOffset' => -8,
 212             'fontSize'     => 10,
 213         );
 214         if ($srid == 0) {
 215             $srid = 4326;
 216         }
 217         $result = $this->getBoundsForOl($srid, $scale_data);
 218
 219         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
 220         $multipoint = substr($spatial, 11, (strlen($spatial) - 12));
 221         $points_arr = $this->extractPoints($multipoint, null);
 222
 223         $result .= 'vectorLayer.addFeatures(new OpenLayers.Feature.Vector('
 224             . 'new OpenLayers.Geometry.MultiPoint('
 225             . $this->getPointsArrayForOpenLayers($points_arr, $srid)
 226             . '), null, ' . json_encode($style_options) . '));';
 227         return $result;
 228     }
 229
 230     /**
 231      * Generate the WKT with the set of parameters passed by the GIS editor.
 232      *
 233      * @param array  $gis_data GIS data
 234      * @param int    $index    Index into the parameter object
 235      * @param string $empty    Multipoint does not adhere to this
 236      *
 237      * @return string WKT with the set of parameters passed by the GIS editor
 238      * @access public
 239      */
 240     public function generateWkt($gis_data, $index, $empty = '')
 241     {
 242         $no_of_points = isset($gis_data[$index]['MULTIPOINT']['no_of_points'])
 243             ? $gis_data[$index]['MULTIPOINT']['no_of_points'] : 1;
 244         if ($no_of_points < 1) {
 245             $no_of_points = 1;
 246         }
 247         $wkt = 'MULTIPOINT(';
 248         for ($i = 0; $i < $no_of_points; $i++) {
 249             $wkt .= ((isset($gis_data[$index]['MULTIPOINT'][$i]['x'])
 250                 && trim($gis_data[$index]['MULTIPOINT'][$i]['x']) != '')
 251                 ? $gis_data[$index]['MULTIPOINT'][$i]['x'] : '')
 252                 . ' ' . ((isset($gis_data[$index]['MULTIPOINT'][$i]['y'])
 253                 && trim($gis_data[$index]['MULTIPOINT'][$i]['y']) != '')
 254                 ? $gis_data[$index]['MULTIPOINT'][$i]['y'] : '') . ',';
 255         }
 256         $wkt = substr($wkt, 0, strlen($wkt) - 1);
 257         $wkt .= ')';
 258         return $wkt;
 259     }
 260
 261     /**
 262      * Generate the WKT for the data from ESRI shape files.
 263      *
 264      * @param array $row_data GIS data
 265      *
 266      * @return string the WKT for the data from ESRI shape files
 267      * @access public
 268      */
 269     public function getShape($row_data)
 270     {
 271         $wkt = 'MULTIPOINT(';
 272         for ($i = 0; $i < $row_data['numpoints']; $i++) {
 273             $wkt .= $row_data['points'][$i]['x'] . ' '
 274                 . $row_data['points'][$i]['y'] . ',';
 275         }
 276         $wkt = substr($wkt, 0, strlen($wkt) - 1);
 277         $wkt .= ')';
 278         return $wkt;
 279     }
 280
 281     /**
 282      * Generate parameters for the GIS data editor from the value of the GIS column.
 283      *
 284      * @param string $value of the GIS column
 285      * @param index  $index of the geometry
 286      *
 287      * @return array params for the GIS data editor from the value of the GIS column
 288      * @access public
 289      */
 290     public function generateParams($value, $index = -1)
 291     {
 292         if ($index == -1) {
 293             $index = 0;
 294             $params = array();
 295             $data = PMA_GIS_Geometry::generateParams($value);
 296             $params['srid'] = $data['srid'];
 297             $wkt = $data['wkt'];
 298         } else {
 299             $params[$index]['gis_type'] = 'MULTIPOINT';
 300             $wkt = $value;
 301         }
 302
 303         // Trim to remove leading 'MULTIPOINT(' and trailing ')'
 304         $points = substr($wkt, 11, (strlen($wkt) - 12));
 305         $points_arr = $this->extractPoints($points, null);
 306
 307         $no_of_points = count($points_arr);
 308         $params[$index]['MULTIPOINT']['no_of_points'] = $no_of_points;
 309         for ($i = 0; $i < $no_of_points; $i++) {
 310             $params[$index]['MULTIPOINT'][$i]['x'] = $points_arr[$i][0];
 311             $params[$index]['MULTIPOINT'][$i]['y'] = $points_arr[$i][1];
 312         }
 313
 314         return $params;
 315     }
 316
 317     /**
 318      * Overidden to make sure that only the points having valid values
 319      * for x and y coordinates are added.
 320      *
 321      * @param array  $points_arr x and y coordinates for each point
 322      * @param string $srid       spatial reference id
 323      *
 324      * @return string JavaScript for adding an array of points to OpenLayers
 325      * @access protected
 326      */
 327     protected function getPointsArrayForOpenLayers($points_arr, $srid)
 328     {
 329         $ol_array = 'new Array(';
 330         foreach ($points_arr as $point) {
 331             if ($point[0] != '' && $point[1] != '') {
 332                 $ol_array .= $this->getPointForOpenLayers($point, $srid) . ', ';
 333             }
 334         }
 335         if (substr($ol_array, strlen($ol_array) - 2) == ', ') {
 336             $ol_array = substr($ol_array, 0, strlen($ol_array) - 2);
 337         }
 338         $ol_array .= ')';
 339
 340         return $ol_array;
 341     }
 342 }
 343 ?>