ProductListProviderInterface
in
Interface ProductListProviderInterface
Tags
Table of Contents
- getAll() : ProductListItemCollection
- Returns all product list items.
- getAllPaged() : ProductListItemCollection
- Returns a paged list of product items.
- getByCategoryId() : ProductListItemCollection
- Returns a product list item collection by the provided category ID.
- searchProducts() : ProductListItemCollection
- Filters products records by a given ProductSearchCondition object and returns an array with results.
- searchProductsCount() : IntType
- Count the total of filtered products.
Methods
getAll()
Returns all product list items.
public
getAll() : ProductListItemCollection
Return values
ProductListItemCollection —getAllPaged()
Returns a paged list of product items.
public
getAllPaged([Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : ProductListItemCollection
Parameters
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
ProductListItemCollection —getByCategoryId()
Returns a product list item collection by the provided category ID.
public
getByCategoryId(IdType $categoryId) : ProductListItemCollection
Parameters
- $categoryId : IdType
-
Category ID.
Return values
ProductListItemCollection —searchProducts()
Filters products records by a given ProductSearchCondition object and returns an array with results.
public
searchProducts(ProductSearchCondition $condition[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : ProductListItemCollection
Parameters
- $condition : ProductSearchCondition
-
Conditions object for search.
- $pager : Pager|null = null
-
(Optional) Pager object with pagination information
- $sorters : array<string|int, mixed> = []
-
(Optional) array of Sorter objects with data sorting information
Return values
ProductListItemCollection —searchProductsCount()
Count the total of filtered products.
public
searchProductsCount(ProductSearchCondition $condition) : IntType
Parameters
- $condition : ProductSearchCondition
-
Conditions object for search.