feat: update errors chapter for laravel 11

Author: lindyhopchris

4.0/getting-started/README.md

@@ -49,41 +49,17 @@ To ensure that clients receive a JSON:API error response for exceptions
 thrown by your application, you need to add the package exception renderer
 to your application's exception handler.
 
-Update the `register()` method on your `\App\Exceptions\Handler` class and
-add our `JsonApiException` to your `$dontReport` property. Both changes are
-shown below:
+Open your `bootstrap/app.php` file and add the following to the `withExceptions()` call:
 
 ```php
-namespace App\Exceptions;
-
-use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
-use LaravelJsonApi\Core\Exceptions\JsonApiException;
-
-class Handler extends ExceptionHandler
-{
-    // ...
-
-    /**
-     * A list of the exception types that should not be reported.
-     *
-     * @var array
-     */
-    protected $dontReport = [
-        JsonApiException::class,
-    ];
-
-    /**
-     * Register the exception handling callbacks for the application.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        $this->renderable(
-            \LaravelJsonApi\Exceptions\ExceptionParser::make()->renderable()
-        );
-    }
-}
+->withExceptions(function (Exceptions $exceptions) {
+    $exceptions->dontReport(
+        \LaravelJsonApi\Core\Exceptions\JsonApiException::class,
+    );
+    $exceptions->render(
+        \LaravelJsonApi\Exceptions\ExceptionParser::renderer(),
+    );
+})
 ```
 
 For more information on exception rendering and reporting, see the

4.0/responses/errors.md

@@ -284,27 +284,18 @@ $errors = $factory
 
 ## Error Rendering
 
