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

  • EmptyProductImage
  • EnvProductImageFileStorageSettings
  • GXEngineProduct
  • LegacyProductImageProcessing
  • ProductImage
  • ProductImageContainer
  • ProductListItem
  • ProductSettings
  • StoredProduct

Class ProductListItem

Class ProductListItem

Package: Product\Entities
Category: System
Located at CoreServices/Product/Entities/ProductListItem.inc.php

Methods summary

public
# __construct( ProductRepositoryInterface $productRepo, IdType $productId, BoolType $isActive, StringType $name, StringType $urlKeywords, StringType $image, StringType $imageAltText )

ProductListItem constructor.

ProductListItem constructor.

Parameters

$productRepo
Product Repository.
$productId
Product ID.
$isActive
Is the product active?
$name
Product name.
$urlKeywords
URL keywords.
$image
Product image.
$imageAltText
Product image alternative text.
public integer
# getProductId( )

Returns the product ID.

Returns the product ID.

Returns

integer
public boolean
# isActive( )

Checks if product is active or not.

Checks if product is active or not.

Returns

boolean
public string
# getName( )

Returns the name of the product.

Returns the name of the product.

Returns

string
public string
# getUrlKeywords( )

Returns the URL keywords.

Returns the URL keywords.

Returns

string
public string
# getImage( )

Returns the image.

Returns the image.

Returns

string
public string
# getImageAltText( )

Returns the alternative image text.

Returns the alternative image text.

Returns

string
public ProductListItem
# getProductObject( )

Returns the product object.

Returns the product object.

Returns

ProductListItem
Same instance for chained method calls.

Throws

InvalidArgumentException
if the product ID is not valid.

Properties summary

protected ProductRepositoryInterface $productRepo

Product repository.

Product repository.

#
protected integer $productId

Product ID.

Product ID.

#
protected boolean $active

Is product active?

Is product active?

#
protected string $name

Product name.

Product name.

#
protected string $urlKeywords

URL keywords.

URL keywords.

#
protected string $image

Image.

Image.

#
protected string $imageAltText

Image alternative text.

Image alternative text.

#
API documentation generated by ApiGen