Merge pull request #187 from MarcinOrlowski/ex-handler-186

ExHandler now expects \Throwable instead of \Exception.

Author: MarcinOrlowski

docs/CHANGES.md

@@ -8,6 +8,9 @@
 
 ## CHANGE LOG ##
 
+* @dev
+   * [RB-186] ExceptionHandler now expects `\Throwable` instead of `\Exception`.
+
 * v9.2.0 (2020-12-27)
    * Updated Travis config to run tests on PHP 8 too.
    * Added Arabic translation (thanks to @mustafa-online)

docs/exceptions.md

@@ -13,6 +13,12 @@
      * [Possible Exception Handler conflicts](#possible-exception-handler-conflicts)
      * [ApiCodes](#apicodes)
 
+---
+
+ > ![WARNING](img/warning.png) Use of provided `ExceptionHandler` helper **requires** additional, **manual**
+ > installation steps to be made, otherwise Laravel's built-in handler will be used instead. See the details
+ > documented below.
+
 ---
 
 # Exception Handling with Response Builder #
@@ -41,7 +47,7 @@ use MarcinOrlowski\ResponseBuilder\ExceptionHandlerHelper;
  Default handler as of Laravel 5.2 has been significantly simplified and by default it looks like this:
 
 ```php
-public function render($request, Exception $e)
+public function render($request, Throwable $e)
 {
     return parent::render($request, $e);
 }
@@ -50,7 +56,7 @@ public function render($request, Exception $e)
  After your edit it shall look like this:
 
 ```php
-public function render($request, Exception $e)
+public function render($request, Throwable $e)
 {
     return ExceptionHandlerHelper::render($request, $e);
 }

src/ExceptionHandlerHelper.php

@@ -14,7 +14,7 @@
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */
 
-use Exception;
+use Throwable;
 use Illuminate\Auth\AuthenticationException as AuthException;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Lang;
@@ -33,11 +33,11 @@ class ExceptionHandlerHelper
 	 * Render an exception into valid API response.
 	 *
 	 * @param \Illuminate\Http\Request $request Request object
-	 * @param \Exception               $ex      Exception
+	 * @param \Throwable               $ex      Throwable to handle
 	 *
 	 * @return HttpResponse
 	 */
-	public static function render(/** @scrutinizer ignore-unused */ $request, Exception $ex): HttpResponse
+	public static function render(/** @scrutinizer ignore-unused */ $request, \Throwable $ex): HttpResponse
 	{
 		$result = null;
 
@@ -62,17 +62,17 @@ public static function render(/** @scrutinizer ignore-unused */ $request, Except
 	}
 
 	/**
-	 * Handles given exception and produces valid HTTP response object.
+	 * Handles given throwable and produces valid HTTP response object.
 	 *
-	 * @param \Exception $ex                 Exception to be handled.
+	 * @param \Throwable $ex                 Throwable to be handled.
 	 * @param array      $ex_cfg             ExceptionHandler's config excerpt related to $ex exception type.
 	 * @param int        $fallback_http_code HTTP code to be assigned to produced $ex related response in
 	 *                                       case configuration array lacks own `http_code` value. Default
 	 *                                       HttpResponse::HTTP_INTERNAL_SERVER_ERROR
 	 *
 	 * @return \Symfony\Component\HttpFoundation\Response
 	 */
-	protected static function processException(\Exception $ex, array $ex_cfg,
+	protected static function processException(\Throwable $ex, array $ex_cfg,
 	                                           int $fallback_http_code = HttpResponse::HTTP_INTERNAL_SERVER_ERROR)
 	{
 		$api_code = $ex_cfg['api_code'];
@@ -110,13 +110,13 @@ protected static function processException(\Exception $ex, array $ex_cfg,
 	 * `default` handler either for HttpException (if $ex is instance of it), or generic `default`
 	 * config.
 	 *
-	 * @param \Exception $ex
+	 * @param \Throwable $ex
 	 * @param int        $http_code
 	 * @param array      $placeholders
 	 *
 	 * @return string
 	 */
-	protected static function getErrorMessageForException(\Exception $ex, int $http_code, array $placeholders): string
+	protected static function getErrorMessageForException(\Throwable $ex, int $http_code, array $placeholders): string
 	{
 		// exception message is uselss, lets go deeper
 		if ($ex instanceof HttpException) {
@@ -153,14 +153,14 @@ protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
 	/**
 	 * Process single error and produce valid API response.
 	 *
-	 * @param Exception $ex Exception to be handled.
+	 * @param \Throwable $ex Exception to be handled.
 	 * @param integer   $api_code
 	 * @param integer   $http_code
 	 * @param string    $error_message
 	 *
 	 * @return HttpResponse
 	 */
-	protected static function error(Exception $ex,
+	protected static function error(Throwable $ex,
 	                                int $api_code, int $http_code = null, string $error_message = null): HttpResponse
 	{
 		$ex_http_code = ($ex instanceof HttpException) ? $ex->getStatusCode() : $ex->getCode();
@@ -265,7 +265,7 @@ protected static function getExceptionHandlerConfig(): array
 	 *
 	 * @return array|null
 	 */
-	protected static function getHandler(Exception $ex): ?array
+	protected static function getHandler(\Throwable $ex): ?array
 	{
 		$result = null;