ModifiersApi
extends ResourceApi
in package
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- MODIFIER_ENDPOINT = 'catalog/products/%d/modifiers/%d'
- MODIFIERS_ENDPOINT = 'catalog/products/%d/modifiers'
- RESOURCE_NAME = 'modifiers'
- __construct() : mixed
- create() : ModifierResponse
- delete() : ResponseInterface
- get() : ModifierResponse
- getAll() : ModifiersResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- image() : ProductModifierImagesApi
- multipleResourceUrl() : string
- singleResourceUrl() : string
- update() : ModifierResponse
- value() : ProductModifierValuesApi
- values() : ProductModifierValuesApi
Constants
MODIFIER_ENDPOINT
public
mixed
MODIFIER_ENDPOINT
= 'catalog/products/%d/modifiers/%d'
Tags
MODIFIERS_ENDPOINT
public
mixed
MODIFIERS_ENDPOINT
= 'catalog/products/%d/modifiers'
Tags
RESOURCE_NAME
public
mixed
RESOURCE_NAME
= 'modifiers'
Tags
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
Tags
Return values
mixed —create()
public
create(ProductModifier $modifier) : ModifierResponse
Parameters
- $modifier : ProductModifier
Tags
Return values
ModifierResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : ModifierResponse
Tags
Return values
ModifierResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ModifiersResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
ModifiersResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —image()
public
image(int $imageId) : ProductModifierImagesApi
Parameters
- $imageId : int
Tags
Return values
ProductModifierImagesApi —multipleResourceUrl()
public
abstract multipleResourceUrl() : string
Tags
Return values
string —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(ProductModifier $modifier) : ModifierResponse
Parameters
- $modifier : ProductModifier
Tags
Return values
ModifierResponse —value()
public
value(int $valueId) : ProductModifierValuesApi
Parameters
- $valueId : int
Tags
Return values
ProductModifierValuesApi —values()
public
values() : ProductModifierValuesApi