Merge pull request #3395 from odan/4.x-phpstan2

Add PHPStan 2

Author: akrabat

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .idea
 .phpunit.result.cache
+.phpunit.cache/
 composer.lock
 phpunit.xml
 clover.xml

Slim/Exception/HttpSpecializedException.php

@@ -17,15 +17,16 @@ abstract class HttpSpecializedException extends HttpException
 {
     /**
      * @param ServerRequestInterface $request
-     * @param string|null            $message
-     * @param Throwable|null         $previous
+     * @param string|null $message
+     * @param Throwable|null $previous
      */
     public function __construct(ServerRequestInterface $request, ?string $message = null, ?Throwable $previous = null)
     {
         if ($message !== null) {
             $this->message = $message;
         }
 
+        // @phpstan-ignore-next-line
         parent::__construct($request, $this->message, $this->code, $previous);
     }
 }

Slim/Factory/Psr17/ServerRequestCreator.php

@@ -39,6 +39,8 @@ public function createServerRequestFromGlobals(): ServerRequestInterface
     {
         /** @var callable $callable */
         $callable = [$this->serverRequestCreator, $this->serverRequestCreatorMethod];
+
+        /** @var ServerRequestInterface */
         return (Closure::fromCallable($callable))();
     }
 }

Slim/Handlers/ErrorHandler.php

@@ -189,6 +189,7 @@ protected function determineContentType(ServerRequestInterface $request): ?strin
                 }
             }
 
+            // @phpstan-ignore-next-line
             if (is_string($current)) {
                 return $current;
             }
@@ -259,11 +260,15 @@ public function setLogErrorRenderer($logErrorRenderer): void
     protected function writeToErrorLog(): void
     {
         $renderer = $this->callableResolver->resolve($this->logErrorRenderer);
+
+        /** @var string $error */
         $error = $renderer($this->exception, $this->logErrorDetails);
+
         if ($this->logErrorRenderer === PlainTextErrorRenderer::class && !$this->displayErrorDetails) {
             $error .= "\nTips: To display error details in HTTP response ";
             $error .= 'set "displayErrorDetails" to true in the ErrorHandler constructor.';
         }
+
         $this->logError($error);
     }
 

Slim/Handlers/Strategies/RequestHandler.php

@@ -43,6 +43,7 @@ public function __invoke(
             }
         }
 
+        /** @var ResponseInterface */
         return $callable($request);
     }
 }

Slim/Handlers/Strategies/RequestResponse.php

@@ -35,6 +35,7 @@ public function __invoke(
             $request = $request->withAttribute($k, $v);
         }
 
+        /** @var ResponseInterface */
         return $callable($request, $response, $routeArguments);
     }
 }

Slim/Handlers/Strategies/RequestResponseArgs.php

@@ -34,6 +34,7 @@ public function __invoke(
         ResponseInterface $response,
         array $routeArguments
     ): ResponseInterface {
+        /** @var ResponseInterface */
         return $callable($request, $response, ...array_values($routeArguments));
     }
 }

Slim/Handlers/Strategies/RequestResponseNamedArgs.php

@@ -33,6 +33,7 @@ public function __invoke(
         ResponseInterface $response,
         array $routeArguments
     ): ResponseInterface {
+        /** @var ResponseInterface */
         return $callable($request, $response, ...$routeArguments);
     }
 }

Slim/Middleware/BodyParsingMiddleware.php

@@ -19,7 +19,6 @@
 use function count;
 use function explode;
 use function is_array;
-use function is_null;
 use function is_object;
 use function is_string;
 use function json_decode;
