PHP 클래스 WC_REST_Report_Sales_Controller

상속: extends WC_REST_Controller
파일 보기 프로젝트 열기: woocommerce/woocommerce

보호된 프로퍼티들

프로퍼티 타입 설명
$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