QuickEditServiceInterface
in
Interface QuickEditServiceInterface
Tags
Table of Contents
- getFilteredProductProperties() : array<string|int, mixed>
- Returns filtered product properties based on the provided filter criteria.
- getFilteredProductPropertiesCount() : int
- Returns products that are subject to the specified filter criteria.
- getFilteredSpecialPrices() : array<string|int, mixed>
- Returns the special prices of the indicated products.
- getFilteredSpecialPricesCount() : int
- Returns the record number of the filtered special prices.
- getGraduatedPrices() : array<string|int, mixed>
- Returns the graduated prices of a product or an empty array nothing was found.
- getProductPropertiesCount() : int
- Returns the number of all product properties found.
- getSpecialPricesCount() : int
- Get special prices record count.
- paginateProperties() : QuickEditProductPropertiesRepository
- Sets the starting point of the pagination and the number of properties.
- paginateSpecialPrices() : QuickEditProductSpecialPricesRepository
- Sets the starting point of the pagination and the number of special prices.
- setByCombisId() : bool
- Saves product by product-combi ID.
- setSpecialPriceById() : bool
- Saves the changed data regarding the special price.
- sortProperties() : QuickEditProductPropertiesRepository
- Sets the sorting order of the product properties.
- sortSpecialPrices() : QuickEditProductSpecialPricesRepository
- Sets the sorting order of the special prices.
Methods
getFilteredProductProperties()
Returns filtered product properties based on the provided filter criteria.
public
getFilteredProductProperties(array<string|int, mixed> $productIds, array<string|int, mixed> $filterParameters) : array<string|int, mixed>
Parameters
- $productIds : array<string|int, mixed>
-
Array containing the selected product IDs to be processed.
- $filterParameters : array<string|int, mixed>
-
Contains the filter parameters.
Return values
array<string|int, mixed> —Returns the query result as a pure array, or an empty array when no result is produced.
getFilteredProductPropertiesCount()
Returns products that are subject to the specified filter criteria.
public
getFilteredProductPropertiesCount(array<string|int, mixed> $productIds, array<string|int, mixed> $filterParameters) : int
Parameters
- $productIds : array<string|int, mixed>
-
Array containing the selected product IDs to be processed.
- $filterParameters : array<string|int, mixed>
-
Contains the filter parameters.
Return values
int —Returns the number of product properties found.
getFilteredSpecialPrices()
Returns the special prices of the indicated products.
public
getFilteredSpecialPrices(array<string|int, mixed> $productIds, array<string|int, mixed> $filterParameters) : array<string|int, mixed>
Parameters
- $productIds : array<string|int, mixed>
-
Array containing the product IDs to be processed.
- $filterParameters : array<string|int, mixed>
-
Contains filter parameters.
Return values
array<string|int, mixed> —Returns the query result as a pure array, or an empty array when no result is produced.
getFilteredSpecialPricesCount()
Returns the record number of the filtered special prices.
public
getFilteredSpecialPricesCount(array<string|int, mixed> $productIds, array<string|int, mixed> $filterParameters) : int
Parameters
- $productIds : array<string|int, mixed>
-
Array containing the product IDs to be processed.
- $filterParameters : array<string|int, mixed>
-
Contains filter parameters.
Return values
int —Returns the number of special prices found.
getGraduatedPrices()
Returns the graduated prices of a product or an empty array nothing was found.
public
getGraduatedPrices([array<string|int, mixed>|null $productIds = null ]) : array<string|int, mixed>
Parameters
- $productIds : array<string|int, mixed>|null = null
-
Array containing the selected product IDs to be processed.
Return values
array<string|int, mixed> —Returns array that contains the graduated prices information.
getProductPropertiesCount()
Returns the number of all product properties found.
public
getProductPropertiesCount() : int
Return values
int —Returns the record number.
getSpecialPricesCount()
Get special prices record count.
public
getSpecialPricesCount() : int
Return values
int —Returns the number of all special prices found.
paginateProperties()
Sets the starting point of the pagination and the number of properties.
public
paginateProperties([IntType|null $start = null ][, IntType|null $length = null ]) : QuickEditProductPropertiesRepository
Parameters
- $start : IntType|null = null
-
Pagination start index.
- $length : IntType|null = null
-
Page length value.
Return values
QuickEditProductPropertiesRepository —QuickEdit products properties repository for chained method calls.
paginateSpecialPrices()
Sets the starting point of the pagination and the number of special prices.
public
paginateSpecialPrices([IntType|null $start = null ][, IntType|null $length = null ]) : QuickEditProductSpecialPricesRepository
Parameters
- $start : IntType|null = null
-
Pagination start index.
- $length : IntType|null = null
-
Page length value.
Return values
QuickEditProductSpecialPricesRepository —QuickEdit products special price repository for chained method calls.
setByCombisId()
Saves product by product-combi ID.
public
setByCombisId(array<string|int, mixed> $productCombi) : bool
Parameters
- $productCombi : array<string|int, mixed>
-
Contains product data to be saved.
Return values
bool —Returns the operation result.
setSpecialPriceById()
Saves the changed data regarding the special price.
public
setSpecialPriceById(array<string|int, mixed> $specialPrice) : bool
Parameters
- $specialPrice : array<string|int, mixed>
-
Contains the special prices data.
Return values
bool —Returns the operation result.
sortProperties()
Sets the sorting order of the product properties.
public
sortProperties([StringType|null $orderBy = null ]) : QuickEditProductPropertiesRepository
Parameters
- $orderBy : StringType|null = null
-
Sorting order (ASC or DESC).
Return values
QuickEditProductPropertiesRepository —QuickEdit products properties repository for chained method calls.
sortSpecialPrices()
Sets the sorting order of the special prices.
public
sortSpecialPrices([StringType|null $orderBy = null ]) : QuickEditProductSpecialPricesRepository
Parameters
- $orderBy : StringType|null = null
-
Sorting order (ASC or DESC)
Return values
QuickEditProductSpecialPricesRepository —QuickEdit products special price repository for chained method calls.