Created
July 23, 2018 00:29
-
-
Save BigZ/4078a1a8e90d88386d8fb16863306fbe to your computer and use it in GitHub Desktop.
An exception controller for rest api in symfony 4 using fostRestBundle
This file contains 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 | |
// src/Controller/ExceptionController.php | |
namespace App\Controller; | |
use FOS\RestBundle\Util\ExceptionValueMap; | |
use Symfony\Component\HttpFoundation\Request; | |
use Symfony\Component\HttpFoundation\Response; | |
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface; | |
use Symfony\Component\HttpKernel\Log\DebugLoggerInterface; | |
/** | |
* Custom ExceptionController that renders to json | |
* | |
* Configure it like so: | |
app.json_exception_controller: | |
public: true | |
class: App\Controller\ExceptionController | |
arguments: | |
- '@fos_rest.exception.codes_map' | |
*/ | |
class ExceptionController | |
{ | |
/** | |
* @var ExceptionValueMap | |
*/ | |
private $exceptionCodes; | |
public function __construct(ExceptionValueMap $exceptionCodes) { | |
$this->exceptionCodes = $exceptionCodes; | |
} | |
/** | |
* Converts an Exception to a Response. | |
* | |
* @param Request $request | |
* @param \Exception|\Throwable $exception | |
* @param DebugLoggerInterface|null $logger | |
* | |
* @throws \InvalidArgumentException | |
* | |
* @return Response | |
*/ | |
public function showAction(Request $request, $exception, DebugLoggerInterface $logger = null) | |
{ | |
$code = $this->getStatusCode($exception); | |
return new Response( | |
json_encode( | |
['error' => $exception->getMessage()], | |
JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | |
), | |
$code, | |
['Content-type' => 'application/json'] | |
); | |
} | |
/** | |
* Determines the status code to use for the response. | |
* | |
* @param \Exception $exception | |
* | |
* @return int | |
*/ | |
protected function getStatusCode(\Exception $exception) | |
{ | |
// If matched | |
if ($statusCode = $this->exceptionCodes->resolveException($exception)) { | |
return $statusCode; | |
} | |
// Otherwise, default | |
if ($exception instanceof HttpExceptionInterface) { | |
return $exception->getStatusCode(); | |
} | |
return 500; | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hint! You can use JsonResponse instead of Response