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

Added segmentby to schema, query arguments and allows parameters in the controller for taxes/stats.

This commit is contained in:
Peter Fabian 2019-01-30 12:16:37 +01:00
parent 6efef57cba
commit 0d95552157
1 changed files with 60 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
plugins/woocommerce-admin/includes/api/class-wc-admin-rest-reports-taxes-stats-controller.php
View File

@ -68,15 +68,16 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
* @return array * @return array
*/ */
protected function prepare_reports_query( $request ) { protected function prepare_reports_query( $request ) {
$args = array(); $args = array();
$args['before'] = $request['before']; $args['before'] = $request['before'];
$args['after'] = $request['after']; $args['after'] = $request['after'];
$args['interval'] = $request['interval']; $args['interval'] = $request['interval'];
$args['page'] = $request['page']; $args['page'] = $request['page'];
$args['per_page'] = $request['per_page']; $args['per_page'] = $request['per_page'];
$args['orderby'] = $request['orderby']; $args['orderby'] = $request['orderby'];
$args['order'] = $request['order']; $args['order'] = $request['order'];
$args['taxes'] = (array) $request['taxes']; $args['taxes'] = (array) $request['taxes'];
$args['segmentby'] = $request['segmentby'];
return $args; return $args;
} }
@ -161,7 +162,7 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
* @return array * @return array
*/ */
public function get_item_schema() { public function get_item_schema() {
$totals = array( $data_values = array(
'total_tax' => array( 'total_tax' => array(
'description' => __( 'Total tax.', 'wc-admin' ), 'description' => __( 'Total tax.', 'wc-admin' ),
'type' => 'number', 'type' => 'number',
@ -192,7 +193,7 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
'readonly' => true, 'readonly' => true,
), ),
'tax_codes' => array( 'tax_codes' => array(
'description' => __( 'Amount of tax codes.', 'wc-admin' ), 'description' => __( 'Amount of tax codes.', 'wc-admin' ),
'type' => 'integer', 'type' => 'integer',
'context' => array( 'view', 'edit' ), 'context' => array( 'view', 'edit' ),
@ -200,6 +201,36 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
), ),
); );
$segments = array(
'segments' => array(
'description' => __( 'Reports data grouped by segment condition.', 'wc-admin' ),
'type' => 'array',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'items' => array(
'type' => 'object',
'properties' => array(
'segment_id' => array(
'description' => __( 'Segment identificator.', 'wc-admin' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'enum' => array( 'day', 'week', 'month', 'year' ),
),
'subtotals' => array(
'description' => __( 'Interval subtotals.', 'wc-admin' ),
'type' => 'object',
'context' => array( 'view', 'edit' ),
'readonly' => true,
'properties' => $data_values,
),
),
),
),
);
$totals = array_merge( $data_values, $segments );
$schema = array( $schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#', '$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'report_taxes_stats', 'title' => 'report_taxes_stats',
@ -273,9 +304,9 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
* @return array * @return array
*/ */
public function get_collection_params() { public function get_collection_params() {
$params = array(); $params = array();
$params['context'] = $this->get_context_param( array( 'default' => 'view' ) ); $params['context'] = $this->get_context_param( array( 'default' => 'view' ) );
$params['page'] = array( $params['page'] = array(
'description' => __( 'Current page of the collection.', 'wc-admin' ), 'description' => __( 'Current page of the collection.', 'wc-admin' ),
'type' => 'integer', 'type' => 'integer',
'default' => 1, 'default' => 1,
@ -283,7 +314,7 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
'minimum' => 1, 'minimum' => 1,
); );
$params['per_page'] = array( $params['per_page'] = array(
'description' => __( 'Maximum number of items to be returned in result set.', 'wc-admin' ), 'description' => __( 'Maximum number of items to be returned in result set.', 'wc-admin' ),
'type' => 'integer', 'type' => 'integer',
'default' => 10, 'default' => 10,
@ -292,26 +323,26 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
'sanitize_callback' => 'absint', 'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['after'] = array( $params['after'] = array(
'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'wc-admin' ), 'description' => __( 'Limit response to resources published after a given ISO8601 compliant date.', 'wc-admin' ),
'type' => 'string', 'type' => 'string',
'format' => 'date-time', 'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['before'] = array( $params['before'] = array(
'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'wc-admin' ), 'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.', 'wc-admin' ),
'type' => 'string', 'type' => 'string',
'format' => 'date-time', 'format' => 'date-time',
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['order'] = array( $params['order'] = array(
'description' => __( 'Order sort attribute ascending or descending.', 'wc-admin' ), 'description' => __( 'Order sort attribute ascending or descending.', 'wc-admin' ),
'type' => 'string', 'type' => 'string',
'default' => 'desc', 'default' => 'desc',
'enum' => array( 'asc', 'desc' ), 'enum' => array( 'asc', 'desc' ),
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['orderby'] = array( $params['orderby'] = array(
'description' => __( 'Sort collection by object attribute.', 'wc-admin' ), 'description' => __( 'Sort collection by object attribute.', 'wc-admin' ),
'type' => 'string', 'type' => 'string',
'default' => 'date', 'default' => 'date',
@ -324,7 +355,7 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
), ),
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['interval'] = array( $params['interval'] = array(
'description' => __( 'Time interval to use for buckets in the returned data.', 'wc-admin' ), 'description' => __( 'Time interval to use for buckets in the returned data.', 'wc-admin' ),
'type' => 'string', 'type' => 'string',
'default' => 'week', 'default' => 'week',
@ -338,7 +369,7 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
), ),
'validate_callback' => 'rest_validate_request_arg', 'validate_callback' => 'rest_validate_request_arg',
); );
$params['taxes'] = array( $params['taxes'] = array(
'description' => __( 'Limit result set to all items that have the specified term assigned in the taxes taxonomy.', 'wc-admin' ), 'description' => __( 'Limit result set to all items that have the specified term assigned in the taxes taxonomy.', 'wc-admin' ),
'type' => 'array', 'type' => 'array',
'sanitize_callback' => 'wp_parse_id_list', 'sanitize_callback' => 'wp_parse_id_list',
@ -347,6 +378,14 @@ class WC_Admin_REST_Reports_Taxes_Stats_Controller extends WC_REST_Reports_Contr
'type' => 'integer', 'type' => 'integer',
), ),
); );
$params['segmentby'] = array(
'description' => __( 'Segment the response by additional constraint.', 'wc-admin' ),
'type' => 'string',
'enum' => array(
'tax_code',
),
'validate_callback' => 'rest_validate_request_arg',
);
return $params; return $params;
} }