Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • ProductObjectService
  • ProductReadService
  • ProductWriteService

Class ProductReadService

Class ProductReadService

ProductReadService implements ProductReadServiceInterface
Package: Product
Category: System
Located at Services/Core/Product/ProductReadService.inc.php

Methods summary

public
# __construct( ProductRepositoryInterface $productRepo, ProductListProviderFactoryInterface $listProviderFactory, ProductCategoryLinkerInterface $productLinker, UrlRewriteStorage $urlRewriteStorage )

ProductReadService constructor.

ProductReadService constructor.

Parameters

$productRepo
$listProviderFactory
$productLinker
$urlRewriteStorage
public StoredProductInterface
# getProductById( IdType $productId )

Get Product by ID

Get Product by ID

Returns a specific product, depending on the provided ID.

Parameters

$productId
The ID of the product to return.

Returns

StoredProductInterface
The stored product.

Implementation of

ProductReadServiceInterface::getProductById()
public ProductListItemCollection
# getProductList( LanguageCode $languageCode, IdType $categoryId = null, IdType $customerStatusLimit = null )

Get Product List

Get Product List

Returns a specific product list.

Parameters

$languageCode
The language code.
$categoryId
The category ID of the product list.
$customerStatusLimit
The customers status limit.

Returns

ProductListItemCollection

Implementation of

ProductReadServiceInterface::getProductList()
public ProductListItemCollection
# getActiveProductList( LanguageCode $languageCode, IdType $categoryId = null, IdType $customerStatusLimit = null )

Get Active Product List

Get Active Product List

Returns an active products list.

Parameters

$languageCode
The language code.
$categoryId
The category ID of the product list.
$customerStatusLimit
The customers status limit.

Returns

ProductListItemCollection

Implementation of

ProductReadServiceInterface::getActiveProductList()
public IdCollection
# getProductLinks( IdType $productId )

Returns the category Ids which are linked with given product id.

Returns the category Ids which are linked with given product id.

Parameters

$productId

Returns

IdCollection

Implementation of

ProductReadServiceInterface::getProductLinks()
public UrlRewriteCollection
# getRewriteUrls( IdType $productId )

Returns an UrlRewriteCollection with UrlRewrite instances for the provided content ID.

Returns an UrlRewriteCollection with UrlRewrite instances for the provided content ID.

Parameters

$productId

Returns

UrlRewriteCollection

Implementation of

ProductReadServiceInterface::getRewriteUrls()
public null|UrlRewrite
# findRewriteUrl( IdType $productId, IdType $languageId )

Returns a single UrlRewrite instance for the provided content ID and language ID or NULL if no entry was found.

Returns a single UrlRewrite instance for the provided content ID and language ID or NULL if no entry was found.

Parameters

$productId
$languageId

Returns

null|UrlRewrite

Implementation of

ProductReadServiceInterface::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

ProductReadServiceInterface::findUrlRewritesByRewriteUrl()

Properties summary

protected ProductRepositoryInterface $productRepo
#
protected ProductListProviderFactoryInterface $listProviderFactory
#
protected ProductCategoryLinkerInterface $productLinker

The product category linker.

The product category linker.

#
protected UrlRewriteStorage $urlRewriteStorage

The url rewrite storage.

The url rewrite storage.

#
API documentation generated by ApiGen