PHP 클래스 WC_API_Reports

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

보호된 프로퍼티들

프로퍼티 타입 설명
$base string the route base

공개 메소드들

메소드 설명
get_reports ( ) : array Get a simple listing of available reports
get_sales_report ( string $fields = null, array $filter = [] ) : array Get the sales report
get_top_sellers_report ( string $fields = null, array $filter = [] ) : array Get the top sellers report
register_routes ( array $routes ) : array Register the routes for this class

보호된 메소드들

메소드 설명
validate_request ( null $id = null, null $type = null, null $context = null ) : boolean Verify that the current user has permission to view reports

비공개 메소드들

메소드 설명
setup_report ( array $filter ) Setup the report object and parse any date filtering

메소드 상세

get_reports() 공개 메소드

Get a simple listing of available reports
부터: 2.1
public get_reports ( ) : array
리턴 array

get_sales_report() 공개 메소드

Get the sales report
부터: 2.1
public get_sales_report ( string $fields = null, array $filter = [] ) : array
$fields string fields to include in response
$filter array date filtering
리턴 array

get_top_sellers_report() 공개 메소드

Get the top sellers report
부터: 2.1
public get_top_sellers_report ( string $fields = null, array $filter = [] ) : array
$fields string fields to include in response
$filter array date filtering
리턴 array

register_routes() 공개 메소드

GET /reports GET /reports/sales
부터: 2.1
public register_routes ( array $routes ) : array
$routes array
리턴 array

validate_request() 보호된 메소드

Verify that the current user has permission to view reports
또한 보기: WC_API_Resource::validate_request()
부터: 2.1
protected validate_request ( null $id = null, null $type = null, null $context = null ) : boolean
$id null unused
$type null unused
$context null unused
리턴 boolean true if the request is valid and should be processed, false otherwise

프로퍼티 상세

$base 보호되어 있는 프로퍼티

the route base
protected string $base
리턴 string