ProductReviewsApi extends ResourceApi
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Table of Contents
- RESOURCE_NAME = 'reviews'
- REVIEW_ENDPOINT = 'catalog/products/%s/reviews/%s'
- REVIEWS_ENDPOINT = 'catalog/products/%s/reviews'
- __construct() : mixed
- get() : ProductReviewResponse
- getAll() : ProductReviewsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
Constants
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'reviews'
REVIEW_ENDPOINT
public
mixed
REVIEW_ENDPOINT
= 'catalog/products/%s/reviews/%s'
REVIEWS_ENDPOINT
public
mixed
REVIEWS_ENDPOINT
= 'catalog/products/%s/reviews'
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Return values
mixed —get()
public
get() : ProductReviewResponse
Return values
ProductReviewResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ProductReviewsResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Return values
ProductReviewsResponse —getClient()
public
getClient() : Client
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Return values
int|null —getResourceId()
public
getResourceId() : int|null