Inheritance diagram for AbstractType:

Public Member Functions
	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	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
	_isStrictProcessMode ($processMode)

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

	_removeNotApplicableAttributes ($product)

Protected Attributes
	$_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

@api Abstract model for product type implementation @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 22 of file AbstractType.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\Framework\Serialize\Serializer\Json	$serializer = `null`
	)

Construct

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\Framework\Serialize\Serializer\Json \| null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 189 of file AbstractType.php.

       {
         $this->_catalogProductOption = $catalogProductOption;
         $this->_eavConfig = $eavConfig;
         $this->_catalogProductType = $catalogProductType;
         $this->_coreRegistry = $coreRegistry;
         $this->_eventManager = $eventManager;
         $this->_fileStorageDb = $fileStorageDb;
         $this->_filesystem = $filesystem;
         $this->_logger = $logger;
         $this->productRepository = $productRepository;
         $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
     }

Member Function Documentation

◆ _isStrictProcessMode()

_isStrictProcessMode ( $processMode )

protected

Check if current process mode is strict

Parameters

string $processMode

Returns: bool

Definition at line 552 of file AbstractType.php.

     {
         return $processMode == self::PROCESS_MODE_FULL;
     }

◆ _prepareOptions()

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

protected

Process custom defined options for product

Parameters

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

Returns: array

Exceptions

LocalizedException

Definition at line 576 of file AbstractType.php.

     {
         $transport = new \stdClass();
         $transport->options = [];
         $options = null;
         if ($product->getHasOptions()) {
             $options = $product->getOptions();
         }
         if ($options !== null) {
             $results = [];
             foreach ($options as $option) {
                 /* @var $option \Magento\Catalog\Model\Product\Option */
                 try {
                     $group = $option->groupFactory($option->getType())
                         ->setOption($option)
                         ->setProduct($product)
                         ->setRequest($buyRequest)
                         ->setProcessMode($processMode)
                         ->validateUserValue($buyRequest->getOptions());
                 } catch (LocalizedException $e) {
                     $results[] = $e->getMessage();
                     continue;
                 }
 
                 $preparedValue = $group->prepareForCart();
                 if ($preparedValue !== null) {
                     $transport->options[$option->getId()] = $preparedValue;
                 }
             }
             if (count($results) > 0) {
                 throw new LocalizedException(__(implode("\n", $results)));
             }
         }
 
         $eventName = sprintf('catalog_product_type_prepare_%s_options', $processMode);
         $this->_eventManager->dispatch(
             $eventName,
             ['transport' => $transport, 'buy_request' => $buyRequest, 'product' => $product]
         );
         return $transport->options;
     }

◆ _removeNotApplicableAttributes()

_removeNotApplicableAttributes ( $product )

protected

Remove don't applicable attributes data

Parameters

\Magento\Catalog\Model\Product $product

Returns: void

Definition at line 722 of file AbstractType.php.

     {
         $entityType = $product->getResource()->getEntityType();
         foreach ($this->_eavConfig->getEntityAttributes($entityType, $product) as $attribute) {
             $applyTo = $attribute->getApplyTo();
             if (is_array($applyTo) && count($applyTo) > 0 && !in_array($product->getTypeId(), $applyTo)) {
                 $product->unsetData($attribute->getAttributeCode());
             }
         }
     }

◆ addFileQueue()

addFileQueue ( $queueOptions )

Add file to File Queue

Parameters

array $queueOptions Array of File Queue (eg. ['operation'=>'move', 'src_name'=>'filename', 'dst_name'=>'filename2'])

Returns: void

Definition at line 541 of file AbstractType.php.

     {
         $this->_fileQueue[] = $queueOptions;
     }

◆ assignProductToOption()

assignProductToOption	(	$optionProduct,
		$option,
		$product
	)

Implementation of product specify logic of which product needs to be assigned to option. For example if product which was added to option already removed from catalog.

Parameters

\Magento\Catalog\Model\Product	$optionProduct
\Magento\Quote\Model\Quote\Item\Option	$option
\Magento\Catalog\Model\Product	$product

Returns: $this

