Interface CategoryReadServiceInterface

Interface CategoryReadServiceInterface

This interface defines methods for retrieving data of a particular category and a collection of specific categories.

Direct known implementers

CategoryReadService

Package: Category\Interfaces
Category: System
Located at Services/Core/Category/Entities/Interfaces/CategoryReadServiceInterface.inc.php

Methods summary

`public StoredCategoryInterface`	# `getCategoryById( IdType $categoryId )` Returns a StoredCategory object with the provided category ID. Returns a StoredCategory object with the provided category ID. Parameters `$categoryId` ID of the category. Returns `StoredCategoryInterface` A StoredCategory object, depending on the provided category ID.
`public CategoryListItemCollection`	# `getCategoryList( LanguageCode $languageCode, IdType $parentId = null, IdType $customerStatusLimit = null )` Returns a CategoryListItemCollection. Returns a CategoryListItemCollection. Parameters `$languageCode` The language code for the wanted language. `$parentId` The parent ID of the categories. `$customerStatusLimit` Customer status ID to decide the allowance. Returns `CategoryListItemCollection` A Category list item collection.
`public CategoryListItemCollection`	# `getActiveCategoryList( LanguageCode $languageCode, IdType $parentId = null, IdType $customerStatusLimit = null )` Returns an active CategoryListItemCollection of active categories. Returns an active CategoryListItemCollection of active categories. Parameters `$languageCode` The language code for the wanted language. `$parentId` The parent ID of the categories. `$customerStatusLimit` Customer status ID to decide the allowance. Returns `CategoryListItemCollection` An CategoryListItemCollection of active categories.
`public UrlRewriteCollection`	# `getRewriteUrls( IdType $categoryId )` Returns an UrlRewriteCollection with UrlRewrite instances for the provided category ID. Returns an UrlRewriteCollection with UrlRewrite instances for the provided category ID. Parameters `$categoryId` Returns `UrlRewriteCollection`
`public null\|UrlRewrite`	# `findRewriteUrl( IdType $categoryId, IdType $languageId )` Returns a single UrlRewrite instance for the provided category ID and language ID or NULL if no entry was found. Returns a single UrlRewrite instance for the provided category ID and language ID or NULL if no entry was found. Parameters `$categoryId` `$languageId` Returns null\|`UrlRewrite`
`public UrlRewriteCollection`	# `findUrlRewritesByRewriteUrl( NonEmptyStringType $rewriteUrl )` Returns an UrlRewriteCollection with UrlRewrite instances for the provided rewrite url. Returns an UrlRewriteCollection with UrlRewrite instances for the provided rewrite url. Parameters `$rewriteUrl` Returns `UrlRewriteCollection`