PHP Class WC_REST_Report_Sales_Controller

Inheritance: extends WC_REST_Controller

Protected Properties

Method	Description
get_collection_params ( ) : array	Get the query params for collections.
get_item_schema ( ) : array	Get the Report's schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : array \| WP_Error	Get sales reports.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean	Check whether a given request has permission to read report.
prepare_item_for_response ( null $_, WP_REST_Request $request ) : WP_REST_Response	Prepare a report sales object for serialization.
register_routes ( )	Register the routes for sales reports.

Method	Description
setup_report ( array $filter )	Setup the report object and parse any date filtering.

Get the query params for collections.

public get_collection_params ( ) : array
return	array

Get the Report's schema, conforming to JSON Schema.

public get_item_schema ( ) : array
return	array

Get sales reports.

public get_items ( WP_REST_Request $request ) : array \| WP_Error
$request	WP_REST_Request
return	array \| WP_Error

Check whether a given request has permission to read report.

public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error \| boolean
$request	WP_REST_Request	Full details about the request.
return	WP_Error \| boolean

Prepare a report sales object for serialization.

public prepare_item_for_response ( null $_, WP_REST_Request $request ) : WP_REST_Response
$_	null
$request	WP_REST_Request	Request object.
return	WP_REST_Response	$response Response data.

public register_routes ( )

Setup the report object and parse any date filtering.

protected setup_report ( array $filter )
$filter	array	date filtering

Endpoint namespace.

protected string $namespace
return	string

Report instance.

protected WC_Admin_Report $report
return	WC_Admin_Report

Route base.

protected string $rest_base
return	string