Definition at line 950 of file AbstractType.php.

     {
         if ($optionProduct) {
             $option->setProduct($optionProduct);
         } else {
             $option->setProduct($product);
         }
 
         return $this;
     }

◆ attributesCompare()

attributesCompare	(	$attributeOne,
		$attributeTwo
	)

Compare attributes sorting

Parameters

\Magento\Catalog\Model\Entity\Attribute	$attributeOne
\Magento\Catalog\Model\Entity\Attribute	$attributeTwo

Returns: int

Definition at line 290 of file AbstractType.php.

     {
         $sortOne = $attributeOne->getGroupSortPath() * 1000 + $attributeOne->getSortPath() * 0.0001;
         $sortTwo = $attributeTwo->getGroupSortPath() * 1000 + $attributeTwo->getSortPath() * 0.0001;
 
         return $sortOne <=> $sortTwo;
     }

◆ beforeSave()

beforeSave ( $product )

Before save type related data

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Definition at line 739 of file AbstractType.php.

     {
         $this->_removeNotApplicableAttributes($product);
         $product->canAffectOptions(true);
         return $this;
     }

◆ canConfigure()

canConfigure ( $product )

Check if product can be configured

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 765 of file AbstractType.php.

     {
         return $this->_canConfigure;
     }

◆ canUseQtyDecimals()

canUseQtyDecimals ( )

Check if product qty is fractional number

Returns: bool

Definition at line 775 of file AbstractType.php.

     {
         return $this->_canUseQtyDecimals;
     }

◆ checkProductBuyState()

checkProductBuyState ( $product )

Check if product can be bought

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Exceptions

Definition at line 625 of file AbstractType.php.

     {
         if (!$product->getSkipCheckRequiredOption() && $product->getHasOptions()) {
             $options = $product->getProductOptionsCollection();
             foreach ($options as $option) {
                 if ($option->getIsRequire()) {
                     $customOption = $product->getCustomOption(self::OPTION_PREFIX . $option->getId());
                     if (!$customOption || strlen($customOption->getValue()) == 0) {
                         $product->setSkipCheckRequiredOption(true);
                         throw new \Magento\Framework\Exception\LocalizedException(
                             __('The product has required options. Enter the options and try again.')
                         );
                     }
                 }
             }
         }
 
         return $this;
     }

◆ checkProductConfiguration()

checkProductConfiguration	(	$product,
		$buyRequest
	)

Check product's options configuration

Parameters

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

Returns: array

cloning product because prepareForCart() method will modify it

Definition at line 1035 of file AbstractType.php.

     {
         $errors = [];
 
         try {
             $productForCheck = clone $product;
             $buyRequestForCheck = clone $buyRequest;
             $result = $this->prepareForCart($buyRequestForCheck, $productForCheck);
 
             if (is_string($result)) {
                 $errors[] = $result;
             }
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             $errors[] = $e->getMessage();
         } catch (\Exception $e) {
             $this->_logger->critical($e);
             $errors[] = __('Something went wrong while processing the request.');
         }
 
         return $errors;
     }

◆ deleteTypeSpecificData()

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

abstract

Delete data specific for this product type

Parameters

\Magento\Catalog\Model\Product $product

Returns: void

◆ getAssociatedProducts()

getAssociatedProducts ( $product )

Parameters

\Magento\Catalog\Model\Product\Type\AbstractType $product

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1099 of file AbstractType.php.

     {
         return [];
     }

◆ getAttributeById()

getAttributeById	(	$attributeId,
		$product
	)

Retrieve product attribute by identifier

Parameters

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

Returns: \Magento\Catalog\Model\ResourceModel\Eav\Attribute|null

Definition at line 316 of file AbstractType.php.

     {
         if ($attributeId) {
             foreach ($this->getSetAttributes($product) as $attribute) {
                 if ($attribute->getId() == $attributeId) {
                     return $attribute;
                 }
             }
         }
         return null;
     }

◆ getChildrenIds()

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

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

@deplacated TODO: refactor to child relation manager

Parameters

int	$parentId
bool	$required

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 249 of file AbstractType.php.

     {
         return [];
     }

◆ getEditableAttributes()

getEditableAttributes ( $product )

