Inheritance diagram for Grouped:

Public Member Functions
	__construct (\Magento\Catalog\Model\Product\Option $catalogProductOption, \Magento\Eav\Model\Config $eavConfig, \Magento\Catalog\Model\Product\Type $catalogProductType, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Registry $coreRegistry, \Psr\Log\LoggerInterface $logger, ProductRepositoryInterface $productRepository, \Magento\GroupedProduct\Model\ResourceModel\Product\Link $catalogProductLink, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Model\Product\Attribute\Source\Status $catalogProductStatus, \Magento\Framework\App\State $appState, \Magento\Msrp\Helper\Data $msrpData, \Magento\Framework\Serialize\Serializer\Json $serializer=null)

	getRelationInfo ()

	getChildrenIds ($parentId, $required=true)

	getParentIdsByChild ($childId)

	getAssociatedProducts ($product)

	flushAssociatedProductsCache ($product)

	addStatusFilter ($status, $product)

	setSaleableStatus ($product)

	getStatusFilters ($product)

	getProductsToPurchaseByReqGroups ($product)

	processBuyRequest ($product, $buyRequest)

	hasWeight ()

	deleteTypeSpecificData (\Magento\Catalog\Model\Product $product)

	beforeSave ($product)

	getChildrenMsrp (\Magento\Catalog\Model\Product $product)

Public Member Functions inherited from AbstractType
	deleteTypeSpecificData (\Magento\Catalog\Model\Product $product)

	__construct (\Magento\Catalog\Model\Product\Option $catalogProductOption, \Magento\Eav\Model\Config $eavConfig, \Magento\Catalog\Model\Product\Type $catalogProductType, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Registry $coreRegistry, \Psr\Log\LoggerInterface $logger, ProductRepositoryInterface $productRepository, \Magento\Framework\Serialize\Serializer\Json $serializer=null)

	setTypeId ($typeId)

	getRelationInfo ()

	getChildrenIds ($parentId, $required=true)

	getParentIdsByChild ($childId)

	getSetAttributes ($product)

	attributesCompare ($attributeOne, $attributeTwo)

	getEditableAttributes ($product)

	getAttributeById ($attributeId, $product)

	isVirtual ($product)

	isSalable ($product)

	processConfiguration (\Magento\Framework\DataObject $buyRequest, $product, $processMode=self::PROCESS_MODE_LITE)

	prepareForCartAdvanced (\Magento\Framework\DataObject $buyRequest, $product, $processMode=null)

	prepareForCart (\Magento\Framework\DataObject $buyRequest, $product)

	addFileQueue ($queueOptions)

	getSpecifyOptionMessage ()

	checkProductBuyState ($product)

	getOrderOptions ($product)

	save ($product)

	beforeSave ($product)

	isComposite ($product)

	canConfigure ($product)

	canUseQtyDecimals ()

	getSku ($product)

	getOptionSku ($product, $sku='')

	getWeight ($product)

	hasOptions ($product)

	updateQtyOption ($options, \Magento\Framework\DataObject $option, $value, $product)

	hasRequiredOptions ($product)

	getStoreFilter ($product)

	setStoreFilter ($store, $product)

	getForceChildItemQtyChanges ($product)

	prepareQuoteItemQty ($qty, $product)

	assignProductToOption ($optionProduct, $option, $product)

	setConfig ($config)

	getSearchableData ($product)

	getProductsToPurchaseByReqGroups ($product)

	processBuyRequest ($product, $buyRequest)

	checkProductConfiguration ($product, $buyRequest)

	hasWeight ()

	setImageFromChildProduct (\Magento\Catalog\Model\Product $product)

	getIdentities (\Magento\Catalog\Model\Product $product)

	getAssociatedProducts ($product)

	isPossibleBuyFromList ($product)

Data Fields
const	TYPE_CODE = 'grouped'

Data Fields inherited from AbstractType
const	CALCULATE_CHILD = 0

const	CALCULATE_PARENT = 1

const	SHIPMENT_SEPARATELY = 1

const	SHIPMENT_TOGETHER = 0

const	PROCESS_MODE_FULL = 'full'

const	PROCESS_MODE_LITE = 'lite'

const	OPTION_PREFIX = 'option_'

Protected Member Functions
	getProductInfo (\Magento\Framework\DataObject $buyRequest, $product, $isStrictProcessMode)

	_prepareProduct (\Magento\Framework\DataObject $buyRequest, $product, $processMode)

Protected Member Functions inherited from AbstractType
	_isStrictProcessMode ($processMode)

	_prepareOptions (\Magento\Framework\DataObject $buyRequest, $product, $processMode)

	_removeNotApplicableAttributes ($product)

