woocommerce
/
includes
/
rest-api
/
Controllers
/
Version3
/
class-wc-rest-report-reviews-totals-controller.php
class-wc-rest-controller.php
3 years ago
class-wc-rest-coupons-controller.php
4 years ago
class-wc-rest-crud-controller.php
4 years ago
class-wc-rest-customer-downloads-controller.php
5 years ago
class-wc-rest-customers-controller.php
3 years ago
class-wc-rest-data-continents-controller.php
4 years ago
class-wc-rest-data-controller.php
5 years ago
class-wc-rest-data-countries-controller.php
4 years ago
class-wc-rest-data-currencies-controller.php
5 years ago
class-wc-rest-network-orders-controller.php
5 years ago
class-wc-rest-order-notes-controller.php
5 years ago
class-wc-rest-order-refunds-controller.php
4 years ago
class-wc-rest-orders-controller.php
3 years ago
class-wc-rest-payment-gateways-controller.php
5 years ago
class-wc-rest-posts-controller.php
5 years ago
class-wc-rest-product-attribute-terms-controller.php
5 years ago
class-wc-rest-product-attributes-controller.php
5 years ago
class-wc-rest-product-categories-controller.php
5 years ago
class-wc-rest-product-reviews-controller.php
4 years ago
class-wc-rest-product-shipping-classes-controller.php
5 years ago
class-wc-rest-product-tags-controller.php
5 years ago
class-wc-rest-product-variations-controller.php
3 years ago
class-wc-rest-products-controller.php
3 years ago
class-wc-rest-report-coupons-totals-controller.php
5 years ago
class-wc-rest-report-customers-totals-controller.php
5 years ago
class-wc-rest-report-orders-totals-controller.php
5 years ago
class-wc-rest-report-products-totals-controller.php
5 years ago
class-wc-rest-report-reviews-totals-controller.php
5 years ago
class-wc-rest-report-sales-controller.php
5 years ago
class-wc-rest-report-top-sellers-controller.php
5 years ago
class-wc-rest-reports-controller.php
5 years ago
class-wc-rest-setting-options-controller.php
3 years ago
class-wc-rest-settings-controller.php
5 years ago
class-wc-rest-shipping-methods-controller.php
5 years ago
class-wc-rest-shipping-zone-locations-controller.php
5 years ago
class-wc-rest-shipping-zone-methods-controller.php
5 years ago
class-wc-rest-shipping-zones-controller-base.php
5 years ago
class-wc-rest-shipping-zones-controller.php
5 years ago
class-wc-rest-system-status-controller.php
5 years ago
class-wc-rest-system-status-tools-controller.php
5 years ago
class-wc-rest-tax-classes-controller.php
5 years ago
class-wc-rest-taxes-controller.php
5 years ago
class-wc-rest-terms-controller.php
3 years ago
class-wc-rest-webhooks-controller.php
5 years ago
class-wc-rest-report-reviews-totals-controller.php
133 lines
| 1 | <?php |
| 2 | /** |
| 3 | * REST API Reports Reviews Totals controller |
| 4 | * |
| 5 | * Handles requests to the /reports/reviews/count endpoint. |
| 6 | * |
| 7 | * @package WooCommerce\RestApi |
| 8 | * @since 3.5.0 |
| 9 | */ |
| 10 | |
| 11 | defined( 'ABSPATH' ) || exit; |
| 12 | |
| 13 | /** |
| 14 | * REST API Reports Reviews Totals controller class. |
| 15 | * |
| 16 | * @package WooCommerce\RestApi |
| 17 | * @extends WC_REST_Reports_Controller |
| 18 | */ |
| 19 | class WC_REST_Report_Reviews_Totals_Controller extends WC_REST_Reports_Controller { |
| 20 | |
| 21 | /** |
| 22 | * Endpoint namespace. |
| 23 | * |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $namespace = 'wc/v3'; |
| 27 | |
| 28 | /** |
| 29 | * Route base. |
| 30 | * |
| 31 | * @var string |
| 32 | */ |
| 33 | protected $rest_base = 'reports/reviews/totals'; |
| 34 | |
| 35 | /** |
| 36 | * Get reports list. |
| 37 | * |
| 38 | * @since 3.5.0 |
| 39 | * @return array |
| 40 | */ |
| 41 | protected function get_reports() { |
| 42 | $data = array(); |
| 43 | |
| 44 | $query_data = array( |
| 45 | 'count' => true, |
| 46 | 'post_type' => 'product', |
| 47 | 'meta_key' => 'rating', // WPCS: slow query ok. |
| 48 | 'meta_value' => '', // WPCS: slow query ok. |
| 49 | ); |
| 50 | |
| 51 | for ( $i = 1; $i <= 5; $i++ ) { |
| 52 | $query_data['meta_value'] = $i; |
| 53 | |
| 54 | $data[] = array( |
| 55 | 'slug' => 'rated_' . $i . '_out_of_5', |
| 56 | /* translators: %s: average rating */ |
| 57 | 'name' => sprintf( __( 'Rated %s out of 5', 'woocommerce' ), $i ), |
| 58 | 'total' => (int) get_comments( $query_data ), |
| 59 | ); |
| 60 | } |
| 61 | |
| 62 | return $data; |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * Prepare a report object for serialization. |
| 67 | * |
| 68 | * @param stdClass $report Report data. |
| 69 | * @param WP_REST_Request $request Request object. |
| 70 | * @return WP_REST_Response $response Response data. |
| 71 | */ |
| 72 | public function prepare_item_for_response( $report, $request ) { |
| 73 | $data = array( |
| 74 | 'slug' => $report->slug, |
| 75 | 'name' => $report->name, |
| 76 | 'total' => $report->total, |
| 77 | ); |
| 78 | |
| 79 | $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
| 80 | $data = $this->add_additional_fields_to_object( $data, $request ); |
| 81 | $data = $this->filter_response_by_context( $data, $context ); |
| 82 | |
| 83 | // Wrap the data in a response object. |
| 84 | $response = rest_ensure_response( $data ); |
| 85 | |
| 86 | /** |
| 87 | * Filter a report returned from the API. |
| 88 | * |
| 89 | * Allows modification of the report data right before it is returned. |
| 90 | * |
| 91 | * @param WP_REST_Response $response The response object. |
| 92 | * @param object $report The original report object. |
| 93 | * @param WP_REST_Request $request Request used to generate the response. |
| 94 | */ |
| 95 | return apply_filters( 'woocommerce_rest_prepare_report_reviews_count', $response, $report, $request ); |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Get the Report's schema, conforming to JSON Schema. |
| 100 | * |
| 101 | * @return array |
| 102 | */ |
| 103 | public function get_item_schema() { |
| 104 | $schema = array( |
| 105 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 106 | 'title' => 'report_review_total', |
| 107 | 'type' => 'object', |
| 108 | 'properties' => array( |
| 109 | 'slug' => array( |
| 110 | 'description' => __( 'An alphanumeric identifier for the resource.', 'woocommerce' ), |
| 111 | 'type' => 'string', |
| 112 | 'context' => array( 'view' ), |
| 113 | 'readonly' => true, |
| 114 | ), |
| 115 | 'name' => array( |
| 116 | 'description' => __( 'Review type name.', 'woocommerce' ), |
| 117 | 'type' => 'string', |
| 118 | 'context' => array( 'view' ), |
| 119 | 'readonly' => true, |
| 120 | ), |
| 121 | 'total' => array( |
| 122 | 'description' => __( 'Amount of reviews.', 'woocommerce' ), |
| 123 | 'type' => 'string', |
| 124 | 'context' => array( 'view' ), |
| 125 | 'readonly' => true, |
| 126 | ), |
| 127 | ), |
| 128 | ); |
| 129 | |
| 130 | return $this->add_additional_fields_schema( $schema ); |
| 131 | } |
| 132 | } |
| 133 |