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 ProductImage

Class ProductImage

ProductImage implements ProductImageInterface

Direct known subclasses

EmptyProductImage

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

Methods summary

public
# __construct( FilenameStringType $filename )

ProductImage constructor.

ProductImage constructor.

Parameters

$filename
Filename of the image.
public string
# getFilename( )

Get Filename

Get Filename

Returns the filename of the product.

Returns

string
The filename of the product.

Implementation of

ProductImageInterface::getFilename()
public string
# getAltText( LanguageCode $language )

Get Alt Text

Get Alt Text

Returns the alternative text of a product image.

Parameters

$language
The language code of the alt text to return.

Returns

string
The alternative text of the product image.

Throws

InvalidArgumentException
if the language code is not valid.

Implementation of

ProductImageInterface::getAltText()
public boolean
# isVisible( )

Is Visible

Is Visible

Checks if the product is set to visible or not.

Returns

boolean
Is the product visible?

Implementation of

ProductImageInterface::isVisible()
public string
# setAltText( StringType $text, LanguageCode $language )

Set Alt Text

Set Alt Text

Sets the alternative text of the product image.

Parameters

$text
The alternative text for the product image.
$language
The language code of the alternative text.

Returns

string
The alternative text of the product image.

Implementation of

ProductImageInterface::setAltText()
public ProductImageInterface
# setVisible( BoolType $visible )

Set Visible

Set Visible

Activates or deactivates the products visibility.

Parameters

$visible
Should the product be visible?

Returns

ProductImageInterface
Same instance for chained method calls.

Implementation of

ProductImageInterface::setVisible()

Properties summary

protected string $filename

Filename of the product image

Filename of the product image

#
protected array $altTexts

Alt texts of the image.

Alt texts of the image.

# array()
protected boolean $productVisibility

Is the product visible?

Is the product visible?

#
API documentation generated by ApiGen