Inheritance diagram for Product:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Catalog\Api\ProductAttributeRepositoryInterface $metadataService, Product\Url $url, Product\Link $productLink, \Magento\Catalog\Model\Product\Configuration\Item\OptionFactory $itemOptionFactory, \Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory $stockItemFactory, \Magento\Catalog\Model\Product\OptionFactory $catalogProductOptionFactory, \Magento\Catalog\Model\Product\Visibility $catalogProductVisibility, \Magento\Catalog\Model\Product\Attribute\Source\Status $catalogProductStatus, \Magento\Catalog\Model\Product\Media\Config $catalogProductMediaConfig, Product\Type $catalogProductType, \Magento\Framework\Module\Manager $moduleManager, \Magento\Catalog\Helper\Product $catalogProduct, \Magento\Catalog\Model\ResourceModel\Product $resource, \Magento\Catalog\Model\ResourceModel\Product\Collection $resourceCollection, \Magento\Framework\Data\CollectionFactory $collectionFactory, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, \Magento\Catalog\Model\Indexer\Product\Flat\Processor $productFlatIndexerProcessor, \Magento\Catalog\Model\Indexer\Product\Price\Processor $productPriceIndexerProcessor, \Magento\Catalog\Model\Indexer\Product\Eav\Processor $productEavIndexerProcessor, CategoryRepositoryInterface $categoryRepository, Product\Image\CacheFactory $imageCacheFactory, \Magento\Catalog\Model\ProductLink\CollectionProvider $entityCollectionProvider, \Magento\Catalog\Model\Product\LinkTypeProvider $linkTypeProvider, \Magento\Catalog\Api\Data\ProductLinkInterfaceFactory $productLinkFactory, \Magento\Catalog\Api\Data\ProductLinkExtensionFactory $productLinkExtensionFactory, EntryConverterPool $mediaGalleryEntryConverterPool, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, \Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface $joinProcessor, array $data=[], \Magento\Eav\Model\Config $config=null, FilterProductCustomAttribute $filterCustomAttribute=null)

	getStoreId ()

	getUrlModel ()

	validate ()

	getName ()

	getPrice ()

	getVisibility ()

	getAttributeSetId ()

	getCreatedAt ()

	getUpdatedAt ()

	setPriceCalculation ($calculate=true)

	getTypeId ()

	getStatus ()

	getTypeInstance ()

	setTypeInstance ($instance)

	getLinkInstance ()

	getIdBySku ($sku)

	getCategoryId ()

	getCategory ()

	getCategoryIds ()

	getCategoryCollection ()

	getWebsiteIds ()

	getStoreIds ()

	getAttributes ($groupId=null, $skipSuper=false)

	beforeSave ()

	canAffectOptions ($value=null)

	afterSave ()

	setQty ($qty)

	getQty ()

	priceReindexCallback ()

	eavReindexCallback ()

	isDataChanged ()

	reindex ()

	beforeDelete ()

	afterDeleteCommit ()

	cleanCache ()

	getPriceModel ()

	getPriceInfo ()

	getTierPrices ()

	setTierPrices (array $tierPrices=null)

	getTierPrice ($qty=null)

	getFormattedPrice ()

	getFormatedPrice ()

	setFinalPrice ($price)

	getFinalPrice ($qty=null)

	getCalculatedFinalPrice ()

	getMinimalPrice ()

	getSpecialPrice ()

	getSpecialFromDate ()

	getSpecialToDate ()

	getRelatedProducts ()

	getRelatedProductIds ()

	getRelatedProductCollection ()

	getRelatedLinkCollection ()

	getUpSellProducts ()

	getUpSellProductIds ()

	getUpSellProductCollection ()

	getUpSellLinkCollection ()

	getCrossSellProducts ()

	getCrossSellProductIds ()

	getCrossSellProductCollection ()

	getCrossSellLinkCollection ()

	getProductLinks ()

	setProductLinks (array $links=null)

	getMediaAttributes ()

	getMediaAttributeValues ()

	getMediaGalleryImages ()

	hasGalleryAttribute ()

	addImageToMediaGallery ($file, $mediaAttribute=null, $move=false, $exclude=true)

	getMediaConfig ()

	getVisibleInCatalogStatuses ()

	getVisibleStatuses ()

	isVisibleInCatalog ()

	getVisibleInSiteVisibilities ()

	isVisibleInSiteVisibility ()

	isDuplicable ()

	setIsDuplicable ($value)

	isSalable ()

	isAvailable ()

	getIsSalable ()

	isVirtual ()

	isSaleable ()

	isInStock ()

	getAttributeText ($attributeCode)

	getCustomDesignDate ()

	getProductUrl ($useSid=null)

	getUrlInStore ($params=[])

	formatUrlKey ($str)

	addAttributeUpdate ($code, $value, $store)

	toArray (array $arrAttributes=[])

	fromArray (array $data)

	getRequestPath ()

	getGiftMessageAvailable ()

	isComposite ()

	canConfigure ()

	getSku ()

	getWeight ()

	getOptionInstance ()

	addOption (Product\Option $option)

	getProductOptionsCollection ()

	getOptions ()

	setOptions (array $options=null)

	getIsVirtual ()

	addCustomOption ($code, $value, $product=null)

	setCustomOptions (array $options)

	getCustomOptions ()

	getCustomOption ($code)

	hasCustomOptions ()

	canBeShowInCategory ($categoryId)

	getAvailableInCategories ()

	getDefaultAttributeSetId ()

	reset ()

	getCacheIdTags ()

	isProductsHasSku (array $productIds)

	processBuyRequest (\Magento\Framework\DataObject $buyRequest)

	getPreconfiguredValues ()

	prepareCustomOptions ()

	getProductEntitiesInfo ($columns=null)

	isDisabled ()

	getImage ()

	getIdentities ()

	reloadPriceInfo ()

	__toArray ()

	setSku ($sku)

	setName ($name)

	setStoreId ($storeId)

	setAttributeSetId ($attributeSetId)

	setPrice ($price)

	setStatus ($status)

	setVisibility ($visibility)

	setCreatedAt ($createdAt)

	setUpdatedAt ($updatedAt)

	setWeight ($weight)

	setTypeId ($typeId)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Catalog\Api\Data\ProductExtensionInterface $extensionAttributes)

	getMediaGalleryEntries ()

	setMediaGalleryEntries (array $mediaGalleryEntries=null)

	getId ()

	setId ($value)

	setAssociatedProductIds (array $productIds)

	getQuantityAndStockStatus ()

	setQuantityAndStockStatus ($quantityAndStockStatusData)

	getStockData ()

	setStockData ($stockData)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	lockAttribute ($attributeCode)

	unlockAttribute ($attributeCode)

	unlockAttributes ()

	getLockedAttributes ()

	hasLockedAttributes ()

	isLockedAttribute ($attributeCode)

	setData ($key, $value=null)

	unsetData ($key=null)

	getResourceCollection ()

	loadByAttribute ($attribute, $value, $additionalAttributes=' *')

	getStore ()

	getWebsiteStoreIds ()

	setAttributeDefaultValue ($attributeCode, $value)

	getAttributeDefaultValue ($attributeCode)

	setExistsStoreValueFlag ($attributeCode)

	getExistsStoreValueFlag ($attributeCode)

	beforeSave ()

	isDeleteable ()

	setIsDeleteable ($value)

	isReadonly ()

	setIsReadonly ($value)

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	ENTITY = 'catalog_product'

const	CACHE_TAG = 'cat_p'

const	CACHE_PRODUCT_CATEGORY_TAG = 'cat_c_p'

const	STORE_ID = 'store_id'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from ProductInterface
const	SKU = 'sku'

const	NAME = 'name'

const	PRICE = 'price'

const	WEIGHT = 'weight'

const	STATUS = 'status'

const	VISIBILITY = 'visibility'

const	ATTRIBUTE_SET_ID = 'attribute_set_id'

const	TYPE_ID = 'type_id'

const	CREATED_AT = 'created_at'

const	UPDATED_AT = 'updated_at'

const	MEDIA_GALLERY = 'media_gallery'

const	TIER_PRICE = 'tier_price'

const	ATTRIBUTES

Protected Member Functions
	_construct ()

	_getResource ()

	getCustomAttributesCodes ()

	setCategoryCollection (\Magento\Framework\Data\Collection $categoryCollection)

	_afterLoad ()

	_clearReferences ()

	_clearData ()

	convertToMediaGalleryInterface (array $mediaGallery)

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$linkRepository

	$_cacheTag = self::CACHE_TAG

	$_eventPrefix = 'catalog_product'

	$_eventObject = 'product'

	$_canAffectOptions = false

	$_typeInstance = null

	$_linkInstance

	$_customOptions = []

	$_urlModel = null

	$_resource

	$_errors = []

	$optionFactory

	$optionInstance

	$_links = null

	$_isDuplicable = true

	$_calculatePrice = true

	$_catalogProduct = null

	$moduleManager

	$_collectionFactory

	$_catalogProductType

	$_catalogProductMediaConfig

	$_catalogProductStatus

	$_catalogProductVisibility

	$_stockItemFactory

	$_itemOptionFactory

	$_filesystem

	$indexerRegistry

	$_productFlatIndexerProcessor

	$_productPriceIndexerProcessor

	$_productEavIndexerProcessor

	$_priceInfo

	$categoryRepository

	$categoryCollection

	$imageCacheFactory

	$metadataService

	$entityCollectionProvider

	$linkProvider

	$productLinkFactory

	$productLinkExtensionFactory

	$dataObjectHelper

	$_productIdCached

	$interfaceAttributes = ProductInterface::ATTRIBUTES

	$joinProcessor

	$mediaGalleryEntryConverterPool

	$mediaGalleryProcessor

	$linkTypeProvider

Protected Attributes inherited from AbstractModel
	$_defaultValues

	$_storeValuesFlags

	$_lockedAttributes = []

	$_isDeleteable = true

	$_isReadonly = false

	$_storeManager

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_url

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Catalog product model

