• Accueil
  • WC_REST_Report_Sales_Controller

PHP Class WC_REST_Report_Sales_Controller

Inheritance: extends WC_REST_Controller
Afficher le fichier Open project: woocommerce/woocommerce

Protected Properties

Свойство Type Description
$namespace string Endpoint namespace.
$report WC_Admin_Report Report instance.
$rest_base string Route base.

Méthodes publiques

Méthode 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.

Méthodes protégées

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

Method Details

get_collection_params() public méthode

Get the query params for collections.
public get_collection_params ( ) : array
Résultat array

get_item_schema() public méthode

Get the Report's schema, conforming to JSON Schema.
public get_item_schema ( ) : array
Résultat array

get_items() public méthode

Get sales reports.
public get_items ( WP_REST_Request $request ) : array | WP_Error
$request WP_REST_Request
Résultat array | WP_Error

get_items_permissions_check() public méthode

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.
Résultat WP_Error | boolean

prepare_item_for_response() public méthode

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.
Résultat WP_REST_Response $response Response data.

register_routes() public méthode

Register the routes for sales reports.
public register_routes ( )

setup_report() protected méthode

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

Property Details

$namespace protected_oe property

Endpoint namespace.
protected string $namespace
Résultat string

$report protected_oe property

Report instance.
protected WC_Admin_Report $report
Résultat WC_Admin_Report

$rest_base protected_oe property

Route base.
protected string $rest_base
Résultat string