GetLogs.php
183 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\Endpoints\Logs; |
| 4 | |
| 5 | use Give\Log\LogRepository; |
| 6 | use Give\Log\ValueObjects\LogType; |
| 7 | use WP_REST_Request; |
| 8 | use WP_REST_Response; |
| 9 | |
| 10 | /** |
| 11 | * Class GetLogs |
| 12 | * @package Give\API\Endpoints\Logs |
| 13 | * |
| 14 | * @since 2.10.0 |
| 15 | */ |
| 16 | class GetLogs extends Endpoint |
| 17 | { |
| 18 | |
| 19 | /** @var string */ |
| 20 | protected $endpoint = 'logs/get-logs'; |
| 21 | |
| 22 | /** |
| 23 | * @var LogRepository |
| 24 | */ |
| 25 | private $logRepository; |
| 26 | |
| 27 | /** |
| 28 | * GetLogs constructor. |
| 29 | * |
| 30 | * @param LogRepository $repository |
| 31 | */ |
| 32 | public function __construct(LogRepository $repository) |
| 33 | { |
| 34 | $this->logRepository = $repository; |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * @inheritDoc |
| 39 | */ |
| 40 | public function registerRoute() |
| 41 | { |
| 42 | register_rest_route( |
| 43 | 'give-api/v2', |
| 44 | $this->endpoint, |
| 45 | [ |
| 46 | [ |
| 47 | 'methods' => 'GET', |
| 48 | 'callback' => [$this, 'handleRequest'], |
| 49 | 'permission_callback' => [$this, 'permissionsCheck'], |
| 50 | 'args' => [ |
| 51 | 'page' => [ |
| 52 | 'validate_callback' => function ($param) { |
| 53 | return filter_var($param, FILTER_VALIDATE_INT); |
| 54 | }, |
| 55 | 'default' => '1', |
| 56 | ], |
| 57 | 'type' => [ |
| 58 | 'validate_callback' => function ($param) { |
| 59 | if (empty($param) || ('all' === $param)) { |
| 60 | return true; |
| 61 | } |
| 62 | |
| 63 | return LogType::isValid($param); |
| 64 | }, |
| 65 | 'default' => 'all', |
| 66 | ], |
| 67 | 'category' => [ |
| 68 | 'validate_callback' => function ($param) { |
| 69 | return is_string($param); |
| 70 | }, |
| 71 | 'default' => '', |
| 72 | ], |
| 73 | 'source' => [ |
| 74 | 'validate_callback' => function ($param) { |
| 75 | return is_string($param); |
| 76 | }, |
| 77 | 'default' => '', |
| 78 | ], |
| 79 | 'sort' => [ |
| 80 | 'validate_callback' => function ($param) { |
| 81 | if (empty($param)) { |
| 82 | return true; |
| 83 | } |
| 84 | |
| 85 | return in_array($param, $this->logRepository->getSortableColumns(), true); |
| 86 | }, |
| 87 | 'default' => 'id', |
| 88 | ], |
| 89 | 'direction' => [ |
| 90 | 'validate_callback' => function ($param) { |
| 91 | if (empty($param)) { |
| 92 | return true; |
| 93 | } |
| 94 | |
| 95 | return in_array(strtoupper($param), ['ASC', 'DESC'], true); |
| 96 | }, |
| 97 | 'default' => 'DESC', |
| 98 | ], |
| 99 | ], |
| 100 | ], |
| 101 | 'schema' => [$this, 'getSchema'], |
| 102 | ] |
| 103 | ); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * @return array |
| 108 | */ |
| 109 | public function getSchema() |
| 110 | { |
| 111 | return [ |
| 112 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 113 | 'title' => 'logs', |
| 114 | 'type' => 'object', |
| 115 | 'properties' => [ |
| 116 | 'page' => [ |
| 117 | 'type' => 'integer', |
| 118 | 'description' => esc_html__('Current page', 'give'), |
| 119 | ], |
| 120 | 'type' => [ |
| 121 | 'type' => 'string', |
| 122 | 'description' => esc_html__('Log type', 'give'), |
| 123 | ], |
| 124 | 'category' => [ |
| 125 | 'type' => 'string', |
| 126 | 'description' => esc_html__('Log category', 'give'), |
| 127 | ], |
| 128 | 'source' => [ |
| 129 | 'type' => 'string', |
| 130 | 'description' => esc_html__('Log source', 'give'), |
| 131 | ], |
| 132 | 'direction' => [ |
| 133 | 'type' => 'string', |
| 134 | 'description' => esc_html__('Sort direction', 'give'), |
| 135 | ], |
| 136 | 'sort' => [ |
| 137 | 'type' => 'string', |
| 138 | 'description' => esc_html__('Sort by column', 'give'), |
| 139 | ], |
| 140 | ], |
| 141 | ]; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * @since 3.12.1 Add 'givewp_log_source_view' filter |
| 146 | * |
| 147 | * @param WP_REST_Request $request |
| 148 | * |
| 149 | * @return WP_REST_Response |
| 150 | */ |
| 151 | public function handleRequest(WP_REST_Request $request) |
| 152 | { |
| 153 | $data = []; |
| 154 | $logs = $this->logRepository->getLogsForRequest($request); |
| 155 | $total = $this->logRepository->getLogCountForRequest($request); |
| 156 | |
| 157 | foreach ($logs as $log) { |
| 158 | $data[] = [ |
| 159 | 'id' => $log->getId(), |
| 160 | 'log_type' => $log->getType(), |
| 161 | 'category' => $log->getCategory(), |
| 162 | 'source' => apply_filters('givewp_log_source_view', $log->getSource(), $log->getContext(), |
| 163 | $log->getId()), |
| 164 | 'message' => $log->getMessage(), |
| 165 | 'context' => $log->getContext(), |
| 166 | 'date' => $log->getDate(), |
| 167 | ]; |
| 168 | } |
| 169 | |
| 170 | return new WP_REST_Response( |
| 171 | [ |
| 172 | 'status' => true, |
| 173 | 'data' => $data, |
| 174 | 'pages' => ceil($total / $this->logRepository->getLogsPerPageLimit()), |
| 175 | 'categories' => $this->logRepository->getCategories(), |
| 176 | 'sources' => $this->logRepository->getSources(), |
| 177 | 'statuses' => LogType::getTypesTranslated(), |
| 178 | ] |
| 179 | ); |
| 180 | } |
| 181 | |
| 182 | } |
| 183 |