@api @method Product setHasError(bool $value) @method null|bool getHasError() @method array getAssociatedProductIds() @method Product setNewVariationsAttributeSetId(int $value) @method int getNewVariationsAttributeSetId() @method int getPriceType() @method string getUrlKey() @method Product setUrlKey(string $urlKey) @method Product setRequestPath(string $requestPath) @method Product setWebsiteIds(array $ids)

@SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 42 of file Product.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Catalog\Api\ProductAttributeRepositoryInterface	$metadataService,
		Product\Url	$url,
		Product\Link	$productLink,
		\Magento\Catalog\Model\Product\Configuration\Item\OptionFactory	$itemOptionFactory,
		\Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory	$stockItemFactory,
		\Magento\Catalog\Model\Product\OptionFactory	$catalogProductOptionFactory,
		\Magento\Catalog\Model\Product\Visibility	$catalogProductVisibility,
		\Magento\Catalog\Model\Product\Attribute\Source\Status	$catalogProductStatus,
		\Magento\Catalog\Model\Product\Media\Config	$catalogProductMediaConfig,
		Product\Type	$catalogProductType,
		\Magento\Framework\Module\Manager	$moduleManager,
		\Magento\Catalog\Helper\Product	$catalogProduct,
		\Magento\Catalog\Model\ResourceModel\Product	$resource,
		\Magento\Catalog\Model\ResourceModel\Product\Collection	$resourceCollection,
		\Magento\Framework\Data\CollectionFactory	$collectionFactory,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry,
		\Magento\Catalog\Model\Indexer\Product\Flat\Processor	$productFlatIndexerProcessor,
		\Magento\Catalog\Model\Indexer\Product\Price\Processor	$productPriceIndexerProcessor,
		\Magento\Catalog\Model\Indexer\Product\Eav\Processor	$productEavIndexerProcessor,
		CategoryRepositoryInterface	$categoryRepository,
		Product\Image\CacheFactory	$imageCacheFactory,
		\Magento\Catalog\Model\ProductLink\CollectionProvider	$entityCollectionProvider,
		\Magento\Catalog\Model\Product\LinkTypeProvider	$linkTypeProvider,
		\Magento\Catalog\Api\Data\ProductLinkInterfaceFactory	$productLinkFactory,
		\Magento\Catalog\Api\Data\ProductLinkExtensionFactory	$productLinkExtensionFactory,
		EntryConverterPool	$mediaGalleryEntryConverterPool,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		\Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface	$joinProcessor,
		array	$data = `[]`,
		\Magento\Eav\Model\Config	$config = `null`,
		FilterProductCustomAttribute	$filterCustomAttribute = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Catalog\Api\ProductAttributeRepositoryInterface	$metadataService
Product\Url	$url
Product\Link	$productLink
Product\Configuration\Item\OptionFactory	$itemOptionFactory
\Magento\CatalogInventory\Api\Data\StockItemInterfaceFactory	$stockItemFactory
Product\OptionFactory	$catalogProductOptionFactory
Product\Visibility	$catalogProductVisibility
Product\Attribute\Source\Status	$catalogProductStatus
Product\Media\Config	$catalogProductMediaConfig
Product\Type	$catalogProductType
\Magento\Framework\Module\Manager	$moduleManager
\Magento\Catalog\Helper\Product	$catalogProduct
ResourceModel\Product	$resource
ResourceModel\Product\Collection	$resourceCollection
\Magento\Framework\Data\CollectionFactory	$collectionFactory
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry
Indexer\Product\Flat\Processor	$productFlatIndexerProcessor
Indexer\Product\Price\Processor	$productPriceIndexerProcessor
Indexer\Product\Eav\Processor	$productEavIndexerProcessor
CategoryRepositoryInterface	$categoryRepository
Product\Image\CacheFactory	$imageCacheFactory
ProductLink\CollectionProvider	$entityCollectionProvider
Product\LinkTypeProvider	$linkTypeProvider
\Magento\Catalog\Api\Data\ProductLinkInterfaceFactory	$productLinkFactory
\Magento\Catalog\Api\Data\ProductLinkExtensionFactory	$productLinkExtensionFactory
EntryConverterPool	$mediaGalleryEntryConverterPool
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
\Magento\Framework\Api\ExtensionAttribute\JoinProcessorInterface	$joinProcessor
array	$data
\Magento\Eav\Model\Config \| null	$config
FilterProductCustomAttribute \| null	$filterCustomAttribute	@SuppressWarnings(PHPMD.ExcessiveParameterList) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 398 of file Product.php.

       {
         $this->metadataService = $metadataService;
         $this->_itemOptionFactory = $itemOptionFactory;
         $this->_stockItemFactory = $stockItemFactory;
         $this->optionFactory = $catalogProductOptionFactory;
         $this->_catalogProductVisibility = $catalogProductVisibility;
         $this->_catalogProductStatus = $catalogProductStatus;
         $this->_catalogProductMediaConfig = $catalogProductMediaConfig;
         $this->_catalogProductType = $catalogProductType;
         $this->moduleManager = $moduleManager;
         $this->_catalogProduct = $catalogProduct;
         $this->_collectionFactory = $collectionFactory;
         $this->_urlModel = $url;
         $this->_linkInstance = $productLink;
         $this->_filesystem = $filesystem;
         $this->indexerRegistry = $indexerRegistry;
         $this->_productFlatIndexerProcessor = $productFlatIndexerProcessor;
         $this->_productPriceIndexerProcessor = $productPriceIndexerProcessor;
         $this->_productEavIndexerProcessor = $productEavIndexerProcessor;
         $this->categoryRepository = $categoryRepository;
         $this->imageCacheFactory = $imageCacheFactory;
         $this->entityCollectionProvider = $entityCollectionProvider;
         $this->linkTypeProvider = $linkTypeProvider;
         $this->productLinkFactory = $productLinkFactory;
         $this->productLinkExtensionFactory = $productLinkExtensionFactory;
         $this->mediaGalleryEntryConverterPool = $mediaGalleryEntryConverterPool;
         $this->dataObjectHelper = $dataObjectHelper;
         $this->joinProcessor = $joinProcessor;
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $storeManager,
             $resource,
             $resourceCollection,
             $data
         );
         $this->eavConfig = $config ?? ObjectManager::getInstance()->get(\Magento\Eav\Model\Config::class);
         $this->filterCustomAttribute = $filterCustomAttribute
             ?? ObjectManager::getInstance()->get(FilterProductCustomAttribute::class);
     }

Member Function Documentation

◆ __toArray()

__toArray ( )

Return Data Object data in array format.

Returns: array

Todo:: refactor with converter for AbstractExtensibleModel

Definition at line 2400 of file Product.php.

     {
         $data = $this->_data;
         $hasToArray = function ($model) {
             return is_object($model) && method_exists($model, '__toArray') && is_callable([$model, '__toArray']);
         };
         foreach ($data as $key => $value) {
             if ($hasToArray($value)) {
                 $data[$key] = $value->__toArray();
             } elseif (is_array($value)) {
                 foreach ($value as $nestedKey => $nestedValue) {
                     if ($hasToArray($nestedValue)) {
                         $value[$nestedKey] = $nestedValue->__toArray();
                     }
                 }
                 $data[$key] = $value;
             }
         }
         return $data;
     }

◆ _afterLoad()

_afterLoad ( )

protected

Load product options if they exists

Returns: $this

Definition at line 1079 of file Product.php.

     {
         if (!$this->hasData(self::STATUS)) {
             $this->setData(self::STATUS, \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_ENABLED);
         }
         parent::_afterLoad();
         return $this;
     }

◆ _clearData()

_clearData ( )

protected

Clearing product's data

Returns: \Magento\Catalog\Model\Product

Definition at line 2264 of file Product.php.

     {
         foreach ($this->_data as $data) {
             if (is_object($data) && method_exists($data, 'reset') && is_callable([$data, 'reset'])) {
                 $data->reset();
             }
         }
 
         $this->setData([]);
         $this->setOrigData();
         $this->_customOptions = [];
         $this->_canAffectOptions = false;
         $this->_errors = [];
 
         return $this;
     }

◆ _clearReferences()

_clearReferences ( )

protected

Clearing references on product

Returns: \Magento\Catalog\Model\Product

Definition at line 2253 of file Product.php.

     {
         $this->_clearOptionReferences();
         return $this;
     }

◆ _construct()

_construct ( )

protected

Initialize resources

Returns: void

Definition at line 484 of file Product.php.

     {
         $this->_init(\Magento\Catalog\Model\ResourceModel\Product::class);
     }

◆ _getResource()

_getResource ( )

protected

Get resource instance

Exceptions

Definition at line 497 of file Product.php.

     {
         return parent::_getResource();
     }

◆ addAttributeUpdate()

addAttributeUpdate	(	$code,
		$value,
		$store
	)

Save current attribute with code $code and assign new value

Parameters

string	$code	Attribute code
mixed	$value	New attribute value
int	$store	Store ID

Returns: void

Definition at line 1824 of file Product.php.

     {
         $oldValue = $this->getData($code);
         $oldStore = $this->getStoreId();
 
         $this->setData($code, $value);
         $this->setStoreId($store);
         $this->getResource()->saveAttribute($this, $code);
 
         $this->setData($code, $oldValue);
         $this->setStoreId($oldStore);
     }

◆ addCustomOption()

addCustomOption	(	$code,
		$value,
		$product = `null`
	)

Add custom option information to product

Parameters

string	$code	Option code
mixed	$value	Value of the option
int \| Product	$product	Product ID

Returns: $this

Definition at line 2040 of file Product.php.

     {
         $product = $product ?: $this;
         $option = $this->_itemOptionFactory->create()->addData(
             ['product_id' => $product->getId(), 'product' => $product, 'code' => $code, 'value' => $value]
         );
         $this->_customOptions[$code] = $option;
         return $this;
     }

◆ addImageToMediaGallery()

addImageToMediaGallery	(	$file,
		$mediaAttribute = `null`,
		$move = `false`,
		$exclude = `true`
	)

