[Bugfix] Correct type-hinting in error response methods

lindyhopchris · lindyhopchris · commit 744d4e0f4bad · 2020-06-15T12:06:34.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@ All notable changes to this project will be documented in this file. This projec
 ### Fixed
 - [#506](https://github.com/cloudcreativity/laravel-json-api/pull/506)
 Resolve model bindings correctly when substituting URL parameters.
+- Updated type-hinting for `Responses::errros()` method and allowed a `null` default
+status code to be passed to `Helpers::httpErrorStatus()` method.
 
 ## [2.0.0-beta.3] - 2020-04-13
 
diff --git a/src/Http/Responses/Responses.php b/src/Http/Responses/Responses.php
@@ -413,7 +413,7 @@ public function error($error, int $defaultStatusCode = null, array $headers = []
      * @param array $headers
      * @return mixed
      */
-    public function errors(iterable $errors, $defaultStatusCode = null, array $headers = [])
+    public function errors(iterable $errors, int $defaultStatusCode = null, array $headers = [])
     {
         $errors = $this->factory->createErrors($errors);
         $statusCode = Helpers::httpErrorStatus($errors, $defaultStatusCode);
diff --git a/src/Utils/Helpers.php b/src/Utils/Helpers.php
@@ -157,13 +157,17 @@ public static function isJsonApi($request)
      * 4xx errors or 500 Internal Server Error might be appropriate for multiple 5xx errors.
      *
      * @param iterable|ErrorInterface $errors
-     * @param int $default
+     * @param int|null $default
      * @return int
      * @see https://jsonapi.org/format/#errors
      * @deprecated 3.0.0 use `Document\Error\Errors::getStatus()`
      */
-    public static function httpErrorStatus($errors, int $default = SymfonyResponse::HTTP_BAD_REQUEST): int
+    public static function httpErrorStatus($errors, int $default = null): int
     {
+        if (\is_null($default)) {
+            $default = SymfonyResponse::HTTP_BAD_REQUEST;
+        }
+
         if ($errors instanceof ErrorInterface) {
             $errors = [$errors];
         }

Original file line number	Diff line number	Diff line change
`@@ -413,7 +413,7 @@ public function error($error, int $defaultStatusCode = null, array $headers = []`
`413`	`413`	`* @param array $headers`
`414`	`414`	`* @return mixed`
`415`	`415`	`*/`
`416`		`- public function errors(iterable $errors, $defaultStatusCode = null, array $headers = [])`
	`416`	`+ public function errors(iterable $errors, int $defaultStatusCode = null, array $headers = [])`
`417`	`417`	`{`
`418`	`418`	`$errors = $this->factory->createErrors($errors);`
`419`	`419`	`$statusCode = Helpers::httpErrorStatus($errors, $defaultStatusCode);`