QuickEditProductPropertiesReaderInterface
in
Interface QuickEditProductsPropertiesReaderInterface
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.
- getProductPropertiesCount() : int
- Returns the number of all product properties found.
- paginateProperties() : QuickEditProductPropertiesReaderInterface
- Sets the starting point of the pagination and the number of products.
- sortProperties() : QuickEditProductPropertiesReaderInterface
- Sets the sorting order of the products
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.
getProductPropertiesCount()
Returns the number of all product properties found.
public
getProductPropertiesCount() : int
Return values
int —Returns the record number.
paginateProperties()
Sets the starting point of the pagination and the number of products.
public
paginateProperties([IntType|null $start = null ][, IntType|null $length = null ]) : QuickEditProductPropertiesReaderInterface
Parameters
Return values
QuickEditProductPropertiesReaderInterface —Returns same instance for chained method calls.
sortProperties()
Sets the sorting order of the products
public
sortProperties([StringType|null $orderBy = null ]) : QuickEditProductPropertiesReaderInterface
Parameters
- $orderBy : StringType|null = null
-
Sorting order (ASC or DESC)
Return values
QuickEditProductPropertiesReaderInterface —Returns same instance for chained method calls.