Add image to media gallery

Parameters

string	$file	file path of image in file system
string \| array	$mediaAttribute	code of type 'media_image', leave blank if image should be only in gallery
boolean	$move	if true, it will move source file
boolean	$exclude	mark image as disabled in product page view

Returns: \Magento\Catalog\Model\Product

Exceptions

Definition at line 1569 of file Product.php.

     {
         if ($this->hasGalleryAttribute()) {
             $this->getMediaGalleryProcessor()->addImage(
                 $this,
                 $file,
                 $mediaAttribute,
                 $move,
                 $exclude
             );
         }
 
         return $this;
     }

◆ addOption()

addOption ( Product\Option $option )

Add option to array of product options

Parameters

Product\Option $option

Returns: \Magento\Catalog\Model\Product

Definition at line 1960 of file Product.php.

     {
         $options = (array)$this->getData('options');
         $options[] = $option;
         $option->setProduct($this);
         $this->setData('options', $options);
         return $this;
     }

◆ afterDeleteCommit()

afterDeleteCommit ( )

Init indexing process after product delete commit

Returns: void

Definition at line 1067 of file Product.php.

     {
         $this->reindex();
         $this->_productPriceIndexerProcessor->reindexRow($this->getId());
         parent::afterDeleteCommit();
     }

◆ afterSave()

afterSave ( )

Saving product type related data and init index

Returns: \Magento\Catalog\Model\Product

Definition at line 948 of file Product.php.

     {
         $this->getLinkInstance()->saveProductRelations($this);
         $this->getTypeInstance()->save($this);
 
         if ($this->getStockData()) {
             $this->setForceReindexEavRequired(true);
         }
 
         $this->_getResource()->addCommitCallback([$this, 'priceReindexCallback']);
         $this->_getResource()->addCommitCallback([$this, 'eavReindexCallback']);
 
         $result = parent::afterSave();
 
         $this->_getResource()->addCommitCallback([$this, 'reindex']);
         $this->reloadPriceInfo();
 
         return $result;
     }

◆ beforeDelete()

beforeDelete ( )

Clear cache related with product and protect delete from not admin

Register indexing event before delete product

Returns: \Magento\Catalog\Model\Product

Exceptions

Definition at line 1056 of file Product.php.

     {
         $this->cleanCache();
         return parent::beforeDelete();
     }

◆ beforeSave()

beforeSave ( )

Check product options and type options and save them, too

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

We need reset attribute set id to attribute after related simple product was saved

Parameters

\Magento\Catalog\Model\ResourceModel\Product	$subject
\Magento\Framework\DataObject	$object

Returns: void

@SuppressWarnings(PHPMD.UnusedFormalParameter)

$this->_canAffectOptions - set by type instance only $this->getCanSaveCustomOptions() - set either in controller when "Custom Options" ajax tab is loaded, or in type instance as well

Set true, if any Set false, ONLY if options have been affected by Options tab and Type instance tab

Definition at line 866 of file Product.php.

     {
         $this->cleanCache();
         $this->setTypeHasOptions(false);
         $this->setTypeHasRequiredOptions(false);
         $this->setHasOptions(false);
         $this->setRequiredOptions(false);
 
         $this->getTypeInstance()->beforeSave($this);
 
         $hasOptions = false;
         $hasRequiredOptions = false;
 
         $this->canAffectOptions($this->_canAffectOptions && $this->getCanSaveCustomOptions());
         if ($this->getCanSaveCustomOptions()) {
             $options = $this->getOptions();
             if (is_array($options)) {
                 $this->setIsCustomOptionChanged(true);
                 foreach ($options as $option) {
                     if ($option instanceof \Magento\Catalog\Api\Data\ProductCustomOptionInterface) {
                         $option = $option->getData();
                     }
                     if (!isset($option['is_delete']) || $option['is_delete'] != '1') {
                         $hasOptions = true;
                     }
                     if ($option['is_require'] == '1') {
                         $hasRequiredOptions = true;
                         break;
                     }
                 }
             }
         }
 
         if ($hasOptions || (bool)$this->getTypeHasOptions()) {
             $this->setHasOptions(true);
             if ($hasRequiredOptions || (bool)$this->getTypeHasRequiredOptions()) {
                 $this->setRequiredOptions(true);
             } elseif ($this->canAffectOptions()) {
                 $this->setRequiredOptions(false);
             }
         } elseif ($this->canAffectOptions()) {
             $this->setHasOptions(false);
             $this->setRequiredOptions(false);
         }
 
         if (!$this->getOrigData('website_ids')) {
             $websiteIds = $this->_getResource()->getWebsiteIds($this);
             $this->setOrigData('website_ids', $websiteIds);
         }
         parent::beforeSave();
     }

◆ canAffectOptions()

canAffectOptions ( $value = null )

Check/set if options can be affected when saving product

If value specified, it will be set.

Parameters

bool $value

Returns: bool

Definition at line 935 of file Product.php.

     {
         if (null !== $value) {
             $this->_canAffectOptions = (bool) $value;
         }
         return $this->_canAffectOptions;
     }

◆ canBeShowInCategory()

canBeShowInCategory ( $categoryId )

Check availability display product in category

Parameters

int $categoryId

Returns: bool

Definition at line 2105 of file Product.php.

     {
         return $this->_getResource()->canBeShowInCategory($this, $categoryId);
     }

◆ canConfigure()

canConfigure ( )

Check if product can be configured

Returns: bool

Definition at line 1914 of file Product.php.

     {
         $options = $this->getOptions();
         return !empty($options) || $this->getTypeInstance()->canConfigure($this);
     }

◆ cleanCache()

cleanCache ( )

Clear cache related with product id

Returns: $this

Definition at line 1093 of file Product.php.

     {
         $this->_cacheManager->clean('catalog_product_' . $this->getId());
         return $this;
     }

◆ convertToMediaGalleryInterface()

convertToMediaGalleryInterface ( array $mediaGallery )

protected

Convert to media gallery interface

Parameters

array $mediaGallery

Returns: \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface[]

Exceptions

Definition at line 2596 of file Product.php.

     {
         $entries = [];
         foreach ($mediaGallery as $image) {
             $entry = $this
                 ->mediaGalleryEntryConverterPool
                 ->getConverterByMediaType($image['media_type'])
                 ->convertTo($this, $image);
             $entries[] = $entry;
         }
         return $entries;
     }

◆ eavReindexCallback()

eavReindexCallback ( )

Reindex callback for EAV indexer

Returns: void

Definition at line 1010 of file Product.php.

     {
         if ($this->isObjectNew() || $this->isDataChanged($this)) {
             $this->_productEavIndexerProcessor->reindexRow($this->getEntityId());
         }
     }

◆ formatUrlKey()

formatUrlKey ( $str )

Formats URL key

Parameters

string $str URL

Returns: string

Definition at line 1811 of file Product.php.

     {
         return $this->getUrlModel()->formatUrlKey($str);
     }

◆ fromArray()

fromArray ( array $data )

Same as setData(), but also initiates the stock item (if it is there)

Parameters

array $data Array to form the object from

Returns: \Magento\Catalog\Model\Product

Definition at line 1860 of file Product.php.

     {
         if (isset($data['stock_item'])) {
             if ($this->moduleManager->isEnabled('Magento_CatalogInventory')) {
                 $stockItem = $this->_stockItemFactory->create();
                 $this->dataObjectHelper->populateWithArray(
                     $stockItem,
                     $data['stock_item'],
                     \Magento\CatalogInventory\Api\Data\StockItemInterface::class
                 );
                 $stockItem->setProduct($this);
                 $this->setStockItem($stockItem);
             }
             unset($data['stock_item']);
         }
         $this->setData($data);
         return $this;
     }

◆ getAttributes()

getAttributes	(	$groupId = `null`,
		$skipSuper = `false`
	)

Retrieve product attributes

If $groupId is null - retrieve all product attributes

Parameters

int	$groupId	Retrieve attributes of the specified group
bool	$skipSuper	Not used

Returns: \Magento\Eav\Model\Entity\Attribute\AbstractAttribute[] @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 842 of file Product.php.

     {
         $productAttributes = $this->getTypeInstance()->getSetAttributes($this);
         if ($groupId) {
             $attributes = [];
             foreach ($productAttributes as $attribute) {
                 if ($attribute->isInGroup($this->getAttributeSetId(), $groupId)) {
                     $attributes[] = $attribute;
                 }
             }
         } else {
             $attributes = $productAttributes;
         }
 
         return $attributes;
     }

◆ getAttributeSetId()

getAttributeSetId ( )

Get product attribute set id

Returns: int

Implements ProductInterface.

Definition at line 611 of file Product.php.

     {
         return $this->_getData(self::ATTRIBUTE_SET_ID);
     }

◆ getAttributeText()

getAttributeText ( $attributeCode )

Get attribute text by its code

Parameters

string $attributeCode Code of the attribute

Returns: string|array|null

Definition at line 1762 of file Product.php.

     {
         return $this->getResource()->getAttribute($attributeCode)->getSource()->getOptionText(
             $this->getData($attributeCode)
         );
     }

◆ getAvailableInCategories()

getAvailableInCategories ( )

Retrieve category ids where product is available

Returns: array

Definition at line 2115 of file Product.php.

     {
         return $this->_getResource()->getAvailableInCategories($this);
     }

◆ getCacheIdTags()

getCacheIdTags ( )

Get cache tags associated with object id

Deprecated:: 102.0.5

See also: \Magento\Catalog\Model\Product::getIdentities

Returns: string[]

Definition at line 2149 of file Product.php.

     {
         $tags = parent::getCacheIdTags();
         $affectedCategoryIds = $this->getAffectedCategoryIds();
         if (!$affectedCategoryIds) {
             $affectedCategoryIds = $this->getCategoryIds();
         }
         foreach ($affectedCategoryIds as $categoryId) {
             $tags[] = \Magento\Catalog\Model\Category::CACHE_TAG . '_' . $categoryId;
         }
         return $tags;
     }

