Merge branch '4.x' into dependabot/composer/phpstan/phpstan-tw-1.11

akrabat · web-flow · commit 33fc44609db3 · 2024-06-13T09:45:04.000+01:00
diff --git a/Slim/App.php b/Slim/App.php
@@ -31,6 +31,11 @@
 
 use function strtoupper;
 
+/**
+ * @api
+ * @template TContainerInterface of (ContainerInterface|null)
+ * @template-extends RouteCollectorProxy<TContainerInterface>
+ */
 class App extends RouteCollectorProxy implements RequestHandlerInterface
 {
     /**
@@ -44,6 +49,9 @@ class App extends RouteCollectorProxy implements RequestHandlerInterface
 
     protected MiddlewareDispatcherInterface $middlewareDispatcher;
 
+    /**
+     * @param TContainerInterface $container
+     */
     public function __construct(
         ResponseFactoryInterface $responseFactory,
         ?ContainerInterface $container = null,
@@ -89,6 +97,7 @@ public function getMiddlewareDispatcher(): MiddlewareDispatcherInterface
 
     /**
      * @param MiddlewareInterface|string|callable $middleware
+     * @return App<TContainerInterface>
      */
     public function add($middleware): self
     {
@@ -98,6 +107,7 @@ public function add($middleware): self
 
     /**
      * @param MiddlewareInterface $middleware
+     * @return App<TContainerInterface>
      */
     public function addMiddleware(MiddlewareInterface $middleware): self
     {
diff --git a/Slim/CallableResolver.php b/Slim/CallableResolver.php
@@ -26,12 +26,19 @@
 use function preg_match;
 use function sprintf;
 
+/**
+ * @template TContainerInterface of (ContainerInterface|null)
+ */
 final class CallableResolver implements AdvancedCallableResolverInterface
 {
     public static string $callablePattern = '!^([^\:]+)\:([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$!';
 
+    /** @var TContainerInterface $container */
     private ?ContainerInterface $container;
 
+    /**
+     * @param TContainerInterface $container
+     */
     public function __construct(?ContainerInterface $container = null)
     {
         $this->container = $container;
@@ -120,11 +127,10 @@ private function isMiddleware($toResolve): bool
      */
     private function resolveSlimNotation(string $toResolve): array
     {
+        /** @psalm-suppress ArgumentTypeCoercion */
         preg_match(CallableResolver::$callablePattern, $toResolve, $matches);
         [$class, $method] = $matches ? [$matches[1], $matches[2]] : [$toResolve, null];
 
-        /** @var string $class */
-        /** @var string|null $method */
         if ($this->container && $this->container->has($class)) {
             $instance = $this->container->get($class);
             if (!is_object($instance)) {
diff --git a/Slim/Error/Renderers/HtmlErrorRenderer.php b/Slim/Error/Renderers/HtmlErrorRenderer.php
@@ -39,7 +39,6 @@ private function renderExceptionFragment(Throwable $exception): string
     {
         $html = sprintf('<div><strong>Type:</strong> %s</div>', get_class($exception));
 
-        /** @var int|string $code */
         $code = $exception->getCode();
         $html .= sprintf('<div><strong>Code:</strong> %s</div>', $code);
 
diff --git a/Slim/Error/Renderers/JsonErrorRenderer.php b/Slim/Error/Renderers/JsonErrorRenderer.php
@@ -43,7 +43,6 @@ public function __invoke(Throwable $exception, bool $displayErrorDetails): strin
      */
     private function formatExceptionFragment(Throwable $exception): array
     {
-        /** @var int|string $code */
         $code = $exception->getCode();
         return [
             'type' => get_class($exception),
diff --git a/Slim/Error/Renderers/PlainTextErrorRenderer.php b/Slim/Error/Renderers/PlainTextErrorRenderer.php
@@ -43,7 +43,7 @@ private function formatExceptionFragment(Throwable $exception): string
         $text = sprintf("Type: %s\n", get_class($exception));
 
         $code = $exception->getCode();
-        /** @var int|string $code */
+
         $text .= sprintf("Code: %s\n", $code);
 
         $text .= sprintf("Message: %s\n", $exception->getMessage());
diff --git a/Slim/Exception/HttpBadRequestException.php b/Slim/Exception/HttpBadRequestException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpBadRequestException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpException.php b/Slim/Exception/HttpException.php
@@ -15,6 +15,7 @@
 use Throwable;
 
 /**
+ * @api
  * @method int getCode()
  */
 class HttpException extends RuntimeException
diff --git a/Slim/Exception/HttpForbiddenException.php b/Slim/Exception/HttpForbiddenException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpForbiddenException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpGoneException.php b/Slim/Exception/HttpGoneException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpGoneException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpInternalServerErrorException.php b/Slim/Exception/HttpInternalServerErrorException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpInternalServerErrorException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpNotImplementedException.php b/Slim/Exception/HttpNotImplementedException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpNotImplementedException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpTooManyRequestsException.php b/Slim/Exception/HttpTooManyRequestsException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpTooManyRequestsException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Exception/HttpUnauthorizedException.php b/Slim/Exception/HttpUnauthorizedException.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Exception;
 
+/** @api */
 class HttpUnauthorizedException extends HttpSpecializedException
 {
     /**
diff --git a/Slim/Factory/AppFactory.php b/Slim/Factory/AppFactory.php
@@ -24,6 +24,7 @@
 use Slim\Interfaces\RouteCollectorInterface;
 use Slim\Interfaces\RouteResolverInterface;
 
+/** @api */
 class AppFactory
 {
     protected static ?Psr17FactoryProviderInterface $psr17FactoryProvider = null;
@@ -44,6 +45,11 @@ class AppFactory
 
     protected static bool $slimHttpDecoratorsAutomaticDetectionEnabled = true;
 
+    /**
+     * @template TContainerInterface of (ContainerInterface|null)
+     * @param TContainerInterface $container
+     * @return (TContainerInterface is ContainerInterface ? App<TContainerInterface> : App<ContainerInterface|null>)
+     */
     public static function create(
         ?ResponseFactoryInterface $responseFactory = null,
         ?ContainerInterface $container = null,
@@ -63,6 +69,11 @@ public static function create(
         );
     }
 
+    /**
+     * @template TContainerInterface of (ContainerInterface)
+     * @param TContainerInterface $container
+     * @return App<TContainerInterface>
+     */
     public static function createFromContainer(ContainerInterface $container): App
     {
         $responseFactory = $container->has(ResponseFactoryInterface::class)
diff --git a/Slim/Factory/ServerRequestCreatorFactory.php b/Slim/Factory/ServerRequestCreatorFactory.php
@@ -17,6 +17,7 @@
 use Slim\Interfaces\Psr17FactoryProviderInterface;
 use Slim\Interfaces\ServerRequestCreatorInterface;
 
+/** @api */
 class ServerRequestCreatorFactory
 {
     protected static ?Psr17FactoryProviderInterface $psr17FactoryProvider = null;
diff --git a/Slim/Handlers/ErrorHandler.php b/Slim/Handlers/ErrorHandler.php
@@ -43,6 +43,7 @@
  *
  * It outputs the error message and diagnostic information in one of the following formats:
  * JSON, XML, Plain Text or HTML based on the Accept header.
+ * @api
  */
 class ErrorHandler implements ErrorHandlerInterface
 {
@@ -259,7 +260,7 @@ protected function writeToErrorLog(): void
     {
         $renderer = $this->callableResolver->resolve($this->logErrorRenderer);
         $error = $renderer($this->exception, $this->logErrorDetails);
-        if (!$this->displayErrorDetails) {
+        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.';
         }
diff --git a/Slim/Handlers/Strategies/RequestResponseArgs.php b/Slim/Handlers/Strategies/RequestResponseArgs.php
@@ -18,6 +18,7 @@
 
 /**
  * Route callback strategy with route parameters as individual arguments.
+ * @api
  */
 class RequestResponseArgs implements InvocationStrategyInterface
 {
diff --git a/Slim/Handlers/Strategies/RequestResponseNamedArgs.php b/Slim/Handlers/Strategies/RequestResponseNamedArgs.php
@@ -17,6 +17,7 @@
 
 /**
  * Route callback strategy with route parameters as individual arguments.
+ * @api
  */
 class RequestResponseNamedArgs implements InvocationStrategyInterface
 {
diff --git a/Slim/Interfaces/MiddlewareDispatcherInterface.php b/Slim/Interfaces/MiddlewareDispatcherInterface.php
@@ -13,6 +13,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
+/** @api */
 interface MiddlewareDispatcherInterface extends RequestHandlerInterface
 {
     /**
diff --git a/Slim/Interfaces/Psr17FactoryProviderInterface.php b/Slim/Interfaces/Psr17FactoryProviderInterface.php
@@ -10,6 +10,7 @@
 
 namespace Slim\Interfaces;
 
+/** @api */
 interface Psr17FactoryProviderInterface
 {
     /**
diff --git a/Slim/Interfaces/RouteCollectorInterface.php b/Slim/Interfaces/RouteCollectorInterface.php
@@ -13,6 +13,7 @@
 use InvalidArgumentException;
 use RuntimeException;
 
+/** @api */
 interface RouteCollectorInterface
 {
     /**
diff --git a/Slim/Interfaces/RouteCollectorProxyInterface.php b/Slim/Interfaces/RouteCollectorProxyInterface.php
@@ -14,12 +14,19 @@
 use Psr\Http\Message\ResponseFactoryInterface;
 use Psr\Http\Message\UriInterface;
 
+/**
+ * @api
+ * @template TContainerInterface of (ContainerInterface|null)
+ */
 interface RouteCollectorProxyInterface
 {
     public function getResponseFactory(): ResponseFactoryInterface;
 
     public function getCallableResolver(): CallableResolverInterface;
 
+    /**
+     * @return TContainerInterface
+     */
     public function getContainer(): ?ContainerInterface;
 
     public function getRouteCollector(): RouteCollectorInterface;
@@ -31,6 +38,7 @@ public function getBasePath(): string;
 
     /**
      * Set the RouteCollectorProxy's base path
+     * @return RouteCollectorProxyInterface<TContainerInterface>
      */
     public function setBasePath(string $basePath): RouteCollectorProxyInterface;
 
diff --git a/Slim/Interfaces/RouteGroupInterface.php b/Slim/Interfaces/RouteGroupInterface.php
@@ -13,6 +13,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Slim\MiddlewareDispatcher;
 
+/** @api */
 interface RouteGroupInterface
 {
     public function collectRoutes(): RouteGroupInterface;
@@ -31,6 +32,7 @@ public function addMiddleware(MiddlewareInterface $middleware): RouteGroupInterf
 
     /**
      * Append the group's middleware to the MiddlewareDispatcher
+     * @param MiddlewareDispatcher<\Psr\Container\ContainerInterface|null> $dispatcher
      */
     public function appendMiddlewareToDispatcher(MiddlewareDispatcher $dispatcher): RouteGroupInterface;
 
diff --git a/Slim/Interfaces/RouteInterface.php b/Slim/Interfaces/RouteInterface.php
@@ -14,6 +14,7 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Psr\Http\Server\MiddlewareInterface;
 
+/** @api */
 interface RouteInterface
 {
     /**
diff --git a/Slim/Interfaces/RouteParserInterface.php b/Slim/Interfaces/RouteParserInterface.php
@@ -14,6 +14,7 @@
 use Psr\Http\Message\UriInterface;
 use RuntimeException;
 
+/** @api */
 interface RouteParserInterface
 {
     /**
diff --git a/Slim/Middleware/BodyParsingMiddleware.php b/Slim/Middleware/BodyParsingMiddleware.php
@@ -33,6 +33,7 @@
 
 use const LIBXML_VERSION;
 
+/** @api */
 class BodyParsingMiddleware implements MiddlewareInterface
 {
     /**
diff --git a/Slim/Middleware/ContentLengthMiddleware.php b/Slim/Middleware/ContentLengthMiddleware.php
@@ -15,6 +15,7 @@
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 
+/** @api */
 class ContentLengthMiddleware implements MiddlewareInterface
 {
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
diff --git a/Slim/Middleware/ErrorMiddleware.php b/Slim/Middleware/ErrorMiddleware.php
@@ -25,6 +25,7 @@
 use function get_class;
 use function is_subclass_of;
 
+/** @api */
 class ErrorMiddleware implements MiddlewareInterface
 {
     protected CallableResolverInterface $callableResolver;
diff --git a/Slim/Middleware/MethodOverrideMiddleware.php b/Slim/Middleware/MethodOverrideMiddleware.php
@@ -18,6 +18,7 @@
 use function is_array;
 use function strtoupper;
 
+/** @api */
 class MethodOverrideMiddleware implements MiddlewareInterface
 {
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
diff --git a/Slim/Middleware/OutputBufferingMiddleware.php b/Slim/Middleware/OutputBufferingMiddleware.php
@@ -23,6 +23,7 @@
 use function ob_get_clean;
 use function ob_start;
 
+/** @api */
 class OutputBufferingMiddleware implements MiddlewareInterface
 {
     public const APPEND = 'append';
diff --git a/Slim/MiddlewareDispatcher.php b/Slim/MiddlewareDispatcher.php
diff --git a/Slim/Routing/Route.php b/Slim/Routing/Route.php
diff --git a/Slim/Routing/RouteCollector.php b/Slim/Routing/RouteCollector.php
diff --git a/Slim/Routing/RouteCollectorProxy.php b/Slim/Routing/RouteCollectorProxy.php
diff --git a/Slim/Routing/RouteContext.php b/Slim/Routing/RouteContext.php
diff --git a/Slim/Routing/RouteGroup.php b/Slim/Routing/RouteGroup.php
diff --git a/Slim/Routing/RouteRunner.php b/Slim/Routing/RouteRunner.php
diff --git a/Slim/Routing/RoutingResults.php b/Slim/Routing/RoutingResults.php
diff --git a/composer.json b/composer.json
diff --git a/psalm.xml b/psalm.xml
diff --git a/tests/Handlers/ErrorHandlerTest.php b/tests/Handlers/ErrorHandlerTest.php

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ private function renderExceptionFragment(Throwable $exception): string`
`39`	`39`	`{`
`40`	`40`	`$html = sprintf('<div><strong>Type:</strong> %s</div>', get_class($exception));`
`41`	`41`
`42`		`- /** @var int\|string $code */`
`43`	`42`	`$code = $exception->getCode();`
`44`	`43`	`$html .= sprintf('<div><strong>Code:</strong> %s</div>', $code);`
`45`	`44`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ public function __invoke(Throwable $exception, bool $displayErrorDetails): strin`
`43`	`43`	`*/`
`44`	`44`	`private function formatExceptionFragment(Throwable $exception): array`
`45`	`45`	`{`
`46`		`- /** @var int\|string $code */`
`47`	`46`	`$code = $exception->getCode();`
`48`	`47`	`return [`
`49`	`48`	`'type' => get_class($exception),`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`
`11`	`11`	`namespace Slim\Exception;`
`12`	`12`
	`13`	`+/** @api */`
`13`	`14`	`class HttpBadRequestException extends HttpSpecializedException`
`14`	`15`	`{`
`15`	`16`	`/**`