Retrieve product type attributes

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Eav\Model\Entity\Attribute\AbstractAttribute[]

Definition at line 304 of file AbstractType.php.

     {
         return $this->getSetAttributes($product);
     }

◆ getForceChildItemQtyChanges()

getForceChildItemQtyChanges ( $product )

Allow for updates of children qty's (applicable for complicated product types. As default returns false)

Parameters

\Magento\Catalog\Model\Product $product

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

Definition at line 923 of file AbstractType.php.

     {
         return false;
     }

◆ getIdentities()

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

Return array of specific to type product entities

Parameters

\Magento\Catalog\Model\Product $product

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1089 of file AbstractType.php.

     {
         return [];
     }

◆ getOptionSku()

getOptionSku	(	$product,
		$sku = `''`
	)

Default action to get sku of product with option

Parameters

\Magento\Catalog\Model\Product	$product	Product with Custom Options
string	$sku	Product SKU without option

Returns: string

Definition at line 802 of file AbstractType.php.

     {
         $skuDelimiter = '-';
         if (empty($sku)) {
             $sku = $product->getData('sku');
         }
         $optionIds = $product->getCustomOption('option_ids');
         if ($optionIds) {
             foreach (explode(',', $optionIds->getValue()) as $optionId) {
                 $option = $product->getOptionById($optionId);
                 if ($option) {
                     $confItemOption = $product->getCustomOption(self::OPTION_PREFIX . $optionId);
 
                     $group = $option->groupFactory($option->getType())
                         ->setOption($option)
                         ->setListener(new \Magento\Framework\DataObject());
 
                     $optionSku = $group->getOptionSku($confItemOption->getValue(), $skuDelimiter);
                     if ($optionSku) {
                         $sku .= $skuDelimiter . $optionSku;
                     }
 
                     if ($group->getListener()->getHasError()) {
                         $product->setHasError(true)->setMessage($group->getListener()->getMessage());
                     }
                 }
             }
         }
         return $sku;
     }

◆ 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

Definition at line 652 of file AbstractType.php.

     {
         $optionArr = [];
         $info = $product->getCustomOption('info_buyRequest');
         if ($info) {
             $optionArr['info_buyRequest'] = $this->serializer->unserialize($info->getValue());
         }
 
         $optionIds = $product->getCustomOption('option_ids');
         if ($optionIds) {
             foreach (explode(',', $optionIds->getValue()) as $optionId) {
                 $option = $product->getOptionById($optionId);
                 if ($option) {
                     $confItemOption = $product->getCustomOption(self::OPTION_PREFIX . $option->getId());
 
                     $group = $option->groupFactory($option->getType())
                         ->setOption($option)
                         ->setProduct($product)
                         ->setConfigurationItemOption($confItemOption);
 
                     $optionArr['options'][] = [
                         'label' => $option->getTitle(),
                         'value' => $group->getFormattedOptionValue($confItemOption->getValue()),
                         'print_value' => $group->getPrintableOptionValue($confItemOption->getValue()),
                         'option_id' => $option->getId(),
                         'option_type' => $option->getType(),
                         'option_value' => $confItemOption->getValue(),
                         'custom_view' => $group->isCustomizedView(),
                     ];
                 }
             }
         }
 
         $productTypeConfig = $product->getCustomOption('product_type');
         if ($productTypeConfig) {
             $optionArr['super_product_config'] = [
                 'product_code' => $productTypeConfig->getCode(),
                 'product_type' => $productTypeConfig->getValue(),
                 'product_id' => $productTypeConfig->getProductId(),
             ];
         }
 
         return $optionArr;
     }

◆ getParentIdsByChild()

getParentIdsByChild ( $childId )

Retrieve parent ids array by required child

Parameters

int | array $childId

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 261 of file AbstractType.php.

     {
         return [];
     }

◆ 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 1007 of file AbstractType.php.

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

◆ getRelationInfo()

getRelationInfo ( )

Return relation info about used products for specific type instance

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

Definition at line 231 of file AbstractType.php.

     {
         return new \Magento\Framework\DataObject();
     }