◆ getCalculatedFinalPrice()

getCalculatedFinalPrice ( )

Returns calculated final price

Returns: float

Definition at line 1215 of file Product.php.

     {
         return $this->_getData('calculated_final_price');
     }

◆ getCategory()

getCategory ( )

Retrieve product category

Returns: \Magento\Catalog\Model\Category

Definition at line 738 of file Product.php.

     {
         $category = $this->getData('category');
         if ($category === null && $this->getCategoryId()) {
             $category = $this->categoryRepository->get($this->getCategoryId());
             $this->setCategory($category);
         }
         return $category;
     }

◆ getCategoryCollection()

getCategoryCollection ( )

Retrieve product categories

Returns: \Magento\Framework\Data\Collection

Get collection of product categories

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Catalog\Model\ResourceModel\Category\Collection

Definition at line 776 of file Product.php.

     {
         if ($this->categoryCollection === null || $this->getId() != $this->_productIdCached) {
             $categoryCollection = $this->_getResource()->getCategoryCollection($this);
             $this->setCategoryCollection($categoryCollection);
             $this->_productIdCached = $this->getId();
         }
         return $this->categoryCollection;
     }

◆ getCategoryId()

getCategoryId ( )

Retrieve product category id

Returns: int

Definition at line 724 of file Product.php.

     {
         $category = $this->_registry->registry('current_category');
         if ($category) {
             return $category->getId();
         }
         return false;
     }

◆ getCategoryIds()

getCategoryIds ( )

Retrieve assigned category Ids

Returns: array

Definition at line 753 of file Product.php.

     {
         if (!$this->hasData('category_ids')) {
             $wasLocked = false;
             if ($this->isLockedAttribute('category_ids')) {
                 $wasLocked = true;
                 $this->unlockAttribute('category_ids');
             }
             $ids = $this->_getResource()->getCategoryIds($this);
             $this->setData('category_ids', $ids);
             if ($wasLocked) {
                 $this->lockAttribute('category_ids');
             }
         }
 
         return (array) $this->_getData('category_ids');
     }

◆ getCreatedAt()

getCreatedAt ( )

Get product creation date

Returns: string

Implements ProductInterface.

Definition at line 621 of file Product.php.

     {
         return $this->_getData(self::CREATED_AT);
     }

◆ getCrossSellLinkCollection()

getCrossSellLinkCollection ( )

Retrieve collection cross sell link

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Collection

Definition at line 1434 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useCrossSellLinks()->getLinkCollection();
         $collection->setProduct($this);
         $collection->addLinkTypeIdFilter();
         $collection->addProductIdFilter();
         $collection->joinAttributes();
         return $collection;
     }

◆ getCrossSellProductCollection()

getCrossSellProductCollection ( )

Retrieve collection cross sell product

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection

Definition at line 1422 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useCrossSellLinks()->getProductCollection()->setIsStrongMode();
         $collection->setProduct($this);
         return $collection;
     }

◆ getCrossSellProductIds()

getCrossSellProductIds ( )

Retrieve cross sell products identifiers

Returns: array

Definition at line 1405 of file Product.php.

     {
         if (!$this->hasCrossSellProductIds()) {
             $ids = [];
             foreach ($this->getCrossSellProducts() as $product) {
                 $ids[] = $product->getId();
             }
             $this->setCrossSellProductIds($ids);
         }
         return $this->getData('cross_sell_product_ids');
     }

◆ getCrossSellProducts()

getCrossSellProducts ( )

Retrieve array of cross sell products

Returns: array

Definition at line 1388 of file Product.php.

     {
         if (!$this->hasCrossSellProducts()) {
             $products = [];
             foreach ($this->getCrossSellProductCollection() as $product) {
                 $products[] = $product;
             }
             $this->setCrossSellProducts($products);
         }
         return $this->getData('cross_sell_products');
     }

◆ getCustomAttributesCodes()

getCustomAttributesCodes ( )

protected

Get a list of custom attribute codes that belongs to product attribute set.

If attribute set not specified for product will return all product attribute codes

Returns: string[]

Definition at line 509 of file Product.php.

     {
         if ($this->customAttributesCodes === null) {
             $this->customAttributesCodes = array_diff(
                 array_keys(
                     $this->filterCustomAttribute->execute(
                         $this->eavConfig->getEntityAttributes(
                             self::ENTITY,
                             $this
                         )
                     )
                 ),
                 ProductInterface::ATTRIBUTES
             );
         }
 
         return $this->customAttributesCodes;
     }

◆ getCustomDesignDate()

getCustomDesignDate ( )

Returns array with dates for custom design

Returns: array

Definition at line 1774 of file Product.php.

     {
         $result = [];
         $result['from'] = $this->getData('custom_design_from');
         $result['to'] = $this->getData('custom_design_to');
 
         return $result;
     }

◆ getCustomOption()

getCustomOption ( $code )

Get product custom option info

Parameters

string $code

Returns: array

Definition at line 2077 of file Product.php.

     {
         if (isset($this->_customOptions[$code])) {
             return $this->_customOptions[$code];
         }
         return null;
     }

◆ getCustomOptions()

getCustomOptions ( )

Get all custom options of the product

Returns: array

Definition at line 2066 of file Product.php.

     {
         return $this->_customOptions;
     }

◆ getDefaultAttributeSetId()

getDefaultAttributeSetId ( )

Retrieve default attribute set id

Returns: int

Definition at line 2125 of file Product.php.

     {
         return $this->getResource()->getEntityType()->getDefaultAttributeSetId();
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Framework\Api\ExtensionAttributesInterface

Implements ProductInterface.

Definition at line 2571 of file Product.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getFinalPrice()

getFinalPrice ( $qty = null )

Get product final price

Parameters

float $qty

Returns: float

Definition at line 1201 of file Product.php.

     {
         if ($this->_calculatePrice || $this->_getData('final_price') === null) {
             return $this->getPriceModel()->getFinalPrice($qty, $this);
         } else {
             return $this->_getData('final_price');
         }
     }

◆ getFormatedPrice()

getFormatedPrice ( )

Get formatted by currency product price

Returns: array|double

Deprecated:: 102.0.6

See also: getFormattedPrice()

Definition at line 1174 of file Product.php.

     {
         return $this->getFormattedPrice();
     }

◆ getFormattedPrice()

getFormattedPrice ( )

Get formatted by currency product price

Returns: array|double

Since: 102.0.6

Definition at line 1161 of file Product.php.

     {
         return $this->getPriceModel()->getFormattedPrice($this);
     }

◆ getGiftMessageAvailable()

getGiftMessageAvailable ( )

Custom function for other modules

Returns: string

Definition at line 1894 of file Product.php.

     {
         return $this->_getData('gift_message_available');
     }

◆ getId()

getId ( )

Identifier getter

Returns: int

Since: 101.0.0

Implements SaleableInterface.

Definition at line 2654 of file Product.php.

     {
         return $this->_getData('entity_id');
     }

◆ getIdBySku()

getIdBySku ( $sku )

Retrieve product id by sku

Parameters

string $sku

Returns: integer

Definition at line 714 of file Product.php.

     {
         return $this->_getResource()->getIdBySku($sku);
     }

◆ getIdentities()

getIdentities ( )

Get identities

Returns: array

Implements IdentityInterface.

Definition at line 2339 of file Product.php.

     {
         $identities = [self::CACHE_TAG . '_' . $this->getId()];
         if ($this->getIsChangedCategories()) {
             foreach ($this->getAffectedCategoryIds() as $categoryId) {
                 $identities[] = self::CACHE_PRODUCT_CATEGORY_TAG . '_' . $categoryId;
             }
         }
 
         if (($this->getOrigData('status') != $this->getData('status')) || $this->isStockStatusChanged()) {
             foreach ($this->getCategoryIds() as $categoryId) {
                 $identities[] = self::CACHE_PRODUCT_CATEGORY_TAG . '_' . $categoryId;
             }
         }
         if ($this->_appState->getAreaCode() == \Magento\Framework\App\Area::AREA_FRONTEND) {
             $identities[] = self::CACHE_TAG;
         }
 
         return array_unique($identities);
     }

◆ getImage()

getImage ( )

Sets product image from it's child if possible

Returns: string

Definition at line 2328 of file Product.php.

     {
         $this->getTypeInstance()->setImageFromChildProduct($this);
         return parent::getImage();
     }

◆ getIsSalable()

getIsSalable ( )

Is product salable detecting by product type

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 1713 of file Product.php.

     {
         $productType = $this->getTypeInstance();
         if (method_exists($productType, 'getIsSalable')) {
             return $productType->getIsSalable($this);
         }
         if ($this->hasData('is_saleable')) {
             return $this->getData('is_saleable');
         }
 
         return $this->isSalable();
     }

◆ getIsVirtual()

getIsVirtual ( )

Retrieve is a virtual product

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 2027 of file Product.php.

     {
         return $this->getTypeInstance()->isVirtual($this);
     }

◆ getLinkInstance()

getLinkInstance ( )

Retrieve link instance

Returns: Product\Link

Definition at line 703 of file Product.php.

     {
         return $this->_linkInstance;
     }

◆ getMediaAttributes()

getMediaAttributes ( )

Retrieve attributes for media gallery

Returns: array

Definition at line 1479 of file Product.php.

     {
         if (!$this->hasMediaAttributes()) {
             $mediaAttributes = [];
             foreach ($this->getAttributes() as $attribute) {
                 if ($attribute->getFrontend()->getInputType() == 'media_image') {
                     $mediaAttributes[$attribute->getAttributeCode()] = $attribute;
                 }
             }
             $this->setMediaAttributes($mediaAttributes);
         }
         return $this->getData('media_attributes');
     }

◆ getMediaAttributeValues()

getMediaAttributeValues ( )

Retrieve assoc array that contains media attribute values of the product

Returns: array

Definition at line 1498 of file Product.php.

     {
         $mediaAttributeCodes = $this->_catalogProductMediaConfig->getMediaAttributeCodes();
         $mediaAttributeValues = [];
         foreach ($mediaAttributeCodes as $attributeCode) {
             $mediaAttributeValues[$attributeCode] = $this->getData($attributeCode);
         }
         return $mediaAttributeValues;
     }

◆ getMediaConfig()

getMediaConfig ( )

Retrieve product media config

Returns: Product\Media\Config

Definition at line 1589 of file Product.php.

     {
         return $this->_catalogProductMediaConfig;
     }

◆ getMediaGalleryEntries()

getMediaGalleryEntries ( )

Get media gallery entries

Returns: \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryInterface[]|null

Exceptions

Implements ProductInterface.

Definition at line 2615 of file Product.php.

     {
         $mediaGallery = $this->getMediaGallery('images');
         if ($mediaGallery === null) {
             return null;
         }
         //convert the data
         $convertedEntries = $this->convertToMediaGalleryInterface($mediaGallery);
         return $convertedEntries;
     }

◆ getMediaGalleryImages()

getMediaGalleryImages ( )

Retrieve media gallery images

Returns: \Magento\Framework\Data\Collection

Definition at line 1513 of file Product.php.

     {
         $directory = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);
         if (!$this->hasData('media_gallery_images')) {
             $this->setData('media_gallery_images', $this->_collectionFactory->create());
         }
         if (!$this->getData('media_gallery_images')->count() && is_array($this->getMediaGallery('images'))) {
             $images = $this->getData('media_gallery_images');
             foreach ($this->getMediaGallery('images') as $image) {
                 if (!empty($image['disabled'])
                     || !empty($image['removed'])
                     || empty($image['value_id'])
                     || $images->getItemById($image['value_id']) != null
                 ) {
                     continue;
                 }
                 $image['url'] = $this->getMediaConfig()->getMediaUrl($image['file']);
                 $image['id'] = $image['value_id'];
                 $image['path'] = $directory->getAbsolutePath($this->getMediaConfig()->getMediaPath($image['file']));
                 $images->addItem(new \Magento\Framework\DataObject($image));
             }
             $this->setData('media_gallery_images', $images);
         }
 
         return $this->getData('media_gallery_images');
     }