-As described in the [installation instructions](../getting-started/#exception-handler),
-the following should have been added to the `register` method on your
-application's exception handler:
+As described in the [installation instructions](../getting-started/#exception-handler), the following should have been
+added to the `withExceptions()` call in your `bootstrap/app.php` file:
 
 ```php
-class Handler extends ExceptionHandler
-{
-    // ...
-
-    /**
-     * Register the exception handling callbacks for the application.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        $this->renderable(
-            \LaravelJsonApi\Exceptions\ExceptionParser::make()->renderable()
-        );
-    }
-}
+->withExceptions(function (Exceptions $exceptions) {
+    $exceptions->dontReport(
+        \LaravelJsonApi\Core\Exceptions\JsonApiException::class,
+    );
+    $exceptions->render(
+        \LaravelJsonApi\Exceptions\ExceptionParser::renderer(),
+    );
+})
 ```
 
 The Laravel exception handler already takes care of converting exceptions to
@@ -334,8 +325,10 @@ of the default Laravel response, use the `acceptsJson()` method when registering
 our exception parser:
 
 ```php
-$this->renderable(
-    ExceptionParser::make()->acceptsJson()->renderable()
+$exceptions->render(
+    \LaravelJsonApi\Exceptions\ExceptionParser::make()
+        ->acceptsJson()
+        ->renderable(),
 );
 ```
 
@@ -350,8 +343,10 @@ In this scenario, use the `acceptsMiddleware()` method when registering our
 exception parser. For example:
 
 ```php
-$this->renderable(
-    ExceptionParser::make()->acceptsMiddleware('api')->renderable()
+$exceptions->render(
+    \LaravelJsonApi\Exceptions\ExceptionParser::make()
+        ->acceptsMiddleware('api')
+        ->renderable(),
 );
 ```
 
@@ -367,8 +362,10 @@ If you want our exception parser to always convert exceptions to JSON:API
 errors, use the `acceptsAll()` helper method:
 
 ```php
-$this->renderable(
-    ExceptionParser::make()->acceptsAll()->renderable()
+$exceptions->render(
+    \LaravelJsonApi\Exceptions\ExceptionParser::make()
+        ->acceptsAll()
+        ->renderable(),
 );
 ```
 
@@ -382,9 +379,10 @@ responses, regardless of what `Accept` header the client sent. We would use
 the request `is()` method to check if the path is our API:
 
 ```php
-$this->renderable(ExceptionParser::make()
-    ->accept(fn(\Throwable $ex, $request) => $request->is('api/*'))
-    ->renderable()
+$exceptions->render(
+    \LaravelJsonApi\Exceptions\ExceptionParser::make()
+        ->accept(static fn(\Throwable $ex, $request) => $request->is('api/*'))
+        ->renderable(),
 );
 ```
 
@@ -442,36 +440,23 @@ We can then add it to the JSON:API exception parser using either the
 `prepend` or `append` method:
 
 ```php
-$this->renderable(ExceptionParser::make()
-    ->append(\App\JsonApi\Exceptions\PaymentFailedHandler::class)
-    ->renderable()
+$exceptions->render(
+    \LaravelJsonApi\Exceptions\ExceptionParser::make()
+        ->append(\App\JsonApi\Exceptions\PaymentFailedHandler::class)
+        ->renderable(),
 );
 ```
 
 ## Error Reporting
 
-As described in the [installation instructions](../getting-started/#exception-handler),
-the following should have been added to the `$dontReport` property on your
-application's exception handler:
+As described in the [installation instructions](../getting-started/#exception-handler), when configuring your
+application's exception handler in the `bootstrap/app.php` file, you should have called `dontReport()` with the JSON:API
+exception class:
 
 ```php
-use LaravelJsonApi\Core\Exceptions\JsonApiException;
-
-class Handler extends ExceptionHandler
-{
-    // ...
-
-    /**
-     * A list of the exception types that should not be reported.
-     *
-     * @var array
-     */
-    protected $dontReport = [
-        JsonApiException::class,
-    ];
-
-    // ...
-}
+$exceptions->dontReport(
+    \LaravelJsonApi\Core\Exceptions\JsonApiException::class,
+);
 ```
 
 This prevents our `JsonApiException` from being reported in your application's
@@ -483,45 +468,42 @@ code (server-side error) will not be reported in your error log. Therefore,
 an alternative is to use the helper methods on the `JsonApiException` class
 to determine whether or not the exception should be reported.
 
-To do this, we will use the `reportable()` method to register a callback
-for the JSON:API exception class. (At the same time, we remove the exception
-class from the `$dontReport` property.) For example, the following will stop
-the propagation of JSON:API exceptions to the default logging stack if the
-exception does not have a 5xx status:
+To do this, we will use the `report()` method when configuring our application exception handler in the
+`bootstrap/app.php` file to register a callback for the JSON:API exception class. (At the same time, we remove
+`dontReport()` call.) For example, the following will stop the propagation of JSON:API exceptions to the default logging
+stack if the exception does not have a 5xx status:
 
 ```php
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
 
-/**
- * Register the exception handling callbacks for the application.
- *
- * @return void
- */
-public function register()
-{
-    $this->reportable(function (JsonApiException $ex) {
-        if (!$ex->is5xx()) {
-          return false;
-        }
-    });
+->withExceptions(function (Exceptions $exceptions) {
+    $exceptions->report(
+        static fn(JsonApiException $ex) => !$ex->is5xx() ? false : null,
+    );
 
-    // ...
-}
+    $exceptions->render(
+        \LaravelJsonApi\Exceptions\ExceptionParser::renderer(),
+    );
+})
 ```
 
 :::tip
-As described in the [Laravel documentation on reporting exceptions](https://laravel.com/docs/8.x/errors#reporting-exceptions), returning `false` from the reportable callback prevents the
-exception from propagating to the default logging stack.
+As described in
+the [Laravel documentation on reporting exceptions](https://laravel.com/docs/8.x/errors#reporting-exceptions), returning
+`false` from the reportable callback prevents the exception from propagating to the default logging stack. Returning
+`null` indicates the Laravel should determine whether to report the exception.
 :::
 
 In the following example, we log 4xx statuses as debug information, while
 letting all other JSON:API exceptions propagate to the default logging stack:
 
 ```php
-$this->reportable(function (JsonApiException $ex) {
+$exceptions->report(static function (JsonApiException $ex) {
     if ($ex->is4xx()) {
       logger('JSON:API client exception.', $ex->getErrors()->toArray());
       return false;
     }
+    
+    return null;
 });
 ```