328 lines
10 KiB
PHP
328 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* REST API Reports products controller
|
|
*
|
|
* Handles requests to the /reports/products endpoint.
|
|
*
|
|
* @package WooCommerce Admin/API
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* REST API Reports products controller class.
|
|
*
|
|
* @package WooCommerce/API
|
|
* @extends WC_REST_Reports_Controller
|
|
*/
|
|
class WC_Admin_REST_Reports_Variations_Controller extends WC_REST_Reports_Controller {
|
|
|
|
/**
|
|
* Endpoint namespace.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $namespace = 'wc/v3';
|
|
|
|
/**
|
|
* Route base.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $rest_base = 'reports/variations';
|
|
|
|
/**
|
|
* Mapping between external parameter name and name used in query class.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $param_mapping = array(
|
|
'products' => 'product_includes',
|
|
);
|
|
|
|
/**
|
|
* Get items.
|
|
*
|
|
* @param WP_REST_Request $request Request data.
|
|
*
|
|
* @return array|WP_Error
|
|
*/
|
|
public function get_items( $request ) {
|
|
$args = array();
|
|
$registered = array_keys( $this->get_collection_params() );
|
|
foreach ( $registered as $param_name ) {
|
|
if ( isset( $request[ $param_name ] ) ) {
|
|
if ( isset( $this->param_mapping[ $param_name ] ) ) {
|
|
$args[ $this->param_mapping[ $param_name ] ] = $request[ $param_name ];
|
|
} else {
|
|
$args[ $param_name ] = $request[ $param_name ];
|
|
}
|
|
}
|
|
}
|
|
|
|
$reports = new WC_Admin_Reports_Variations_Query( $args );
|
|
$products_data = $reports->get_data();
|
|
|
|
$data = array();
|
|
|
|
foreach ( $products_data->data as $product_data ) {
|
|
$item = $this->prepare_item_for_response( $product_data, $request );
|
|
$data[] = $this->prepare_response_for_collection( $item );
|
|
}
|
|
|
|
$response = rest_ensure_response( $data );
|
|
$response->header( 'X-WP-Total', (int) $products_data->total );
|
|
$response->header( 'X-WP-TotalPages', (int) $products_data->pages );
|
|
|
|
$page = $products_data->page_no;
|
|
$max_pages = $products_data->pages;
|
|
$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );
|
|
if ( $page > 1 ) {
|
|
$prev_page = $page - 1;
|
|
if ( $prev_page > $max_pages ) {
|
|
$prev_page = $max_pages;
|
|
}
|
|
$prev_link = add_query_arg( 'page', $prev_page, $base );
|
|
$response->link_header( 'prev', $prev_link );
|
|
}
|
|
if ( $max_pages > $page ) {
|
|
$next_page = $page + 1;
|
|
$next_link = add_query_arg( 'page', $next_page, $base );
|
|
$response->link_header( 'next', $next_link );
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Prepare a report object for serialization.
|
|
*
|
|
* @param array $report Report data.
|
|
* @param WP_REST_Request $request Request object.
|
|
* @return WP_REST_Response
|
|
*/
|
|
public function prepare_item_for_response( $report, $request ) {
|
|
$data = $report;
|
|
|
|
$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( $this->prepare_links( $report ) );
|
|
|
|
/**
|
|
* 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_variations', $response, $report, $request );
|
|
}
|
|
|
|
/**
|
|
* Prepare links for the request.
|
|
*
|
|
* @param array $object Object data.
|
|
* @return array Links for the given post.
|
|
*/
|
|
protected function prepare_links( $object ) {
|
|
$links = array(
|
|
'product' => array(
|
|
'href' => rest_url( sprintf( '/%s/%s/%d', $this->namespace, 'products', $object['product_id'] ) ),
|
|
),
|
|
'variation' => array(
|
|
'href' => rest_url( sprintf( '/%s/%s/%d/%s/%d', $this->namespace, 'products', $object['product_id'], 'variation', $object['variation_id'] ) ),
|
|
),
|
|
);
|
|
|
|
return $links;
|
|
}
|
|
|
|
/**
|
|
* 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_varitations',
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'product_id' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product ID.', 'wc-admin' ),
|
|
),
|
|
'variation_id' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product ID.', 'wc-admin' ),
|
|
),
|
|
'items_sold' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Number of items sold.', 'wc-admin' ),
|
|
),
|
|
'net_revenue' => array(
|
|
'type' => 'number',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Total net revenue of all items sold.', 'wc-admin' ),
|
|
),
|
|
'orders_count' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Number of orders product appeared in.', 'wc-admin' ),
|
|
),
|
|
'extended_info' => array(
|
|
'name' => array(
|
|
'type' => 'string',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product name.', 'wc-admin' ),
|
|
),
|
|
'price' => array(
|
|
'type' => 'number',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product price.', 'wc-admin' ),
|
|
),
|
|
'image' => array(
|
|
'type' => 'string',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product image.', 'wc-admin' ),
|
|
),
|
|
'permalink' => array(
|
|
'type' => 'string',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product link.', 'wc-admin' ),
|
|
),
|
|
'attributes' => array(
|
|
'type' => 'array',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product attributes.', 'wc-admin' ),
|
|
),
|
|
'stock_status' => array(
|
|
'type' => 'string',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product inventory status.', 'wc-admin' ),
|
|
),
|
|
'stock_quantity' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product inventory quantity.', 'wc-admin' ),
|
|
),
|
|
'low_stock_amount' => array(
|
|
'type' => 'integer',
|
|
'readonly' => true,
|
|
'context' => array( 'view', 'edit' ),
|
|
'description' => __( 'Product inventory threshold for low stock.', 'wc-admin' ),
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
return $this->add_additional_fields_schema( $schema );
|
|
}
|
|
|
|
/**
|
|
* Get the query params for collections.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_collection_params() {
|
|
$params = array();
|
|
$params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
|
|
$params['page'] = array(
|
|
'description' => __( 'Current page of the collection.', 'wc-admin' ),
|
|
'type' => 'integer',
|
|
'default' => 1,
|
|
'sanitize_callback' => 'absint',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
'minimum' => 1,
|
|
);
|
|
$params['per_page'] = array(
|
|
'description' => __( 'Maximum number of items to be returned in result set.', 'wc-admin' ),
|
|
'type' => 'integer',
|
|
'default' => 10,
|
|
'minimum' => 1,
|
|
'maximum' => 100,
|
|
'sanitize_callback' => 'absint',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
$params['after'] = array(
|
|
'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'wc-admin' ),
|
|
'type' => 'string',
|
|
'format' => 'date-time',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
$params['before'] = array(
|
|
'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'wc-admin' ),
|
|
'type' => 'string',
|
|
'format' => 'date-time',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
$params['order'] = array(
|
|
'description' => __( 'Order sort attribute ascending or descending.', 'wc-admin' ),
|
|
'type' => 'string',
|
|
'default' => 'desc',
|
|
'enum' => array( 'asc', 'desc' ),
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
$params['orderby'] = array(
|
|
'description' => __( 'Sort collection by object attribute.', 'wc-admin' ),
|
|
'type' => 'string',
|
|
'default' => 'date',
|
|
'enum' => array(
|
|
'date',
|
|
'gross_revenue',
|
|
'orders_count',
|
|
'items_sold',
|
|
),
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
$params['products'] = array(
|
|
'description' => __( 'Limit result to items with specified product ids.', 'wc-admin' ),
|
|
'type' => 'array',
|
|
'sanitize_callback' => 'wp_parse_id_list',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
'items' => array(
|
|
'type' => 'integer',
|
|
),
|
|
);
|
|
$params['variations'] = array(
|
|
'description' => __( 'Limit result to items with specified variation ids.', 'wc-admin' ),
|
|
'type' => 'array',
|
|
'sanitize_callback' => 'wp_parse_id_list',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
'items' => array(
|
|
'type' => 'integer',
|
|
),
|
|
);
|
|
$params['extended_info'] = array(
|
|
'description' => __( 'Add additional piece of info about each product to the report.', 'wc-admin' ),
|
|
'type' => 'boolean',
|
|
'default' => false,
|
|
'sanitize_callback' => 'wc_string_to_bool',
|
|
'validate_callback' => 'rest_validate_request_arg',
|
|
);
|
|
|
|
return $params;
|
|
}
|
|
}
|