◆ getMinimalPrice()

getMinimalPrice ( )

Returns minimal price

Returns: float

Definition at line 1225 of file Product.php.

     {
         return max($this->_getData('minimal_price'), 0);
     }

◆ getName()

getName ( )

Get product name

Returns: string @codeCoverageIgnoreStart

Implements ProductInterface.

Definition at line 572 of file Product.php.

     {
         return $this->_getData(self::NAME);
     }

◆ getOptionInstance()

getOptionInstance ( )

Retrieve option instance

Returns: Product\Option

Definition at line 1945 of file Product.php.

     {
         if (!isset($this->optionInstance)) {
             $this->optionInstance = $this->optionFactory->create();
             $this->optionInstance->setProduct($this);
         }
         return $this->optionInstance;
     }

◆ getOptions()

getOptions ( )

Get all options of product

Returns: \Magento\Catalog\Api\Data\ProductCustomOptionInterface[]|null

Implements ProductInterface.

Definition at line 2004 of file Product.php.

     {
         return $this->getData('options');
     }

◆ getPreconfiguredValues()

getPreconfiguredValues ( )

Get preconfigured values from product

Returns: \Magento\Framework\DataObject

Definition at line 2220 of file Product.php.

     {
         $preConfiguredValues = $this->getData('preconfigured_values');
         if (!$preConfiguredValues) {
             $preConfiguredValues = new \Magento\Framework\DataObject();
         }
 
         return $preConfiguredValues;
     }

◆ getPrice()

getPrice ( )

Get product price through type instance

Returns: float

Implements ProductInterface.

Definition at line 584 of file Product.php.

     {
         if ($this->_calculatePrice || !$this->getData(self::PRICE)) {
             return $this->getPriceModel()->getPrice($this);
         } else {
             return $this->getData(self::PRICE);
         }
     }

◆ getPriceInfo()

getPriceInfo ( )

Get product Price Info object

Returns: \Magento\Framework\Pricing\PriceInfo\Base

Implements SaleableInterface.

Definition at line 1114 of file Product.php.

     {
         if (!$this->_priceInfo) {
             $this->_priceInfo = $this->_catalogProductType->getPriceInfo($this);
         }
         return $this->_priceInfo;
     }

◆ getPriceModel()

getPriceModel ( )

Get product price model

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

Definition at line 1104 of file Product.php.

     {
         return $this->_catalogProductType->priceFactory($this->getTypeId());
     }

◆ getProductEntitiesInfo()

getProductEntitiesInfo ( $columns = null )

Retrieve product entities info as array

Parameters

string | array $columns One or several columns

Returns: array

Definition at line 2308 of file Product.php.

     {
         return $this->_getResource()->getProductEntitiesInfo($columns);
     }

◆ getProductLinks()

getProductLinks ( )

Get product links info

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

Implements ProductInterface.

Definition at line 1449 of file Product.php.

     {
         if ($this->_links === null) {
             $this->_links = $this->getLinkRepository()->getList($this);
         }
         return $this->_links;
     }

◆ getProductOptionsCollection()

getProductOptionsCollection ( )

Retrieve options collection of product

Returns: \Magento\Catalog\Model\ResourceModel\Product\Option\Collection

Definition at line 1994 of file Product.php.

     {
         return $this->getOptionInstance()->getProductOptionCollection($this);
     }

◆ getProductUrl()

getProductUrl ( $useSid = null )

Retrieve Product URL

Parameters

bool $useSid

Returns: string

Definition at line 1789 of file Product.php.

     {
         return $this->getUrlModel()->getProductUrl($this, $useSid);
     }

◆ getQty()

getQty ( )

Get quantity for product

Returns: float

Implements SaleableInterface.

Definition at line 988 of file Product.php.

     {
         return $this->getData('qty');
     }

◆ getQuantityAndStockStatus()

getQuantityAndStockStatus ( )

Get quantity and stock status data

Returns: array|null

Deprecated:: 102.0.0 as Product model shouldn't be responsible for stock status

See also: StockItemInterface when you want to change the stock data; StockStatusInterface when you want to read the stock data for representation layer (storefront); StockItemRepositoryInterface::save as extension point for customization of saving process

Since: 102.0.0

Definition at line 2723 of file Product.php.

     {
         return $this->getData('quantity_and_stock_status');
     }

◆ getRelatedLinkCollection()

getRelatedLinkCollection ( )

Retrieve collection related link

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Collection

Definition at line 1312 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useRelatedLinks()->getLinkCollection();
         $collection->setProduct($this);
         $collection->addLinkTypeIdFilter();
         $collection->addProductIdFilter();
         $collection->joinAttributes();
         return $collection;
     }

◆ getRelatedProductCollection()

getRelatedProductCollection ( )

Retrieve collection related product

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection

Definition at line 1300 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useRelatedLinks()->getProductCollection()->setIsStrongMode();
         $collection->setProduct($this);
         return $collection;
     }

◆ getRelatedProductIds()

getRelatedProductIds ( )

Retrieve related products identifiers

Returns: array

Definition at line 1283 of file Product.php.

     {
         if (!$this->hasRelatedProductIds()) {
             $ids = [];
             foreach ($this->getRelatedProducts() as $product) {
                 $ids[] = $product->getId();
             }
             $this->setRelatedProductIds($ids);
         }
         return $this->getData('related_product_ids');
     }

◆ getRelatedProducts()

getRelatedProducts ( )

Retrieve array of related products

Returns: array

Definition at line 1265 of file Product.php.

     {
         if (!$this->hasRelatedProducts()) {
             $products = [];
             $collection = $this->getRelatedProductCollection();
             foreach ($collection as $product) {
                 $products[] = $product;
             }
             $this->setRelatedProducts($products);
         }
         return $this->getData('related_products');
     }

◆ getRequestPath()

getRequestPath ( )

Returns request path

Returns: string

Definition at line 1884 of file Product.php.

     {
         return $this->_getData('request_path');
     }

◆ getSku()

getSku ( )

Retrieve sku through type instance

Returns: string

Implements ProductInterface.

Definition at line 1925 of file Product.php.

     {
         return $this->getTypeInstance()->getSku($this);
     }

◆ getSpecialFromDate()

getSpecialFromDate ( )

Returns starting date of the special price

Returns: mixed

Definition at line 1245 of file Product.php.

     {
         return $this->_getData('special_from_date');
     }

◆ getSpecialPrice()

getSpecialPrice ( )

Returns special price

Returns: float

Definition at line 1235 of file Product.php.

     {
         return $this->_getData('special_price');
     }

◆ getSpecialToDate()

getSpecialToDate ( )

Returns end date of the special price

Returns: mixed

Definition at line 1255 of file Product.php.

     {
         return $this->_getData('special_to_date');
     }

◆ getStatus()

getStatus ( )

Get product status

Returns: int

Implements ProductInterface.

Definition at line 665 of file Product.php.

     {
         $status = $this->_getData(self::STATUS);
         return $status !== null ? $status : \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_ENABLED;
     }

◆ getStockData()

getStockData ( )

Get stock data

Returns: array|null

Deprecated:: 102.0.0 as Product model shouldn't be responsible for stock status

See also: StockItemInterface when you want to change the stock data; StockStatusInterface when you want to read the stock data for representation layer (storefront); StockItemRepositoryInterface::save as extension point for customization of saving process

Since: 102.0.0

Definition at line 2757 of file Product.php.

     {
         return $this->getData('stock_data');
     }

◆ getStoreId()

getStoreId ( )

Retrieve Store Id

Returns: int

Definition at line 533 of file Product.php.

     {
         if ($this->hasData(self::STORE_ID)) {
             return $this->getData(self::STORE_ID);
         }
         return $this->_storeManager->getStore()->getId();
     }

◆ getStoreIds()

getStoreIds ( )

Get all sore ids where product is presented

Returns: array

