Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 01:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Refactor notify exception to clean up api exception handling

Browse Source
This commit is contained in:
Thomas Kuschan 2023-06-14 11:07:13 +02:00
parent 321a459421
commit 34d8268b2b
2 changed files with 36 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/Exceptions/Handler.php
View File

@ -103,10 +103,6 @@ class Handler extends ExceptionHandler
$code = $e->status;
}
if (method_exists($e, 'getStatus')) {
$code = $e->getStatus();
}
$responseData['error']['code'] = $code;
return new JsonResponse($responseData, $code, $headers);

40
app/Exceptions/NotifyException.php
View File

@ -4,29 +4,61 @@ namespace BookStack\Exceptions;
use Exception;
use Illuminate\Contracts\Support\Responsable;
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
class NotifyException extends Exception implements Responsable
class NotifyException extends Exception implements Responsable, HttpExceptionInterface
{
public $message;
public $redirectLocation;
protected $status;
/**
* @var array<mixed>
*/
protected array $headers = [];
public function __construct(string $message, string $redirectLocation = '/', int $status = 500)
{
$this->message = $message;
$this->redirectLocation = $redirectLocation;
$this->status = $status;
if ($status >= 300 && $status < 400) {
// add redirect header only when a matching HTTP status is given
$this->headers = ['location' => $redirectLocation];
}
parent::__construct();
}
/**
* Get the desired status code for this exception.
* Get the desired HTTP status code for this exception.
*
* {@inheritdoc}
*/
public function getStatus(): int
public function getStatusCode(): int
{
return $this->status;
}
/**
* Get the desired HTTP headers for this exception.
*
* {@inheritdoc}
*/
public function getHeaders(): array
{
return $this->headers;
}
/**
* @param array<mixed> $headers
*/
public function setHeaders(array $headers): void
{
$this->headers = $headers;
}
/**
* Send the response for this type of exception.
*
@ -38,7 +70,7 @@ class NotifyException extends Exception implements Responsable
// Front-end JSON handling. API-side handling managed via handler.
if ($request->wantsJson()) {
return response()->json(['error' => $message], 403);
return response()->json(['error' => $message], $this->getStatusCode());
}
if (!empty($message)) {