minor #59061 [Mime] Fix wrong PHPDoc in FormDataPart constructor (MaximePinot)

nicolas-grekas · nicolas-grekas · commit 8804980fb413 · 2024-12-02T18:59:46.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [Mime] Fix wrong PHPDoc in `FormDataPart` constructor | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | no  | Deprecations? | no  | Issues | -  | License | MIT I believe the PHPDoc is wrong. As far as I understand, the `FormDataPart` expects instances of `TextPart`: ```php if (!\is_string($item) && !$item instanceof TextPart) { throw new InvalidArgumentException(sprintf('The value of the form field "%s" can only be a string, an array, or an instance of TextPart, "%s" given.', $fieldName, get_debug_type($item))); } ``` https://github.com/symfony/symfony/blob/6.4/src/Symfony/Component/Mime/Part/Multipart/FormDataPart.php#L74 The following code is rejected by PHPStan while it works: ```php final readonly class Foo { public function bar(): void { new FormDataPart([ new TextPart('baz'), ]); } } ``` ```shell ------ ------------------------------------------------------------------------------------------------------------------- Line src/Foo.php ------ ------------------------------------------------------------------------------------------------------------------- 14 Parameter #1 $fields of class Symfony\Component\Mime\Part\Multipart\FormDataPart constructor expects array<array|string|Symfony\Component\Mime\Part\DataPart>, array<int, Symfony\Component\Mime\Part\TextPart> given. ------ ------------------------------------------------------------------------------------------------------------------- ``` (cc `@B`-Galati) Commits ------- 886d4ed [Mime] Fix wrong PHPDoc in `FormDataPart` constructor
diff --git a/src/Symfony/Component/Mime/Part/Multipart/FormDataPart.php b/src/Symfony/Component/Mime/Part/Multipart/FormDataPart.php
@@ -26,7 +26,7 @@ final class FormDataPart extends AbstractMultipartPart
     private array $fields = [];
 
     /**
-     * @param array<string|array|DataPart> $fields
+     * @param array<string|array|TextPart> $fields
      */
     public function __construct(array $fields = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ final class FormDataPart extends AbstractMultipartPart`
`26`	`26`	`private array $fields = [];`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * @param array<string\|array\|DataPart> $fields`
	`29`	`+ * @param array<string\|array\|TextPart> $fields`
`30`	`30`	`*/`
`31`	`31`	`public function __construct(array $fields = [])`
`32`	`32`	`{`