Protected Attributes
	$_keyAssociatedProducts = '_cache_instance_associated_products'

	$_keyAssociatedProductIds = '_cache_instance_associated_product_ids'

	$_keyStatusFilters = '_cache_instance_status_filters'

	$_isComposite = true

	$_canConfigure = true

	$_catalogProductStatus

	$_storeManager

	$productLinks

	$_appState

	$msrpData

Protected Attributes inherited from AbstractType
	$_typeId

	$_editableAttributes

	$_isComposite = false

	$_canConfigure = false

	$_canUseQtyDecimals = true

	$_fileQueue = []

	$_filesystem

	$_fileStorageDb

	$_cacheProductSetAttributes = '_cache_instance_product_set_attributes'

	$_coreRegistry

	$_eventManager

	$_logger

	$_catalogProductType

	$_eavConfig

	$_catalogProductOption

	$productRepository

	$serializer

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 17 of file Grouped.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Model\Product\Option	$catalogProductOption,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Catalog\Model\Product\Type	$catalogProductType,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Registry	$coreRegistry,
		\Psr\Log\LoggerInterface	$logger,
		ProductRepositoryInterface	$productRepository,
		\Magento\GroupedProduct\Model\ResourceModel\Product\Link	$catalogProductLink,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Model\Product\Attribute\Source\Status	$catalogProductStatus,
		\Magento\Framework\App\State	$appState,
		\Magento\Msrp\Helper\Data	$msrpData,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = `null`
	)

Parameters

\Magento\Catalog\Model\Product\Option	$catalogProductOption
\Magento\Eav\Model\Config	$eavConfig
\Magento\Catalog\Model\Product\Type	$catalogProductType
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Registry	$coreRegistry
\Psr\Log\LoggerInterface	$logger
ProductRepositoryInterface	$productRepository
\Magento\GroupedProduct\Model\ResourceModel\Product\Link	$catalogProductLink
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Model\Product\Attribute\Source\Status	$catalogProductStatus
\Magento\Framework\App\State	$appState
\Magento\Msrp\Helper\Data	$msrpData
\Magento\Framework\Serialize\Serializer\Json \| null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 105 of file Grouped.php.

       {
         $this->productLinks = $catalogProductLink;
         $this->_storeManager = $storeManager;
         $this->_catalogProductStatus = $catalogProductStatus;
         $this->_appState = $appState;
         $this->msrpData = $msrpData;
         parent::__construct(
             $catalogProductOption,
             $eavConfig,
             $catalogProductType,
             $eventManager,
             $fileStorageDb,
             $filesystem,
             $coreRegistry,
             $logger,
             $productRepository,
             $serializer
         );
     }

Member Function Documentation

◆ _prepareProduct()

_prepareProduct	(	\Magento\Framework\DataObject	$buyRequest,
			$product,
			$processMode
	)

protected

Prepare product and its configuration to be added to some products list. Perform standard preparation process and add logic specific to Grouped product type.

Parameters

\Magento\Framework\DataObject	$buyRequest
\Magento\Catalog\Model\Product	$product
string	$processMode

Returns: \Magento\Framework\Phrase|array|string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 362 of file Grouped.php.

     {
         $products = [];
         $associatedProductsInfo = [];
         $isStrictProcessMode = $this->_isStrictProcessMode($processMode);
         $productsInfo = $this->getProductInfo($buyRequest, $product, $isStrictProcessMode);
         if (is_string($productsInfo)) {
             return $productsInfo;
         }
         $associatedProducts = !$isStrictProcessMode || !empty($productsInfo)
             ? $this->getAssociatedProducts($product)
             : false;
 
         foreach ($associatedProducts as $subProduct) {
             $qty = $productsInfo[$subProduct->getId()];
             if (!is_numeric($qty) || empty($qty)) {
                 continue;
             }
 
             $_result = $subProduct->getTypeInstance()->_prepareProduct($buyRequest, $subProduct, $processMode);
 
             if (is_string($_result)) {
                 return $_result;
             } elseif (!isset($_result[0])) {
                 return __('Cannot process the item.')->render();
             }
 
             if ($isStrictProcessMode) {
                 $_result[0]->setCartQty($qty);
                 $_result[0]->addCustomOption('product_type', self::TYPE_CODE, $product);
                 $_result[0]->addCustomOption(
                     'info_buyRequest',
                     $this->serializer->serialize(
                         [
                             'super_product_config' => [
                                 'product_type' => self::TYPE_CODE,
                                 'product_id' => $product->getId(),
                             ],
                         ]
                     )
                 );
                 $products[] = $_result[0];
             } else {
                 $associatedProductsInfo[] = [$subProduct->getId() => $qty];
                 $product->addCustomOption('associated_product_' . $subProduct->getId(), $qty);
             }
         }
 
         if (!$isStrictProcessMode || count($associatedProductsInfo)) {
             $product->addCustomOption('product_type', self::TYPE_CODE, $product);
             $product->addCustomOption('info_buyRequest', $this->serializer->serialize($buyRequest->getData()));
 
             $products[] = $product;
         }
 
         if (count($products)) {
             return $products;
         }
 
         return __('Please specify the quantity of product(s).')->render();
     }

