CategoryListProviderInterface
in
Interface CategoryListProviderInterface
This interface defines methods for creating a list of flattened categories with just its essential data. The list of categories is filtered by its parent category ID and customer status permissions and for simplicity it contains language specific data only in one language.
Tags
Table of Contents
- getByParentId() : CategoryListItemCollection
- Returns a category list based the parent ID provided.
- searchCategories() : CategoryListItemCollection
- Filters category records by a given CategorySearchCondition object and returns an collection with results.
Methods
getByParentId()
Returns a category list based the parent ID provided.
public
getByParentId(IdType $parentId) : CategoryListItemCollection
Parameters
- $parentId : IdType
-
Category parent ID.
Return values
CategoryListItemCollection —searchCategories()
Filters category records by a given CategorySearchCondition object and returns an collection with results.
public
searchCategories(CategorySearchCondition $condition[, Pager|null $pager = null ][, array<string|int, mixed> $sorters = [] ]) : CategoryListItemCollection
Parameters
- $condition : CategorySearchCondition
-
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