Last active
August 23, 2018 06:21
-
-
Save hscstudio/d007d7ed84627b18b86b15606c09a045 to your computer and use it in GitHub Desktop.
Laravel Handler Best Practice For Web Service?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
namespace App\Exceptions; | |
use Exception; | |
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; | |
use Illuminate\Http\Response; | |
use Symfony\Component\HttpKernel\Exception\HttpException; | |
use Illuminate\Database\Eloquent\ModelNotFoundException; | |
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; | |
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException; | |
use Illuminate\Validation\ValidationException; | |
use Illuminate\Database\QueryException; | |
use Illuminate\Auth\AuthenticationException; | |
use Illuminate\Auth\Access\AuthorizationException; | |
use Illuminate\Session\TokenMismatchException; | |
class Handler extends ExceptionHandler | |
{ | |
/** | |
* A list of the exception types that are not reported. | |
* | |
* @var array | |
*/ | |
protected $dontReport = [ | |
HttpException::class, | |
ModelNotFoundException::class, | |
NotFoundHttpException::class, | |
MethodNotAllowedHttpException::class, | |
ValidationException::class, | |
QueryException::class, | |
AuthenticationException::class, | |
AuthorizationException::class, | |
TokenMismatchException::class, | |
]; | |
/** | |
* A list of the inputs that are never flashed for validation exceptions. | |
* | |
* @var array | |
*/ | |
protected $dontFlash = [ | |
'password', | |
'password_confirmation', | |
]; | |
/** | |
* Report or log an exception. | |
* | |
* @param \Exception $exception | |
* @return void | |
*/ | |
public function report(Exception $exception) | |
{ | |
parent::report($exception); | |
} | |
/** | |
* Render an exception into an HTTP response. | |
* | |
* @param \Illuminate\Http\Request $request | |
* @param \Exception $exception | |
* @return \Illuminate\Http\Response | |
*/ | |
public function render($request, Exception $exception) | |
{ | |
$debug = config('app.debug'); | |
$message = ''; | |
$status_code = '500'; | |
if ($exception instanceof ModelNotFoundException) { | |
$message = 'Resource is not found'; | |
$status_code = 404; | |
} | |
elseif ($exception instanceof NotFoundHttpException) { | |
$message = 'Endpoint is not found'; | |
$status_code = 404; | |
} | |
elseif ($exception instanceof MethodNotAllowedHttpException) { | |
$message = 'Method is not allowed'; | |
$status_code = 405; | |
} | |
else if ($exception instanceof ValidationException) { | |
$validationErrors = $exception->validator->errors()->getMessages(); | |
$validationErrors = array_map(function($error) { | |
return array_map(function($message) { | |
return $message; | |
}, $error); | |
}, $validationErrors); | |
$message = $validationErrors; | |
$status_code = 405; | |
} | |
else if ($exception instanceof QueryException) { | |
if ($debug) { | |
$message = $exception->getMessage(); | |
} else { | |
$message = 'Query failed to execute'; | |
} | |
$status_code = 500; | |
} | |
$rendered = parent::render($request, $exception); | |
$status_code = $rendered->getStatusCode(); | |
if ( empty($message) ) { | |
$message = $exception->getMessage(); | |
} | |
$errors = []; | |
if ($debug) { | |
$errors['exception'] = get_class($exception); | |
$errors['trace'] = explode("\n", $exception->getTraceAsString()); | |
} | |
return response()->json([ | |
'status' => 'error', | |
'message' => $message, | |
'data' => null, | |
'errors' => $errors, | |
], $status_code); | |
} | |
/** | |
* Convert an authentication exception into an unauthenticated response. | |
* | |
* @param \Illuminate\Http\Request $request | |
* @param \Illuminate\Auth\AuthenticationException $exception | |
* @return \Illuminate\Http\Response | |
*/ | |
protected function unauthenticated($request, AuthenticationException $exception) | |
{ | |
return response()->json([ | |
'status' => 'error', | |
'message' => 'Unauthenticate', | |
'data' => null | |
], 401); | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment