Add endpoint to initiate report CSV export generation.
This commit is contained in:
Jeff Stieler
parent
b6190e7fb0
commit
73e0c455d7
|
|
@ -0,0 +1,147 @@
|
|||
<?php
|
||||
/**
|
||||
* REST API Reports Export Controller
|
||||
*
|
||||
* Handles requests to:
|
||||
* - /reports/[report]/export
|
||||
* - /reports/[report]/export/[id]/status
|
||||
*
|
||||
* @package WooCommerce Admin/API
|
||||
*/
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Reports Export controller.
|
||||
*
|
||||
* @package WooCommerce Admin/API
|
||||
* @extends WC_REST_Data_Controller
|
||||
*/
|
||||
class WC_Admin_REST_Reports_Export_Controller extends WC_Admin_REST_Reports_Controller {
|
||||
/**
|
||||
* Endpoint namespace.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $namespace = 'wc/v4';
|
||||
|
||||
/**
|
||||
* Route base.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $rest_base = 'reports/(?P<type>[a-z]+)/export';
|
||||
|
||||
/**
|
||||
* Register routes.
|
||||
*/
|
||||
public function register_routes() {
|
||||
register_rest_route(
|
||||
$this->namespace,
|
||||
'/' . $this->rest_base,
|
||||
array(
|
||||
array(
|
||||
'methods' => WP_REST_Server::EDITABLE,
|
||||
'callback' => array( $this, 'export_items' ),
|
||||
'permission_callback' => array( $this, 'export_permissions_check' ),
|
||||
'args' => $this->get_export_collection_params(),
|
||||
),
|
||||
'schema' => array( $this, 'get_export_public_schema' ),
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes sure the current user has access to WRITE the settings APIs.
|
||||
*
|
||||
* @param WP_REST_Request $request Full data about the request.
|
||||
* @return WP_Error|bool
|
||||
*/
|
||||
public function export_permissions_check( $request ) {
|
||||
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
|
||||
// @todo: better message?
|
||||
return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'woocommerce-admin' ), array( 'status' => rest_authorization_required_code() ) );
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the query params for collections.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_export_collection_params() {
|
||||
$params = array();
|
||||
$params['report_args'] = array(
|
||||
'description' => __( 'Parameters to pass on to the exported report.', 'woocommerce-admin' ),
|
||||
'type' => 'object',
|
||||
'validate_callback' => 'rest_validate_request_arg', // @todo: use each controller's schema?
|
||||
);
|
||||
return $params;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Report's schema, conforming to JSON Schema.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function get_export_public_schema() {
|
||||
$schema = array(
|
||||
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
||||
'title' => 'report_export',
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'status' => array(
|
||||
'description' => __( 'Regeneration status.', 'woocommerce-admin' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'message' => array(
|
||||
'description' => __( 'Regenerate data message.', 'woocommerce-admin' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
return $this->add_additional_fields_schema( $schema );
|
||||
}
|
||||
|
||||
/**
|
||||
* Export data based on user request params.
|
||||
*
|
||||
* @param WP_REST_Request $request Request data.
|
||||
* @return WP_Error|WP_REST_Response
|
||||
*/
|
||||
public function export_items( $request ) {
|
||||
$report_type = $request['type'];
|
||||
$report_args = empty( $request['report_args'] ) ? array() : $request['report_args'];
|
||||
$user_id = get_current_user_id();
|
||||
$export_id = str_replace( '.', '', microtime( true ) );
|
||||
|
||||
WC_Admin_Report_Exporter::queue_report_export( $user_id, $export_id, $report_type, $report_args );
|
||||
|
||||
// @todo: handle error case?
|
||||
$result = array(
|
||||
'status' => 'success',
|
||||
'message' => __( 'Your report file is being generated.', 'woocommerce-admin' ),
|
||||
);
|
||||
|
||||
// Wrap the data in a response object.
|
||||
$response = rest_ensure_response( $result );
|
||||
// Include a link to the export status endpoint.
|
||||
$response->add_links(
|
||||
array(
|
||||
'status' => array(
|
||||
'href' => rest_url( sprintf( '%s/reports/%s/export/%s/status', $this->namespace, $report_type, $export_id ) ),
|
||||
),
|
||||
)
|
||||
);
|
||||
|
||||
$data = $this->prepare_response_for_collection( $response );
|
||||
|
||||
return rest_ensure_response( $data );
|
||||
}
|
||||
}
|
||||
|
|
@ -132,6 +132,7 @@ class WC_Admin_Api_Init {
|
|||
require_once WC_ADMIN_ABSPATH . 'includes/api/class-wc-admin-rest-reports-stock-stats-controller.php';
|
||||
require_once WC_ADMIN_ABSPATH . 'includes/api/class-wc-admin-rest-taxes-controller.php';
|
||||
require_once WC_ADMIN_ABSPATH . 'includes/api/class-wc-admin-rest-customers-controller.php';
|
||||
require_once WC_ADMIN_ABSPATH . 'includes/api/class-wc-admin-rest-reports-export-controller.php';
|
||||
|
||||
$controllers = array(
|
||||
'WC_Admin_REST_Admin_Notes_Controller',
|
||||
|
|
@ -151,6 +152,7 @@ class WC_Admin_Api_Init {
|
|||
'WC_Admin_REST_Reports_Controller',
|
||||
'WC_Admin_REST_Setting_Options_Controller',
|
||||
'WC_Admin_REST_Reports_Import_Controller',
|
||||
'WC_Admin_REST_Reports_Export_Controller',
|
||||
'WC_Admin_REST_Reports_Products_Controller',
|
||||
'WC_Admin_REST_Reports_Variations_Controller',
|
||||
'WC_Admin_REST_Reports_Products_Stats_Controller',
|
||||
|
|
|
|||
|
|
@ -78,6 +78,7 @@ class WC_Admin_Report_Exporter {
|
|||
$num_batches = (int) ceil( $total_rows / $batch_size );
|
||||
$start_time = time() + 5;
|
||||
|
||||
// @todo - batch these batches, like initial import.
|
||||
for ( $batch = 1; $batch <= $num_batches; $batch++ ) {
|
||||
$report_batch_args = array_merge(
|
||||
$report_args,
|
||||
|
|
|
|||
Loading…
Reference in New Issue