◆ addStatusFilter()

addStatusFilter	(	$status,
		$product
	)

Add status filter to collection

Parameters

int	$status
\Magento\Catalog\Model\Product	$product

Returns: $this

Definition at line 245 of file Grouped.php.

     {
         $statusFilters = $product->getData($this->_keyStatusFilters);
         if (!is_array($statusFilters)) {
             $statusFilters = [];
         }
 
         $statusFilters[] = $status;
         $product->setData($this->_keyStatusFilters, $statusFilters);
 
         return $this;
     }

◆ beforeSave()

beforeSave ( $product )

{}

Definition at line 478 of file Grouped.php.

     {
         //clear cached associated links
         $product->unsetData($this->_keyAssociatedProducts);
         if ($product->hasData('product_options') && !empty($product->getData('product_options'))) {
             throw new \Exception('Custom options for grouped product type are not supported');
         }
         return parent::beforeSave($product);
     }

◆ deleteTypeSpecificData()

deleteTypeSpecificData ( \Magento\Catalog\Model\Product $product )

Delete data specific for Grouped product type

Parameters

\Magento\Catalog\Model\Product $product

Returns: void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 471 of file Grouped.php.

472 {

473 }

◆ flushAssociatedProductsCache()

flushAssociatedProductsCache ( $product )

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Catalog\Model\Product

Since: 100.1.0

Definition at line 233 of file Grouped.php.

     {
         return $product->unsData($this->_keyAssociatedProducts);
     }

◆ getAssociatedProducts()

getAssociatedProducts ( $product )

Retrieve array of associated products

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Definition at line 201 of file Grouped.php.

     {
         if (!$product->hasData($this->_keyAssociatedProducts)) {
             $associatedProducts = [];
 
             $this->setSaleableStatus($product);
 
             $collection = $this->getAssociatedProductCollection(
                 $product
             )->addAttributeToSelect(
                 ['name', 'price', 'special_price', 'special_from_date', 'special_to_date', 'tax_class_id']
             )->addFilterByRequiredOptions()->setPositionOrder()->addStoreFilter(
                 $this->getStoreFilter($product)
             )->addAttributeToFilter(
                 'status',
                 ['in' => $this->getStatusFilters($product)]
             );
 
             foreach ($collection as $item) {
                 $associatedProducts[] = $item;
             }
 
             $product->setData($this->_keyAssociatedProducts, $associatedProducts);
         }
         return $product->getData($this->_keyAssociatedProducts);
     }

◆ getChildrenIds()

getChildrenIds	(	$parentId,
		$required = `true`
	)

Retrieve Required children ids Return grouped array, ex array( group => array(ids) )

Parameters

int	$parentId
bool	$required

Returns: array

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 173 of file Grouped.php.

     {
         return $this->productLinks->getChildrenIds(
             $parentId,
             \Magento\GroupedProduct\Model\ResourceModel\Product\Link::LINK_TYPE_GROUPED
         );
     }

◆ getChildrenMsrp()

getChildrenMsrp ( \Magento\Catalog\Model\Product $product )

Parameters

\Magento\Catalog\Model\Product $product

Returns: int

Definition at line 492 of file Grouped.php.

     {
         $prices = [];
         foreach ($this->getAssociatedProducts($product) as $item) {
             if ($item->getMsrp() !== null) {
                 $prices[] = $item->getMsrp();
             }
         }
         return $prices ? min($prices) : 0;
     }

◆ getParentIdsByChild()

getParentIdsByChild ( $childId )

Retrieve parent ids array by requested child

Parameters

int | array $childId

Returns: array

Definition at line 187 of file Grouped.php.

     {
         return $this->productLinks->getParentIdsByChild(
             $childId,
             \Magento\GroupedProduct\Model\ResourceModel\Product\Link::LINK_TYPE_GROUPED
         );
     }

◆ getProductInfo()

getProductInfo	(	\Magento\Framework\DataObject	$buyRequest,
			$product,
			$isStrictProcessMode
	)

protected

Parameters

\Magento\Framework\DataObject	$buyRequest
\Magento\Catalog\Model\Product	$product
bool	$isStrictProcessMode

Returns: array|string

