phpdoc + changelog

Author: vjik

CHANGELOG.md

@@ -1,8 +1,12 @@
 # Yii Error Handler Change Log
 
-## 4.0.1 under development
+## 4.1.0 under development
 
 - Bug #142: Fix dark mode argument display issues (@pamparam83)
+- Enh #145: Set content type header in renderers (@vjik)
+- New #145: Add `Yiisoft\ErrorHandler\ThrowableResponseFactory` that provides a response for `Throwable` object with
+  renderer provider usage (@vjik)
+- Chg #145: Mark `Yiisoft\ErrorHandler\Factory\ThrowableResponseFactory` as deprecated (@vjik)
 
 ## 4.0.0 February 05, 2025
 
@@ -11,7 +15,7 @@
 - Chg #139: Change PHP constraint in `composer.json` to `~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0` (@vjik)
 - Enh #125: Add error code & show function arguments (@xepozz)
 - Enh #130: Pass exception message instead of rendered exception to logger in `ErrorHandler` (@olegbaturin)
-- Enh #133: Extract response generator from `ErrorCatcher` middleware into separate `ThrowableResponseFactory` 
+- Enh #133: Extract response generator from `ErrorCatcher` middleware into separate `ThrowableResponseFactory`
   class (@olegbaturin)
 - Enh #138, #139: Raise the minimum PHP version to 8.1 and minor refactoring (@vjik)
 - Bug #139: Explicitly mark nullable parameters (@vjik)

src/Renderer/HeaderRenderer.php

@@ -15,6 +15,9 @@
  */
 final class HeaderRenderer implements ThrowableRendererInterface
 {
+    /**
+     * @param string|null $contentType The content type to be set in the response header.
+     */
     public function __construct(
         private readonly ?string $contentType = null,
     ) {

src/RendererProvider/ClosureRendererProvider.php

@@ -12,6 +12,8 @@
 use function is_string;
 
 /**
+ * Provides a renderer based on a closure that returns a `ThrowableRendererInterface` or its class name.
+ *
  * @psalm-type TClosure = Closure(ServerRequestInterface $request): (class-string<ThrowableRendererInterface>|ThrowableRendererInterface|null)
  */
 final class ClosureRendererProvider implements RendererProviderInterface

src/RendererProvider/CompositeRendererProvider.php

@@ -7,6 +7,9 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 
+/**
+ * `CompositeRendererProvider` aggregates multiple `RendererProviderInterface` implementations.
+ */
 final class CompositeRendererProvider implements RendererProviderInterface
 {
     /**

src/RendererProvider/ContentTypeRendererProvider.php

@@ -17,6 +17,9 @@
 
 use function array_key_exists;
 
+/**
+ * Provides a renderer based on the "Accept" header of the request.
+ */
 final class ContentTypeRendererProvider implements RendererProviderInterface
 {
     /**

src/RendererProvider/HeadRendererProvider.php

@@ -12,6 +12,9 @@
 use Yiisoft\Http\HeaderValueHelper;
 use Yiisoft\Http\Method;
 
+/**
+ * Provides a renderer for HEAD requests.
+ */
 final class HeadRendererProvider implements RendererProviderInterface
 {
     public function get(ServerRequestInterface $request): ?ThrowableRendererInterface

src/RendererProvider/RendererProviderInterface.php

@@ -7,7 +7,15 @@
 use Psr\Http\Message\ServerRequestInterface;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 
+/**
+ * Interface that provides a way to get a `ThrowableRendererInterface` implementation based on the request.
+ */
 interface RendererProviderInterface
 {
+    /**
+     * @param ServerRequestInterface $request The server request.
+     *
+     * @return ThrowableRendererInterface|null The `ThrowableRendererInterface` implementation or null if not found.
+     */
     public function get(ServerRequestInterface $request): ?ThrowableRendererInterface;
 }

src/ThrowableResponseFactory.php

@@ -11,6 +11,9 @@
 use Yiisoft\ErrorHandler\RendererProvider\RendererProviderInterface;
 use Yiisoft\Http\Status;
 
+/**
+ * `ThrowableResponseFactory` produces a response with rendered `Throwable` object.
+ */
 final class ThrowableResponseFactory implements ThrowableResponseFactoryInterface
 {
     private readonly HeadersProvider $headersProvider;