◆ 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 987 of file AbstractType.php.

     {
         $searchData = [];
         if ($product->getHasOptions()) {
             $searchData = $this->_catalogProductOption->getSearchableData(
                 $product->getEntityId(),
                 $product->getStoreId()
             );
         }
 
         return $searchData;
     }

◆ getSetAttributes()

getSetAttributes ( $product )

Get array of product set attributes

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Eav\Model\Entity\Attribute\AbstractAttribute[]

Definition at line 272 of file AbstractType.php.

     {
         if (!$product->hasData($this->_cacheProductSetAttributes)) {
             $setAttributes = $product->getResource()
                 ->loadAllAttributes($product)
                 ->getSortedAttributes($product->getAttributeSetId());
             $product->setData($this->_cacheProductSetAttributes, $setAttributes);
         }
         return $product->getData($this->_cacheProductSetAttributes);
     }

◆ getSku()

getSku ( $product )

Default action to get sku of product

Parameters

\Magento\Catalog\Model\Product $product

Returns: string

Definition at line 786 of file AbstractType.php.

     {
         $sku = $product->getData('sku');
         if ($product->getCustomOption('option_ids')) {
             $sku = $this->getOptionSku($product, $sku);
         }
         return $sku;
     }

◆ getSpecifyOptionMessage()

getSpecifyOptionMessage ( )

Retrieve message for specify option(s)

Returns: \Magento\Framework\Phrase

Definition at line 562 of file AbstractType.php.

     {
         return __("The product's required option(s) weren't entered. Make sure the options are entered and try again.");
     }

◆ getStoreFilter()

getStoreFilter ( $product )

Retrieve store filter for associated products

Parameters

\Magento\Catalog\Model\Product $product

Returns: int|\Magento\Store\Model\Store

Definition at line 894 of file AbstractType.php.

     {
         $cacheKey = '_cache_instance_store_filter';
         return $product->getData($cacheKey);
     }

◆ getWeight()

getWeight ( $product )

Default action to get weight of product

Parameters

\Magento\Catalog\Model\Product $product

Returns: float

Definition at line 839 of file AbstractType.php.

     {
         return $product->getData('weight');
     }

◆ hasOptions()

hasOptions ( $product )

Return true if product has options

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 850 of file AbstractType.php.

     {
         return $product->getHasOptions();
     }

◆ hasRequiredOptions()

hasRequiredOptions ( $product )

Check if product has required options

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 880 of file AbstractType.php.

     {
         if ($product->getRequiredOptions()) {
             return true;
         }
         return false;
     }

◆ hasWeight()

hasWeight ( )

Determine presence of weight for product type

Returns: bool

Definition at line 1065 of file AbstractType.php.

     {
         return true;
     }

◆ isComposite()

isComposite ( $product )

Check if product is composite

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 753 of file AbstractType.php.

     {
         return $this->_isComposite;
     }

◆ isPossibleBuyFromList()

isPossibleBuyFromList ( $product )

Check if product can be potentially buyed from the category page or some other list

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Since: 101.0.11

Definition at line 1111 of file AbstractType.php.

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

◆ isSalable()

isSalable ( $product )

Check is product available for sale

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 346 of file AbstractType.php.

     {
         $salable = $product->getStatus() == \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_ENABLED;
         if ($salable && $product->hasData('is_salable')) {
             $salable = $product->getData('is_salable');
         }
 
         return (bool)(int)$salable;
     }

◆ isVirtual()

isVirtual ( $product )

Check is virtual product

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 335 of file AbstractType.php.

     {
         return false;
     }

◆ prepareForCart()

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

Initialize product(s) for add to cart process

Parameters

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

Returns: array|string

Definition at line 467 of file AbstractType.php.

     {
         return $this->prepareForCartAdvanced($buyRequest, $product, self::PROCESS_MODE_FULL);
     }

◆ prepareForCartAdvanced()

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

Initialize product(s) for add to cart process. Advanced version of func to prepare product for cart - processMode can be specified there.

Parameters

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

Returns: array|string

Definition at line 450 of file AbstractType.php.

     {
         if (!$processMode) {
             $processMode = self::PROCESS_MODE_FULL;
         }
         $_products = $this->_prepareProduct($buyRequest, $product, $processMode);
         $this->processFileQueue();
         return $_products;
     }