Definition at line 817 of file Product.php.

     {
         if (!$this->hasStoreIds()) {
             $storeIds = [];
             if ($websiteIds = $this->getWebsiteIds()) {
                 foreach ($websiteIds as $websiteId) {
                     $websiteStores = $this->_storeManager->getWebsite($websiteId)->getStoreIds();
                     $storeIds = array_merge($storeIds, $websiteStores);
                 }
             }
             $this->setStoreIds($storeIds);
         }
         return $this->getData('store_ids');
     }

◆ getTierPrice()

getTierPrice ( $qty = null )

Get product tier price for the customer, based on qty of this product

Parameters

float $qty

Returns: float|array

Definition at line 1150 of file Product.php.

     {
         return $this->getPriceModel()->getTierPrice($qty, $this);
     }

◆ getTierPrices()

getTierPrices ( )

Gets list of product tier prices

Returns: \Magento\Catalog\Api\Data\ProductTierPriceInterface[]|null

Implements ProductInterface.

Definition at line 1127 of file Product.php.

     {
         return $this->getPriceModel()->getTierPrices($this);
     }

◆ getTypeId()

getTypeId ( )

Get product type identifier

Returns: array|string

Implements SaleableInterface.

Definition at line 653 of file Product.php.

     {
         return $this->_getData(self::TYPE_ID);
     }

◆ getTypeInstance()

getTypeInstance ( )

Retrieve type instance of the product.

Type instance implements product type depended logic and is a singleton shared by all products of the same type.

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

Definition at line 678 of file Product.php.

     {
         if ($this->_typeInstance === null) {
             $this->_typeInstance = $this->_catalogProductType->factory($this);
         }
         return $this->_typeInstance;
     }

◆ getUpdatedAt()

getUpdatedAt ( )

Get previous product update date

Returns: string

Implements ProductInterface.

Definition at line 631 of file Product.php.

     {
         return $this->_getData(self::UPDATED_AT);
     }

◆ getUpSellLinkCollection()

getUpSellLinkCollection ( )

Retrieve collection up sell link

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Collection

Definition at line 1373 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useUpSellLinks()->getLinkCollection();
         $collection->setProduct($this);
         $collection->addLinkTypeIdFilter();
         $collection->addProductIdFilter();
         $collection->joinAttributes();
         return $collection;
     }

◆ getUpSellProductCollection()

getUpSellProductCollection ( )

Retrieve collection up sell product

Returns: \Magento\Catalog\Model\ResourceModel\Product\Link\Product\Collection

Definition at line 1361 of file Product.php.

     {
         $collection = $this->getLinkInstance()->useUpSellLinks()->getProductCollection()->setIsStrongMode();
         $collection->setProduct($this);
         return $collection;
     }

◆ getUpSellProductIds()

getUpSellProductIds ( )

Retrieve up sell products identifiers

Returns: array

Definition at line 1344 of file Product.php.

     {
         if (!$this->hasUpSellProductIds()) {
             $ids = [];
             foreach ($this->getUpSellProducts() as $product) {
                 $ids[] = $product->getId();
             }
             $this->setUpSellProductIds($ids);
         }
         return $this->getData('up_sell_product_ids');
     }

◆ getUpSellProducts()

getUpSellProducts ( )

Retrieve array of up sell products

Returns: array

Definition at line 1327 of file Product.php.

     {
         if (!$this->hasUpSellProducts()) {
             $products = [];
             foreach ($this->getUpSellProductCollection() as $product) {
                 $products[] = $product;
             }
             $this->setUpSellProducts($products);
         }
         return $this->getData('up_sell_products');
     }

◆ getUrlInStore()

getUrlInStore ( $params = [] )

Retrieve URL in current store

Parameters

array $params the route params

Returns: string

Definition at line 1800 of file Product.php.

     {
         return $this->getUrlModel()->getUrlInStore($this, $params);
     }

◆ getUrlModel()

getUrlModel ( )

Get product url model

Returns: Product\Url

Definition at line 546 of file Product.php.

     {
         return $this->_urlModel;
     }

◆ getVisibility()

getVisibility ( )

Get visibility status

@codeCoverageIgnoreStart

See also: \Magento\Catalog\Model\Product\Visibility

Returns: int

Implements ProductInterface.

Definition at line 601 of file Product.php.

     {
         return $this->_getData(self::VISIBILITY);
     }

◆ getVisibleInCatalogStatuses()

getVisibleInCatalogStatuses ( )

Returns visible status IDs in catalog

Returns: array

Definition at line 1599 of file Product.php.

     {
         return $this->_catalogProductStatus->getVisibleStatusIds();
     }

◆ getVisibleInSiteVisibilities()

getVisibleInSiteVisibilities ( )

Retrieve visible in site visibilities

Returns: array

Definition at line 1629 of file Product.php.

     {
         return $this->_catalogProductVisibility->getVisibleInSiteIds();
     }

◆ getVisibleStatuses()

getVisibleStatuses ( )

Retrieve visible statuses

Returns: array

Definition at line 1609 of file Product.php.

     {
         return $this->_catalogProductStatus->getVisibleStatusIds();
     }

◆ getWebsiteIds()

getWebsiteIds ( )

Retrieve product websites identifiers

Returns: array

Definition at line 803 of file Product.php.

     {
         if (!$this->hasWebsiteIds()) {
             $ids = $this->_getResource()->getWebsiteIds($this);
             $this->setWebsiteIds($ids);
         }
         return $this->getData('website_ids');
     }

◆ getWeight()

getWeight ( )

Retrieve weight through type instance

Returns: float

Implements ProductInterface.

Definition at line 1935 of file Product.php.

     {
         return $this->getTypeInstance()->getWeight($this);
     }

◆ hasCustomOptions()

hasCustomOptions ( )

Checks if there custom option for this product

Returns: bool

Definition at line 2090 of file Product.php.

     {
         if (count($this->_customOptions)) {
             return true;
         } else {
             return false;
         }
     }

◆ hasGalleryAttribute()

hasGalleryAttribute ( )

Checks whether product has Media Gallery attribute.

Returns: bool

Since: 101.0.0

Definition at line 1546 of file Product.php.

     {
         $attributes = $this->getAttributes();
 
         if (!isset($attributes['media_gallery'])
             || !($attributes['media_gallery'] instanceof \Magento\Eav\Model\Entity\Attribute\AbstractAttribute)
         ) {
             return false;
         }
 
         return true;
     }

◆ isAvailable()

isAvailable ( )

Check whether the product type or stock allows to purchase the product

Returns: bool

Definition at line 1702 of file Product.php.

     {
         return $this->_catalogProduct->getSkipSaleableCheck() || $this->getTypeInstance()->isSalable($this);
     }

◆ isComposite()

isComposite ( )

Check is product composite

Returns: bool

Definition at line 1904 of file Product.php.

     {
         return $this->getTypeInstance()->isComposite($this);
     }

◆ isDataChanged()

isDataChanged ( )

Check if data was changed

Returns: bool

Definition at line 1022 of file Product.php.

     {
         foreach (array_keys($this->getData()) as $field) {
             if ($this->dataHasChangedFor($field)) {
                 return true;
             }
         }
         return false;
     }

◆ isDisabled()

isDisabled ( )

Checks whether product has disabled status

Returns: bool

Definition at line 2318 of file Product.php.

     {
         return $this->getStatus() == \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_DISABLED;
     }

◆ isDuplicable()

isDuplicable ( )

Checks product can be duplicated

Returns: boolean

Definition at line 1649 of file Product.php.

     {
         return $this->_isDuplicable;
     }

◆ isInStock()

isInStock ( )

Whether product available in stock

Returns: bool

Definition at line 1751 of file Product.php.

     {
         return $this->getStatus() == \Magento\Catalog\Model\Product\Attribute\Source\Status::STATUS_ENABLED;
     }

◆ isProductsHasSku()

isProductsHasSku ( array $productIds )

Check for empty SKU on each product

Parameters

array $productIds

Returns: boolean|null

Definition at line 2168 of file Product.php.

     {
         $products = $this->_getResource()->getProductsSku($productIds);
         if (count($products)) {
             foreach ($products as $product) {
                 if (!strlen($product['sku'])) {
                     return false;
                 }
             }
             return true;
         }
         return null;
     }

◆ isSalable()

isSalable ( )

Check is product available for sale

Returns: bool

Definition at line 1671 of file Product.php.

     {
         if ($this->_catalogProduct->getSkipSaleableCheck()) {
             return true;
         }
         if (($this->getOrigData('status') != $this->getData('status'))
             || $this->isStockStatusChanged()) {
             $this->unsetData('salable');
         }
 
         if ($this->hasData('salable')) {
             return $this->getData('salable');
         }
         $this->_eventManager->dispatch('catalog_product_is_salable_before', ['product' => $this]);
 
         $salable = $this->isAvailable();
 
         $object = new \Magento\Framework\DataObject(['product' => $this, 'is_salable' => $salable]);
         $this->_eventManager->dispatch(
             'catalog_product_is_salable_after',
             ['product' => $this, 'salable' => $object]
         );
         $this->setData('salable', $object->getIsSalable());
         return $this->getData('salable');
     }

◆ isSaleable()

isSaleable ( )

Alias for isSalable()

Returns: bool

Definition at line 1741 of file Product.php.

     {
         return $this->isSalable();
     }

◆ isVirtual()

isVirtual ( )

Check is a virtual product

Returns: bool

Definition at line 1731 of file Product.php.

     {
         return $this->getIsVirtual();
     }

◆ isVisibleInCatalog()

isVisibleInCatalog ( )

Check Product visible in catalog

Returns: bool

Definition at line 1619 of file Product.php.

     {
         return in_array($this->getStatus(), $this->getVisibleInCatalogStatuses());
     }

◆ isVisibleInSiteVisibility()

isVisibleInSiteVisibility ( )

Check Product visible in site

Returns: bool

Definition at line 1639 of file Product.php.

     {
         return in_array($this->getVisibility(), $this->getVisibleInSiteVisibilities());
     }

◆ prepareCustomOptions()

prepareCustomOptions ( )

