Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Initial /reports/reviews/totals endpoint

This commit is contained in:
Claudio Sanches 2018-09-08 21:19:57 -03:00
parent 2fcabfe7e6
commit d2b0ff0f32
2 changed files with 115 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
includes/api/class-wc-rest-report-reviews-totals-controller.php Normal file
View File

@ -0,0 +1,114 @@
<?php
/**
* REST API Reports Reviews Totals controller
*
* Handles requests to the /reports/reviews/count endpoint.
*
* @package WooCommerce/API
* @since 3.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* REST API Reports Reviews Totals controller class.
*
* @package WooCommerce/API
* @extends WC_REST_Reports_Controller
*/
class WC_REST_Report_Reviews_Totals_Controller extends WC_REST_Reports_Controller {
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v3';
/**
* Route base.
*
* @var string
*/
protected $rest_base = 'reports/reviews/totals';
/**
* Get reports list.
*
* @since 3.5.0
* @return array
*/
protected function get_reports() {
$data = array();
return $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,
'name' => $report->name,
'total' => $report->total,
);
$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 );
/**
* 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_reviews_count', $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_review_total',
'type' => 'object',
'properties' => array(
'slug' => array(
'description' => __( 'An alphanumeric identifier for the resource.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Review type name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
'total' => array(
'description' => __( 'Amount of reviews.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view' ),
'readonly' => true,
),
),
);
return $this->add_additional_fields_schema( $schema );
}
}

1
includes/class-wc-api.php
View File

@ -222,6 +222,7 @@ class WC_API extends WC_Legacy_API {
include_once dirname( __FILE__ ) . '/api/class-wc-rest-report-products-totals-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-report-customers-totals-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-report-coupons-totals-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-report-reviews-totals-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-settings-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-setting-options-controller.php';
include_once dirname( __FILE__ ) . '/api/class-wc-rest-shipping-zones-controller.php';