GalleryManagement Class Reference

Inheritance diagram for GalleryManagement:

Public Member Functions
	__construct (\Magento\Catalog\Api\ProductRepositoryInterface $productRepository, ImageContentValidatorInterface $contentValidator)
	update ($sku, ProductAttributeMediaGalleryEntryInterface $entry)
	remove ($sku, $entryId)
	get ($sku, $entryId)
Public Member Functions inherited from ProductAttributeMediaGalleryManagementInterface
	create ( $sku, \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface $entry)
	update ( $sku, \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface $entry)
	getList ($sku)

Protected Attributes
	$productRepository
	$contentValidator

Detailed Description

Class GalleryManagement

Provides implementation of api interface ProductAttributeMediaGalleryManagementInterface

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 22 of file GalleryManagement.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		ImageContentValidatorInterface	$contentValidator
	)

Parameters

\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
ImageContentValidatorInterface	$contentValidator	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 40 of file GalleryManagement.php.

      {
        $this->productRepository = $productRepository;
        $this->contentValidator = $contentValidator;
    }

Member Function Documentation

get()

get	(		$sku,
			$entryId
	)

Return information about gallery entry

Parameters

string	$sku
int	$entryId

Exceptions

Implements ProductAttributeMediaGalleryManagementInterface.

Definition at line 162 of file GalleryManagement.php.

    {
        try {
            $product = $this->productRepository->get($sku);
        } catch (\Exception $exception) {
            throw new NoSuchEntityException(__("The product doesn't exist. Verify and try again."));
        }

        $mediaGalleryEntries = $product->getMediaGalleryEntries();
        foreach ($mediaGalleryEntries as $entry) {
            if ($entry->getId() == $entryId) {
                return $entry;
            }
        }

        throw new NoSuchEntityException(__("The image doesn't exist. Verify and try again."));
    }

remove()

remove	(		$sku,
			$entryId
	)

Remove gallery entry

Parameters

string	$sku
int	$entryId

Returns

bool

Exceptions

Implements ProductAttributeMediaGalleryManagementInterface.

Definition at line 132 of file GalleryManagement.php.

    {
        $product = $this->productRepository->get($sku, true);
        $existingMediaGalleryEntries = $product->getMediaGalleryEntries();
        if ($existingMediaGalleryEntries == null) {
            throw new NoSuchEntityException(
                __('No image with the provided ID was found. Verify the ID and try again.')
            );
        }
        $found = false;
        foreach ($existingMediaGalleryEntries as $key => $entry) {
            if ($entry->getId() == $entryId) {
                unset($existingMediaGalleryEntries[$key]);
                $found = true;
                break;
            }
        }
        if (!$found) {
            throw new NoSuchEntityException(
                __('No image with the provided ID was found. Verify the ID and try again.')
            );
        }
        $product->setMediaGalleryEntries($existingMediaGalleryEntries);
        $this->productRepository->save($product);
        return true;
    }

update()

update	(		$sku,
		ProductAttributeMediaGalleryEntryInterface	$entry
	)

Definition at line 91 of file GalleryManagement.php.

    {
        $product = $this->productRepository->get($sku, true);
        $existingMediaGalleryEntries = $product->getMediaGalleryEntries();
        if ($existingMediaGalleryEntries == null) {
            throw new NoSuchEntityException(
                __('No image with the provided ID was found. Verify the ID and try again.')
            );
        }
        $found = false;
        foreach ($existingMediaGalleryEntries as $key => $existingEntry) {
            $entryTypes = (array)$entry->getTypes();
            $existingEntryTypes = (array)$existingMediaGalleryEntries[$key]->getTypes();
            $existingMediaGalleryEntries[$key]->setTypes(array_diff($existingEntryTypes, $entryTypes));

            if ($existingEntry->getId() == $entry->getId()) {
                $found = true;
                if ($entry->getFile()) {
                    $entry->setId(null);
                }
                $existingMediaGalleryEntries[$key] = $entry;
            }
        }
        if (!$found) {
            throw new NoSuchEntityException(
                __('No image with the provided ID was found. Verify the ID and try again.')
            );
        }
        $product->setMediaGalleryEntries($existingMediaGalleryEntries);

        try {
            $this->productRepository->save($product);
        } catch (\Exception $exception) {
            throw new StateException(__("The product can't be saved."));
        }
        return true;
    }

Field Documentation

$contentValidator

$contentValidator

protected

Definition at line 32 of file GalleryManagement.php.

$productRepository

$productRepository

protected

Definition at line 27 of file GalleryManagement.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-catalog/Model/Product/Gallery/GalleryManagement.php