Skip to content

Instantly share code, notes, and snippets.

@patrickmaciel
Forked from joseluisq/1README.md
Created December 21, 2018 18:00
Show Gist options
  • Save patrickmaciel/cb3ce60d838ee28bac19e67dbf49ac6d to your computer and use it in GitHub Desktop.
Save patrickmaciel/cb3ce60d838ee28bac19e67dbf49ac6d to your computer and use it in GitHub Desktop.
Configure PHP Lumen 5 HTTP Exception Handlers with common JSON responses.

Lumen 5 HTTP Exception Handlers with JSON support.

Configure PHP Lumen 5 HTTP Exception Handlers with common JSON responses.

image

Setup

Copy (replace) only the attached files to their respective directories. app/Exceptions/Handler.php and app/Http/Middleware/Authenticate.php

Tip: Via your .env file you can handle the visibility of the HTTP Exception responses. APP_DEBUG=false (for display json exception responses in production)

<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Contracts\Auth\Factory as Auth;
class Authenticate
{
/**
* The authentication guard factory instance.
*
* @var \Illuminate\Contracts\Auth\Factory
*/
protected $auth;
/**
* Create a new middleware instance.
*
* @param \Illuminate\Contracts\Auth\Factory $auth
* @return void
*/
public function __construct(Auth $auth)
{
$this->auth = $auth;
}
/**
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @param string|null $guard
* @return mixed
*/
public function handle($request, Closure $next, $guard = null)
{
if ($this->auth->guard($guard)->guest()) {
return response()
->json([
'success' => false,
'status' => 401,
'message' => 'HTTP_UNAUTHORIZED'
], 401);
}
return $next($request);
}
}
<?php
namespace App\Exceptions;
use Exception;
use Illuminate\Validation\ValidationException;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Laravel\Lumen\Exceptions\Handler as ExceptionHandler;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
use Illuminate\Http\Exception\HttpResponseException;
use Illuminate\Http\Response;
class Handler extends ExceptionHandler
{
/**
* A list of the exception types that should not be reported.
*
* @var array
*/
protected $dontReport = [
AuthorizationException::class,
HttpException::class,
ModelNotFoundException::class,
ValidationException::class,
];
/**
* Report or log an exception.
*
* This is a great spot to send exceptions to Sentry, Bugsnag, etc.
*
* @param \Exception $e
* @return void
*/
public function report(Exception $e)
{
parent::report($e);
}
/**
* Render an exception into an HTTP response.
*
* @param \Illuminate\Http\Request $request
* @param \Exception $e
* @return \Illuminate\Http\Response
*/
public function render($request, Exception $e)
{
if (env('APP_DEBUG')) {
return parent::render($request, $e);
}
$status = Response::HTTP_INTERNAL_SERVER_ERROR;
if ($e instanceof HttpResponseException) {
$status = Response::HTTP_INTERNAL_SERVER_ERROR;
} elseif ($e instanceof MethodNotAllowedHttpException) {
$status = Response::HTTP_METHOD_NOT_ALLOWED;
$e = new MethodNotAllowedHttpException([], 'HTTP_METHOD_NOT_ALLOWED', $e);
} elseif ($e instanceof NotFoundHttpException) {
$status = Response::HTTP_NOT_FOUND;
$e = new NotFoundHttpException('HTTP_NOT_FOUND', $e);
} elseif ($e instanceof AuthorizationException) {
$status = Response::HTTP_FORBIDDEN;
$e = new AuthorizationException('HTTP_FORBIDDEN', $status);
} elseif ($e instanceof \Dotenv\Exception\ValidationException && $e->getResponse()) {
$status = Response::HTTP_BAD_REQUEST;
$e = new \Dotenv\Exception\ValidationException('HTTP_BAD_REQUEST', $status, $e);
} elseif ($e) {
$e = new HttpException($status, 'HTTP_INTERNAL_SERVER_ERROR');
}
return response()->json([
'success' => false,
'status' => $status,
'message' => $e->getMessage()
], $status);
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment