JsonResponseHelper.php 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. <?php
  2. namespace App\Http\Controllers;
  3. use Illuminate\Http\JsonResponse;
  4. use Illuminate\Http\Response;
  5. trait JsonResponseHelper
  6. {
  7. /**
  8. * 201
  9. *
  10. * @param array|string|null $content
  11. * @return Response
  12. */
  13. protected function created(array|string $content = null): Response
  14. {
  15. return new Response($content, Response::HTTP_CREATED);
  16. }
  17. /**
  18. * 202
  19. *
  20. * @return Response
  21. */
  22. protected function accepted(): Response
  23. {
  24. return new Response('', Response::HTTP_ACCEPTED);
  25. }
  26. /**
  27. * 204
  28. *
  29. * @return Response
  30. */
  31. protected function noContent(): Response
  32. {
  33. return new Response('', Response::HTTP_NO_CONTENT);
  34. }
  35. /**
  36. * 400
  37. *
  38. * @param string $message
  39. * @param array $headers
  40. * @param int $options
  41. * @return JsonResponse
  42. */
  43. protected function badRequest(string $message, array $headers = [], int $options = 0): JsonResponse
  44. {
  45. return response()->json([
  46. 'message' => $message
  47. ], Response::HTTP_BAD_REQUEST, $headers, $options);
  48. }
  49. /**
  50. * 401
  51. *
  52. * @param string $message
  53. * @param array $headers
  54. * @param int $options
  55. * @return JsonResponse
  56. */
  57. protected function unauthorized(string $message = '', array $headers = [], int $options = 0): JsonResponse
  58. {
  59. return response()->json([
  60. 'message' => $message ? $message : 'Token Signature could not be verified.'
  61. ], Response::HTTP_UNAUTHORIZED, $headers, $options);
  62. }
  63. /**
  64. * 403
  65. *
  66. * @param string $message
  67. * @param array $headers
  68. * @param int $options
  69. * @return JsonResponse
  70. */
  71. protected function forbidden(string $message = '', array $headers = [], int $options = 0): JsonResponse
  72. {
  73. return response()->json([
  74. 'message' => $message ? $message : 'Insufficient permissions.'
  75. ], Response::HTTP_FORBIDDEN, $headers, $options);
  76. }
  77. /**
  78. * 422
  79. *
  80. * @param array $errors
  81. * @param array $headers
  82. * @param string $message
  83. * @param $options
  84. * @return JsonResponse
  85. */
  86. protected function unprocesableEtity(array $errors = [], array $headers = [], string $message = '', $options = 0): JsonResponse
  87. {
  88. return response()->json([
  89. 'message' => $message ? $message : '422 Unprocessable Entity',
  90. 'errors' => $errors
  91. ], Response::HTTP_UNPROCESSABLE_ENTITY, $headers, $options);
  92. }
  93. /**
  94. * 200
  95. *
  96. * @param array $data
  97. * @param array $headers
  98. * @param $options
  99. * @return JsonResponse
  100. */
  101. protected function success(array $data, array $headers = [], $options = 0): JsonResponse
  102. {
  103. return response()->json($data, Response::HTTP_OK, $headers, $options);
  104. }
  105. }