Raphaël G. Git Repositories - packbundle/blob - Util/MapUtil.php

   1 <?php declare(strict_types=1);
   2
   3 /*
   4  * This file is part of the Rapsys PackBundle package.
   5  *
   6  * (c) Raphaël Gertz <symfony@rapsys.eu>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Rapsys\PackBundle\Util;
  13
  14 use Symfony\Component\Routing\RouterInterface;
  15
  16 /**
  17  * Helps manage map
  18  */
  19 class MapUtil {
  20         /**
  21          * The cycle tile server
  22          *
  23          * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Tile_servers
  24          */
  25         const cycle = 'http://a.tile.thunderforest.com/cycle/{Z}/{X}/{Y}.png';
  26
  27         /**
  28          * The fill color
  29          */
  30         const fill = '#cff';
  31
  32         /**
  33          * The font size
  34          */
  35         const fontSize = 20;
  36
  37         /**
  38          * The high fill color
  39          */
  40         const highFill = '#c3c3f9';
  41
  42         /**
  43          * The high font size
  44          */
  45         const highFontSize = 30;
  46
  47         /**
  48          * The high radius size
  49          */
  50         const highRadius = 6;
  51
  52         /**
  53          * The high stroke color
  54          */
  55         const highStroke = '#3333c3';
  56
  57         /**
  58          * The high stroke size
  59          */
  60         const highStrokeWidth = 4;
  61
  62         /**
  63          * The map width
  64          */
  65         const width = 640;
  66
  67         /**
  68          * The map height
  69          */
  70         const height = 640;
  71
  72         /**
  73          * The osm tile server
  74          *
  75          * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Tile_servers
  76          */
  77         const osm = 'https://tile.openstreetmap.org/{Z}/{X}/{Y}.png';
  78
  79         /**
  80          * The radius size
  81          */
  82         const radius = 5;
  83
  84         /**
  85          * The stroke color
  86          */
  87         const stroke = '#00c3f9';
  88
  89         /**
  90          * The stroke size
  91          */
  92         const strokeWidth = 2;
  93
  94         /**
  95          * The transport tile server
  96          *
  97          * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Tile_servers
  98          */
  99         const transport = 'http://a.tile.thunderforest.com/transport/{Z}/{X}/{Y}.png';
 100
 101         /**
 102          * The tile size
 103          */
 104         const tz = 256;
 105
 106         /**
 107          * The map zoom
 108          */
 109         const zoom = 17;
 110
 111         /**
 112          * The RouterInterface instance
 113          */
 114         protected RouterInterface $router;
 115
 116         /**
 117          * The SluggerUtil instance
 118          */
 119         protected SluggerUtil $slugger;
 120
 121         /**
 122          * The fill color
 123          */
 124         public string $fill;
 125
 126         /**
 127          * The font size
 128          */
 129         public int $fontSize;
 130
 131         /**
 132          * The high fill color
 133          */
 134         public string $highFill;
 135
 136         /**
 137          * The font size
 138          */
 139         public int $highFontSize;
 140
 141         /**
 142          * The radius size
 143          */
 144         public int $highRadius;
 145
 146         /**
 147          * The high stroke color
 148          */
 149         public string $highStroke;
 150
 151         /**
 152          * The stroke size
 153          */
 154         public int $highStrokeWidth;
 155
 156         /**
 157          * The stroke color
 158          */
 159         public string $stroke;
 160
 161         /**
 162          * The stroke size
 163          */
 164         public int $strokeWidth;
 165
 166         /**
 167          * The radius size
 168          */
 169         public int $radius;
 170
 171         /**
 172          * Creates a new map util
 173          *
 174          * @param RouterInterface $router The RouterInterface instance
 175          * @param SluggerUtil $slugger The SluggerUtil instance
 176          */
 177         function __construct(RouterInterface $router, SluggerUtil $slugger, string $fill = self::fill, int $fontSize = self::fontSize, string $highFill = self::highFill, int $highFontSize = self::highFontSize, int $highRadius = self::highRadius, string $highStroke = self::highStroke, int $highStrokeWidth = self::highStrokeWidth, int $radius = self::radius, string $stroke = self::stroke, int $strokeWidth = self::strokeWidth) {
 178                 //Set router
 179                 $this->router = $router;
 180
 181                 //Set slugger
 182                 $this->slugger = $slugger;
 183
 184                 //Set fill
 185                 $this->fill = $fill;
 186
 187                 //Set font size
 188                 $this->fontSize = $fontSize;
 189
 190                 //Set highFill
 191                 $this->highFill = $highFill;
 192
 193                 //Set high font size
 194                 $this->highFontSize = $highFontSize;
 195
 196                 //Set high radius size
 197                 $this->highRadius = $highRadius;
 198
 199                 //Set highStroke
 200                 $this->highStroke = $highStroke;
 201
 202                 //Set high stroke size
 203                 $this->highStrokeWidth = $highStrokeWidth;
 204
 205                 //Set radius size
 206                 $this->radius = $radius;
 207
 208                 //Set stroke
 209                 $this->stroke = $stroke;
 210
 211                 //Set stroke size
 212                 $this->strokeWidth = $strokeWidth;
 213         }
 214
 215         /**
 216          * Get map data
 217          *
 218          * @param string $caption The caption
 219          * @param int $updated The updated timestamp
 220          * @param float $latitude The latitude
 221          * @param float $longitude The longitude
 222          * @param int $zoom The zoom
 223          * @param int $width The width
 224          * @param int $height The height
 225          * @return array The map data
 226          */
 227         public function getMap(string $caption, int $updated, float $latitude, float $longitude, int $zoom = self::zoom, int $width = self::width, int $height = self::height): array {
 228                 //Set link hash
 229                 $link = $this->slugger->hash([$updated, $latitude, $longitude, $zoom + 1, $width * 2, $height * 2]);
 230
 231                 //Set src hash
 232                 $src = $this->slugger->hash([$updated, $latitude, $longitude, $zoom, $width, $height]);
 233
 234                 //Return array
 235                 return [
 236                         'caption' => $caption,
 237                         'link' => $this->router->generate('rapsys_pack_map', ['hash' => $link, 'updated' => $updated, 'latitude' => $latitude, 'longitude' => $longitude, 'zoom' => $zoom + 1, 'width' => $width * 2, 'height' => $height * 2]),
 238                         'src' => $this->router->generate('rapsys_pack_map', ['hash' => $src, 'updated' => $updated, 'latitude' => $latitude, 'longitude' => $longitude, 'zoom' => $zoom, 'width' => $width, 'height' => $height]),
 239                         'width' => $width,
 240                         'height' => $height
 241                 ];
 242         }
 243
 244         /**
 245          * Get multi map data
 246          *
 247          * @param string $caption The caption
 248          * @param int $updated The updated timestamp
 249          * @param float $latitude The latitude
 250          * @param float $longitude The longitude
 251          * @param array $coordinates The coordinates array
 252          * @param int $zoom The zoom
 253          * @param int $width The width
 254          * @param int $height The height
 255          * @return array The multi map data
 256          */
 257         public function getMultiMap(string $caption, int $updated, float $latitude, float $longitude, $coordinates = [], int $zoom = self::zoom, int $width = self::width, int $height = self::height): array {
 258                 //Set coordinate
 259                 $coordinate = implode('-', array_map(function ($v) { return $v['latitude'].','.$v['longitude']; }, $coordinates));
 260
 261                 //Set coordinate hash
 262                 $hash = $this->slugger->hash($coordinate);
 263
 264                 //Set link hash
 265                 $link = $this->slugger->hash([$updated, $latitude, $longitude, $hash, $zoom + 1, $width * 2, $height * 2]);
 266
 267                 //Set src hash
 268                 $src = $this->slugger->hash([$updated, $latitude, $longitude, $hash, $zoom, $width, $height]);
 269
 270                 //Return array
 271                 return [
 272                         'caption' => $caption,
 273                         'link' => $this->router->generate('rapsys_pack_multimap', ['hash' => $link, 'updated' => $updated, 'latitude' => $latitude, 'longitude' => $longitude, 'coordinates' => $coordinate, 'zoom' => $zoom + 1, 'width' => $width * 2, 'height' => $height * 2]),
 274                         'src' => $this->router->generate('rapsys_pack_multimap', ['hash' => $src, 'updated' => $updated, 'latitude' => $latitude, 'longitude' => $longitude, 'coordinates' => $coordinate, 'zoom' => $zoom, 'width' => $width, 'height' => $height]),
 275                         'width' => $width,
 276                         'height' => $height
 277                 ];
 278         }
 279
 280         /**
 281          * Get multi zoom
 282          *
 283          * Compute a zoom to have all coordinates on multi map
 284          * Multi map visible only from -($width / 2) until ($width / 2) and from -($height / 2) until ($height / 2)
 285          *
 286          * @see Wether we need to take in consideration circle radius in coordinates comparisons, likely +/-(radius / self::tz)
 287          *
 288          * @param float $latitude The latitude
 289          * @param float $longitude The longitude
 290          * @param array $coordinates The coordinates array
 291          * @param int $zoom The zoom
 292          * @param int $width The width
 293          * @param int $height The height
 294          * @return int The zoom
 295          */
 296         public function getMultiZoom(float $latitude, float $longitude, array $coordinates = [], int $zoom = self::zoom, int $width = self::width, int $height = self::height): int {
 297                 //Iterate on each zoom
 298                 for ($i = $zoom; $i >= 1; $i--) {
 299                         //Get tile xy
 300                         $centerX = self::longitudeToX($longitude, $i);
 301                         $centerY = self::latitudeToY($latitude, $i);
 302
 303                         //Calculate start xy
 304                         $startX = floor($centerX - $width / 2 / self::tz);
 305                         $startY = floor($centerY - $height / 2 / self::tz);
 306
 307                         //Calculate end xy
 308                         $endX = ceil($centerX + $width / 2 / self::tz);
 309                         $endY = ceil($centerY + $height / 2 / self::tz);
 310
 311                         //Iterate on each coordinates
 312                         foreach($coordinates as $k => $coordinate) {
 313                                 //Set dest x
 314                                 $destX = self::longitudeToX($coordinate['longitude'], $i);
 315
 316                                 //With outside point
 317                                 if ($startX >= $destX || $endX <= $destX) {
 318                                         //Skip zoom
 319                                         continue(2);
 320                                 }
 321
 322                                 //Set dest y
 323                                 $destY = self::latitudeToY($coordinate['latitude'], $i);
 324
 325                                 //With outside point
 326                                 if ($startY >= $destY || $endY <= $destY) {
 327                                         //Skip zoom
 328                                         continue(2);
 329                                 }
 330                         }
 331
 332                         //Found zoom
 333                         break;
 334                 }
 335
 336                 //Return zoom
 337                 return $i;
 338         }
 339
 340         /**
 341          * Convert longitude to tile x number
 342          *
 343          * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Lon..2Flat._to_tile_numbers_5
 344          *
 345          * @param float $longitude The longitude
 346          * @param int $zoom The zoom
 347          *
 348          * @return float The tile x
 349          */
 350         public static function longitudeToX(float $longitude, int $zoom): float {
 351                 return (($longitude + 180) / 360) * pow(2, $zoom);
 352         }
 353
 354         /**
 355          * Convert latitude to tile y number
 356          *
 357          * @see https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Lon..2Flat._to_tile_numbers_5
 358          *
 359          * @param $latitude The latitude
 360          * @param $zoom The zoom
 361          *
 362          * @return float The tile y
 363          */
 364         public static function latitudeToY(float $latitude, int $zoom): float {
 365                 return (1 - log(tan(deg2rad($latitude)) + 1 / cos(deg2rad($latitude))) / pi()) / 2 * pow(2, $zoom);
 366         }
 367
 368         /**
 369          * Convert tile x to longitude
 370          *
 371          * @param float $x The tile x
 372          * @param int $zoom The zoom
 373          *
 374          * @return float The longitude
 375          */
 376         public static function xToLongitude(float $x, int $zoom): float {
 377                 return $x / pow(2, $zoom) * 360.0 - 180.0;
 378         }
 379
 380         /**
 381          * Convert tile y to latitude
 382          *
 383          * @param float $y The tile y
 384          * @param int $zoom The zoom
 385          *
 386          * @return float The latitude
 387          */
 388         public static function yToLatitude(float $y, int $zoom): float {
 389                 return rad2deg(atan(sinh(pi() * (1 - 2 * $y / pow(2, $zoom)))));
 390         }
 391
 392         /**
 393          * Convert decimal latitude to sexagesimal
 394          *
 395          * @param float $latitude The decimal latitude
 396          *
 397          * @return string The sexagesimal longitude
 398          */
 399         public static function latitudeToSexagesimal(float $latitude): string {
 400                 //Set degree
 401                 $degree = $latitude % 60;
 402
 403                 //Set minute
 404                 $minute = ($latitude - $degree) * 60 % 60;
 405
 406                 //Set second
 407                 $second = ($latitude - $degree - $minute / 60) * 3600 % 3600;
 408
 409                 //Return sexagesimal longitude
 410                 return $degree.'°'.$minute.'\''.$second.'"'.($latitude >= 0 ? 'N' : 'S');
 411         }
 412
 413         /**
 414          * Convert decimal longitude to sexagesimal
 415          *
 416          * @param float $longitude The decimal longitude
 417          *
 418          * @return string The sexagesimal longitude
 419          */
 420         public static function longitudeToSexagesimal(float $longitude): string {
 421                 //Set degree
 422                 $degree = $longitude % 60;
 423
 424                 //Set minute
 425                 $minute = ($longitude - $degree) * 60 % 60;
 426
 427                 //Set second
 428                 $second = ($longitude - $degree - $minute / 60) * 3600 % 3600;
 429
 430                 //Return sexagesimal longitude
 431                 return $degree.'°'.$minute.'\''.$second.'"'.($longitude >= 0 ? 'E' : 'W');
 432         }
 433 }