Controller.php
177 lines
| 1 | <?php |
| 2 | /** |
| 3 | * REST API Reports coupons stats controller |
| 4 | * |
| 5 | * Handles requests to the /reports/coupons/stats endpoint. |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\WooCommerce\Admin\API\Reports\Coupons\Stats; |
| 9 | |
| 10 | defined( 'ABSPATH' ) || exit; |
| 11 | |
| 12 | use Automattic\WooCommerce\Admin\API\Reports\GenericStatsController; |
| 13 | use Automattic\WooCommerce\Admin\API\Reports\GenericQuery; |
| 14 | use WP_REST_Request; |
| 15 | use WP_REST_Response; |
| 16 | |
| 17 | /** |
| 18 | * REST API Reports coupons stats controller class. |
| 19 | * |
| 20 | * @internal |
| 21 | * @extends GenericStatsController |
| 22 | */ |
| 23 | class Controller extends GenericStatsController { |
| 24 | |
| 25 | /** |
| 26 | * Route base. |
| 27 | * |
| 28 | * @var string |
| 29 | */ |
| 30 | protected $rest_base = 'reports/coupons/stats'; |
| 31 | |
| 32 | |
| 33 | /** |
| 34 | * Maps query arguments from the REST request. |
| 35 | * |
| 36 | * @param array $request Request array. |
| 37 | * @return array |
| 38 | */ |
| 39 | protected function prepare_reports_query( $request ) { |
| 40 | $args = array(); |
| 41 | $args['before'] = $request['before']; |
| 42 | $args['after'] = $request['after']; |
| 43 | $args['interval'] = $request['interval']; |
| 44 | $args['page'] = $request['page']; |
| 45 | $args['per_page'] = $request['per_page']; |
| 46 | $args['orderby'] = $request['orderby']; |
| 47 | $args['order'] = $request['order']; |
| 48 | $args['coupons'] = (array) $request['coupons']; |
| 49 | $args['segmentby'] = $request['segmentby']; |
| 50 | $args['fields'] = $request['fields']; |
| 51 | $args['force_cache_refresh'] = $request['force_cache_refresh']; |
| 52 | |
| 53 | return $args; |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Get data from `'coupons-stats'` GenericQuery. |
| 58 | * |
| 59 | * @override GenericController::get_datastore_data() |
| 60 | * |
| 61 | * @param array $query_args Query arguments. |
| 62 | * @return mixed Results from the data store. |
| 63 | */ |
| 64 | protected function get_datastore_data( $query_args = array() ) { |
| 65 | $query = new GenericQuery( $query_args, 'coupons-stats' ); |
| 66 | return $query->get_data(); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Prepare a report data item for serialization. |
| 71 | * |
| 72 | * @param mixed $report Report data item as returned from Data Store. |
| 73 | * @param WP_REST_Request $request Request object. |
| 74 | * @return WP_REST_Response |
| 75 | */ |
| 76 | public function prepare_item_for_response( $report, $request ) { |
| 77 | $response = parent::prepare_item_for_response( $report, $request ); |
| 78 | |
| 79 | // Map to `object` for backwards compatibility. |
| 80 | $report = (object) $report; |
| 81 | /** |
| 82 | * Filter a report returned from the API. |
| 83 | * |
| 84 | * Allows modification of the report data right before it is returned. |
| 85 | * |
| 86 | * @param WP_REST_Response $response The response object. |
| 87 | * @param object $report The original report object. |
| 88 | * @param WP_REST_Request $request Request used to generate the response. |
| 89 | */ |
| 90 | return apply_filters( 'woocommerce_rest_prepare_report_coupons_stats', $response, $report, $request ); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Get the Report's item properties schema. |
| 95 | * Will be used by `get_item_schema` as `totals` and `subtotals`. |
| 96 | * |
| 97 | * @return array |
| 98 | */ |
| 99 | protected function get_item_properties_schema() { |
| 100 | return array( |
| 101 | 'amount' => array( |
| 102 | 'description' => __( 'Net discount amount.', 'woocommerce' ), |
| 103 | 'type' => 'number', |
| 104 | 'context' => array( 'view', 'edit' ), |
| 105 | 'readonly' => true, |
| 106 | 'indicator' => true, |
| 107 | 'format' => 'currency', |
| 108 | ), |
| 109 | 'coupons_count' => array( |
| 110 | 'description' => __( 'Number of coupons.', 'woocommerce' ), |
| 111 | 'type' => 'integer', |
| 112 | 'context' => array( 'view', 'edit' ), |
| 113 | 'readonly' => true, |
| 114 | ), |
| 115 | 'orders_count' => array( |
| 116 | 'title' => __( 'Discounted orders', 'woocommerce' ), |
| 117 | 'description' => __( 'Number of discounted orders.', 'woocommerce' ), |
| 118 | 'type' => 'integer', |
| 119 | 'context' => array( 'view', 'edit' ), |
| 120 | 'readonly' => true, |
| 121 | 'indicator' => true, |
| 122 | ), |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Get the Report's schema, conforming to JSON Schema. |
| 128 | * |
| 129 | * @return array |
| 130 | */ |
| 131 | public function get_item_schema() { |
| 132 | $schema = parent::get_item_schema(); |
| 133 | $schema['title'] = 'report_coupons_stats'; |
| 134 | |
| 135 | return $this->add_additional_fields_schema( $schema ); |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * Get the query params for collections. |
| 140 | * |
| 141 | * @return array |
| 142 | */ |
| 143 | public function get_collection_params() { |
| 144 | $params = parent::get_collection_params(); |
| 145 | $params['orderby']['enum'] = $this->apply_custom_orderby_filters( |
| 146 | array( |
| 147 | 'date', |
| 148 | 'amount', |
| 149 | 'coupons_count', |
| 150 | 'orders_count', |
| 151 | ) |
| 152 | ); |
| 153 | $params['coupons'] = array( |
| 154 | 'description' => __( 'Limit result set to coupons assigned specific coupon IDs.', 'woocommerce' ), |
| 155 | 'type' => 'array', |
| 156 | 'sanitize_callback' => 'wp_parse_id_list', |
| 157 | 'validate_callback' => 'rest_validate_request_arg', |
| 158 | 'items' => array( |
| 159 | 'type' => 'integer', |
| 160 | ), |
| 161 | ); |
| 162 | $params['segmentby'] = array( |
| 163 | 'description' => __( 'Segment the response by additional constraint.', 'woocommerce' ), |
| 164 | 'type' => 'string', |
| 165 | 'enum' => array( |
| 166 | 'product', |
| 167 | 'variation', |
| 168 | 'category', |
| 169 | 'coupon', |
| 170 | ), |
| 171 | 'validate_callback' => 'rest_validate_request_arg', |
| 172 | ); |
| 173 | |
| 174 | return $params; |
| 175 | } |
| 176 | } |
| 177 |