Public Member Functions
	__construct (CollectionFactory $productCollectionFactory, ProductRepositoryInterface $productRepository, StoreManagerInterface $storeManager, SwatchCollectionFactory $swatchCollectionFactory, UrlBuilder $urlBuilder, Json $serializer=null, SwatchAttributesProvider $swatchAttributesProvider=null, SwatchAttributeType $swatchTypeChecker=null)

	assembleAdditionalDataEavAttribute (Attribute $attribute)

	loadFirstVariationWithSwatchImage (Product $configurableProduct, array $requiredAttributes)

	loadFirstVariationWithImage (Product $configurableProduct, array $requiredAttributes)

	loadVariationByFallback (Product $parentProduct, array $attributes)

	getProductMediaGallery (ModelProduct $product)

	getSwatchAttributesAsArray (Product $product)

	isProductHasSwatch (Product $product)

	isSwatchAttribute (Attribute $attribute)

	isVisualSwatch (Attribute $attribute)

	isTextSwatch (Attribute $attribute)

Data Fields
const	EMPTY_IMAGE_VALUE = 'no_selection'

const	DEFAULT_STORE_ID = 0

Protected Member Functions
	getMetadataPool ()

Protected Attributes
	$productCollectionFactory

	$productRepository

	$storeManager

	$swatchCollectionFactory

	$eavAttributeAdditionalDataKeys

Detailed Description

Class Helper Data

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 30 of file Data.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	CollectionFactory	$productCollectionFactory,
		ProductRepositoryInterface	$productRepository,
		StoreManagerInterface	$storeManager,
		SwatchCollectionFactory	$swatchCollectionFactory,
		UrlBuilder	$urlBuilder,
		Json	$serializer = `null`,
		SwatchAttributesProvider	$swatchAttributesProvider = `null`,
		SwatchAttributeType	$swatchTypeChecker = `null`
	)

Parameters

CollectionFactory	$productCollectionFactory
ProductRepositoryInterface	$productRepository
StoreManagerInterface	$storeManager
SwatchCollectionFactory	$swatchCollectionFactory
UrlBuilder	$urlBuilder
Json \| null	$serializer
SwatchAttributesProvider	$swatchAttributesProvider
SwatchAttributeType \| null	$swatchTypeChecker

Definition at line 112 of file Data.php.

       {
         $this->productCollectionFactory = $productCollectionFactory;
         $this->productRepository = $productRepository;
         $this->storeManager = $storeManager;
         $this->swatchCollectionFactory = $swatchCollectionFactory;
         $this->serializer = $serializer ?: ObjectManager::getInstance()->create(Json::class);
         $this->swatchAttributesProvider = $swatchAttributesProvider
             ?: ObjectManager::getInstance()->get(SwatchAttributesProvider::class);
         $this->swatchTypeChecker = $swatchTypeChecker
             ?: ObjectManager::getInstance()->create(SwatchAttributeType::class);
         $this->imageUrlBuilder = $urlBuilder;
     }

Member Function Documentation

◆ assembleAdditionalDataEavAttribute()

assembleAdditionalDataEavAttribute ( Attribute $attribute )

Parameters

Attribute $attribute

Returns: $this

Definition at line 138 of file Data.php.

     {
         $initialAdditionalData = [];
         $additionalData = (string)$attribute->getData('additional_data');
         if (!empty($additionalData)) {
             $additionalData = $this->serializer->unserialize($additionalData);
             if (is_array($additionalData)) {
                 $initialAdditionalData = $additionalData;
             }
         }
 
         $dataToAdd = [];
         foreach ($this->eavAttributeAdditionalDataKeys as $key) {
             $dataValue = $attribute->getData($key);
             if (null !== $dataValue) {
                 $dataToAdd[$key] = $dataValue;
             }
         }
         $additionalData = array_merge($initialAdditionalData, $dataToAdd);
         $attribute->setData('additional_data', $this->serializer->serialize($additionalData));
         return $this;
     }

