[Map] Add polygon to twig component

Author: rrr63

src/Map/src/Map.php

@@ -122,6 +122,7 @@ public function toArray(): array
      *     center?: array{lat: float, lng: float},
      *     zoom?: float,
      *     markers?: list<array>,
+     *     polygons?: list<array>,
      *     fitBoundsToMarkers?: bool,
      *     options?: object,
      * } $map
@@ -146,6 +147,12 @@ public static function fromArray(array $map): self
         }
         $map['markers'] = array_map(Marker::fromArray(...), $map['markers']);
 
+        $map['polygons'] ??= [];
+        if (!\is_array($map['polygons'])) {
+            throw new InvalidArgumentException('The "polygons" parameter must be an array.');
+        }
+        $map['polygons'] = array_map(Polygon::fromArray(...), $map['polygons']);
+
         return new self(...$map);
     }
 }

src/Map/src/Polygon.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\UX\Map;
 
+use Symfony\UX\Map\Exception\InvalidArgumentException;
+
 /**
  * Represents a polygon on a map.
  *
@@ -41,4 +43,28 @@ public function toArray(): array
             'extra' => (object) $this->extra,
         ];
     }
+
+    /**
+     * @param array{
+     *     points: array<array{lat: float, lng: float}>,
+     *     title: string|null,
+     *     infoWindow: array<string, mixed>|null,
+     *     extra: object,
+     * } $polygon
+     *
+     * @internal
+     */
+    public static function fromArray(array $polygon): self
+    {
+        if (!isset($polygon['points'])) {
+            throw new InvalidArgumentException('The "points" parameter is required.');
+        }
+        $polygon['points'] = array_map(Point::fromArray(...), $polygon['points']);
+
+        if (isset($polygon['infoWindow'])) {
+            $polygon['infoWindow'] = InfoWindow::fromArray($polygon['infoWindow']);
+        }
+
+        return new self(...$polygon);
+    }
 }

src/Map/src/Twig/MapRuntime.php

@@ -14,6 +14,7 @@
 use Symfony\UX\Map\Map;
 use Symfony\UX\Map\Marker;
 use Symfony\UX\Map\Point;
+use Symfony\UX\Map\Polygon;
 use Symfony\UX\Map\Renderer\RendererInterface;
 use Twig\Extension\RuntimeExtensionInterface;
 
@@ -32,11 +33,13 @@ public function __construct(
     /**
      * @param array<string, mixed> $attributes
      * @param array<string, mixed> $markers
+     * @param array<string, mixed> $polygons
      */
     public function renderMap(
         ?Map $map = null,
         array $attributes = [],
         ?array $markers = null,
+        ?array $polygons = null,
         ?array $center = null,
         ?float $zoom = null,
     ): string {
@@ -52,6 +55,9 @@ public function renderMap(
         foreach ($markers ?? [] as $marker) {
             $map->addMarker(Marker::fromArray($marker));
         }
+        foreach ($polygons ?? [] as $polygons) {
+            $map->addPolygon(Polygon::fromArray($polygons));
+        }
         if (null !== $center) {
             $map->center(Point::fromArray($center));
         }

src/Map/src/Twig/UXMapComponent.php

@@ -13,6 +13,7 @@
 
 use Symfony\UX\Map\Marker;
 use Symfony\UX\Map\Point;
+use Symfony\UX\Map\Polygon;
 
 /**
  * @author Simon André <smn.andre@gmail.com>
@@ -29,4 +30,9 @@ final class UXMapComponent
      * @var Marker[]
      */
     public array $markers;
+
+    /**
+     * @var Polygon[]
+     */
+    public array $polygons;
 }

src/Map/src/Twig/UXMapComponentListener.php

@@ -32,7 +32,7 @@ public function onPreCreateForRender(PreCreateForRenderEvent $event): void
         }
 
         $attributes = $event->getInputProps();
-        $map = array_intersect_key($attributes, ['markers' => 0, 'center' => 1, 'zoom' => 2]);
+        $map = array_intersect_key($attributes, ['markers' => 0, 'polygons' => 0, 'center' => 1, 'zoom' => 2]);
         $attributes = array_diff_key($attributes, $map);
 
         $html = $this->mapRuntime->renderMap(...$map, attributes: $attributes);

src/Map/tests/MapFactoryTest.php

@@ -32,6 +32,13 @@ public function testFromArray(): void
         $this->assertSame($array['markers'][0]['title'], $markers[0]['title']);
         $this->assertSame($array['markers'][0]['infoWindow']['headerContent'], $markers[0]['infoWindow']['headerContent']);
         $this->assertSame($array['markers'][0]['infoWindow']['content'], $markers[0]['infoWindow']['content']);
+
+        $this->assertCount(1, $polygons = $map->toArray()['polygons']);
+        $this->assertEquals($array['polygons'][0]['points'], $polygons[0]['points']);
+        $this->assertEquals($array['polygons'][0]['points'], $polygons[0]['points']);
+        $this->assertSame($array['polygons'][0]['title'], $polygons[0]['title']);
+        $this->assertSame($array['polygons'][0]['infoWindow']['headerContent'], $polygons[0]['infoWindow']['headerContent']);
+        $this->assertSame($array['polygons'][0]['infoWindow']['content'], $polygons[0]['infoWindow']['content']);
     }
 
     public function testFromArrayWithInvalidCenter(): void
@@ -76,6 +83,30 @@ public function testFromArrayWithInvalidMarker(): void
         Map::fromArray($array);
     }
 
+    public function testFromArrayWithInvalidPolygons(): void
+    {
+        $array = self::createMapArray();
+        $array['polygons'] = 'invalid';
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('The "polygons" parameter must be an array.');
+        Map::fromArray($array);
+    }
+
+    public function testFromArrayWithInvalidPolygon(): void
+    {
+        $array = self::createMapArray();
+        $array['polygons'] = [
+            [
+                'invalid',
+            ],
+        ];
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('The "points" parameter is required.');
+        Map::fromArray($array);
+    }
+
     private static function createMapArray(): array
     {
         return [
@@ -97,6 +128,29 @@ private static function createMapArray(): array
                     ],
                 ],
             ],
+            'polygons' => [
+                [
+                    'points' => [
+                        [
+                            'lat' => 48.858844,
+                            'lng' => 2.294351,
+                        ],
+                        [
+                            'lat' => 48.853,
+                            'lng' => 2.3499,
+                        ],
+                        [
+                            'lat' => 48.8566,
+                            'lng' => 2.3522,
+                        ],
+                    ],
+                    'title' => 'Polygon 1',
+                    'infoWindow' => [
+                        'headerContent' => 'Polygon 1',
+                        'content' => 'Polygon 1',
+                    ],
+                ],
+            ],
         ];
     }
 }