Skip to content

Commit b4b7f61

Browse files
committed
[Map] Reword PHPDoc about "extra" properties
1 parent c481a97 commit b4b7f61

File tree

5 files changed

+17
-6
lines changed

5 files changed

+17
-6
lines changed

src/Map/src/Circle.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121
final class Circle implements Element
2222
{
2323
/**
24-
* @param array<string, mixed> $extra Extra data, can be used by the developer to store additional information and use them later JavaScript side
24+
* @param array<string, mixed> $extra Extra data forwarded to the JavaScript side. It can be used in your custom
25+
* Stimulus controller to benefit from greater flexibility and customization.
26+
* These data must be serializable to JSON. These data are not used by UX Map.
2527
* @param float $radius The radius of the circle in meters
2628
*/
2729
public function __construct(

src/Map/src/Marker.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
use Symfony\UX\Map\Exception\InvalidArgumentException;
1515
use Symfony\UX\Map\Icon\Icon;
16-
use Symfony\UX\Map\Icon\IconType;
1716

1817
/**
1918
* Represents a marker on a map.
@@ -23,8 +22,9 @@
2322
final class Marker implements Element
2423
{
2524
/**
26-
* @param array<string, mixed> $extra Extra data, can be used by the developer to store additional information and
27-
* use them later JavaScript side
25+
* @param array<string, mixed> $extra Extra data forwarded to the JavaScript side. It can be used in your custom
26+
* Stimulus controller to benefit from greater flexibility and customization.
27+
* These data must be serializable to JSON. These data are not used by UX Map.
2828
*/
2929
public function __construct(
3030
public readonly Point $position,

src/Map/src/Polygon.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ final class Polygon implements Element
2222
{
2323
/**
2424
* @param array<Point>|array<array<Point>> $points a list of point representing the polygon, or a list of paths (each path is an array of points) representing a polygon with holes
25-
* @param array<string, mixed> $extra Extra data, can be used by the developer to store additional information and use them later JavaScript side
25+
* @param array<string, mixed> $extra Extra data forwarded to the JavaScript side. It can be used in your custom
26+
* Stimulus controller to benefit from greater flexibility and customization.
27+
* These data must be serializable to JSON. These data are not used by UX Map.
2628
*/
2729
public function __construct(
2830
private readonly array $points,

src/Map/src/Polyline.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121
final class Polyline implements Element
2222
{
2323
/**
24-
* @param array<string, mixed> $extra Extra data, can be used by the developer to store additional information and use them later JavaScript side
24+
* @param array<string, mixed> $extra Extra data forwarded to the JavaScript side. It can be used in your custom
25+
* Stimulus controller to benefit from greater flexibility and customization.
26+
* These data must be serializable to JSON. These data are not used by UX Map.
2527
*/
2628
public function __construct(
2729
private readonly array $points,

src/Map/src/Rectangle.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020
*/
2121
final class Rectangle implements Element
2222
{
23+
/**
24+
* @param array<string, mixed> $extra Extra data forwarded to the JavaScript side. It can be used in your custom
25+
* Stimulus controller to benefit from greater flexibility and customization.
26+
* These data must be serializable to JSON. These data are not used by UX Map.
27+
*/
2328
public function __construct(
2429
public readonly Point $southWest,
2530
public readonly Point $northEast,

0 commit comments

Comments
 (0)