Prepare product custom options.

To be sure that all product custom options does not has ID and has product instance

Returns: \Magento\Catalog\Model\Product

Definition at line 2237 of file Product.php.

     {
         foreach ($this->getCustomOptions() as $option) {
             if (!is_object($option->getProduct()) || $option->getId()) {
                 $this->addCustomOption($option->getCode(), $option->getValue());
             }
         }
 
         return $this;
     }

◆ priceReindexCallback()

priceReindexCallback ( )

Callback for entity reindex

Returns: void

Definition at line 998 of file Product.php.

     {
         if ($this->isObjectNew() || $this->_catalogProduct->isDataForPriceIndexerWasChanged($this)) {
             $this->_productPriceIndexerProcessor->reindexRow($this->getEntityId());
         }
     }

◆ processBuyRequest()

processBuyRequest ( \Magento\Framework\DataObject $buyRequest )

Parse buyRequest into options values used by product

Parameters

\Magento\Framework\DataObject $buyRequest

Returns: \Magento\Framework\DataObject

Definition at line 2188 of file Product.php.

     {
         $options = new \Magento\Framework\DataObject();
 
         /* add product custom options data */
         $customOptions = $buyRequest->getOptions();
         if (is_array($customOptions)) {
             array_filter(
                 $customOptions,
                 function ($value) {
                     return $value !== '';
                 }
             );
             $options->setOptions($customOptions);
         }
 
         /* add product type selected options data */
         $type = $this->getTypeInstance();
         $typeSpecificOptions = $type->processBuyRequest($this, $buyRequest);
         $options->addData($typeSpecificOptions);
 
         /* check correctness of product's options */
         $options->setErrors($type->checkProductConfiguration($this, $buyRequest));
 
         return $options;
     }

◆ reindex()

reindex ( )

Init indexing process after product save

Returns: void

Definition at line 1037 of file Product.php.

     {
         if ($this->_catalogProduct->isDataForProductCategoryIndexerWasChanged($this) || $this->isDeleted()) {
             $productCategoryIndexer = $this->indexerRegistry->get(Indexer\Product\Category::INDEXER_ID);
             if (!$productCategoryIndexer->isScheduled()) {
                 $productCategoryIndexer->reindexRow($this->getId());
             }
         }
         $this->_productFlatIndexerProcessor->reindexRow($this->getEntityId());
     }

◆ reloadPriceInfo()

reloadPriceInfo ( )

Reload PriceInfo object

Returns: \Magento\Framework\Pricing\PriceInfo\Base

Definition at line 2386 of file Product.php.

     {
         if ($this->_priceInfo) {
             $this->_priceInfo = null;
             return $this->getPriceInfo();
         }
     }

◆ reset()

reset ( )

Reset all model data

Returns: \Magento\Catalog\Model\Product

Definition at line 2135 of file Product.php.

     {
         $this->unlockAttributes();
         $this->_clearData();
         return $this;
     }

◆ setAssociatedProductIds()

setAssociatedProductIds ( array $productIds )

Set the associated products

Parameters

array $productIds

Returns: $this

Since: 101.0.2

Definition at line 2706 of file Product.php.

     {
         $this->getExtensionAttributes()->setConfigurableProductLinks($productIds);
         return $this;
     }

◆ setAttributeSetId()

setAttributeSetId ( $attributeSetId )

Set product attribute set id

Parameters

int $attributeSetId

Returns: $this

Implements ProductInterface.

Definition at line 2481 of file Product.php.

     {
         return $this->setData(self::ATTRIBUTE_SET_ID, $attributeSetId);
     }

◆ setCategoryCollection()

setCategoryCollection ( \Magento\Framework\Data\Collection $categoryCollection )

protected

Set product categories.

Parameters

\Magento\Framework\Data\Collection $categoryCollection

Returns: $this

Definition at line 792 of file Product.php.

     {
         $this->categoryCollection = $categoryCollection;
         return $this;
     }

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Set product created date

Parameters

string $createdAt

Returns: $this

Implements ProductInterface.

Definition at line 2525 of file Product.php.

     {
         return $this->setData(self::CREATED_AT, $createdAt);
     }

◆ setCustomOptions()

setCustomOptions ( array $options )

Sets custom options for the product

Parameters

array $options Array of options

Returns: void

Definition at line 2056 of file Product.php.

     {
         $this->_customOptions = $options;
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Catalog\Api\Data\ProductExtensionInterface $extensionAttributes )

Set an extension attributes object.

Parameters

\Magento\Catalog\Api\Data\ProductExtensionInterface $extensionAttributes

Returns: $this

Implements ProductInterface.

Definition at line 2582 of file Product.php.

     {
         return $this->_setExtensionAttributes($extensionAttributes);
     }

◆ setFinalPrice()

setFinalPrice ( $price )

Sets final price of product

This func is equal to magic 'setFinalPrice()', but added as a separate func, because in cart with bundle products it's called very often in Item->getProduct(). So removing chain of magic with more cpu consuming algorithms gives nice optimization boost.

Parameters

float $price Price amount

Returns: \Magento\Catalog\Model\Product

Definition at line 1189 of file Product.php.

     {
         $this->_data['final_price'] = $price;
         return $this;
     }

◆ setId()

setId ( $value )

Set entity Id

Parameters

int $value

Returns: $this

Since: 101.0.0

Implements ProductInterface.

Definition at line 2666 of file Product.php.

     {
         return $this->setData('entity_id', $value);
     }

◆ setIsDuplicable()

setIsDuplicable ( $value )

Set is duplicable flag

Parameters

boolean $value

Returns: \Magento\Catalog\Model\Product

Definition at line 1660 of file Product.php.

     {
         $this->_isDuplicable = (bool)$value;
         return $this;
     }

◆ setMediaGalleryEntries()

setMediaGalleryEntries ( array $mediaGalleryEntries = null )

Set media gallery entries

Parameters

ProductAttributeMediaGalleryEntryInterface[] $mediaGalleryEntries

Returns: $this

Exceptions

Implements ProductInterface.

Definition at line 2633 of file Product.php.

     {
         if ($mediaGalleryEntries !== null) {
             $images = [];
             foreach ($mediaGalleryEntries as $entry) {
                 $images[] = $this
                     ->mediaGalleryEntryConverterPool
                     ->getConverterByMediaType($entry->getMediaType())
                     ->convertFrom($entry);
             }
             $this->setData('media_gallery', ['images' => $images]);
         }
         return $this;
     }

◆ setName()

setName ( $name )

Set product name

Parameters

string $name

Returns: $this

Implements ProductInterface.

Definition at line 2459 of file Product.php.

     {
         return $this->setData(self::NAME, $name);
     }

◆ setOptions()

setOptions ( array $options = null )

Set options for product

Parameters

Implements ProductInterface.

Definition at line 2015 of file Product.php.

     {
         $this->setData('options', $options);
         return $this;
     }

◆ setPrice()

setPrice ( $price )

Set product price

Parameters

float $price

Returns: $this

Implements ProductInterface.

Definition at line 2492 of file Product.php.

     {
         return $this->setData(self::PRICE, $price);
     }

◆ setPriceCalculation()

setPriceCalculation ( $calculate = true )

Set Price calculation flag

Parameters

bool $calculate

Returns: void

Deprecated:: 102.0.4

Definition at line 643 of file Product.php.

     {
         $this->_calculatePrice = $calculate;
     }

◆ setProductLinks()

setProductLinks ( array $links = null )

Set product links info

Parameters

Implements ProductInterface.

Definition at line 1463 of file Product.php.

     {
         if ($links === null) {
             $this->setData('ignore_links_flag', true);
         } else {
             $this->setData('ignore_links_flag', false);
         }
         $this->_links = $links;
         return $this;
     }

◆ setQty()

setQty ( $qty )

Set quantity for product

Parameters

float $qty

Returns: $this

Definition at line 974 of file Product.php.

     {
         if ($this->getData('qty') != $qty) {
             $this->setData('qty', $qty);
             $this->reloadPriceInfo();
         }
         return $this;
     }

◆ setQuantityAndStockStatus()

setQuantityAndStockStatus ( $quantityAndStockStatusData )

Set quantity and stock status data

Parameters

array $quantityAndStockStatusData

Returns: $this

Deprecated:: 102.0.0 as Product model shouldn't be responsible for stock status

See also: StockItemInterface when you want to change the stock data; StockStatusInterface when you want to read the stock data for representation layer (storefront); StockItemRepositoryInterface::save as extension point for customization of saving process

Since: 102.0.0

Definition at line 2740 of file Product.php.

     {
         $this->setData('quantity_and_stock_status', $quantityAndStockStatusData);
         return $this;
     }

◆ setSku()

setSku ( $sku )

Set product sku

Parameters

string $sku

Returns: $this

Implements ProductInterface.

Definition at line 2448 of file Product.php.

     {
         return $this->setData(self::SKU, $sku);
     }

◆ setStatus()

setStatus ( $status )

Set product status

Parameters

int $status

Returns: $this

Implements ProductInterface.

Definition at line 2503 of file Product.php.

     {
         return $this->setData(self::STATUS, $status);
     }

◆ setStockData()

setStockData ( $stockData )

Set stock data

Parameters

array $stockData

Returns: $this

Deprecated:: 102.0.0 as Product model shouldn't be responsible for stock status

See also: StockItemInterface when you want to change the stock data; StockStatusInterface when you want to read the stock data for representation layer (storefront); StockItemRepositoryInterface::save as extension point for customization of saving process

Since: 102.0.0

Definition at line 2774 of file Product.php.

     {
         $this->setData('stock_data', $stockData);
         return $this;
     }

◆ setStoreId()

setStoreId ( $storeId )

Set product store id

Parameters

int $storeId

Returns: $this

Definition at line 2470 of file Product.php.

     {
         return $this->setData(self::STORE_ID, $storeId);
     }

◆ setTierPrices()

setTierPrices ( array $tierPrices = null )

Sets list of product tier prices

Parameters

Implements ProductInterface.