◆ getMetadataPool()

getMetadataPool ( )

protected

Get product metadata pool.

Returns: \Magento\Framework\EntityManager\MetadataPool @deprecared

Definition at line 549 of file Data.php.

     {
         if (!$this->metadataPool) {
             $this->metadataPool = \Magento\Framework\App\ObjectManager::getInstance()
                 ->get(\Magento\Framework\EntityManager\MetadataPool::class);
         }
         return $this->metadataPool;
     }

◆ getProductMediaGallery()

getProductMediaGallery ( ModelProduct $product )

Method getting full media gallery for current Product Array structure: [ ['image'] => 'http://url/pub/media/catalog/product/2/0/blabla.jpg', ['mediaGallery'] => [ galleryImageId1 => simpleProductImage1.jpg, galleryImageId2 => simpleProductImage2.jpg, ..., ] ]

Parameters

ModelProduct $product

Returns: array

Definition at line 313 of file Data.php.

     {
         $baseImage = null;
         $gallery = [];
 
         $mediaGallery = $product->getMediaGalleryEntries();
         foreach ($mediaGallery as $mediaEntry) {
             if ($mediaEntry->isDisabled()) {
                 continue;
             }
 
             if (in_array('image', $mediaEntry->getTypes(), true) || !$baseImage) {
                 $baseImage = $mediaEntry->getFile();
             }
 
             $gallery[$mediaEntry->getId()] = $this->getAllSizeImages($mediaEntry->getFile());
         }
 
         if (!$baseImage) {
             return [];
         }
 
         $resultGallery = $this->getAllSizeImages($baseImage);
         $resultGallery['gallery'] = $gallery;
 
         return $resultGallery;
     }

◆ getSwatchAttributesAsArray()

getSwatchAttributesAsArray ( Product $product )

Retrieve all visible Swatch attributes for current product.

Parameters

Product $product

Returns: array

Definition at line 394 of file Data.php.

     {
         $result = [];
         $swatchAttributes = $this->getSwatchAttributes($product);
         foreach ($swatchAttributes as $swatchAttribute) {
             $swatchAttribute->setStoreId($this->storeManager->getStore()->getId());
             $attributeData = $swatchAttribute->getData();
             foreach ($swatchAttribute->getSource()->getAllOptions(false) as $option) {
                 $attributeData['options'][$option['value']] = $option['label'];
             }
             $result[$attributeData['attribute_id']] = $attributeData;
         }
 
         return $result;
     }

◆ isProductHasSwatch()

isProductHasSwatch ( Product $product )

Check if the Product has Swatch attributes

Parameters

Product $product

Returns: bool

Definition at line 505 of file Data.php.

     {
         return !empty($this->getSwatchAttributes($product));
     }

◆ isSwatchAttribute()

isSwatchAttribute ( Attribute $attribute )

Check if an attribute is Swatch

Parameters

Attribute $attribute

Returns: bool

Definition at line 516 of file Data.php.

     {
         return $this->swatchTypeChecker->isSwatchAttribute($attribute);
     }

◆ isTextSwatch()

isTextSwatch ( Attribute $attribute )

Is attribute Textual Swatch

Parameters

Attribute $attribute

Returns: bool

Definition at line 538 of file Data.php.

     {
         return $this->swatchTypeChecker->isTextSwatch($attribute);
     }

◆ isVisualSwatch()

isVisualSwatch ( Attribute $attribute )

Is attribute Visual Swatch

Parameters

Attribute $attribute

Returns: bool

Definition at line 527 of file Data.php.

     {
         return $this->swatchTypeChecker->isVisualSwatch($attribute);
     }

◆ loadFirstVariationWithImage()

loadFirstVariationWithImage	(	Product	$configurableProduct,
		array	$requiredAttributes
	)

Parameters

Product	$configurableProduct
array	$requiredAttributes

