minor #60294 align the type to the one in the human description (dkarlovi)

fabpot · fabpot · commit 4d29af365bda · 2025-04-29T13:18:53.000+02:00
This PR was squashed before being merged into the 7.3 branch. Discussion ---------- align the type to the one in the human description | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | N/A | License | MIT The current type is too wide and not aligned with the intent described in the comment, it's `array-key` but `string` is intended It's fixing the type to align with what was intended judging by the implementation and the human description of the type. Commits ------- 31c45d4 align the type to the one in the human description
diff --git a/src/Symfony/Component/HttpClient/Response/TransportResponseTrait.php b/src/Symfony/Component/HttpClient/Response/TransportResponseTrait.php
@@ -30,6 +30,7 @@
 trait TransportResponseTrait
 {
     private Canary $canary;
+    /** @var array<string, list<string>> */
     private array $headers = [];
     private array $info = [
         'response_headers' => [],
diff --git a/src/Symfony/Contracts/HttpClient/ResponseInterface.php b/src/Symfony/Contracts/HttpClient/ResponseInterface.php
@@ -36,7 +36,7 @@ public function getStatusCode(): int;
      *
      * @param bool $throw Whether an exception should be thrown on 3/4/5xx status codes
      *
-     * @return string[][] The headers of the response keyed by header names in lowercase
+     * @return array<string, list<string>> The headers of the response keyed by header names in lowercase
      *
      * @throws TransportExceptionInterface   When a network error occurs
      * @throws RedirectionExceptionInterface On a 3xx when $throw is true and the "max_redirects" option has been reached

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`trait TransportResponseTrait`
`31`	`31`	`{`
`32`	`32`	`private Canary $canary;`
	`33`	`+ /** @var array<string, list<string>> */`
`33`	`34`	`private array $headers = [];`
`34`	`35`	`private array $info = [`
`35`	`36`	`'response_headers' => [],`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function getStatusCode(): int;`
`36`	`36`	`*`
`37`	`37`	`* @param bool $throw Whether an exception should be thrown on 3/4/5xx status codes`
`38`	`38`	`*`
`39`		`- * @return string[][] The headers of the response keyed by header names in lowercase`
	`39`	`+ * @return array<string, list<string>> The headers of the response keyed by header names in lowercase`
`40`	`40`	`*`
`41`	`41`	`* @throws TransportExceptionInterface When a network error occurs`
`42`	`42`	`* @throws RedirectionExceptionInterface On a 3xx when $throw is true and the "max_redirects" option has been reached`