ProductImageContainerInterface
in
Interface ProductImageContainerInterface
Tags
Table of Contents
- addAdditional() : ProductImageContainerInterface
- Adds an additional image to the container.
- delete() : ProductImageContainerInterface
- Deletes an image from the image container.
- getAdditionals() : ProductImageCollection
- Returns the collection of additional images from the image container.
- getPrimary() : ProductImageInterface
- Returns the primary product image from the image container.
- replaceAdditional() : ProductImageContainerInterface
- Replaces an additional product image in the container.
- setPrimary() : ProductImageContainerInterface
- Sets the primary image of the image container.
Methods
addAdditional()
Adds an additional image to the container.
public
addAdditional(ProductImageInterface $image) : ProductImageContainerInterface
Parameters
- $image : ProductImageInterface
-
Additional product image to add to the container.
Return values
ProductImageContainerInterface —Same instance for chained method calls.
delete()
Deletes an image from the image container.
public
delete(FilenameStringType $imageFile) : ProductImageContainerInterface
Parameters
- $imageFile : FilenameStringType
-
Image filename.
Return values
ProductImageContainerInterface —Same instance for chained method calls.
getAdditionals()
Returns the collection of additional images from the image container.
public
getAdditionals() : ProductImageCollection
Return values
ProductImageCollection —The requested additional images from the image container.
getPrimary()
Returns the primary product image from the image container.
public
getPrimary() : ProductImageInterface
Return values
ProductImageInterface —The requested primary product image from container.
replaceAdditional()
Replaces an additional product image in the container.
public
replaceAdditional(FilenameStringType $imageFile, ProductImageInterface $image) : ProductImageContainerInterface
Parameters
- $imageFile : FilenameStringType
-
Image filename.
- $image : ProductImageInterface
-
Image to place.
Return values
ProductImageContainerInterface —Same instance for chained method calls.
setPrimary()
Sets the primary image of the image container.
public
setPrimary(ProductImageInterface $image) : ProductImageContainerInterface
Parameters
- $image : ProductImageInterface
-
Primary product image to set.
Return values
ProductImageContainerInterface —Same instance for chained method calls.