Returns: bool|Product

Definition at line 221 of file Data.php.

     {
         return $this->loadFirstVariation('image', $configurableProduct, $requiredAttributes);
     }

◆ loadFirstVariationWithSwatchImage()

loadFirstVariationWithSwatchImage	(	Product	$configurableProduct,
		array	$requiredAttributes
	)

Parameters

Product	$configurableProduct
array	$requiredAttributes

Returns: bool|Product

Definition at line 211 of file Data.php.

     {
         return $this->loadFirstVariation('swatch_image', $configurableProduct, $requiredAttributes);
     }

◆ loadVariationByFallback()

loadVariationByFallback	(	Product	$parentProduct,
		array	$attributes
	)

Load Variation Product using fallback

Parameters

Product	$parentProduct
array	$attributes

Returns: bool|Product

Definition at line 233 of file Data.php.

     {
         if (!$this->isProductHasSwatch($parentProduct)) {
             return false;
         }
 
         $productCollection = $this->productCollectionFactory->create();
 
         $productLinkedFiled = $this->getMetadataPool()
             ->getMetadata(\Magento\Catalog\Api\Data\ProductInterface::class)
             ->getLinkField();
         $parentId = $parentProduct->getData($productLinkedFiled);
 
         $this->addFilterByParent($productCollection, $parentId);
 
         $configurableAttributes = $this->getAttributesFromConfigurable($parentProduct);
         $allAttributesArray = [];
         foreach ($configurableAttributes as $attribute) {
             if (!empty($attribute['default_value'])) {
                 $allAttributesArray[$attribute['attribute_code']] = $attribute['default_value'];
             }
         }
 
         $resultAttributesToFilter = array_merge(
             $attributes,
             array_diff_key($allAttributesArray, $attributes)
         );
 
         $this->addFilterByAttributes($productCollection, $resultAttributesToFilter);
 
         $variationProduct = $productCollection->getFirstItem();
         if ($variationProduct && $variationProduct->getId()) {
             return $this->productRepository->getById($variationProduct->getId());
         }
 
         return false;
     }

Field Documentation

◆ $eavAttributeAdditionalDataKeys

$eavAttributeAdditionalDataKeys

protected

Initial value:

= [
        Swatch::SWATCH_INPUT_TYPE_KEY,
        'update_product_preview_image',
        'use_product_image_for_swatch'
    ]

Definition at line 79 of file Data.php.

◆ $productCollectionFactory

$productCollectionFactory

protected

Definition at line 45 of file Data.php.

◆ $productRepository

$productRepository

protected

Definition at line 50 of file Data.php.

◆ $storeManager

$storeManager

protected

Definition at line 55 of file Data.php.

◆ $swatchCollectionFactory

$swatchCollectionFactory

protected

Definition at line 60 of file Data.php.

◆ DEFAULT_STORE_ID

const DEFAULT_STORE_ID = 0

Default store ID

Definition at line 40 of file Data.php.

◆ EMPTY_IMAGE_VALUE

const EMPTY_IMAGE_VALUE = 'no_selection'

When we init media gallery empty image types contain this value.

Definition at line 35 of file Data.php.

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

vendor/magento/module-swatches/Helper/Data.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assembleAdditionalDataEavAttribute()

◆ getMetadataPool()

◆ getProductMediaGallery()

◆ getSwatchAttributesAsArray()

◆ isProductHasSwatch()

◆ isSwatchAttribute()

◆ isTextSwatch()

◆ isVisualSwatch()

◆ loadFirstVariationWithImage()

◆ loadFirstVariationWithSwatchImage()

◆ loadVariationByFallback()

Field Documentation

◆ $eavAttributeAdditionalDataKeys

◆ $productCollectionFactory

◆ $productRepository

◆ $storeManager

◆ $swatchCollectionFactory

◆ DEFAULT_STORE_ID

◆ EMPTY_IMAGE_VALUE