@@ -66,8 +65,8 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
     }
 
     /**
-     * @param string   $mediaType A HTTP media type (excluding content-type params).
-     * @param callable $callable  A callable that returns parsed contents for media type.
+     * @param string $mediaType A HTTP media type (excluding content-type params).
+     * @param callable $callable A callable that returns parsed contents for media type.
      */
     public function registerBodyParser(string $mediaType, callable $callable): self
     {
@@ -76,15 +75,15 @@ public function registerBodyParser(string $mediaType, callable $callable): self
     }
 
     /**
-     * @param string   $mediaType A HTTP media type (excluding content-type params).
+     * @param string $mediaType A HTTP media type (excluding content-type params).
      */
     public function hasBodyParser(string $mediaType): bool
     {
         return isset($this->bodyParsers[$mediaType]);
     }
 
     /**
-     * @param string    $mediaType A HTTP media type (excluding content-type params).
+     * @param string $mediaType A HTTP media type (excluding content-type params).
      * @throws RuntimeException
      */
     public function getBodyParser(string $mediaType): callable
@@ -98,6 +97,7 @@ public function getBodyParser(string $mediaType): callable
     protected function registerDefaultBodyParsers(): void
     {
         $this->registerBodyParser('application/json', static function ($input) {
+            /** @var string $input */
             $result = json_decode($input, true);
 
             if (!is_array($result)) {
@@ -108,11 +108,15 @@ protected function registerDefaultBodyParsers(): void
         });
 
         $this->registerBodyParser('application/x-www-form-urlencoded', static function ($input) {
+            /** @var string $input */
             parse_str($input, $data);
+
             return $data;
         });
 
         $xmlCallable = static function ($input) {
+            /** @var string $input */
+
             $backup = self::disableXmlEntityLoader(true);
             $backup_errors = libxml_use_internal_errors(true);
             $result = simplexml_load_string($input);

Slim/Middleware/ErrorMiddleware.php

@@ -89,6 +89,7 @@ public function handleException(ServerRequestInterface $request, Throwable $exce
         $exceptionType = get_class($exception);
         $handler = $this->getErrorHandler($exceptionType);
 
+        /** @var ResponseInterface */
         return $handler($request, $exception, $this->displayErrorDetails, $this->logErrors, $this->logErrorDetails);
     }
 
@@ -141,7 +142,8 @@ public function getDefaultErrorHandler()
      *
      * The callable signature MUST match the ErrorHandlerInterface
      *
-     * @see \Slim\Interfaces\ErrorHandlerInterface
+     * @param string|callable|ErrorHandler $handler
+     * @see ErrorHandlerInterface
      *
      * 1. Instance of \Psr\Http\Message\ServerRequestInterface
      * 2. Instance of \Throwable
@@ -152,7 +154,6 @@ public function getDefaultErrorHandler()
      * The callable MUST return an instance of
      * \Psr\Http\Message\ResponseInterface.
      *
-     * @param string|callable|ErrorHandler $handler
      */
     public function setDefaultErrorHandler($handler): self
     {
@@ -169,7 +170,12 @@ public function setDefaultErrorHandler($handler): self
      * Pass true to $handleSubclasses to make the handler handle all subclasses of
      * the type as well. Pass an array of classes to make the same function handle multiple exceptions.
      *
-     * @see \Slim\Interfaces\ErrorHandlerInterface
+     * @param string|string[] $typeOrTypes Exception/Throwable name.
+     * ie: RuntimeException::class or an array of classes
+     * ie: [HttpNotFoundException::class, HttpMethodNotAllowedException::class]
+     * @param string|callable|ErrorHandlerInterface $handler
+     *
+     * @see ErrorHandlerInterface
      *
      * 1. Instance of \Psr\Http\Message\ServerRequestInterface
      * 2. Instance of \Throwable
@@ -180,10 +186,6 @@ public function setDefaultErrorHandler($handler): self
      * The callable MUST return an instance of
      * \Psr\Http\Message\ResponseInterface.
      *
-     * @param string|string[] $typeOrTypes Exception/Throwable name.
-     * ie: RuntimeException::class or an array of classes
-     * ie: [HttpNotFoundException::class, HttpMethodNotAllowedException::class]
-     * @param string|callable|ErrorHandlerInterface $handler
      */
     public function setErrorHandler($typeOrTypes, $handler, bool $handleSubclasses = false): self
     {