Definition at line 1138 of file Product.php.

     {
         $this->getPriceModel()->setTierPrices($this, $tierPrices);
         return $this;
     }

◆ setTypeId()

setTypeId ( $typeId )

Set product type id

Parameters

string $typeId

Returns: $this

Implements ProductInterface.

Definition at line 2558 of file Product.php.

     {
         if ($typeId !== $this->_getData('type_id')) {
             $this->_typeInstance = null;
         }
         return $this->setData(self::TYPE_ID, $typeId);
     }

◆ setTypeInstance()

setTypeInstance ( $instance )

Set type instance for the product

Parameters

\Magento\Catalog\Model\Product\Type\AbstractType | null $instance Product type instance

Returns: \Magento\Catalog\Model\Product

Definition at line 692 of file Product.php.

     {
         $this->_typeInstance = $instance;
         return $this;
     }

◆ setUpdatedAt()

setUpdatedAt ( $updatedAt )

Set product updated date

Parameters

string $updatedAt

Returns: $this

Implements ProductInterface.

Definition at line 2536 of file Product.php.

     {
         return $this->setData(self::UPDATED_AT, $updatedAt);
     }

◆ setVisibility()

setVisibility ( $visibility )

Set product visibility

Parameters

int $visibility

Returns: $this

Implements ProductInterface.

Definition at line 2514 of file Product.php.

     {
         return $this->setData(self::VISIBILITY, $visibility);
     }

◆ setWeight()

setWeight ( $weight )

Set product weight

Parameters

float $weight

Returns: $this

Implements ProductInterface.

Definition at line 2547 of file Product.php.

     {
         return $this->setData(self::WEIGHT, $weight);
     }

◆ toArray()

toArray ( array $arrAttributes = [] )

Renders the object to array

Parameters

array $arrAttributes Attribute array

Returns: array

Definition at line 1843 of file Product.php.

     {
         $data = parent::toArray($arrAttributes);
         $stock = $this->getStockItem();
         if ($stock) {
             $data['stock_item'] = $stock->toArray();
         }
         unset($data['stock_item']['product']);
         return $data;
     }

◆ validate()

validate ( )

Validate Product Data

Todo:: implement full validation process with errors returning which are ignoring now

Returns: array

Definition at line 558 of file Product.php.

     {
         $this->_eventManager->dispatch($this->_eventPrefix . '_validate_before', $this->_getEventData());
         $result = $this->_getResource()->validate($this);
         $this->_eventManager->dispatch($this->_eventPrefix . '_validate_after', $this->_getEventData());
         return $result;
     }

Field Documentation

◆ $_cacheTag

$_cacheTag = self::CACHE_TAG

protected

Definition at line 77 of file Product.php.

◆ $_calculatePrice

$_calculatePrice = true

protected

Definition at line 169 of file Product.php.

◆ $_canAffectOptions

$_canAffectOptions = false

protected

Definition at line 92 of file Product.php.

◆ $_catalogProduct

$_catalogProduct = null

protected

Definition at line 176 of file Product.php.

◆ $_catalogProductMediaConfig

$_catalogProductMediaConfig

protected

Definition at line 200 of file Product.php.

◆ $_catalogProductStatus

$_catalogProductStatus

protected

Definition at line 207 of file Product.php.

◆ $_catalogProductType

$_catalogProductType

protected

Definition at line 193 of file Product.php.

◆ $_catalogProductVisibility

$_catalogProductVisibility

protected

Definition at line 214 of file Product.php.

◆ $_collectionFactory

$_collectionFactory

protected

Definition at line 186 of file Product.php.

◆ $_customOptions

$_customOptions = []

protected

Definition at line 113 of file Product.php.

◆ $_errors

$_errors = []

protected

Definition at line 136 of file Product.php.

◆ $_eventObject

$_eventObject = 'product'

protected

Definition at line 87 of file Product.php.

◆ $_eventPrefix

$_eventPrefix = 'catalog_product'

protected

Definition at line 82 of file Product.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 235 of file Product.php.

◆ $_isDuplicable

$_isDuplicable = true

protected

Definition at line 162 of file Product.php.

◆ $_itemOptionFactory

$_itemOptionFactory

protected

Definition at line 228 of file Product.php.

◆ $_linkInstance

$_linkInstance

protected

Definition at line 106 of file Product.php.

◆ $_links

$_links = null

protected

Definition at line 155 of file Product.php.

◆ $_priceInfo

$_priceInfo

protected

Definition at line 260 of file Product.php.

◆ $_productEavIndexerProcessor

$_productEavIndexerProcessor

protected

Definition at line 255 of file Product.php.

◆ $_productFlatIndexerProcessor

$_productFlatIndexerProcessor

protected

Definition at line 245 of file Product.php.

◆ $_productIdCached

$_productIdCached

protected

Definition at line 313 of file Product.php.

◆ $_productPriceIndexerProcessor

$_productPriceIndexerProcessor

protected

Definition at line 250 of file Product.php.

◆ $_resource

$_resource

protected

Definition at line 126 of file Product.php.

◆ $_stockItemFactory

$_stockItemFactory

protected

Definition at line 221 of file Product.php.

◆ $_typeInstance

$_typeInstance = null

protected

Definition at line 99 of file Product.php.

◆ $_url

$_url

staticprotected

Definition at line 131 of file Product.php.

◆ $_urlModel

$_urlModel = null

protected

Definition at line 120 of file Product.php.

◆ $categoryCollection

$categoryCollection

protected

Definition at line 272 of file Product.php.

◆ $categoryRepository

$categoryRepository

protected

Definition at line 265 of file Product.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 308 of file Product.php.

◆ $entityCollectionProvider

$entityCollectionProvider

protected

Parameters

Definition at line 288 of file Product.php.

◆ $imageCacheFactory

$imageCacheFactory

protected

Definition at line 277 of file Product.php.

◆ $indexerRegistry

$indexerRegistry

protected

Definition at line 240 of file Product.php.

◆ $interfaceAttributes

$interfaceAttributes = ProductInterface::ATTRIBUTES

protected

Definition at line 322 of file Product.php.

◆ $joinProcessor

$joinProcessor

protected

Definition at line 327 of file Product.php.

◆ $linkProvider

$linkProvider

protected

Parameters

Definition at line 293 of file Product.php.

◆ $linkRepository

$linkRepository

protected

Definition at line 51 of file Product.php.

◆ $linkTypeProvider

$linkTypeProvider

protected

Definition at line 346 of file Product.php.

◆ $mediaGalleryEntryConverterPool

$mediaGalleryEntryConverterPool

protected

Definition at line 334 of file Product.php.

◆ $mediaGalleryProcessor

$mediaGalleryProcessor

protected

Definition at line 340 of file Product.php.

◆ $metadataService

$metadataService

protected

Definition at line 283 of file Product.php.

◆ $moduleManager

$moduleManager

protected

Definition at line 181 of file Product.php.

◆ $optionFactory

$optionFactory

protected

Definition at line 143 of file Product.php.

◆ $optionInstance

$optionInstance

protected

Definition at line 150 of file Product.php.

◆ $productLinkExtensionFactory

$productLinkExtensionFactory

protected

Parameters

Definition at line 303 of file Product.php.

◆ $productLinkFactory

$productLinkFactory

protected

Parameters

Definition at line 298 of file Product.php.

◆ CACHE_PRODUCT_CATEGORY_TAG

const CACHE_PRODUCT_CATEGORY_TAG = 'cat_c_p'

Category product relation cache tag

Definition at line 67 of file Product.php.

◆ CACHE_TAG

const CACHE_TAG = 'cat_p'

Product cache tag

Definition at line 62 of file Product.php.

◆ ENTITY

const ENTITY = 'catalog_product'

Entity code. Can be used as part of method name for entity processing

Definition at line 57 of file Product.php.

◆ STORE_ID

const STORE_ID = 'store_id'

Product Store Id

Definition at line 72 of file Product.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toArray()

◆ _afterLoad()

◆ _clearData()

◆ _clearReferences()

◆ _construct()

◆ _getResource()

◆ addAttributeUpdate()

◆ addCustomOption()

◆ addImageToMediaGallery()

◆ addOption()

◆ afterDeleteCommit()

◆ afterSave()

◆ beforeDelete()

◆ beforeSave()

◆ canAffectOptions()

◆ canBeShowInCategory()

◆ canConfigure()

◆ cleanCache()

◆ convertToMediaGalleryInterface()

◆ eavReindexCallback()

◆ formatUrlKey()

◆ fromArray()

◆ getAttributes()

◆ getAttributeSetId()

◆ getAttributeText()

◆ getAvailableInCategories()

◆ getCacheIdTags()

◆ getCalculatedFinalPrice()

◆ getCategory()

◆ getCategoryCollection()

◆ getCategoryId()

◆ getCategoryIds()

◆ getCreatedAt()

◆ getCrossSellLinkCollection()

◆ getCrossSellProductCollection()

◆ getCrossSellProductIds()

◆ getCrossSellProducts()

◆ getCustomAttributesCodes()

◆ getCustomDesignDate()

◆ getCustomOption()

◆ getCustomOptions()

◆ getDefaultAttributeSetId()

◆ getExtensionAttributes()

◆ getFinalPrice()

◆ getFormatedPrice()

◆ getFormattedPrice()

◆ getGiftMessageAvailable()

◆ getId()

◆ getIdBySku()

◆ getIdentities()

◆ getImage()

◆ getIsSalable()

◆ getIsVirtual()

◆ getLinkInstance()

◆ getMediaAttributes()

◆ getMediaAttributeValues()

◆ getMediaConfig()

◆ getMediaGalleryEntries()

◆ getMediaGalleryImages()

◆ getMinimalPrice()

◆ getName()

◆ getOptionInstance()

◆ getOptions()

◆ getPreconfiguredValues()

◆ getPrice()

◆ getPriceInfo()

◆ getPriceModel()

◆ getProductEntitiesInfo()

◆ getProductLinks()

◆ getProductOptionsCollection()

◆ getProductUrl()