Definition at line 331 of file Grouped.php.

     {
         $productsInfo = $buyRequest->getSuperGroup() ?: [];
         $associatedProducts = $this->getAssociatedProducts($product);
 
         if (!is_array($productsInfo)) {
             return __('Please specify the quantity of product(s).')->render();
         }
         foreach ($associatedProducts as $subProduct) {
             if (!isset($productsInfo[$subProduct->getId()])) {
                 if ($isStrictProcessMode && !$subProduct->getQty()) {
                     return __('Please specify the quantity of product(s).')->render();
                 }
                 $productsInfo[$subProduct->getId()] = intval($subProduct->getQty());
             }
         }
 
         return $productsInfo;
     }

◆ getProductsToPurchaseByReqGroups()

getProductsToPurchaseByReqGroups ( $product )

Retrieve products divided into groups required to purchase At least one product in each group has to be purchased

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Definition at line 431 of file Grouped.php.

     {
         return [$this->getAssociatedProducts($product)];
     }

◆ getRelationInfo()

getRelationInfo ( )

Return relation info about used products

Returns: \Magento\Framework\DataObject Object with information data

Definition at line 146 of file Grouped.php.

     {
         $info = new \Magento\Framework\DataObject();
         $info->setTable(
             'catalog_product_link'
         )->setParentFieldName(
             'product_id'
         )->setChildFieldName(
             'linked_product_id'
         )->setWhere(
             'link_type_id=' . \Magento\GroupedProduct\Model\ResourceModel\Product\Link::LINK_TYPE_GROUPED
         );
         return $info;
     }

◆ getStatusFilters()

getStatusFilters ( $product )

Return all assigned status filters

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Definition at line 276 of file Grouped.php.

     {
         if (!$product->hasData($this->_keyStatusFilters)) {
             return [
                 \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_ENABLED,
                 \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_DISABLED,
             ];
         }
         return $product->getData($this->_keyStatusFilters);
     }

◆ hasWeight()

hasWeight ( )

Check that product of this type has weight

Returns: bool

Definition at line 459 of file Grouped.php.

     {
         return false;
     }

◆ processBuyRequest()

processBuyRequest	(	$product,
		$buyRequest
	)

Prepare selected qty for grouped product's options

Parameters

\Magento\Catalog\Model\Product	$product
\Magento\Framework\DataObject	$buyRequest

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 444 of file Grouped.php.

     {
         $superGroup = $buyRequest->getSuperGroup();
         $superGroup = is_array($superGroup) ? array_filter($superGroup, 'intval') : [];
 
         $options = ['super_group' => $superGroup];
 
         return $options;
     }

◆ setSaleableStatus()

setSaleableStatus ( $product )

Set only saleable filter

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Definition at line 264 of file Grouped.php.

     {
         $product->setData($this->_keyStatusFilters, $this->_catalogProductStatus->getSaleableStatusIds());
         return $this;
     }

Field Documentation

◆ $_appState

$_appState

protected

Definition at line 80 of file Grouped.php.

◆ $_canConfigure

$_canConfigure = true

protected

Definition at line 54 of file Grouped.php.

◆ $_catalogProductStatus

$_catalogProductStatus

protected

Definition at line 61 of file Grouped.php.

◆ $_isComposite

$_isComposite = true

protected

Definition at line 47 of file Grouped.php.

◆ $_keyAssociatedProductIds

$_keyAssociatedProductIds = '_cache_instance_associated_product_ids'

protected

Definition at line 33 of file Grouped.php.

◆ $_keyAssociatedProducts

$_keyAssociatedProducts = '_cache_instance_associated_products'

protected

Definition at line 26 of file Grouped.php.

◆ $_keyStatusFilters

$_keyStatusFilters = '_cache_instance_status_filters'

protected

Definition at line 40 of file Grouped.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 68 of file Grouped.php.

◆ $msrpData

$msrpData

protected

Definition at line 85 of file Grouped.php.

◆ $productLinks

$productLinks

protected

Definition at line 75 of file Grouped.php.

◆ TYPE_CODE

const TYPE_CODE = 'grouped'

Definition at line 19 of file Grouped.php.

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

vendor/magento/module-grouped-product/Model/Product/Type/Grouped.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _prepareProduct()

◆ addStatusFilter()

◆ beforeSave()

◆ deleteTypeSpecificData()

◆ flushAssociatedProductsCache()

◆ getAssociatedProducts()

◆ getChildrenIds()

◆ getChildrenMsrp()

◆ getParentIdsByChild()

◆ getProductInfo()

◆ getProductsToPurchaseByReqGroups()

◆ getRelationInfo()

◆ getStatusFilters()

◆ hasWeight()

◆ processBuyRequest()

◆ setSaleableStatus()

Field Documentation

◆ $_appState

◆ $_canConfigure

◆ $_catalogProductStatus

◆ $_isComposite

◆ $_keyAssociatedProductIds

◆ $_keyAssociatedProducts

◆ $_keyStatusFilters

◆ $_storeManager

◆ $msrpData

◆ $productLinks

◆ TYPE_CODE