Inheritance diagram for Type:

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\Catalog\Helper\Product $catalogProduct, \Magento\Catalog\Helper\Data $catalogData, \Magento\Bundle\Model\SelectionFactory $bundleModelSelection, \Magento\Bundle\Model\ResourceModel\BundleFactory $bundleFactory, \Magento\Bundle\Model\ResourceModel\Selection\CollectionFactory $bundleCollection, \Magento\Catalog\Model\Config $config, \Magento\Bundle\Model\ResourceModel\Selection $bundleSelection, \Magento\Bundle\Model\OptionFactory $bundleOption, \Magento\Store\Model\StoreManagerInterface $storeManager, PriceCurrencyInterface $priceCurrency, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, \Magento\CatalogInventory\Api\StockStateInterface $stockState, Json $serializer=null, MetadataPool $metadataPool=null, SelectionCollectionFilterApplier $selectionCollectionFilterApplier=null)

	getRelationInfo ()

	getChildrenIds ($parentId, $required=true)

	getParentIdsByChild ($childId)

	getSku ($product)

	getWeight ($product)

	isVirtual ($product)

	beforeSave ($product)

	getOptions ($product)

	getOptionsIds ($product)

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

	prepareQuoteItemQty ($qty, $product)

	isSalable ($product)

	getSpecifyOptionMessage ()

	getOptionsByIds ($optionIds, $product)

	getOrderOptions ($product)

	shakeSelections ($firstItem, $secondItem)

	hasOptions ($product)

	getForceChildItemQtyChanges ($product)

	getSearchableData ($product)

	checkProductBuyState ($product)

	getProductsToPurchaseByReqGroups ($product)

	processBuyRequest ($product, $buyRequest)

	canConfigure ($product)

	deleteTypeSpecificData (\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 = 'bundle'

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
	_prepareProduct (\Magento\Framework\DataObject $buyRequest, $product, $processMode)

	getQty ($selection, $qtys, $selectionOptionId)

	getBeforeQty ($product, $selection)

	checkIsAllRequiredOptions ($product, $isStrictProcessMode, $optionsCollection, $options)

	checkSelectionsIsSale ($selections, $skipSaleableCheck, $optionsCollection, $options)

	checkIsResult ($_result)

	mergeSelectionsWithOptions ($options, $selections)

Protected Member Functions inherited from AbstractType
	_isStrictProcessMode ($processMode)

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

	_removeNotApplicableAttributes ($product)

Protected Attributes
	$_isComposite = true

	$_keyOptionsCollection = '_cache_instance_options_collection'

	$_keySelectionsCollection = '_cache_instance_selections_collection'

	$_keyUsedSelections = '_cache_instance_used_selections'

	$_keyUsedSelectionsIds = '_cache_instance_used_selections_ids'

	$_keyUsedOptions = '_cache_instance_used_options'

	$_keyUsedOptionsIds = '_cache_instance_used_options_ids'

	$_canConfigure = true

	$_catalogData = null

	$_catalogProduct = null

	$_storeManager

	$_bundleOption

	$_bundleSelection

	$_config

	$_bundleCollection

	$_bundleFactory

	$_bundleModelSelection

	$priceCurrency

	$_stockRegistry

	$_stockState

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

Bundle Type Model @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 25 of file Type.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\Catalog\Helper\Product	$catalogProduct,
		\Magento\Catalog\Helper\Data	$catalogData,
		\Magento\Bundle\Model\SelectionFactory	$bundleModelSelection,
		\Magento\Bundle\Model\ResourceModel\BundleFactory	$bundleFactory,
		\Magento\Bundle\Model\ResourceModel\Selection\CollectionFactory	$bundleCollection,
		\Magento\Catalog\Model\Config	$config,
		\Magento\Bundle\Model\ResourceModel\Selection	$bundleSelection,
		\Magento\Bundle\Model\OptionFactory	$bundleOption,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		PriceCurrencyInterface	$priceCurrency,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		\Magento\CatalogInventory\Api\StockStateInterface	$stockState,
		Json	$serializer = `null`,
		MetadataPool	$metadataPool = `null`,
		SelectionCollectionFilterApplier	$selectionCollectionFilterApplier = `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\Catalog\Helper\Product	$catalogProduct
\Magento\Catalog\Helper\Data	$catalogData
\Magento\Bundle\Model\SelectionFactory	$bundleModelSelection
\Magento\Bundle\Model\ResourceModel\BundleFactory	$bundleFactory
\Magento\Bundle\Model\ResourceModel\Selection\CollectionFactory	$bundleCollection
\Magento\Catalog\Model\Config	$config
\Magento\Bundle\Model\ResourceModel\Selection	$bundleSelection
\Magento\Bundle\Model\OptionFactory	$bundleOption
\Magento\Store\Model\StoreManagerInterface	$storeManager
PriceCurrencyInterface	$priceCurrency
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
\Magento\CatalogInventory\Api\StockStateInterface	$stockState
\Magento\Framework\Serialize\Serializer\Json	$serializer
MetadataPool \| null	$metadataPool
SelectionCollectionFilterApplier \| null	$selectionCollectionFilterApplier	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 191 of file Type.php.

       {
         $this->_catalogProduct = $catalogProduct;
         $this->_catalogData = $catalogData;
         $this->_storeManager = $storeManager;
         $this->_bundleOption = $bundleOption;
         $this->_bundleSelection = $bundleSelection;
         $this->_config = $config;
         $this->_bundleCollection = $bundleCollection;
         $this->_bundleFactory = $bundleFactory;
         $this->_bundleModelSelection = $bundleModelSelection;
         $this->priceCurrency = $priceCurrency;
         $this->_stockRegistry = $stockRegistry;
         $this->_stockState = $stockState;
 
         $this->metadataPool = $metadataPool
             ?: ObjectManager::getInstance()->get(MetadataPool::class);
 
         $this->selectionCollectionFilterApplier = $selectionCollectionFilterApplier
             ?: ObjectManager::getInstance()->get(SelectionCollectionFilterApplier::class);
 
         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 then prepare of bundle selections options.

Parameters

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

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

Definition at line 638 of file Type.php.

     {
         $result = parent::_prepareProduct($buyRequest, $product, $processMode);
 
         try {
             if (is_string($result)) {
                 throw new \Magento\Framework\Exception\LocalizedException(__($result));
             }
 
             $selections = [];
             $isStrictProcessMode = $this->_isStrictProcessMode($processMode);
 
             $skipSaleableCheck = $this->_catalogProduct->getSkipSaleableCheck();
             $_appendAllSelections = (bool)$product->getSkipCheckRequiredOption() || $skipSaleableCheck;
 
             $options = $buyRequest->getBundleOption();
             if (is_array($options)) {
                 $options = $this->recursiveIntval($options);
                 $optionIds = array_keys($options);
 
                 if (empty($optionIds) && $isStrictProcessMode) {
                     throw new \Magento\Framework\Exception\LocalizedException(__('Please specify product option(s).'));
                 }
 
                 $product->getTypeInstance()
                     ->setStoreFilter($product->getStoreId(), $product);
                 $optionsCollection = $this->getOptionsCollection($product);
                 $this->checkIsAllRequiredOptions(
                     $product,
                     $isStrictProcessMode,
                     $optionsCollection,
                     $options
                 );
 
                 $selectionIds = $this->multiToFlatArray($options);
                 // If product has not been configured yet then $selections array should be empty
                 if (!empty($selectionIds)) {
                     $selections = $this->getSelectionsByIds($selectionIds, $product);
 
                     if (count($selections->getItems()) !== count($selectionIds)) {
                         throw new \Magento\Framework\Exception\LocalizedException(
                             __('The options you selected are not available.')
                         );
                     }
 
                     // Check if added selections are still on sale
                     $this->checkSelectionsIsSale(
                         $selections,
                         $skipSaleableCheck,
                         $optionsCollection,
                         $options
                     );
 
                     $optionsCollection->appendSelections($selections, true, $_appendAllSelections);
 
                     $selections = $selections->getItems();
                 } else {
                     $selections = [];
                 }
             } else {
                 $product->setOptionsValidationFail(true);
                 $product->getTypeInstance()
                     ->setStoreFilter($product->getStoreId(), $product);
 
                 $optionCollection = $product->getTypeInstance()
                     ->getOptionsCollection($product);
                 $optionIds = $product->getTypeInstance()
                     ->getOptionsIds($product);
                 $selectionCollection = $product->getTypeInstance()
                     ->getSelectionsCollection($optionIds, $product);
                 $options = $optionCollection->appendSelections($selectionCollection, true, $_appendAllSelections);
 
                 $selections = $this->mergeSelectionsWithOptions($options, $selections);
             }
             if ((is_array($selections) && count($selections) > 0) || !$isStrictProcessMode) {
                 $uniqueKey = [$product->getId()];
                 $selectionIds = [];
                 $qtys = $buyRequest->getBundleOptionQty();
 
                 // Shuffle selection array by option position
                 usort($selections, [$this, 'shakeSelections']);
 
                 foreach ($selections as $selection) {
                     $selectionOptionId = $selection->getOptionId();
                     $qty = $this->getQty($selection, $qtys, $selectionOptionId);
 
                     $selectionId = $selection->getSelectionId();
                     $product->addCustomOption('selection_qty_' . $selectionId, $qty, $selection);
                     $selection->addCustomOption('selection_id', $selectionId);
 
                     $beforeQty = $this->getBeforeQty($product, $selection);
                     $product->addCustomOption('product_qty_' . $selection->getId(), $qty + $beforeQty, $selection);
 
                     /*
                      * Create extra attributes that will be converted to product options in order item
                      * for selection (not for all bundle)
                      */
                     $price = $product->getPriceModel()
                         ->getSelectionFinalTotalPrice($product, $selection, 0, $qty);
                     $attributes = [
                         'price' => $this->priceCurrency->convert($price),
                         'qty' => $qty,
                         'option_label' => $selection->getOption()
                             ->getTitle(),
                         'option_id' => $selection->getOption()
                             ->getId(),
                     ];
 
                     $_result = $selection->getTypeInstance()
                         ->prepareForCart($buyRequest, $selection);
                     $this->checkIsResult($_result);
 
                     $result[] = $_result[0]->setParentProductId($product->getId())
                         ->addCustomOption(
                             'bundle_option_ids',
                             $this->serializer->serialize(array_map('intval', $optionIds))
                         )
                         ->addCustomOption(
                             'bundle_selection_attributes',
                             $this->serializer->serialize($attributes)
                         );
 
                     if ($isStrictProcessMode) {
                         $_result[0]->setCartQty($qty);
                     }
 
                     $resultSelectionId = $_result[0]->getSelectionId();
                     $selectionIds[] = $resultSelectionId;
                     $uniqueKey[] = $resultSelectionId;
                     $uniqueKey[] = $qty;
                 }
 
                 // "unique" key for bundle selection and add it to selections and bundle for selections
                 $uniqueKey = implode('_', $uniqueKey);
                 foreach ($result as $item) {
                     $item->addCustomOption('bundle_identity', $uniqueKey);
                 }
                 $product->addCustomOption(
                     'bundle_option_ids',
                     $this->serializer->serialize(
                         array_map('intval', $optionIds)
                     )
                 );
                 $product->addCustomOption('bundle_selection_ids', $this->serializer->serialize($selectionIds));
 
                 return $result;
             }
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             return $e->getMessage();
         }
 
         return $this->getSpecifyOptionMessage();
     }

◆ beforeSave()

beforeSave ( $product )

Before save type related data

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this|void @SuppressWarnings(PHPMD.CyclomaticComplexity)

unset product custom options for dynamic price

Definition at line 384 of file Type.php.

     {
         parent::beforeSave($product);
 
         // If bundle product has dynamic weight, than delete weight attribute
         if (!$product->getData('weight_type') && $product->hasData('weight')) {
             $product->setData('weight', false);
         }
 
         if ($product->getPriceType() == Price::PRICE_TYPE_DYNAMIC) {
             if ($product->hasData('product_options')) {
                 $product->unsetData('product_options');
             }
         }
 
         $product->canAffectOptions(false);
 
         if ($product->getCanSaveBundleSelections()) {
             $product->canAffectOptions(true);
             $selections = $product->getBundleSelectionsData();
             if ($selections && !empty($selections)) {
                 $options = $product->getBundleOptionsData();
                 if ($options) {
                     foreach ($options as $option) {
                         if (empty($option['delete']) || 1 != (int)$option['delete']) {
                             $product->setTypeHasOptions(true);
                             if (1 == (int)$option['required']) {
                                 $product->setTypeHasRequiredOptions(true);
                                 break;
                             }
                         }
                     }
                 }
             }
         }
     }

◆ canConfigure()

canConfigure ( $product )

Check if product can be configured

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 1176 of file Type.php.

     {
         return $product instanceof \Magento\Catalog\Model\Product && $product->isAvailable() && parent::canConfigure(
             $product
         );
     }

◆ checkIsAllRequiredOptions()

checkIsAllRequiredOptions	(	$product,
		$isStrictProcessMode,
		$optionsCollection,
		$options
	)

protected

Parameters

\Magento\Catalog\Model\Product	$product
bool	$isStrictProcessMode
\Magento\Bundle\Model\ResourceModel\Option\Collection	$optionsCollection
	int[]	$options

Returns: void

Exceptions

Definition at line 1259 of file Type.php.

     {
         if (!$product->getSkipCheckRequiredOption() && $isStrictProcessMode) {
             foreach ($optionsCollection->getItems() as $option) {
                 if ($option->getRequired() && !isset($options[$option->getId()])) {
                     throw new \Magento\Framework\Exception\LocalizedException(
                         __('Please select all required options.')
                     );
                 }
             }
         }
     }

◆ checkIsResult()

checkIsResult ( $_result )

protected

Parameters

array $_result

Returns: void

Exceptions

Definition at line 1307 of file Type.php.

     {
         if (is_string($_result)) {
             throw new \Magento\Framework\Exception\LocalizedException(__($_result));
         }
 
         if (!isset($_result[0])) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('We can\'t add this item to your shopping cart right now.')
             );
         }
     }

◆ checkProductBuyState()

checkProductBuyState ( $product )

Check if product can be bought

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Exceptions

Definition at line 1081 of file Type.php.

     {
         parent::checkProductBuyState($product);
         $productOptionIds = $this->getOptionsIds($product);
         $productSelections = $this->getSelectionsCollection($productOptionIds, $product);
         $selectionIds = $product->getCustomOption('bundle_selection_ids');
         $selectionIds = $this->serializer->unserialize($selectionIds->getValue());
         $buyRequest = $product->getCustomOption('info_buyRequest');
         $buyRequest = new \Magento\Framework\DataObject($this->serializer->unserialize($buyRequest->getValue()));
         $bundleOption = $buyRequest->getBundleOption();
 
         if (empty($bundleOption)) {
             throw new \Magento\Framework\Exception\LocalizedException($this->getSpecifyOptionMessage());
         }
 
         $skipSaleableCheck = $this->_catalogProduct->getSkipSaleableCheck();
         foreach ($selectionIds as $selectionId) {
             /* @var $selection \Magento\Bundle\Model\Selection */
             $selection = $productSelections->getItemById($selectionId);
             if (!$selection || !$selection->isSalable() && !$skipSaleableCheck) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('The required options you selected are not available.')
                 );
             }
         }
 
         $product->getTypeInstance()
             ->setStoreFilter($product->getStoreId(), $product);
         $optionsCollection = $this->getOptionsCollection($product);
         foreach ($optionsCollection->getItems() as $option) {
             if ($option->getRequired() && empty($bundleOption[$option->getId()])) {
                 throw new \Magento\Framework\Exception\LocalizedException(__('Please select all required options.'));
             }
         }
 
         return $this;
     }

◆ checkSelectionsIsSale()

checkSelectionsIsSale	(	$selections,
		$skipSaleableCheck,
		$optionsCollection,
		$options
	)

protected

Parameters

\Magento\Bundle\Model\ResourceModel\Selection\Collection	$selections
bool	$skipSaleableCheck
\Magento\Bundle\Model\ResourceModel\Option\Collection	$optionsCollection
	int[]	$options

Returns: void

Exceptions

Definition at line 1280 of file Type.php.

     {
         foreach ($selections->getItems() as $selection) {
             if (!$selection->isSalable() && !$skipSaleableCheck) {
                 $_option = $optionsCollection->getItemById($selection->getOptionId());
                 $optionId = $_option->getId();
                 if (is_array($options[$optionId]) && count($options[$optionId]) > 1) {
                     $moreSelections = true;
                 } else {
                     $moreSelections = false;
                 }
                 $isMultiSelection = $_option->isMultiSelection();
                 if ($_option->getRequired() && (!$isMultiSelection || !$moreSelections)
                 ) {
                     throw new \Magento\Framework\Exception\LocalizedException(
                         __('The required options you selected are not available.')
                     );
                 }
             }
         }
     }

◆ deleteTypeSpecificData()

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

Delete data specific for Bundle product type

Parameters

\Magento\Catalog\Model\Product $product

Returns: void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1190 of file Type.php.

1191 {

1192 }

◆ getBeforeQty()

getBeforeQty	(	$product,
		$selection
	)

protected

Parameters

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

Returns: float|int

Definition at line 1239 of file Type.php.

     {
         $beforeQty = 0;
         $customOption = $product->getCustomOption('product_qty_' . $selection->getId());
         if ($customOption && $customOption->getProduct()->getId() == $selection->getId()) {
             $beforeQty = (float)$customOption->getValue();
             return $beforeQty;
         }
 
         return $beforeQty;
     }

◆ getChildrenIds()

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

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

Parameters

int	$parentId
bool	$required

Returns: array

Definition at line 275 of file Type.php.

     {
         return $this->_bundleSelection->getChildrenIds($parentId, $required);
     }

◆ getForceChildItemQtyChanges()

getForceChildItemQtyChanges ( $product )

Allow for updates of children qty's

Parameters

\Magento\Catalog\Model\Product $product

Returns: boolean true @SuppressWarnings(PHPMD.BooleanGetMethodName) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1046 of file Type.php.

     {
         return true;
     }

◆ getOptions()

getOptions ( $product )

Retrieve bundle options items

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Framework\DataObject[]

Definition at line 428 of file Type.php.

     {
         return $this->getOptionsCollection($product)
             ->getItems();
     }

◆ getOptionsByIds()

getOptionsByIds	(	$optionIds,
		$product
	)

Retrieve bundle options collection based on ids

Parameters

array	$optionIds
\Magento\Catalog\Model\Product	$product

Returns: \Magento\Bundle\Model\ResourceModel\Option\Collection

Definition at line 895 of file Type.php.

     {
         sort($optionIds);
 
         $usedOptions = $product->getData($this->_keyUsedOptions);
         $usedOptionsIds = $product->getData($this->_keyUsedOptionsIds);
 
         if (!$usedOptions
             || $this->serializer->serialize($usedOptionsIds) != $this->serializer->serialize($optionIds)
         ) {
             $usedOptions = $this->_bundleOption
                 ->create()
                 ->getResourceCollection()
                 ->setProductIdFilter($product->getId())
                 ->setPositionOrder()
                 ->joinValues(
                     $this->_storeManager->getStore()
                         ->getId()
                 )
                 ->setIdFilter($optionIds);
             $product->setData($this->_keyUsedOptions, $usedOptions);
             $product->setData($this->_keyUsedOptionsIds, $optionIds);
         }
 
         return $usedOptions;
     }

◆ getOptionsIds()

getOptionsIds ( $product )

Retrieve bundle options ids

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Definition at line 440 of file Type.php.

     {
         return $this->getOptionsCollection($product)
             ->getAllIds();
     }

◆ getOrderOptions()

getOrderOptions ( $product )

Prepare additional options/information for order item which will be created from this product

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Product Prices calculations save

Definition at line 929 of file Type.php.

     {
         $optionArr = parent::getOrderOptions($product);
         $bundleOptions = [];
 
         if ($product->hasCustomOptions()) {
             $customOption = $product->getCustomOption('bundle_option_ids');
             $optionIds = $this->serializer->unserialize($customOption->getValue());
             $options = $this->getOptionsByIds($optionIds, $product);
             $customOption = $product->getCustomOption('bundle_selection_ids');
             $selectionIds = $this->serializer->unserialize($customOption->getValue());
             $selections = $this->getSelectionsByIds($selectionIds, $product);
             foreach ($selections->getItems() as $selection) {
                 if ($selection->isSalable()) {
                     $selectionQty = $product->getCustomOption('selection_qty_' . $selection->getSelectionId());
                     if ($selectionQty) {
                         $price = $product->getPriceModel()
                             ->getSelectionFinalTotalPrice(
                                 $product,
                                 $selection,
                                 0,
                                 $selectionQty->getValue()
                             );
 
                         $option = $options->getItemById($selection->getOptionId());
                         if (!isset($bundleOptions[$option->getId()])) {
                             $bundleOptions[$option->getId()] = [
                                 'option_id' => $option->getId(),
                                 'label' => $option->getTitle(),
                                 'value' => [],
                             ];
                         }
 
                         $bundleOptions[$option->getId()]['value'][] = [
                             'title' => $selection->getName(),
                             'qty' => $selectionQty->getValue(),
                             'price' => $this->priceCurrency->convert($price),
                         ];
                     }
                 }
             }
         }
 
         $optionArr['bundle_options'] = $bundleOptions;
 
         if ($product->getPriceType()) {
             $optionArr['product_calculations'] = self::CALCULATE_PARENT;
         } else {
             $optionArr['product_calculations'] = self::CALCULATE_CHILD;
         }
 
         $optionArr['shipment_type'] = $product->getShipmentType();
 
         return $optionArr;
     }

◆ getParentIdsByChild()

getParentIdsByChild ( $childId )

Retrieve parent ids array by required child

Parameters

int | array $childId

Returns: array

Definition at line 286 of file Type.php.

     {
         return $this->_bundleSelection->getParentIdsByChild($childId);
     }

◆ 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 1126 of file Type.php.

     {
         $groups = [];
         $allProducts = [];
         $hasRequiredOptions = false;
         foreach ($this->getOptions($product) as $option) {
             $groupProducts = [];
             foreach ($this->getSelectionsCollection([$option->getId()], $product) as $childProduct) {
                 $groupProducts[] = $childProduct;
                 $allProducts[] = $childProduct;
             }
             if ($option->getRequired()) {
                 $groups[] = $groupProducts;
                 $hasRequiredOptions = true;
             }
         }
         if (!$hasRequiredOptions) {
             $groups = [$allProducts];
         }
 
         return $groups;
     }

◆ getQty()

getQty	(	$selection,
		$qtys,
		$selectionOptionId
	)

protected

Parameters

\Magento\Framework\DataObject	$selection
	int[]	$qtys
int	$selectionOptionId

Returns: float

Definition at line 1222 of file Type.php.

     {
         if ($selection->getSelectionCanChangeQty() && isset($qtys[$selectionOptionId])) {
             $qty = (float)$qtys[$selectionOptionId] > 0 ? $qtys[$selectionOptionId] : 1;
         } else {
             $qty = (float)$selection->getSelectionQty() ? $selection->getSelectionQty() : 1;
         }
         $qty = (float)$qty;
 
         return $qty;
     }

◆ getRelationInfo()

getRelationInfo ( )

Return relation info about used products

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

Definition at line 255 of file Type.php.

     {
         $info = new \Magento\Framework\DataObject();
         $info->setTable('catalog_product_bundle_selection')
             ->setParentFieldName('parent_product_id')
             ->setChildFieldName('product_id');
 
         return $info;
     }

◆ getSearchableData()

getSearchableData ( $product )

Retrieve additional searchable data from type instance Using based on product id and store_id data

Parameters

\Magento\Catalog\Model\Product $product

Returns: array

Definition at line 1058 of file Type.php.

     {
         $searchData = parent::getSearchableData($product);
 
         $optionSearchData = $this->_bundleOption->create()
             ->getSearchableData(
                 $product->getId(),
                 $product->getStoreId()
             );
         if ($optionSearchData) {
             $searchData = array_merge($searchData, $optionSearchData);
         }
 
         return $searchData;
     }

◆ getSku()

getSku ( $product )

Return product sku based on sku_type attribute

Parameters

\Magento\Catalog\Model\Product $product

Returns: string

Definition at line 297 of file Type.php.

     {
         $sku = parent::getSku($product);
 
         if ($product->getData('sku_type')) {
             return $sku;
         } else {
             $skuParts = [$sku];
 
             if ($product->hasCustomOptions()) {
                 $customOption = $product->getCustomOption('bundle_selection_ids');
                 $selectionIds = $this->serializer->unserialize($customOption->getValue());
                 if (!empty($selectionIds)) {
                     $selections = $this->getSelectionsByIds($selectionIds, $product);
                     foreach ($selections->getItems() as $selection) {
                         $skuParts[] = $selection->getSku();
                     }
                 }
             }
 
             return implode('-', $skuParts);
         }
     }

◆ getSpecifyOptionMessage()

getSpecifyOptionMessage ( )

Retrieve message for specify option(s)

Returns: \Magento\Framework\Phrase

Definition at line 834 of file Type.php.

     {
         return __('Please specify product option(s).');
     }

◆ getWeight()

getWeight ( $product )

Return product weight based on weight_type attribute

Parameters

\Magento\Catalog\Model\Product $product

Returns: float

Definition at line 327 of file Type.php.

     {
         if ($product->getData('weight_type')) {
             return $product->getData('weight');
         } else {
             $weight = 0;
 
             if ($product->hasCustomOptions()) {
                 $customOption = $product->getCustomOption('bundle_selection_ids');
                 $selectionIds = $this->serializer->unserialize($customOption->getValue());
                 $selections = $this->getSelectionsByIds($selectionIds, $product);
                 foreach ($selections->getItems() as $selection) {
                     $qtyOption = $product->getCustomOption('selection_qty_' . $selection->getSelectionId());
                     if ($qtyOption) {
                         $weight += $selection->getWeight() * $qtyOption->getValue();
                     } else {
                         $weight += $selection->getWeight();
                     }
                 }
             }
 
             return $weight;
         }
     }

◆ hasOptions()

hasOptions ( $product )

Return true if product has options

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 1024 of file Type.php.

     {
         $this->setStoreFilter($product->getStoreId(), $product);
         $optionIds = $this->getOptionsCollection($product)
             ->getAllIds();
         $collection = $this->getSelectionsCollection($optionIds, $product);
 
         if ($collection->getSize() > 0 || $product->getOptions()) {
             return true;
         }
 
         return false;
     }

◆ isSalable()

isSalable ( $product )

Checking if we can sale this bundle

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 573 of file Type.php.

     {
         if (!parent::isSalable($product)) {
             return false;
         }
 
         if ($product->hasData('all_items_salable')) {
             return $product->getData('all_items_salable');
         }
 
         $metadata = $this->metadataPool->getMetadata(
             \Magento\Catalog\Api\Data\ProductInterface::class
         );
 
         $isSalable = false;
         foreach ($this->getOptionsCollection($product) as $option) {
             $hasSalable = false;
 
             $selectionsCollection = $this->_bundleCollection->create();
             $selectionsCollection->addAttributeToSelect('status');
             $selectionsCollection->addQuantityFilter();
             $selectionsCollection->setFlag('product_children', true);
             $selectionsCollection->addFilterByRequiredOptions();
             $selectionsCollection->setOptionIdsFilter([$option->getId()]);
 
             $this->selectionCollectionFilterApplier->apply(
                 $selectionsCollection,
                 'parent_product_id',
                 $product->getData($metadata->getLinkField())
             );
 
             foreach ($selectionsCollection as $selection) {
                 if ($selection->isSalable()) {
                     $hasSalable = true;
                     break;
                 }
             }
 
             if ($hasSalable) {
                 $isSalable = true;
             }
 
             if (!$hasSalable && $option->getRequired()) {
                 $isSalable = false;
                 break;
             }
         }
 
         $product->setData('all_items_salable', $isSalable);
 
         return $isSalable;
     }

◆ isVirtual()

isVirtual ( $product )

Check is virtual product

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 358 of file Type.php.

     {
         if ($product->hasCustomOptions()) {
             $customOption = $product->getCustomOption('bundle_selection_ids');
             $selectionIds = $this->serializer->unserialize($customOption->getValue());
             $selections = $this->getSelectionsByIds($selectionIds, $product);
             $virtualCount = 0;
             foreach ($selections->getItems() as $selection) {
                 if ($selection->isVirtual()) {
                     $virtualCount++;
                 }
             }
 
             return $virtualCount === count($selections);
         }
 
         return false;
     }

◆ mergeSelectionsWithOptions()

mergeSelectionsWithOptions	(	$options,
		$selections
	)

protected

Parameters

Definition at line 1325 of file Type.php.

     {
         foreach ($options as $option) {
             $optionSelections = $option->getSelections();
             if ($option->getRequired() && is_array($optionSelections) && count($optionSelections) == 1) {
                 $selections = array_merge($selections, $optionSelections);
             } else {
                 $selections = [];
                 break;
             }
         }
 
         return $selections;
     }

◆ prepareQuoteItemQty()

prepareQuoteItemQty	(	$qty,
		$product
	)

Prepare Quote Item Quantity

Parameters

mixed	$qty
\Magento\Catalog\Model\Product	$product

Returns: int @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 560 of file Type.php.

     {
         return (int) $qty;
     }

◆ processBuyRequest()

processBuyRequest	(	$product,
		$buyRequest
	)

Prepare selected options for bundle product

Parameters

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

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1157 of file Type.php.

     {
         $option = $buyRequest->getBundleOption();
         $optionQty = $buyRequest->getBundleOptionQty();
 
         $option = is_array($option) ? array_filter($option, 'intval') : [];
         $optionQty = is_array($optionQty) ? array_filter($optionQty, 'intval') : [];
 
         $options = ['bundle_option' => $option, 'bundle_option_qty' => $optionQty];
 
         return $options;
     }

◆ shakeSelections()

shakeSelections	(	$firstItem,
		$secondItem
	)

Sort selections method for usort function Sort selections by option position, selection position and selection id

Parameters

\Magento\Catalog\Model\Product	$firstItem
\Magento\Catalog\Model\Product	$secondItem

Returns: int

Definition at line 996 of file Type.php.

     {
         $aPosition = [
             $firstItem->getOption()
                 ->getPosition(),
             $firstItem->getOptionId(),
             $firstItem->getPosition(),
             $firstItem->getSelectionId(),
         ];
         $bPosition = [
             $secondItem->getOption()
                 ->getPosition(),
             $secondItem->getOptionId(),
             $secondItem->getPosition(),
             $secondItem->getSelectionId(),
         ];
         if ($aPosition == $bPosition) {
             return 0;
         }
         return $aPosition < $bPosition ? -1 : 1;
     }

◆ updateQtyOption()

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

Method is needed for specific actions to change given quote options values according current product type logic Example: the catalog inventory validation of decimal qty can change qty to int, so need to change quote item qty option value too.

Parameters

array	$options
\Magento\Framework\DataObject	$option
mixed	$value
\Magento\Catalog\Model\Product	$product

Returns: $this

Definition at line 527 of file Type.php.

     {
         $optionProduct = $option->getProduct($product);
         $optionUpdateFlag = $option->getHasQtyOptionUpdate();
         $optionCollection = $this->getOptionsCollection($product);
 
         $selections = $this->getSelectionsCollection($optionCollection->getAllIds(), $product);
 
         foreach ($selections as $selection) {
             if ($selection->getProductId() == $optionProduct->getId()) {
                 foreach ($options as $quoteItemOption) {
                     if ($quoteItemOption->getCode() == 'selection_qty_' . $selection->getSelectionId()) {
                         if ($optionUpdateFlag) {
                             $quoteItemOption->setValue(intval($quoteItemOption->getValue()));
                         } else {
                             $quoteItemOption->setValue($value);
                         }
                     }
                 }
             }
         }
 
         return $this;
     }

Field Documentation

◆ $_bundleCollection

$_bundleCollection

protected

Definition at line 126 of file Type.php.

◆ $_bundleFactory

$_bundleFactory

protected

Definition at line 131 of file Type.php.

◆ $_bundleModelSelection

$_bundleModelSelection

protected

Definition at line 136 of file Type.php.

◆ $_bundleOption

$_bundleOption

protected

Definition at line 111 of file Type.php.

◆ $_bundleSelection

$_bundleSelection

protected

Definition at line 116 of file Type.php.

◆ $_canConfigure

$_canConfigure = true

protected

Definition at line 87 of file Type.php.

◆ $_catalogData

$_catalogData = null

protected

Definition at line 94 of file Type.php.

◆ $_catalogProduct

$_catalogProduct = null

protected

Definition at line 101 of file Type.php.

◆ $_config

$_config

protected

Definition at line 121 of file Type.php.

◆ $_isComposite

$_isComposite = true

protected

Definition at line 37 of file Type.php.

◆ $_keyOptionsCollection

$_keyOptionsCollection = '_cache_instance_options_collection'

protected

Definition at line 44 of file Type.php.

◆ $_keySelectionsCollection

$_keySelectionsCollection = '_cache_instance_selections_collection'

protected

Definition at line 52 of file Type.php.

◆ $_keyUsedOptions

$_keyUsedOptions = '_cache_instance_used_options'

protected

Definition at line 73 of file Type.php.

◆ $_keyUsedOptionsIds

$_keyUsedOptionsIds = '_cache_instance_used_options_ids'

protected

Definition at line 80 of file Type.php.

◆ $_keyUsedSelections

$_keyUsedSelections = '_cache_instance_used_selections'

protected

Definition at line 59 of file Type.php.

◆ $_keyUsedSelectionsIds

$_keyUsedSelectionsIds = '_cache_instance_used_selections_ids'

protected

Definition at line 66 of file Type.php.

◆ $_stockRegistry

$_stockRegistry

protected

Definition at line 146 of file Type.php.

◆ $_stockState

$_stockState

protected

Definition at line 151 of file Type.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 106 of file Type.php.

◆ $priceCurrency

$priceCurrency

protected

Definition at line 141 of file Type.php.

◆ TYPE_CODE

const TYPE_CODE = 'bundle'

Product type

Definition at line 30 of file Type.php.

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

vendor/magento/module-bundle/Model/Product/Type.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _prepareProduct()

◆ beforeSave()

◆ canConfigure()

◆ checkIsAllRequiredOptions()

◆ checkIsResult()

◆ checkProductBuyState()

◆ checkSelectionsIsSale()

◆ deleteTypeSpecificData()

◆ getBeforeQty()

◆ getChildrenIds()

◆ getForceChildItemQtyChanges()

◆ getOptions()

◆ getOptionsByIds()

◆ getOptionsIds()

◆ getOrderOptions()

◆ getParentIdsByChild()

◆ getProductsToPurchaseByReqGroups()

◆ getQty()

◆ getRelationInfo()

◆ getSearchableData()

◆ getSku()

◆ getSpecifyOptionMessage()

◆ getWeight()

◆ hasOptions()

◆ isSalable()

◆ isVirtual()

◆ mergeSelectionsWithOptions()

◆ prepareQuoteItemQty()

◆ processBuyRequest()

◆ shakeSelections()

◆ updateQtyOption()

Field Documentation

◆ $_bundleCollection

◆ $_bundleFactory

◆ $_bundleModelSelection

◆ $_bundleOption

◆ $_bundleSelection

◆ $_canConfigure

◆ $_catalogData

◆ $_catalogProduct

◆ $_config

◆ $_isComposite

◆ $_keyOptionsCollection

◆ $_keySelectionsCollection

◆ $_keyUsedOptions

◆ $_keyUsedOptionsIds

◆ $_keyUsedSelections

◆ $_keyUsedSelectionsIds

◆ $_stockRegistry

◆ $_stockState

◆ $_storeManager

◆ $priceCurrency

◆ TYPE_CODE