PHP Класс WC_REST_Report_Sales_Controller

Наследование: extends WC_REST_Controller
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$namespace string Endpoint namespace.
$report WC_Admin_Report Report instance.
$rest_base string Route base.

Открытые методы

Метод Описание
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.

Защищенные методы

Метод Описание
setup_report ( array $filter ) Setup the report object and parse any date filtering.

Описание методов

get_collection_params() публичный Метод

Get the query params for collections.
public get_collection_params ( ) : array
Результат array

get_item_schema() публичный Метод

Get the Report's schema, conforming to JSON Schema.
public get_item_schema ( ) : array
Результат array

get_items() публичный Метод

Get sales reports.
public get_items ( WP_REST_Request $request ) : array | WP_Error
$request WP_REST_Request
Результат array | WP_Error

get_items_permissions_check() публичный Метод

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.
Результат WP_Error | boolean

prepare_item_for_response() публичный Метод

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.
Результат WP_REST_Response $response Response data.

register_routes() публичный Метод

Register the routes for sales reports.
public register_routes ( )

setup_report() защищенный Метод

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

Описание свойств

$namespace защищенное свойство

Endpoint namespace.
protected string $namespace
Результат string

$report защищенное свойство

Report instance.
protected WC_Admin_Report $report
Результат WC_Admin_Report

$rest_base защищенное свойство

Route base.
protected string $rest_base
Результат string