JsonResponse.php
106 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Trait for re-useable JSON response helper. |
| 4 | * |
| 5 | * @package Tutor\Traits |
| 6 | * @since 2.5.0 |
| 7 | */ |
| 8 | |
| 9 | namespace Tutor\Traits; |
| 10 | |
| 11 | /** |
| 12 | * JsonResponse trait |
| 13 | * |
| 14 | * @since 2.5.0 |
| 15 | */ |
| 16 | trait JsonResponse { |
| 17 | |
| 18 | /** |
| 19 | * JSON response |
| 20 | * |
| 21 | * @since 3.0.0 |
| 22 | * |
| 23 | * @param string $message message. |
| 24 | * @param mixed $data data. |
| 25 | * @param integer $status_code status code. |
| 26 | * |
| 27 | * @return void JSON data response. |
| 28 | */ |
| 29 | public function json_response( string $message = '', $data = null, int $status_code = 200 ) { |
| 30 | wp_send_json( |
| 31 | array( |
| 32 | 'status_code' => $status_code, |
| 33 | 'message' => $message, |
| 34 | 'data' => $data, |
| 35 | ), |
| 36 | $status_code |
| 37 | ); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * JSON response for bad request |
| 42 | * |
| 43 | * @param string $message message. |
| 44 | * |
| 45 | * @return void |
| 46 | */ |
| 47 | public function response_bad_request( ?string $message = null ) { |
| 48 | $this->json_response( $message ?? __( 'Bad request', 'tutor' ), null, 400 ); |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Response JSON success message. |
| 53 | * |
| 54 | * @param string $message success message. |
| 55 | * @param int $status_code status code. |
| 56 | * |
| 57 | * @return void |
| 58 | */ |
| 59 | public function response_success( $message, $status_code = 200 ) { |
| 60 | wp_send_json( |
| 61 | array( |
| 62 | 'status_code' => $status_code, |
| 63 | 'success' => true, |
| 64 | 'message' => $message, |
| 65 | ), |
| 66 | $status_code |
| 67 | ); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * Response JSON fail message. |
| 72 | * |
| 73 | * @param string $message fail message. |
| 74 | * @param int $status_code status code. |
| 75 | * |
| 76 | * @return void |
| 77 | */ |
| 78 | public function response_fail( $message, $status_code = 200 ) { |
| 79 | wp_send_json( |
| 80 | array( |
| 81 | 'success' => false, |
| 82 | 'message' => $message, |
| 83 | ), |
| 84 | $status_code |
| 85 | ); |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Response JSON data. |
| 90 | * |
| 91 | * @param array $data data. |
| 92 | * @param int $status_code status code. |
| 93 | * |
| 94 | * @return void |
| 95 | */ |
| 96 | public function response_data( $data, $status_code = 200 ) { |
| 97 | wp_send_json( |
| 98 | array( |
| 99 | 'success' => true, |
| 100 | 'data' => $data, |
| 101 | ), |
| 102 | $status_code |
| 103 | ); |
| 104 | } |
| 105 | } |
| 106 |