From ed3daf867615b12328e0c4b085dbdd7329e35ec6 Mon Sep 17 00:00:00 2001 From: Mike Jolley Date: Thu, 30 May 2019 14:12:47 +0100 Subject: [PATCH] Reports --- src/RestApi/Version4/Controllers/Reports.php | 318 ++++++++++++++++++ src/RestApi/Version4/changelog.md | 1 + .../class-wc-rest-reports-v1-controller.php | 184 ---------- 3 files changed, 319 insertions(+), 184 deletions(-) create mode 100644 src/RestApi/Version4/Controllers/Reports.php delete mode 100644 src/RestApi/Version4/class-wc-rest-reports-v1-controller.php diff --git a/src/RestApi/Version4/Controllers/Reports.php b/src/RestApi/Version4/Controllers/Reports.php new file mode 100644 index 00000000000..6105a7625e6 --- /dev/null +++ b/src/RestApi/Version4/Controllers/Reports.php @@ -0,0 +1,318 @@ +namespace, + '/' . $this->rest_base, + array( + array( + 'methods' => WP_REST_Server::READABLE, + 'callback' => array( $this, 'get_items' ), + 'permission_callback' => array( $this, 'get_items_permissions_check' ), + 'args' => $this->get_collection_params(), + ), + 'schema' => array( $this, 'get_public_item_schema' ), + ) + ); + } + + /** + * Check whether a given request has permission to read reports. + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|boolean + */ + public function get_items_permissions_check( $request ) { + if ( ! wc_rest_check_manager_permissions( 'reports', 'read' ) ) { + return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce-admin' ), array( 'status' => rest_authorization_required_code() ) ); + } + + return true; + } + + + /** + * Get all reports. + * + * @param WP_REST_Request $request Request data. + * @return array|WP_Error + */ + public function get_items( $request ) { + $data = array(); + $reports = array( + array( + 'slug' => 'performance-indicators', + 'description' => __( 'Batch endpoint for getting specific performance indicators from `stats` endpoints.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'revenue/stats', + 'description' => __( 'Stats about revenue.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'orders/stats', + 'description' => __( 'Stats about orders.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'products', + 'description' => __( 'Products detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'products/stats', + 'description' => __( 'Stats about products.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'categories', + 'description' => __( 'Product categories detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'categories/stats', + 'description' => __( 'Stats about product categories.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'coupons', + 'description' => __( 'Coupons detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'coupons/stats', + 'description' => __( 'Stats about coupons.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'taxes', + 'description' => __( 'Taxes detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'taxes/stats', + 'description' => __( 'Stats about taxes.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'downloads', + 'description' => __( 'Product downloads detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'downloads/files', + 'description' => __( 'Product download files detailed reports.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'downloads/stats', + 'description' => __( 'Stats about product downloads.', 'woocommerce-admin' ), + ), + array( + 'slug' => 'customers', + 'description' => __( 'Customers detailed reports.', 'woocommerce-admin' ), + ), + ); + + /** + * Filter the list of allowed reports, so that data can be loaded from third party extensions in addition to WooCommerce core. + * Array items should be in format of array( 'slug' => 'downloads/stats', 'description' => '', + * 'url' => '', and 'path' => '/wc-ext/v1/...'. + * + * @param array $endpoints The list of allowed reports.. + */ + $reports = apply_filters( 'woocommerce_admin_reports', $reports ); + + foreach ( $reports as $report ) { + if ( empty( $report['slug'] ) ) { + continue; + } + + if ( empty( $report['path'] ) ) { + $report['path'] = '/' . $this->namespace . '/reports/' . $report['slug']; + } + + // Allows a different admin page to be loaded here, + // or allows an empty url if no report exists for a set of performance indicators. + if ( ! isset( $report['url'] ) ) { + if ( '/stats' === substr( $report['slug'], -6 ) ) { + $url_slug = substr( $report['slug'], 0, -6 ); + } else { + $url_slug = $report['slug']; + } + + $report['url'] = '/analytics/' . $url_slug; + } + + $item = $this->prepare_item_for_response( (object) $report, $request ); + $data[] = $this->prepare_response_for_collection( $item ); + } + + return rest_ensure_response( $data ); + } + + /** + * Get the order number for an order. If no filter is present for `woocommerce_order_number`, we can just return the ID. + * Returns the parent order number if the order is actually a refund. + * + * @param int $order_id Order ID. + * @return string + */ + public function get_order_number( $order_id ) { + $order = wc_get_order( $order_id ); + + if ( 'shop_order_refund' === $order->get_type() ) { + $order = wc_get_order( $order->get_parent_id() ); + } + + if ( ! has_filter( 'woocommerce_order_number' ) ) { + return $order->get_id(); + } + + return $order->get_order_number(); + } + + /** + * Prepare a report object for serialization. + * + * @param stdClass $report Report data. + * @param WP_REST_Request $request Request object. + * @return WP_REST_Response + */ + public function prepare_item_for_response( $report, $request ) { + $data = array( + 'slug' => $report->slug, + 'description' => $report->description, + 'path' => $report->path, + ); + + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; + $data = $this->add_additional_fields_to_object( $data, $request ); + $data = $this->filter_response_by_context( $data, $context ); + + // Wrap the data in a response object. + $response = rest_ensure_response( $data ); + $response->add_links( + array( + 'self' => array( + 'href' => rest_url( $report->path ), + ), + 'report' => array( + 'href' => $report->url, + ), + 'collection' => array( + 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), + ), + ) + ); + + /** + * Filter a report returned from the API. + * + * Allows modification of the report data right before it is returned. + * + * @param WP_REST_Response $response The response object. + * @param object $report The original report object. + * @param WP_REST_Request $request Request used to generate the response. + */ + return apply_filters( 'woocommerce_rest_prepare_report', $response, $report, $request ); + } + + /** + * Get the Report's schema, conforming to JSON Schema. + * + * @return array + */ + public function get_item_schema() { + $schema = array( + '$schema' => 'http://json-schema.org/draft-04/schema#', + 'title' => 'report', + 'type' => 'object', + 'properties' => array( + 'slug' => array( + 'description' => __( 'An alphanumeric identifier for the resource.', 'woocommerce-admin' ), + 'type' => 'string', + 'context' => array( 'view' ), + 'readonly' => true, + ), + 'description' => array( + 'description' => __( 'A human-readable description of the resource.', 'woocommerce-admin' ), + 'type' => 'string', + 'context' => array( 'view' ), + 'readonly' => true, + ), + 'path' => array( + 'description' => __( 'API path.', 'woocommerce-admin' ), + 'type' => 'string', + 'context' => array( 'view' ), + 'readonly' => true, + ), + ), + ); + + return $this->add_additional_fields_schema( $schema ); + } + + /** + * Get the query params for collections. + * + * @return array + */ + public function get_collection_params() { + return array( + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), + ); + } + + /** + * Get order statuses without prefixes. + * + * @return array + */ + public function get_order_statuses() { + $order_statuses = array(); + + foreach ( array_keys( wc_get_order_statuses() ) as $status ) { + $order_statuses[] = str_replace( 'wc-', '', $status ); + } + + return $order_statuses; + } + + /** + * Check whether a given request has permission to read reports. + * + * @param WP_REST_Request $request Full details about the request. + * @return WP_Error|boolean + */ + public function get_items_permissions_check( $request ) { + if ( ! wc_rest_check_manager_permissions( 'reports', 'read' ) ) { + return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) ); + } + + return true; + } +} diff --git a/src/RestApi/Version4/changelog.md b/src/RestApi/Version4/changelog.md index afd213f053e..f3cebffafc4 100644 --- a/src/RestApi/Version4/changelog.md +++ b/src/RestApi/Version4/changelog.md @@ -7,6 +7,7 @@ - Orders - Added order number to schema. - Product Reviews - Updated response links. - Products - Added `low_in_stock` and `search` parameter. +- Reports - Updated with updated list of available reports. ## New endpoints diff --git a/src/RestApi/Version4/class-wc-rest-reports-v1-controller.php b/src/RestApi/Version4/class-wc-rest-reports-v1-controller.php deleted file mode 100644 index 4b40f00875f..00000000000 --- a/src/RestApi/Version4/class-wc-rest-reports-v1-controller.php +++ /dev/null @@ -1,184 +0,0 @@ -namespace, '/' . $this->rest_base, array( - array( - 'methods' => WP_REST_Server::READABLE, - 'callback' => array( $this, 'get_items' ), - 'permission_callback' => array( $this, 'get_items_permissions_check' ), - 'args' => $this->get_collection_params(), - ), - 'schema' => array( $this, 'get_public_item_schema' ), - ) ); - } - - /** - * Check whether a given request has permission to read reports. - * - * @param WP_REST_Request $request Full details about the request. - * @return WP_Error|boolean - */ - public function get_items_permissions_check( $request ) { - if ( ! wc_rest_check_manager_permissions( 'reports', 'read' ) ) { - return new WP_Error( 'woocommerce_rest_cannot_view', __( 'Sorry, you cannot list resources.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) ); - } - - return true; - } - - /** - * Get reports list. - * - * @since 3.5.0 - * @return array - */ - protected function get_reports() { - return array( - array( - 'slug' => 'sales', - 'description' => __( 'List of sales reports.', 'woocommerce' ), - ), - array( - 'slug' => 'top_sellers', - 'description' => __( 'List of top sellers products.', 'woocommerce' ), - ), - ); - } - - /** - * Get all reports. - * - * @param WP_REST_Request $request - * @return array|WP_Error - */ - public function get_items( $request ) { - $data = array(); - $reports = $this->get_reports(); - - foreach ( $reports as $report ) { - $item = $this->prepare_item_for_response( (object) $report, $request ); - $data[] = $this->prepare_response_for_collection( $item ); - } - - return rest_ensure_response( $data ); - } - - /** - * Prepare a report object for serialization. - * - * @param stdClass $report Report data. - * @param WP_REST_Request $request Request object. - * @return WP_REST_Response $response Response data. - */ - public function prepare_item_for_response( $report, $request ) { - $data = array( - 'slug' => $report->slug, - 'description' => $report->description, - ); - - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; - $data = $this->add_additional_fields_to_object( $data, $request ); - $data = $this->filter_response_by_context( $data, $context ); - - // Wrap the data in a response object. - $response = rest_ensure_response( $data ); - $response->add_links( array( - 'self' => array( - 'href' => rest_url( sprintf( '/%s/%s/%s', $this->namespace, $this->rest_base, $report->slug ) ), - ), - 'collection' => array( - 'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ), - ), - ) ); - - /** - * Filter a report returned from the API. - * - * Allows modification of the report data right before it is returned. - * - * @param WP_REST_Response $response The response object. - * @param object $report The original report object. - * @param WP_REST_Request $request Request used to generate the response. - */ - return apply_filters( 'woocommerce_rest_prepare_report', $response, $report, $request ); - } - - /** - * Get the Report's schema, conforming to JSON Schema. - * - * @return array - */ - public function get_item_schema() { - $schema = array( - '$schema' => 'http://json-schema.org/draft-04/schema#', - 'title' => 'report', - 'type' => 'object', - 'properties' => array( - 'slug' => array( - 'description' => __( 'An alphanumeric identifier for the resource.', 'woocommerce' ), - 'type' => 'string', - 'context' => array( 'view' ), - 'readonly' => true, - ), - 'description' => array( - 'description' => __( 'A human-readable description of the resource.', 'woocommerce' ), - 'type' => 'string', - 'context' => array( 'view' ), - 'readonly' => true, - ), - ), - ); - - return $this->add_additional_fields_schema( $schema ); - } - - /** - * Get the query params for collections. - * - * @return array - */ - public function get_collection_params() { - return array( - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), - ); - } -}