Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • CategoryObjectService
  • CategoryReadService
  • CategoryWriteService

Class CategoryReadService

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 CoreServices/Category/CategoryReadService.inc.php

Methods summary

public
# __construct( CategoryRepositoryInterface $categoryRepo, CategoryListProviderFactoryInterface $categoryListProviderFactory )

CategoryReadService constructor.

CategoryReadService constructor.

Parameters

$categoryRepo
Category repository.
$categoryListProviderFactory
Category list provider.
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()

Properties summary

protected CategoryRepositoryInterface $categoryRepo

Category repository interface.

Category repository interface.

#
protected CategoryListProviderFactoryInterface $categoryListProviderFactory

Category list provider factory.

Category list provider factory.

#
API documentation generated by ApiGen