◆ prepareQuoteItemQty()

prepareQuoteItemQty	(	$qty,
		$product
	)

Prepare Quote Item Quantity

Parameters

int \| float	$qty
\Magento\Catalog\Model\Product	$product

Returns: float @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 936 of file AbstractType.php.

     {
         return (float)$qty;
     }

◆ processBuyRequest()

processBuyRequest	(	$product,
		$buyRequest
	)

Prepare selected options for product

Parameters

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

Returns: array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1023 of file AbstractType.php.

     {
         return [];
     }

◆ processConfiguration()

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

Process product configuration

Parameters

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

Returns: array|string

Definition at line 431 of file AbstractType.php.

       {
         $products = $this->_prepareProduct($buyRequest, $product, $processMode);
         $this->processFileQueue();
         return $products;
     }

◆ save()

save ( $product )

Save type related data

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Definition at line 703 of file AbstractType.php.

     {
         if ($product->dataHasChangedFor('type_id') && $product->getOrigData('type_id')) {
             $oldTypeProduct = clone $product;
             $oldTypeInstance = $this->_catalogProductType->factory(
                 $oldTypeProduct->setTypeId($product->getOrigData('type_id'))
             );
             $oldTypeProduct->setTypeInstance($oldTypeInstance);
             $oldTypeInstance->deleteTypeSpecificData($oldTypeProduct);
         }
         return $this;
     }

◆ setConfig()

setConfig ( $config )

Setting specified product type variables

Parameters

array $config

Returns: $this

Definition at line 967 of file AbstractType.php.

     {
         if (isset($config['composite'])) {
             $this->_isComposite = (bool)$config['composite'];
         }
 
         if (isset($config['can_use_qty_decimals'])) {
             $this->_canUseQtyDecimals = (bool)$config['can_use_qty_decimals'];
         }
 
         return $this;
     }

◆ setImageFromChildProduct()

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

Set image for product without image if possible

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1077 of file AbstractType.php.

     {
         return $this;
     }

◆ setStoreFilter()

setStoreFilter	(	$store,
		$product
	)

Set store filter for associated products

Parameters

	$store	int\|\Magento\Store\Model\Store
\Magento\Catalog\Model\Product	$product

Returns: $this

Definition at line 907 of file AbstractType.php.

     {
         $cacheKey = '_cache_instance_store_filter';
         $product->setData($cacheKey, $store);
         return $this;
     }

◆ setTypeId()

setTypeId ( $typeId )

Specify type identifier

Parameters

string $typeId

Returns: \Magento\Catalog\Model\Product\Type\AbstractType

Definition at line 220 of file AbstractType.php.

     {
         $this->_typeId = $typeId;
         return $this;
     }

◆ updateQtyOption()

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

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

Parameters

array	$options
\Magento\Framework\DataObject	$option
int \| float \| null	$value
\Magento\Catalog\Model\Product	$product

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 869 of file AbstractType.php.

     {
         return $this;
     }

Field Documentation

◆ $_cacheProductSetAttributes

$_cacheProductSetAttributes = '_cache_instance_product_set_attributes'

protected

Definition at line 111 of file AbstractType.php.

◆ $_canConfigure

$_canConfigure = false

protected

Definition at line 48 of file AbstractType.php.

◆ $_canUseQtyDecimals

$_canUseQtyDecimals = true

protected

Definition at line 55 of file AbstractType.php.

◆ $_catalogProductOption

$_catalogProductOption

protected

Definition at line 159 of file AbstractType.php.

◆ $_catalogProductType

$_catalogProductType

protected

Definition at line 145 of file AbstractType.php.

◆ $_coreRegistry

$_coreRegistry

protected

Definition at line 126 of file AbstractType.php.

◆ $_eavConfig

$_eavConfig

protected

Definition at line 152 of file AbstractType.php.

◆ $_editableAttributes

$_editableAttributes

protected

Definition at line 34 of file AbstractType.php.

◆ $_eventManager

$_eventManager

protected

Definition at line 133 of file AbstractType.php.

◆ $_fileQueue

