Management Class Reference

Inheritance diagram for Management:

Public Member Functions
	__construct (\Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Catalog\Model\Product\LinkTypeProvider $linkTypeProvider)
	getLinkedItemsByType ($sku, $type)
	setProductLinks ($sku, array $items)

Protected Attributes
	$productRepository
	$linkTypeProvider

Detailed Description

Definition at line 14 of file Management.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Catalog\Model\Product\LinkTypeProvider	$linkTypeProvider
	)

Parameters

\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\Catalog\Model\Product\LinkTypeProvider	$linkTypeProvider

Definition at line 30 of file Management.php.

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

Member Function Documentation

getLinkedItemsByType()

getLinkedItemsByType	(		$sku,
			$type
	)

{Provide the list of links for a specific product

Parameters

string	$sku
string	$type

Returns

\Magento\Catalog\Api\Data\ProductLinkInterface[]

}

Implements ProductLinkManagementInterface.

Definition at line 41 of file Management.php.

    {
        $output = [];

        $linkTypes = $this->linkTypeProvider->getLinkTypes();

        if (!isset($linkTypes[$type])) {
            throw new NoSuchEntityException(
                __('The "%1" link type is unknown. Verify the type and try again.', (string)$type)
            );
        }
        $product = $this->productRepository->get($sku);
        $links = $product->getProductLinks();

        // Only return the links of type specified
        foreach ($links as $link) {
            if ($link->getLinkType() == $type) {
                $output[] = $link;
            }
        }

        return $output;
    }

setProductLinks()

setProductLinks	(		$sku,
		array	$items
	)

{Assign a product link to another product

Parameters

string	$sku

}

Implements ProductLinkManagementInterface.

Definition at line 68 of file Management.php.

    {
        $linkTypes = $this->linkTypeProvider->getLinkTypes();

        // Check if product link type is set and correct
        if (!empty($items)) {
            foreach ($items as $newLink) {
                $type = $newLink->getLinkType();
                if ($type == null) {
                    throw InputException::requiredField("linkType");
                }
                if (!isset($linkTypes[$type])) {
                    throw new NoSuchEntityException(
                        __('The "%1" link type wasn\'t found. Verify the type and try again.', $type)
                    );
                }
            }
        }

        $product = $this->productRepository->get($sku);

        // Replace only links of the specified type
        $existingLinks = $product->getProductLinks();
        $newLinks = [];
        if (!empty($existingLinks)) {
            foreach ($existingLinks as $link) {
                if ($link->getLinkType() != $type) {
                    $newLinks[] = $link;
                }
            }
            $newLinks = array_merge($newLinks, $items);
        } else {
            $newLinks = $items;
        }
        $product->setProductLinks($newLinks);
        try {
            $this->productRepository->save($product);
        } catch (\Exception $exception) {
            throw new CouldNotSaveException(__('The linked products data is invalid. Verify the data and try again.'));
        }

        return true;
    }

Field Documentation

$linkTypeProvider

$linkTypeProvider

protected

Definition at line 24 of file Management.php.

$productRepository

$productRepository

protected

Definition at line 19 of file Management.php.

---

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

• vendor/magento/module-catalog/Model/ProductLink/Management.php