API Documentation
Back to top  

ProductImageContainerInterface

Extends

Interface ProductImageContainerInterface

category

System
package

Product
subpackage

Interfaces

Methods

Adds an additional image to the container.

addAdditional(\ProductImageInterface $image) : \ProductImageContainerInterface

Arguments

$image

\ProductImageInterface

Additional product image to add to the container.

Response

\ProductImageContainerInterface

Same instance for chained method calls.

Deletes an image from the image container.

delete(\FilenameStringType $imageFile) : \ProductImageContainerInterface

Arguments

$imageFile

\FilenameStringType

Image filename.

Response

\ProductImageContainerInterface

Same instance for chained method calls.

Returns the collection of additional images from the image container.

getAdditionals() : \ProductImageCollection

Response

\ProductImageCollection

The requested additional images from the image container.

Returns the primary product image from the image container.

getPrimary() : \ProductImageInterface

Response

\ProductImageInterface

The requested primary product image from container.

Replaces an additional product image in the container.

replaceAdditional(\FilenameStringType $imageFile, \ProductImageInterface $image) : \ProductImageContainerInterface

Arguments

$imageFile

\FilenameStringType

Image filename.

$image

\ProductImageInterface

Image to place.

Response

\ProductImageContainerInterface

Same instance for chained method calls.

Sets the primary image of the image container.

setPrimary(\ProductImageInterface $image) : \ProductImageContainerInterface

Arguments

$image

\ProductImageInterface

Primary product image to set.

Response

\ProductImageContainerInterface

Same instance for chained method calls.