|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace Ejetar\ApiResponseFormatter\Exceptions; |
| 4 | + |
| 5 | +use Ejetar\ApiResponseFormatter\Responses\CsvResponse; |
| 6 | +use Ejetar\ApiResponseFormatter\Responses\XmlResponse; |
| 7 | +use Ejetar\ApiResponseFormatter\Responses\YamlResponse; |
| 8 | +use Illuminate\Contracts\Support\Responsable; |
| 9 | +use Illuminate\Http\Exceptions\HttpResponseException; |
| 10 | +use Illuminate\Routing\Router; |
| 11 | +use Illuminate\Validation\ValidationException; |
| 12 | +use Throwable; |
| 13 | +use Illuminate\Auth\AuthenticationException; |
| 14 | +use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; |
| 15 | + |
| 16 | +class Handler extends ExceptionHandler { |
| 17 | + /** |
| 18 | + * Prepare a CSV response for the given exception. |
| 19 | + * |
| 20 | + * @param \Illuminate\Http\Request $request |
| 21 | + * @param \Throwable $e |
| 22 | + * @return CsvResponse |
| 23 | + */ |
| 24 | + protected function prepareCsvResponse($request, Throwable $e) { |
| 25 | + return new CsvResponse( |
| 26 | + $this->convertExceptionToArray($e), |
| 27 | + $this->isHttpException($e) ? $e->getStatusCode() : 500, |
| 28 | + $this->isHttpException($e) ? $e->getHeaders() : [] |
| 29 | + ); |
| 30 | + } |
| 31 | + |
| 32 | + /** |
| 33 | + * Prepare a YAML response for the given exception. |
| 34 | + * |
| 35 | + * @param \Illuminate\Http\Request $request |
| 36 | + * @param \Throwable $e |
| 37 | + * @return YamlResponse |
| 38 | + */ |
| 39 | + protected function prepareYamlResponse($request, Throwable $e) { |
| 40 | + return new YamlResponse( |
| 41 | + $this->convertExceptionToArray($e), |
| 42 | + $this->isHttpException($e) ? $e->getStatusCode() : 500, |
| 43 | + $this->isHttpException($e) ? $e->getHeaders() : [] |
| 44 | + ); |
| 45 | + } |
| 46 | + |
| 47 | + /** |
| 48 | + * Prepare a XML response for the given exception. |
| 49 | + * |
| 50 | + * @param \Illuminate\Http\Request $request |
| 51 | + * @param \Throwable $e |
| 52 | + * @return XmlResponse |
| 53 | + */ |
| 54 | + protected function prepareXmlResponse($request, Throwable $e) { |
| 55 | + return new XmlResponse( |
| 56 | + $this->convertExceptionToArray($e), |
| 57 | + $this->isHttpException($e) ? $e->getStatusCode() : 500, |
| 58 | + $this->isHttpException($e) ? $e->getHeaders() : [] |
| 59 | + ); |
| 60 | + } |
| 61 | + |
| 62 | + /** |
| 63 | + * Convert a validation exception into a XML response. |
| 64 | + * |
| 65 | + * @param \Illuminate\Http\Request $request |
| 66 | + * @param \Illuminate\Validation\ValidationException $exception |
| 67 | + * @return XmlResponse |
| 68 | + */ |
| 69 | + protected function invalidXml($request, ValidationException $exception) { |
| 70 | + return new XmlResponse([ |
| 71 | + 'message' => $exception->getMessage(), |
| 72 | + 'errors' => $exception->errors(), |
| 73 | + ], $exception->status); |
| 74 | + } |
| 75 | + |
| 76 | + /** |
| 77 | + * Convert a validation exception into a CSV response. |
| 78 | + * |
| 79 | + * @param \Illuminate\Http\Request $request |
| 80 | + * @param \Illuminate\Validation\ValidationException $exception |
| 81 | + * @return CsvResponse |
| 82 | + */ |
| 83 | + protected function invalidCsv($request, ValidationException $exception) { |
| 84 | + return new CsvResponse([ |
| 85 | + 'message' => $exception->getMessage(), |
| 86 | + 'errors' => $exception->errors(), |
| 87 | + ], $exception->status); |
| 88 | + } |
| 89 | + |
| 90 | + /** |
| 91 | + * Convert a validation exception into a YAML response. |
| 92 | + * |
| 93 | + * @param \Illuminate\Http\Request $request |
| 94 | + * @param \Illuminate\Validation\ValidationException $exception |
| 95 | + * @return YamlResponse |
| 96 | + */ |
| 97 | + protected function invalidYaml($request, ValidationException $exception) { |
| 98 | + return new YamlResponse([ |
| 99 | + 'message' => $exception->getMessage(), |
| 100 | + 'errors' => $exception->errors(), |
| 101 | + ], $exception->status); |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Create a response object from the given validation exception. |
| 106 | + * |
| 107 | + * @param \Illuminate\Validation\ValidationException $e |
| 108 | + * @param \Illuminate\Http\Request $request |
| 109 | + * @return \Symfony\Component\HttpFoundation\Response |
| 110 | + */ |
| 111 | + protected function convertValidationExceptionToResponse(ValidationException $e, $request) { |
| 112 | + if ($e->response) |
| 113 | + return $e->response; |
| 114 | + |
| 115 | + if ($request->expectsJson()) { |
| 116 | + return $this->invalidJson($request, $e); |
| 117 | + |
| 118 | + } elseif ($request->expectsXml()) { |
| 119 | + return $this->invalidXml($request, $e); |
| 120 | + |
| 121 | + } elseif ($request->expectsCsv()) { |
| 122 | + return $this->invalidCsv($request, $e); |
| 123 | + |
| 124 | + } elseif ($request->expectsYaml()) { |
| 125 | + return $this->invalidYaml($request, $e); |
| 126 | + |
| 127 | + } else { |
| 128 | + $this->invalid($request, $e); |
| 129 | + } |
| 130 | + } |
| 131 | + |
| 132 | + /** |
| 133 | + * Render an exception into an HTTP response. |
| 134 | + * |
| 135 | + * @param \Illuminate\Http\Request $request |
| 136 | + * @param Throwable $exception |
| 137 | + * @return \Illuminate\Http\Response |
| 138 | + */ |
| 139 | + public function render($request, Throwable $e) { |
| 140 | + if (method_exists($e, 'render') && $response = $e->render($request)) { |
| 141 | + return Router::toResponse($request, $response); |
| 142 | + } elseif ($e instanceof Responsable) { |
| 143 | + return $e->toResponse($request); |
| 144 | + } |
| 145 | + |
| 146 | + $e = $this->prepareException($e); |
| 147 | + |
| 148 | + if ($e instanceof HttpResponseException) { |
| 149 | + return $e->getResponse(); |
| 150 | + } elseif ($e instanceof AuthenticationException) { |
| 151 | + return $this->unauthenticated($request, $e); |
| 152 | + } elseif ($e instanceof ValidationException) { |
| 153 | + return $this->convertValidationExceptionToResponse($e, $request); |
| 154 | + } |
| 155 | + |
| 156 | + if ($request->expectsJson()) { |
| 157 | + return $this->prepareJsonResponse($request, $e); |
| 158 | + |
| 159 | + } elseif ($request->expectsXml()) { |
| 160 | + return $this->prepareXmlResponse($request, $e); |
| 161 | + |
| 162 | + } elseif ($request->expectsCsv()) { |
| 163 | + return $this->prepareCsvResponse($request, $e); |
| 164 | + |
| 165 | + } elseif ($request->expectsYaml()) { |
| 166 | + return $this->prepareYamlResponse($request, $e); |
| 167 | + |
| 168 | + } else { |
| 169 | + if (\Request::is('api/*')) |
| 170 | + return $this->prepareJsonResponse($request, $e); |
| 171 | + else |
| 172 | + return $this->prepareResponse($request, $e); |
| 173 | + } |
| 174 | + } |
| 175 | +} |
0 commit comments