minor #46119 [HttpClient] Add missing return type (GromNaN)

Tobion · Tobion · commit 76b921912c5d · 2022-04-20T20:42:41.000+02:00
This PR was merged into the 6.1 branch. Discussion ---------- [HttpClient] Add missing return type | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | n/a Return type on private methods; useful when reading the code. Commits ------- 2daae46 Add missing return type to HttpClient
diff --git a/src/Symfony/Component/HttpClient/Response/AmpResponse.php b/src/Symfony/Component/HttpClient/Response/AmpResponse.php
@@ -226,7 +226,7 @@ private static function select(ClientState $multi, float $timeout): int
         return null === self::$delay ? 1 : 0;
     }
 
-    private static function generateResponse(Request $request, AmpClientState $multi, string $id, array &$info, array &$headers, CancellationTokenSource $canceller, array &$options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause)
+    private static function generateResponse(Request $request, AmpClientState $multi, string $id, array &$info, array &$headers, CancellationTokenSource $canceller, array &$options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause): \Generator
     {
         $request->setInformationalResponseHandler(static function (Response $response) use ($multi, $id, &$info, &$headers) {
             self::addResponseHeaders($response, $info, $headers);
@@ -285,7 +285,7 @@ private static function generateResponse(Request $request, AmpClientState $multi
         self::stopLoop();
     }
 
-    private static function followRedirects(Request $originRequest, AmpClientState $multi, array &$info, array &$headers, CancellationTokenSource $canceller, array $options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause)
+    private static function followRedirects(Request $originRequest, AmpClientState $multi, array &$info, array &$headers, CancellationTokenSource $canceller, array $options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause): \Generator
     {
         yield $pause;
 
@@ -399,7 +399,7 @@ private static function addResponseHeaders(Response $response, array &$info, arr
     /**
      * Accepts pushed responses only if their headers related to authentication match the request.
      */
-    private static function getPushedResponse(Request $request, AmpClientState $multi, array &$info, array &$headers, array $options, ?LoggerInterface $logger)
+    private static function getPushedResponse(Request $request, AmpClientState $multi, array &$info, array &$headers, array $options, ?LoggerInterface $logger): \Generator
     {
         if ('' !== $options['body']) {
             return null;
diff --git a/src/Symfony/Component/HttpClient/Response/MockResponse.php b/src/Symfony/Component/HttpClient/Response/MockResponse.php
@@ -229,7 +229,7 @@ protected static function select(ClientState $multi, float $timeout): int
     /**
      * Simulates sending the request.
      */
-    private static function writeRequest(self $response, array $options, ResponseInterface $mock)
+    private static function writeRequest(self $response, array $options, ResponseInterface $mock): void
     {
         $onProgress = $options['on_progress'] ?? static function () {};
         $response->info += $mock->getInfo() ?: [];
@@ -272,7 +272,7 @@ private static function writeRequest(self $response, array $options, ResponseInt
     /**
      * Simulates reading the response.
      */
-    private static function readResponse(self $response, array $options, ResponseInterface $mock, int &$offset)
+    private static function readResponse(self $response, array $options, ResponseInterface $mock, int &$offset): void
     {
         $onProgress = $options['on_progress'] ?? static function () {};
 
diff --git a/src/Symfony/Component/HttpClient/Response/StreamWrapper.php b/src/Symfony/Component/HttpClient/Response/StreamWrapper.php
@@ -117,7 +117,7 @@ public function stream_open(string $path, string $mode, int $options): bool
         return false;
     }
 
-    public function stream_read(int $count)
+    public function stream_read(int $count): string|false
     {
         if (\is_resource($this->content)) {
             // Empty the internal activity list
diff --git a/src/Symfony/Component/HttpClient/Response/TraceableResponse.php b/src/Symfony/Component/HttpClient/Response/TraceableResponse.php
@@ -202,7 +202,7 @@ public static function stream(HttpClientInterface $client, iterable $responses,
         }
     }
 
-    private function checkStatusCode(int $code)
+    private function checkStatusCode(int $code): void
     {
         if (500 <= $code) {
             throw new ServerException($this);
diff --git a/src/Symfony/Component/HttpClient/Response/TransportResponseTrait.php b/src/Symfony/Component/HttpClient/Response/TransportResponseTrait.php
@@ -131,7 +131,7 @@ private static function addResponseHeaders(array $responseHeaders, array &$info,
     /**
      * Ensures the request is always sent and that the response code was checked.
      */
-    private function doDestruct()
+    private function doDestruct(): void
     {
         $this->shouldBuffer = true;
 

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ private static function select(ClientState $multi, float $timeout): int`
`226`	`226`	`return null === self::$delay ? 1 : 0;`
`227`	`227`	`}`
`228`	`228`
`229`		`- private static function generateResponse(Request $request, AmpClientState $multi, string $id, array &$info, array &$headers, CancellationTokenSource $canceller, array &$options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause)`
	`229`	`+ private static function generateResponse(Request $request, AmpClientState $multi, string $id, array &$info, array &$headers, CancellationTokenSource $canceller, array &$options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause): \Generator`
`230`	`230`	`{`
`231`	`231`	`$request->setInformationalResponseHandler(static function (Response $response) use ($multi, $id, &$info, &$headers) {`
`232`	`232`	`self::addResponseHeaders($response, $info, $headers);`
`@@ -285,7 +285,7 @@ private static function generateResponse(Request $request, AmpClientState $multi`
`285`	`285`	`self::stopLoop();`
`286`	`286`	`}`
`287`	`287`
`288`		`- private static function followRedirects(Request $originRequest, AmpClientState $multi, array &$info, array &$headers, CancellationTokenSource $canceller, array $options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause)`
	`288`	`+ private static function followRedirects(Request $originRequest, AmpClientState $multi, array &$info, array &$headers, CancellationTokenSource $canceller, array $options, \Closure $onProgress, &$handle, ?LoggerInterface $logger, Promise &$pause): \Generator`
`289`	`289`	`{`
`290`	`290`	`yield $pause;`
`291`	`291`
`@@ -399,7 +399,7 @@ private static function addResponseHeaders(Response $response, array &$info, arr`
`399`	`399`	`/**`
`400`	`400`	`* Accepts pushed responses only if their headers related to authentication match the request.`
`401`	`401`	`*/`
`402`		`- private static function getPushedResponse(Request $request, AmpClientState $multi, array &$info, array &$headers, array $options, ?LoggerInterface $logger)`
	`402`	`+ private static function getPushedResponse(Request $request, AmpClientState $multi, array &$info, array &$headers, array $options, ?LoggerInterface $logger): \Generator`
`403`	`403`	`{`
`404`	`404`	`if ('' !== $options['body']) {`
`405`	`405`	`return null;`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ public function stream_open(string $path, string $mode, int $options): bool`
`117`	`117`	`return false;`
`118`	`118`	`}`
`119`	`119`
`120`		`- public function stream_read(int $count)`
	`120`	`+ public function stream_read(int $count): string\|false`
`121`	`121`	`{`
`122`	`122`	`if (\is_resource($this->content)) {`
`123`	`123`	`// Empty the internal activity list`
Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ public static function stream(HttpClientInterface $client, iterable $responses,`
`202`	`202`	`}`
`203`	`203`	`}`
`204`	`204`
`205`		`- private function checkStatusCode(int $code)`
	`205`	`+ private function checkStatusCode(int $code): void`
`206`	`206`	`{`
`207`	`207`	`if (500 <= $code) {`
`208`	`208`	`throw new ServerException($this);`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ private static function addResponseHeaders(array $responseHeaders, array &$info,`
`131`	`131`	`/**`
`132`	`132`	`* Ensures the request is always sent and that the response code was checked.`
`133`	`133`	`*/`
`134`		`- private function doDestruct()`
	`134`	`+ private function doDestruct(): void`
`135`	`135`	`{`
`136`	`136`	`$this->shouldBuffer = true;`
`137`	`137`