$_fileQueue = []

protected

Definition at line 62 of file AbstractType.php.

◆ $_fileStorageDb

$_fileStorageDb

protected

Definition at line 104 of file AbstractType.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 99 of file AbstractType.php.

◆ $_isComposite

$_isComposite = false

protected

Definition at line 41 of file AbstractType.php.

◆ $_logger

$_logger

protected

Definition at line 138 of file AbstractType.php.

◆ $_typeId

$_typeId

protected

Definition at line 29 of file AbstractType.php.

◆ $productRepository

$productRepository

protected

Definition at line 164 of file AbstractType.php.

◆ $serializer

$serializer

protected

Definition at line 172 of file AbstractType.php.

◆ CALCULATE_CHILD

const CALCULATE_CHILD = 0

Definition at line 64 of file AbstractType.php.

◆ CALCULATE_PARENT

const CALCULATE_PARENT = 1

Definition at line 66 of file AbstractType.php.

◆ OPTION_PREFIX

const OPTION_PREFIX = 'option_'

Item options prefix

Definition at line 94 of file AbstractType.php.

◆ PROCESS_MODE_FULL

const PROCESS_MODE_FULL = 'full'

#- Process modes

Full validation - all required options must be set, whole configuration must be valid

Definition at line 82 of file AbstractType.php.

◆ PROCESS_MODE_LITE

const PROCESS_MODE_LITE = 'lite'

Process modes

Lite validation - only received options are validated

Definition at line 89 of file AbstractType.php.

◆ SHIPMENT_SEPARATELY

const SHIPMENT_SEPARATELY = 1

#+ values for shipment type (invoice etc)

Definition at line 71 of file AbstractType.php.

◆ SHIPMENT_TOGETHER

const SHIPMENT_TOGETHER = 0

Definition at line 73 of file AbstractType.php.

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

vendor/magento/module-catalog/Model/Product/Type/AbstractType.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _isStrictProcessMode()

◆ _prepareOptions()

◆ _removeNotApplicableAttributes()

◆ addFileQueue()

◆ assignProductToOption()

◆ attributesCompare()

◆ beforeSave()

◆ canConfigure()

◆ canUseQtyDecimals()

◆ checkProductBuyState()

◆ checkProductConfiguration()

◆ deleteTypeSpecificData()

◆ getAssociatedProducts()

◆ getAttributeById()

◆ getChildrenIds()

◆ getEditableAttributes()

◆ getForceChildItemQtyChanges()

◆ getIdentities()

◆ getOptionSku()

◆ getOrderOptions()

◆ getParentIdsByChild()

◆ getProductsToPurchaseByReqGroups()

◆ getRelationInfo()

◆ getSearchableData()

◆ getSetAttributes()

◆ getSku()

◆ getSpecifyOptionMessage()

◆ getStoreFilter()

◆ getWeight()

◆ hasOptions()

◆ hasRequiredOptions()

◆ hasWeight()

◆ isComposite()

◆ isPossibleBuyFromList()

◆ isSalable()

◆ isVirtual()

◆ prepareForCart()

◆ prepareForCartAdvanced()

◆ prepareQuoteItemQty()

◆ processBuyRequest()

◆ processConfiguration()

◆ save()

◆ setConfig()

◆ setImageFromChildProduct()

◆ setStoreFilter()

◆ setTypeId()

◆ updateQtyOption()

Field Documentation

◆ $_cacheProductSetAttributes

◆ $_canConfigure

◆ $_canUseQtyDecimals

◆ $_catalogProductOption

◆ $_catalogProductType

◆ $_coreRegistry

◆ $_eavConfig

◆ $_editableAttributes

◆ $_eventManager

◆ $_fileQueue

◆ $_fileStorageDb

◆ $_filesystem

◆ $_isComposite

◆ $_logger

◆ $_typeId

◆ $productRepository

◆ $serializer

◆ CALCULATE_CHILD

◆ CALCULATE_PARENT

◆ OPTION_PREFIX

◆ PROCESS_MODE_FULL

◆ PROCESS_MODE_LITE

◆ SHIPMENT_SEPARATELY

◆ SHIPMENT_TOGETHER