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 ProductImageContainer

Class ProductImageContainer

ProductImageContainer implements ProductImageContainerInterface
Package: Product\Entities
Category: System
Located at CoreServices/Product/Entities/ProductImageContainer.php

Methods summary

public
# __construct( )

ProductImageContainer constructor.

ProductImageContainer constructor.

public ProductImageContainer
# setPrimary( ProductImageInterface $image )

Sets the primary image of the image container.

Sets the primary image of the image container.

Parameters

$image
Primary product image to set.

Returns

ProductImageContainer
Same instance for chained method calls.

Implementation of

ProductImageContainerInterface::setPrimary()
public ProductImageInterface
# getPrimary( )

Returns the product primary image from container.

Returns the product primary image from container.

Returns

ProductImageInterface
The requested primary product image from the image container.

Implementation of

ProductImageContainerInterface::getPrimary()
public ProductImageContainer
# addAdditional( ProductImageInterface $image )

Adds an additional image to the additional images array.

Adds an additional image to the additional images array.

Parameters

$image
Additional product image to set in the container.

Returns

ProductImageContainer
Same instance for chained method calls.

Throws

InvalidArgumentException
if the provided image type is not valid.

Implementation of

ProductImageContainerInterface::addAdditional()
public ProductImageCollection
# getAdditionals( )

Returns the array of additional images as a collection.

Returns the array of additional images as a collection.

Returns

ProductImageCollection
The requested additional images from container.

Implementation of

ProductImageContainerInterface::getAdditionals()
public ProductImageContainer
# replaceAdditional( FilenameStringType $imageFile, ProductImageInterface $image )

Replaces an additional product image in the container.

Replaces an additional product image in the container.

Parameters

$imageFile
Image file name.
$image
Image to place.

Returns

ProductImageContainer
Same instance for chained method calls.

Implementation of

ProductImageContainerInterface::replaceAdditional()
public ProductImageContainer
# delete( FilenameStringType $imageFile )

Deletes an image from the additional images array.

Deletes an image from the additional images array.

Parameters

$imageFile
Image filename.

Returns

ProductImageContainer
Same instance for chained method calls.

Implementation of

ProductImageContainerInterface::delete()

Properties summary

protected ProductImage $primaryImage

Primary image.

Primary image.

#
protected array $additionalImages

Additional image associative array.

Additional image associative array.

#
API documentation generated by ApiGen