1414
1515trait ApiResponseHelpers
1616{
17- private ?array $ _api_helpers_defaultSuccessData'success ' => true ];
18-
19- /**
20- * @param string|\Exception $message
21- * @param string|null $key
22- *
23- * @return \Illuminate\Http\JsonResponse
24- */
17+ private ?array $ _api_helpers_defaultSuccessData
18+ 'success ' => true ,
19+ ];
20+
2521 public function respondNotFound (
26- $ message
22+ string | Exception $ message
2723 ?string $ key'error '
2824 ): JsonResponse
2925 return $ this apiResponse (
30- [$ key$ this morphMessage ($ message
31- Response::HTTP_NOT_FOUND
26+ data: [$ key$ this morphMessage ($ message
27+ code: Response::HTTP_NOT_FOUND
3228 );
3329 }
3430
35- /**
36- * @param array|Arrayable|JsonSerializable|null $contents
37- */
38- public function respondWithSuccess ($ contentsnull ): JsonResponse
39- {
40- $ contents$ this morphToArray ($ contents
31+ public function respondWithSuccess (
32+ array |Arrayable JsonSerializable null $ contentsnull
33+ ): JsonResponse
34+ $ contents$ this morphToArray (data: $ contents
4135
4236 $ data$ contents
4337 ? $ this _api_helpers_defaultSuccessData
4438 : $ contents
4539
46- return $ this apiResponse ($ data
40+ return $ this apiResponse (data: $ data
4741 }
4842
4943 public function setDefaultSuccessResponse (?array $ contentnull ): self
@@ -54,90 +48,80 @@ public function setDefaultSuccessResponse(?array $content = null): self
5448
5549 public function respondOk (string $ messageJsonResponse
5650 {
57- return $ this respondWithSuccess (['success ' => $ message
51+ return $ this respondWithSuccess (contents: ['success ' => $ message
5852 }
5953
6054 public function respondUnAuthenticated (?string $ messagenull ): JsonResponse
6155 {
6256 return $ this apiResponse (
63- ['error ' => $ message'Unauthenticated ' ],
64- Response::HTTP_UNAUTHORIZED
57+ data: ['error ' => $ message'Unauthenticated ' ],
58+ code: Response::HTTP_UNAUTHORIZED
6559 );
6660 }
6761
6862 public function respondForbidden (?string $ messagenull ): JsonResponse
6963 {
7064 return $ this apiResponse (
71- ['error ' => $ message'Forbidden ' ],
72- Response::HTTP_FORBIDDEN
65+ data: ['error ' => $ message'Forbidden ' ],
66+ code: Response::HTTP_FORBIDDEN
7367 );
7468 }
7569
7670 public function respondError (?string $ messagenull ): JsonResponse
7771 {
7872 return $ this apiResponse (
79- ['error ' => $ message'Error ' ],
80- Response::HTTP_BAD_REQUEST
73+ data: ['error ' => $ message'Error ' ],
74+ code: Response::HTTP_BAD_REQUEST
8175 );
8276 }
8377
84- /**
85- * @param array|Arrayable|JsonSerializable|null $data
86- */
87- public function respondCreated ($ datanull ): JsonResponse
88- {
78+ public function respondCreated (
79+ array |Arrayable JsonSerializable null $ datanull
80+ ): JsonResponse
8981 $ data
82+
9083 return $ this apiResponse (
91- $ this morphToArray ($ data
92- Response::HTTP_CREATED
84+ data: $ this morphToArray (data: $ data
85+ code: Response::HTTP_CREATED
9386 );
9487 }
95-
96- /**
97- * @param string|\Exception $message
98- * @param string|null $key
99- *
100- * @return \Illuminate\Http\JsonResponse
101- */
88+
10289 public function respondFailedValidation (
103- $ message
90+ string | Exception $ message
10491 ?string $ key'message '
10592 ): JsonResponse
10693 return $ this apiResponse (
107- [$ key$ this morphMessage ($ message
108- Response::HTTP_UNPROCESSABLE_ENTITY
94+ data: [$ key$ this morphMessage ($ message
95+ code: Response::HTTP_UNPROCESSABLE_ENTITY
10996 );
11097 }
11198
11299 public function respondTeapot (): JsonResponse
113100 {
114101 return $ this apiResponse (
115- ['message ' => 'I \'m a teapot ' ],
116- Response::HTTP_I_AM_A_TEAPOT
102+ data: ['message ' => 'I \'m a teapot ' ],
103+ code: Response::HTTP_I_AM_A_TEAPOT
117104 );
118105 }
119106
120- /**
121- * @param array|Arrayable|JsonSerializable|null $data
122- */
123- public function respondNoContent ($ datanull ): JsonResponse
124- {
107+ public function respondNoContent (
108+ array |Arrayable JsonSerializable null $ datanull
109+ ): JsonResponse
125110 $ data
126- $ data$ this morphToArray ($ data
111+ $ data$ this morphToArray (data: $ data
127112
128- return $ this apiResponse ($ dataHTTP_NO_CONTENT );
113+ return $ this apiResponse (
114+ data: $ data
115+ code: Response::HTTP_NO_CONTENT
116+ );
129117 }
130118
131119 private function apiResponse (array $ dataint $ code200 ): JsonResponse
132120 {
133- return response ()->json ($ data$ code
121+ return response ()->json (data: $ data status: $ code
134122 }
135123
136- /**
137- * @param array|Arrayable|JsonSerializable|null $data
138- * @return array|null
139- */
140- private function morphToArray ($ data
124+ private function morphToArray (array |Arrayable JsonSerializable null $ dataarray
141125 {
142126 if ($ datainstanceof Arrayable) {
143127 return $ datatoArray ();
@@ -150,11 +134,7 @@ private function morphToArray($data)
150134 return $ data
151135 }
152136
153- /**
154- * @param string|\Exception $message
155- * @return string
156- */
157- private function morphMessage ($ messagestring
137+ private function morphMessage (string |Exception $ messagestring
158138 {
159139 return $ messageinstanceof Exception
160140 ? $ messagegetMessage ()
0 commit comments