minor #118 Add native types where possible (derrabus)

derrabus · derrabus · commit 18c9e8203aec · 2023-07-25T11:11:04.000+02:00
This PR was merged into the 2.2-dev branch. Discussion ---------- Add native types where possible This PR improves the typing throughout the codebase: * Native types are added where possible without a BC break * PHPDoc``@return`` annotations have been added to prevent deprecations triggered by ErrorHandler * More PHPDoc has been added where a native type cannot be set as long as we support PHP 7.2. * PHPUnit data providers have been declared `static`. Commits ------- 4fd4323 Add native types where possible
diff --git a/Factory/HttpFoundationFactory.php b/Factory/HttpFoundationFactory.php
@@ -41,6 +41,8 @@ public function __construct(int $responseBufferMaxLength = 16372)
 
     /**
      * {@inheritdoc}
+     *
+     * @return Request
      */
     public function createRequest(ServerRequestInterface $psrRequest, bool $streamed = false)
     {
@@ -121,6 +123,8 @@ protected function getTemporaryPath()
 
     /**
      * {@inheritdoc}
+     *
+     * @return Response
      */
     public function createResponse(ResponseInterface $psrResponse, bool $streamed = false)
     {
diff --git a/Factory/PsrHttpFactory.php b/Factory/PsrHttpFactory.php
@@ -12,7 +12,9 @@
 namespace Symfony\Bridge\PsrHttpMessage\Factory;
 
 use Psr\Http\Message\ResponseFactoryInterface;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestFactoryInterface;
+use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Message\StreamFactoryInterface;
 use Psr\Http\Message\UploadedFileFactoryInterface;
 use Psr\Http\Message\UploadedFileInterface;
@@ -45,6 +47,8 @@ public function __construct(ServerRequestFactoryInterface $serverRequestFactory,
 
     /**
      * {@inheritdoc}
+     *
+     * @return ServerRequestInterface
      */
     public function createRequest(Request $symfonyRequest)
     {
@@ -84,10 +88,8 @@ public function createRequest(Request $symfonyRequest)
 
     /**
      * Converts Symfony uploaded files array to the PSR one.
-     *
-     * @return array
      */
-    private function getFiles(array $uploadedFiles)
+    private function getFiles(array $uploadedFiles): array
     {
         $files = [];
 
@@ -108,10 +110,8 @@ private function getFiles(array $uploadedFiles)
 
     /**
      * Creates a PSR-7 UploadedFile instance from a Symfony one.
-     *
-     * @return UploadedFileInterface
      */
-    private function createUploadedFile(UploadedFile $symfonyUploadedFile)
+    private function createUploadedFile(UploadedFile $symfonyUploadedFile): UploadedFileInterface
     {
         return $this->uploadedFileFactory->createUploadedFile(
             $this->streamFactory->createStreamFromFile(
@@ -126,6 +126,8 @@ private function createUploadedFile(UploadedFile $symfonyUploadedFile)
 
     /**
      * {@inheritdoc}
+     *
+     * @return ResponseInterface
      */
     public function createResponse(Response $symfonyResponse)
     {
diff --git a/Factory/UploadedFile.php b/Factory/UploadedFile.php
@@ -52,7 +52,7 @@ public function __construct(UploadedFileInterface $psrUploadedFile, callable $ge
     /**
      * {@inheritdoc}
      */
-    public function move($directory, $name = null): File
+    public function move(string $directory, string $name = null): File
     {
         if (!$this->isValid() || $this->test) {
             return parent::move($directory, $name);
diff --git a/Tests/EventListener/PsrResponseListenerTest.php b/Tests/EventListener/PsrResponseListenerTest.php
@@ -46,6 +46,9 @@ public function testDoesNotConvertControllerResult()
         self::assertFalse($event->hasResponse());
     }
 
+    /**
+     * @param mixed $controllerResult
+     */
     private function createEventMock($controllerResult): ViewEvent
     {
         return new ViewEvent($this->createMock(HttpKernelInterface::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $controllerResult);
diff --git a/Tests/Factory/HttpFoundationFactoryTest.php b/Tests/Factory/HttpFoundationFactoryTest.php
@@ -196,7 +196,7 @@ public function testCreateUploadedFileWithError()
         $symfonyUploadedFile->move($this->tmpDir, 'shouldFail.txt');
     }
 
-    private function createUploadedFile($content, $error, $clientFileName, $clientMediaType): UploadedFile
+    private function createUploadedFile(string $content, int $error, string $clientFileName, string $clientMediaType): UploadedFile
     {
         $filePath = tempnam($this->tmpDir, uniqid());
         file_put_contents($filePath, $content);
diff --git a/Tests/Factory/PsrHttpFactoryTest.php b/Tests/Factory/PsrHttpFactoryTest.php
@@ -28,7 +28,10 @@
  */
 class PsrHttpFactoryTest extends TestCase
 {
+    /** @var HttpMessageFactoryInterface */
     private $factory;
+
+    /** @var string */
     private $tmpDir;
 
     protected function buildHttpMessageFactory(): HttpMessageFactoryInterface
@@ -135,7 +138,7 @@ public function testGetContentCanBeCalledAfterRequestCreation()
         $this->assertSame('Content', $request->getContent());
     }
 
-    private function createUploadedFile($content, $originalName, $mimeType, $error)
+    private function createUploadedFile(string $content, string $originalName, string $mimeType, int $error): UploadedFile
     {
         $path = tempnam($this->tmpDir, uniqid());
         file_put_contents($path, $content);
diff --git a/Tests/Fixtures/Message.php b/Tests/Fixtures/Message.php
@@ -25,7 +25,7 @@ class Message implements MessageInterface
     private $headers = [];
     private $body;
 
-    public function __construct($version = '1.1', array $headers = [], StreamInterface $body = null)
+    public function __construct(string $version = '1.1', array $headers = [], StreamInterface $body = null)
     {
         $this->version = $version;
         $this->headers = $headers;
diff --git a/Tests/Fixtures/Response.php b/Tests/Fixtures/Response.php
@@ -21,7 +21,7 @@ class Response extends Message implements ResponseInterface
 {
     private $statusCode;
 
-    public function __construct($version = '1.1', array $headers = [], StreamInterface $body = null, $statusCode = 200)
+    public function __construct(string $version = '1.1', array $headers = [], StreamInterface $body = null, int $statusCode = 200)
     {
         parent::__construct($version, $headers, $body);
 
diff --git a/Tests/Fixtures/ServerRequest.php b/Tests/Fixtures/ServerRequest.php
@@ -31,7 +31,11 @@ class ServerRequest extends Message implements ServerRequestInterface
     private $data;
     private $attributes;
 
-    public function __construct($version = '1.1', array $headers = [], StreamInterface $body = null, $requestTarget = '/', $method = 'GET', $uri = null, array $server = [], array $cookies = [], array $query = [], array $uploadedFiles = [], $data = null, array $attributes = [])
+    /**
+     * @param UriInterface|string|null $uri
+     * @param array|object|null        $data
+     */
+    public function __construct(string $version = '1.1', array $headers = [], StreamInterface $body = null, string $requestTarget = '/', string $method = 'GET', $uri = null, array $server = [], array $cookies = [], array $query = [], array $uploadedFiles = [], $data = null, array $attributes = [])
     {
         parent::__construct($version, $headers, $body);
 
diff --git a/Tests/Fixtures/Stream.php b/Tests/Fixtures/Stream.php
@@ -21,7 +21,7 @@ class Stream implements StreamInterface
     private $stringContent;
     private $eof = true;
 
-    public function __construct($stringContent = '')
+    public function __construct(string $stringContent = '')
     {
         $this->stringContent = $stringContent;
     }
diff --git a/Tests/Fixtures/UploadedFile.php b/Tests/Fixtures/UploadedFile.php
@@ -25,7 +25,7 @@ class UploadedFile implements UploadedFileInterface
     private $clientFileName;
     private $clientMediaType;
 
-    public function __construct($filePath, $size = null, $error = \UPLOAD_ERR_OK, $clientFileName = null, $clientMediaType = null)
+    public function __construct(string $filePath, int $size = null, int $error = \UPLOAD_ERR_OK, string $clientFileName = null, string $clientMediaType = null)
     {
         $this->filePath = $filePath;
         $this->size = $size;
diff --git a/Tests/Functional/CovertTest.php b/Tests/Functional/CovertTest.php
@@ -98,7 +98,7 @@ public function testConvertRequestMultipleTimes($request, $firstFactory, $second
         }
     }
 
-    public function requestProvider()
+    public static function requestProvider(): array
     {
         $sfRequest = new Request(
             [
@@ -120,8 +120,8 @@ public function requestProvider()
                 'c2' => ['c3' => 'bar'],
             ],
             [
-                'f1' => $this->createUploadedFile('F1', 'f1.txt', 'text/plain', \UPLOAD_ERR_OK),
-                'foo' => ['f2' => $this->createUploadedFile('F2', 'f2.txt', 'text/plain', \UPLOAD_ERR_OK)],
+                'f1' => self::createUploadedFile('F1', 'f1.txt', 'text/plain', \UPLOAD_ERR_OK),
+                'foo' => ['f2' => self::createUploadedFile('F2', 'f2.txt', 'text/plain', \UPLOAD_ERR_OK)],
             ],
             [
                 'REQUEST_METHOD' => 'POST',
@@ -195,7 +195,7 @@ public function testConvertResponseMultipleTimes($response, $firstFactory, $seco
         }
     }
 
-    public function responseProvider()
+    public static function responseProvider(): array
     {
         $sfResponse = new Response(
             'Response content.',
@@ -227,7 +227,7 @@ public function responseProvider()
         ];
     }
 
-    private function createUploadedFile($content, $originalName, $mimeType, $error)
+    private static function createUploadedFile(string $content, string $originalName, string $mimeType, int $error): UploadedFile
     {
         $path = tempnam(sys_get_temp_dir(), uniqid());
         file_put_contents($path, $content);

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function __construct(UploadedFileInterface $psrUploadedFile, callable $ge`
`52`	`52`	`/**`
`53`	`53`	`* {@inheritdoc}`
`54`	`54`	`*/`
`55`		`- public function move($directory, $name = null): File`
	`55`	`+ public function move(string $directory, string $name = null): File`
`56`	`56`	`{`
`57`	`57`	`if (!$this->isValid() \|\| $this->test) {`
`58`	`58`	`return parent::move($directory, $name);`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,9 @@ public function testDoesNotConvertControllerResult()`
`46`	`46`	`self::assertFalse($event->hasResponse());`
`47`	`47`	`}`
`48`	`48`
	`49`	`+ /**`
	`50`	`+ * @param mixed $controllerResult`
	`51`	`+ */`
`49`	`52`	`private function createEventMock($controllerResult): ViewEvent`
`50`	`53`	`{`
`51`	`54`	`return new ViewEvent($this->createMock(HttpKernelInterface::class), new Request(), HttpKernelInterface::MAIN_REQUEST, $controllerResult);`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ public function testCreateUploadedFileWithError()`
`196`	`196`	`$symfonyUploadedFile->move($this->tmpDir, 'shouldFail.txt');`
`197`	`197`	`}`
`198`	`198`
`199`		`- private function createUploadedFile($content, $error, $clientFileName, $clientMediaType): UploadedFile`
	`199`	`+ private function createUploadedFile(string $content, int $error, string $clientFileName, string $clientMediaType): UploadedFile`
`200`	`200`	`{`
`201`	`201`	`$filePath = tempnam($this->tmpDir, uniqid());`
`202`	`202`	`file_put_contents($filePath, $content);`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,10 @@`
`28`	`28`	`*/`
`29`	`29`	`class PsrHttpFactoryTest extends TestCase`
`30`	`30`	`{`
	`31`	`+ /** @var HttpMessageFactoryInterface */`
`31`	`32`	`private $factory;`
	`33`	`+`
	`34`	`+ /** @var string */`
`32`	`35`	`private $tmpDir;`
`33`	`36`
`34`	`37`	`protected function buildHttpMessageFactory(): HttpMessageFactoryInterface`
`@@ -135,7 +138,7 @@ public function testGetContentCanBeCalledAfterRequestCreation()`
`135`	`138`	`$this->assertSame('Content', $request->getContent());`
`136`	`139`	`}`
`137`	`140`
`138`		`- private function createUploadedFile($content, $originalName, $mimeType, $error)`
	`141`	`+ private function createUploadedFile(string $content, string $originalName, string $mimeType, int $error): UploadedFile`
`139`	`142`	`{`
`140`	`143`	`$path = tempnam($this->tmpDir, uniqid());`
`141`	`144`	`file_put_contents($path, $content);`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class Message implements MessageInterface`
`25`	`25`	`private $headers = [];`
`26`	`26`	`private $body;`
`27`	`27`
`28`		`- public function __construct($version = '1.1', array $headers = [], StreamInterface $body = null)`
	`28`	`+ public function __construct(string $version = '1.1', array $headers = [], StreamInterface $body = null)`
`29`	`29`	`{`
`30`	`30`	`$this->version = $version;`
`31`	`31`	`$this->headers = $headers;`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class Response extends Message implements ResponseInterface`
`21`	`21`	`{`
`22`	`22`	`private $statusCode;`
`23`	`23`
`24`		`- public function __construct($version = '1.1', array $headers = [], StreamInterface $body = null, $statusCode = 200)`
	`24`	`+ public function __construct(string $version = '1.1', array $headers = [], StreamInterface $body = null, int $statusCode = 200)`
`25`	`25`	`{`
`26`	`26`	`parent::__construct($version, $headers, $body);`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class Stream implements StreamInterface`
`21`	`21`	`private $stringContent;`
`22`	`22`	`private $eof = true;`
`23`	`23`
`24`		`- public function __construct($stringContent = '')`
	`24`	`+ public function __construct(string $stringContent = '')`
`25`	`25`	`{`
`26`	`26`	`$this->stringContent = $stringContent;`
`27`	`27`	`}`