Class CategoryReadService

This class provides methods for retrieving data of a particular category and a collection of specific categories.

CategoryReadService implements CategoryReadServiceInterface

Package: Category
Category: System
Located at Services/Core/Category/CategoryReadService.inc.php

Methods summary

`public`	# `__construct( CategoryRepositoryInterface $categoryRepo, CategoryListProviderFactoryInterface $categoryListProviderFactory, UrlRewriteStorage $urlRewriteStorage )` CategoryReadService constructor. CategoryReadService constructor. Parameters `$categoryRepo` Category repository. `$categoryListProviderFactory` Category list provider. `$urlRewriteStorage`
`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` Implementation of `CategoryReadServiceInterface::getCategoryById()`
`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` Implementation of `CategoryReadServiceInterface::getCategoryList()`
`public CategoryListItemCollection`	# `getActiveCategoryList( LanguageCode $languageCode, IdType $parentId = null, IdType $customerStatusLimit = null )` Returns CategoryListItemCollection of active categories. Returns 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` Implementation of `CategoryReadServiceInterface::getActiveCategoryList()`
`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` Implementation of `CategoryReadServiceInterface::getRewriteUrls()`
`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` Implementation of `CategoryReadServiceInterface::findRewriteUrl()`
`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` Implementation of `CategoryReadServiceInterface::findUrlRewritesByRewriteUrl()`

Properties summary

`protected CategoryRepositoryInterface`	`$categoryRepo` Category repository interface. Category repository interface.	#
`protected CategoryListProviderFactoryInterface`	`$categoryListProviderFactory` Category list provider factory. Category list provider factory.	#
`protected UrlRewriteStorage`	`$urlRewriteStorage` The url rewrite storage. The url rewrite storage.	#

Packages

Classes

Class CategoryReadService

Methods summary

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Properties summary