Inheritance diagram for Item:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, \Magento\Sales\Model\Status\ListFactory $statusListFactory, \Magento\Framework\Locale\FormatInterface $localeFormat, \Magento\Quote\Model\Quote\Item\OptionFactory $itemOptionFactory, \Magento\Quote\Model\Quote\Item\Compare $quoteItemCompare, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Framework\Serialize\Serializer\Json $serializer=null)

	beforeSave ()

	getAddress ()

	setQuote (\Magento\Quote\Model\Quote $quote)

	getQuote ()

	addQty ($qty)

	setQty ($qty)

	setQtyOptions ($qtyOptions)

	setProduct ($product)

	representProduct ($product)

	compareOptions ($options1, $options2)

	compare ($item)

	getProductType ()

	getRealProductType ()

	toArray (array $arrAttributes=[])

	setOptions ($options)

	getOptions ()

	getOptionsByCode ()

	addOption ($option)

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

	removeOption ($code)

	getOptionByCode ($code)

	saveItemOptions ()

	setIsOptionsSaved ($flag)

	isOptionsSaved ()

	afterSave ()

	__clone ()

	getBuyRequest ()

	setHasError ($flag)

	addErrorInfo ($origin=null, $code=null, $message=null, $additionalData=null)

	getErrorInfos ()

	removeErrorInfosByParams ($params)

	getItemId ()

	setItemId ($itemID)

	getSku ()

	setSku ($sku)

	getQty ()

	getName ()

	setName ($name)

	getPrice ()

	setPrice ($price)

	setProductType ($productType)

	getQuoteId ()

	setQuoteId ($quoteId)

	getProductOption ()

	setProductOption (\Magento\Quote\Api\Data\ProductOptionInterface $productOption)

	getExtensionAttributes ()

	setExtensionAttributes (\Magento\Quote\Api\Data\CartItemExtensionInterface $extensionAttributes)

Public Member Functions inherited from AbstractItem
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Framework\Pricing\PriceCurrencyInterface $priceCurrency, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getQuote ()

	getAddress ()

	getProduct ()

	getFileDownloadParams ()

	beforeSave ()

	setParentItem ($parentItem)

	getParentItem ()

	getChildren ()

	addChild ($child)

	setMessage ($messages)

	addMessage ($message)

	getMessage ($string=true)

	removeMessageByText ($text)

	clearMessage ()

	getStore ()

	checkData ()

	getQty ()

	getTotalQty ()

	calcRowTotal ()

	getCalculationPrice ()

	getCalculationPriceOriginal ()

	getBaseCalculationPrice ()

	getBaseCalculationPriceOriginal ()

	getOriginalPrice ()

	setOriginalPrice ($price)

	getBaseOriginalPrice ()

	setCustomPrice ($value)

	getPrice ()

	setPrice ($value)

	getConvertedPrice ()

	setConvertedPrice ($value)

	__clone ()

	isChildrenCalculated ()

	isShipSeparately ()

	getTotalDiscountAmount ()

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)

Public Member Functions inherited from CartItemInterface
	setProductOption (\Magento\Quote\Api\Data\ProductOptionInterface $productOption)

	setExtensionAttributes (\Magento\Quote\Api\Data\CartItemExtensionInterface $extensionAttributes)

Protected Member Functions
	_construct ()

	_prepareQty ($qty)

	_addOptionCode ($option)

	_hasModelChanged ()

	_setHasError ($flag)

	_clearErrorInfo ()

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
	$_eventPrefix = 'sales_quote_item'

	$_eventObject = 'item'

	$_quote

	$_options = []

	$_optionsByCode = []

	$_notRepresentOptions = ['info_buyRequest']

	$_flagOptionsSaved

	$_errorInfos

	$_localeFormat

	$_itemOptionFactory

	$quoteItemCompare

	$stockRegistry

Protected Attributes inherited from AbstractItem
	$_parentItem = null

	$_children = []

	$_messages = []

	$_optionsByCode

	$productRepository

	$priceCurrency

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 = []

Additional Inherited Members
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 CartItemInterface
const	KEY_ITEM_ID = 'item_id'

const	KEY_SKU = 'sku'

const	KEY_QTY = 'qty'

const	KEY_NAME = 'name'

const	KEY_PRICE = 'price'

const	KEY_PRODUCT_TYPE = 'product_type'

const	KEY_QUOTE_ID = 'quote_id'

const	KEY_PRODUCT_OPTION = 'product_option'

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

Detailed Description

Sales Quote Item Model

@api @method string getCreatedAt() @method \Magento\Quote\Model\Quote\Item setCreatedAt(string $value) @method string getUpdatedAt() @method \Magento\Quote\Model\Quote\Item setUpdatedAt(string $value) @method int getStoreId() @method \Magento\Quote\Model\Quote\Item setStoreId(int $value) @method int getParentItemId() @method \Magento\Quote\Model\Quote\Item setParentItemId(int $value) @method int getIsVirtual() @method \Magento\Quote\Model\Quote\Item setIsVirtual(int $value) @method string getDescription() @method \Magento\Quote\Model\Quote\Item setDescription(string $value) @method string getAdditionalData() @method \Magento\Quote\Model\Quote\Item setAdditionalData(string $value) @method int getFreeShipping() @method \Magento\Quote\Model\Quote\Item setFreeShipping(int $value) @method int getIsQtyDecimal() @method \Magento\Quote\Model\Quote\Item setIsQtyDecimal(int $value) @method int getNoDiscount() @method \Magento\Quote\Model\Quote\Item setNoDiscount(int $value) @method float getWeight() @method \Magento\Quote\Model\Quote\Item setWeight(float $value) @method float getBasePrice() @method \Magento\Quote\Model\Quote\Item setBasePrice(float $value) @method float getCustomPrice() @method float getTaxPercent() @method \Magento\Quote\Model\Quote\Item setTaxPercent(float $value) @method \Magento\Quote\Model\Quote\Item setTaxAmount(float $value) @method \Magento\Quote\Model\Quote\Item setBaseTaxAmount(float $value) @method \Magento\Quote\Model\Quote\Item setRowTotal(float $value) @method \Magento\Quote\Model\Quote\Item setBaseRowTotal(float $value) @method float getRowTotalWithDiscount() @method \Magento\Quote\Model\Quote\Item setRowTotalWithDiscount(float $value) @method float getRowWeight() @method \Magento\Quote\Model\Quote\Item setRowWeight(float $value) @method float getBaseTaxBeforeDiscount() @method \Magento\Quote\Model\Quote\Item setBaseTaxBeforeDiscount(float $value) @method float getTaxBeforeDiscount() @method \Magento\Quote\Model\Quote\Item setTaxBeforeDiscount(float $value) @method float getOriginalCustomPrice() @method \Magento\Quote\Model\Quote\Item setOriginalCustomPrice(float $value) @method string getRedirectUrl() @method \Magento\Quote\Model\Quote\Item setRedirectUrl(string $value) @method float getBaseCost() @method \Magento\Quote\Model\Quote\Item setBaseCost(float $value) @method \Magento\Quote\Model\Quote\Item setPriceInclTax(float $value) @method float getBasePriceInclTax() @method \Magento\Quote\Model\Quote\Item setBasePriceInclTax(float $value) @method \Magento\Quote\Model\Quote\Item setRowTotalInclTax(float $value) @method float getBaseRowTotalInclTax() @method \Magento\Quote\Model\Quote\Item setBaseRowTotalInclTax(float $value) @method int getGiftMessageId() @method \Magento\Quote\Model\Quote\Item setGiftMessageId(int $value) @method string getWeeeTaxApplied() @method \Magento\Quote\Model\Quote\Item setWeeeTaxApplied(string $value) @method float getWeeeTaxAppliedAmount() @method \Magento\Quote\Model\Quote\Item setWeeeTaxAppliedAmount(float $value) @method float getWeeeTaxAppliedRowAmount() @method \Magento\Quote\Model\Quote\Item setWeeeTaxAppliedRowAmount(float $value) @method float getBaseWeeeTaxAppliedAmount() @method \Magento\Quote\Model\Quote\Item setBaseWeeeTaxAppliedAmount(float $value) @method float getBaseWeeeTaxAppliedRowAmnt() @method \Magento\Quote\Model\Quote\Item setBaseWeeeTaxAppliedRowAmnt(float $value) @method float getWeeeTaxDisposition() @method \Magento\Quote\Model\Quote\Item setWeeeTaxDisposition(float $value) @method float getWeeeTaxRowDisposition() @method \Magento\Quote\Model\Quote\Item setWeeeTaxRowDisposition(float $value) @method float getBaseWeeeTaxDisposition() @method \Magento\Quote\Model\Quote\Item setBaseWeeeTaxDisposition(float $value) @method float getBaseWeeeTaxRowDisposition() @method \Magento\Quote\Model\Quote\Item setBaseWeeeTaxRowDisposition(float $value) @method float getDiscountTaxCompensationAmount() @method \Magento\Quote\Model\Quote\Item setDiscountTaxCompensationAmount(float $value) @method float getBaseDiscountTaxCompensationAmount() @method \Magento\Quote\Model\Quote\Item setBaseDiscountTaxCompensationAmount(float $value) @method null|bool getHasConfigurationUnavailableError() @method \Magento\Quote\Model\Quote\Item setHasConfigurationUnavailableError(bool $value) @method \Magento\Quote\Model\Quote\Item unsHasConfigurationUnavailableError() @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity)

Since: 100.0.2

Definition at line 98 of file Item.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency,
		\Magento\Sales\Model\Status\ListFactory	$statusListFactory,
		\Magento\Framework\Locale\FormatInterface	$localeFormat,
		\Magento\Quote\Model\Quote\Item\OptionFactory	$itemOptionFactory,
		\Magento\Quote\Model\Quote\Item\Compare	$quoteItemCompare,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Framework\Serialize\Serializer\Json	$serializer = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
\Magento\Framework\Pricing\PriceCurrencyInterface	$priceCurrency
\Magento\Sales\Model\Status\ListFactory	$statusListFactory
\Magento\Framework\Locale\FormatInterface	$localeFormat
Item\OptionFactory	$itemOptionFactory
Item\Compare	$quoteItemCompare
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
\Magento\Framework\Serialize\Serializer\Json	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 204 of file Item.php.

       {
         $this->_errorInfos = $statusListFactory->create();
         $this->_localeFormat = $localeFormat;
         $this->_itemOptionFactory = $itemOptionFactory;
         $this->quoteItemCompare = $quoteItemCompare;
         $this->stockRegistry = $stockRegistry;
         $this->serializer = $serializer ?: \Magento\Framework\App\ObjectManager::getInstance()
             ->get(\Magento\Framework\Serialize\Serializer\Json::class);
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $productRepository,
             $priceCurrency,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ __clone()

__clone ( )

Clone quote item

Returns: $this

Definition at line 802 of file Item.php.

     {
         parent::__clone();
         $options = $this->getOptions();
         $this->_quote = null;
         $this->_options = [];
         $this->_optionsByCode = [];
         foreach ($options as $option) {
             $this->addOption(clone $option);
         }
         return $this;
     }

◆ _addOptionCode()

_addOptionCode ( $option )

protected

Register option code

Parameters

\Magento\Quote\Model\Quote\Item\Option $option

Returns: $this

Exceptions

Definition at line 694 of file Item.php.

     {
         if (!isset($this->_optionsByCode[$option->getCode()])) {
             $this->_optionsByCode[$option->getCode()] = $option;
         } else {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('An item option with code %1 already exists.', $option->getCode())
             );
         }
         return $this;
     }

◆ _clearErrorInfo()

_clearErrorInfo ( )

protected

Clears list of errors, associated with this quote item. Also automatically removes error-flag from oneself.

Returns: $this

Definition at line 870 of file Item.php.

     {
         $this->_errorInfos->clear();
         $this->_setHasError(false);
         return $this;
     }

◆ _construct()

_construct ( )

protected

Initialize resource model

Returns: void

Definition at line 246 of file Item.php.

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

◆ _hasModelChanged()

_hasModelChanged ( )

protected

Checks that item model has data changes. Call save item options if model isn't need to save in DB

Returns: boolean

Definition at line 726 of file Item.php.

     {
         if (!$this->hasDataChanges()) {
             return false;
         }
 
         return $this->_getResource()->hasDataChanged($this);
     }

◆ _prepareQty()

_prepareQty ( $qty )

protected

Prepare quantity

Parameters

float | int $qty

Returns: int|float

Definition at line 314 of file Item.php.

     {
         $qty = $this->_localeFormat->getNumber($qty);
         $qty = $qty > 0 ? $qty : 1;
         return $qty;
     }

◆ _setHasError()

_setHasError ( $flag )

protected

Sets flag, whether this quote item has some error associated with it.

Parameters

bool $flag

Returns: \Magento\Quote\Model\Quote\Item

Definition at line 839 of file Item.php.

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

◆ addErrorInfo()

addErrorInfo	(	$origin = `null`,
		$code = `null`,
		$message = `null`,
		$additionalData = `null`
	)

Adds error information to the quote item. Automatically sets error flag.

Parameters

string \| null	$origin	Usually a name of module, that embeds error
int \| null	$code	Error code, unique for origin, that sets it
string \| null	$message	Error message
\Magento\Framework\DataObject \| null	$additionalData	Any additional data, that caller would like to store

Returns: $this

Definition at line 887 of file Item.php.

     {
         $this->_errorInfos->addItem($origin, $code, $message, $additionalData);
         if ($message !== null) {
             $this->setMessage($message);
         }
         $this->_setHasError(true);
 
         return $this;
     }

◆ addOption()

addOption ( $option )

Add option to item

Parameters

\Magento\Quote\Model\Quote\Item\Option | \Magento\Framework\DataObject $option

Returns: $this

Exceptions

Definition at line 614 of file Item.php.

     {
         if (is_array($option)) {
             $option = $this->_itemOptionFactory->create()->setData($option)->setItem($this);
         } elseif ($option instanceof \Magento\Framework\DataObject &&
             !$option instanceof \Magento\Quote\Model\Quote\Item\Option
         ) {
             $option = $this->_itemOptionFactory->create()->setData(
                 $option->getData()
             )->setProduct(
                 $option->getProduct()
             )->setItem(
                 $this
             );
         } elseif ($option instanceof \Magento\Quote\Model\Quote\Item\Option) {
             $option->setItem($this);
         } else {
             throw new \Magento\Framework\Exception\LocalizedException(__('We found an invalid item option format.'));
         }
 
         $exOption = $this->getOptionByCode($option->getCode());
         if ($exOption) {
             $exOption->addData($option->getData());
         } else {
             $this->_addOptionCode($option);
             $this->_options[] = $option;
         }
         return $this;
     }

◆ addQty()

addQty ( $qty )

Adding quantity to quote item

Parameters

float $qty

Returns: $this

We can't modify quantity of existing items which have parent This qty declared just once during add process and is not editable

Definition at line 327 of file Item.php.

     {
         if (!$this->getParentItem() || !$this->getId()) {
             $qty = $this->_prepareQty($qty);
             $this->setQtyToAdd($qty);
             $this->setQty($this->getQty() + $qty);
         }
         return $this;
     }

◆ afterSave()

afterSave ( )

Save item options after item saved

Returns: \Magento\Quote\Model\Quote\Item

Definition at line 791 of file Item.php.

     {
         $this->saveItemOptions();
         return parent::afterSave();
     }

◆ beforeSave()

beforeSave ( )

Quote Item Before Save prepare data process

Returns: $this

Definition at line 256 of file Item.php.

     {
         parent::beforeSave();
         $this->setIsVirtual($this->getProduct()->getIsVirtual());
         if ($this->getQuote()) {
             $this->setQuoteId($this->getQuote()->getId());
         }
         return $this;
     }

◆ compare()

compare ( $item )

Compare items

Parameters

\Magento\Quote\Model\Quote\Item $item

Returns: bool

Definition at line 514 of file Item.php.

     {
         return $this->quoteItemCompare->compare($this, $item);
     }

◆ compareOptions()

compareOptions	(	$options1,
		$options2
	)

Check if two options array are identical First options array is prerogative Second options array checked against first one

Parameters

array	$options1
array	$options2

Returns: bool

Definition at line 494 of file Item.php.

     {
         foreach ($options1 as $option) {
             $code = $option->getCode();
             if (in_array($code, $this->_notRepresentOptions)) {
                 continue;
             }
             if (!isset($options2[$code]) || $options2[$code]->getValue() != $option->getValue()) {
                 return false;
             }
         }
         return true;
     }

◆ getAddress()

getAddress ( )

Retrieve address model

Returns: \Magento\Quote\Model\Quote\Address

Definition at line 271 of file Item.php.

     {
         if ($this->getQuote()->getItemsQty() == $this->getQuote()->getVirtualItemsQty()) {
             $address = $this->getQuote()->getBillingAddress();
         } else {
             $address = $this->getQuote()->getShippingAddress();
         }
 
         return $address;
     }

◆ getBuyRequest()

getBuyRequest ( )

Returns formatted buy request - object, holding request received from product view page with keys and options for configured product

Returns: \Magento\Framework\DataObject

Definition at line 821 of file Item.php.

     {
         $option = $this->getOptionByCode('info_buyRequest');
         $data = $option ? $this->serializer->unserialize($option->getValue()) : [];
         $buyRequest = new \Magento\Framework\DataObject($data);
 
         // Overwrite standard buy request qty, because item qty could have changed since adding to quote
         $buyRequest->setOriginalQty($buyRequest->getQty())->setQty($this->getQty() * 1);
 
         return $buyRequest;
     }

◆ getErrorInfos()

getErrorInfos ( )

Retrieves all error infos, associated with this item

Returns: array

Definition at line 903 of file Item.php.

     {
         return $this->_errorInfos->getItems();
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

{Retrieve existing extension attributes object or create a new one.

Returns: \Magento\Quote\Api\Data\CartItemExtensionInterface|null

}

Returns: \Magento\Quote\Api\Data\CartItemExtensionInterface|null

Implements CartItemInterface.

Definition at line 1058 of file Item.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getItemId()

getItemId ( )

@codeCoverageIgnoreStart

{#- Returns the item ID.

Returns: int|null Item ID. Otherwise, null.

}

Implements CartItemInterface.

Definition at line 937 of file Item.php.

     {
         return $this->getData(self::KEY_ITEM_ID);
     }

◆ getName()

getName ( )

{Returns the product name.

Returns: string|null Product name. Otherwise, null.

}

Implements CartItemInterface.

Definition at line 977 of file Item.php.

     {
         return $this->getData(self::KEY_NAME);
     }

◆ getOptionByCode()

getOptionByCode ( $code )

Get item option by code

Parameters

string $code

Returns: \Magento\Quote\Model\Quote\Item\Option || null

Implements ItemInterface.

Definition at line 712 of file Item.php.

     {
         if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
             return $this->_optionsByCode[$code];
         }
         return null;
     }

◆ getOptions()

getOptions ( )

Get all item options

@codeCoverageIgnore

Returns: \Magento\Quote\Model\Quote\Item\Option[]

Definition at line 590 of file Item.php.

     {
         return $this->_options;
     }

◆ getOptionsByCode()

getOptionsByCode ( )

Get all item options as array with codes in array key

@codeCoverageIgnore

Returns: array

Definition at line 602 of file Item.php.

     {
         return $this->_optionsByCode;
     }

◆ getPrice()

getPrice ( )

{Returns the product price.

Returns: float|null Product price. Otherwise, null.

}

Implements CartItemInterface.

Definition at line 993 of file Item.php.

     {
         return $this->getData(self::KEY_PRICE);
     }

◆ getProductOption()

getProductOption ( )

Returns product option

Returns: \Magento\Quote\Api\Data\ProductOptionInterface|null

Implements CartItemInterface.

Definition at line 1035 of file Item.php.

     {
         return $this->getData(self::KEY_PRODUCT_OPTION);
     }

◆ getProductType()

getProductType ( )

Get item product type

Returns: string

Implements CartItemInterface.

Definition at line 524 of file Item.php.

     {
         $option = $this->getOptionByCode(self::KEY_PRODUCT_TYPE);
         if ($option) {
             return $option->getValue();
         }
         $product = $this->getProduct();
         if ($product) {
             return $product->getTypeId();
         }
         // $product should always exist or there will be an error in getProduct()
         return $this->_getData(self::KEY_PRODUCT_TYPE);
     }

◆ getQty()

getQty ( )

{Returns the product quantity.

Returns: float Product quantity.

}

Implements CartItemInterface.

Definition at line 969 of file Item.php.

     {
         return $this->getData(self::KEY_QTY);
     }

◆ getQuote()

getQuote ( )

Retrieve quote model object

@codeCoverageIgnore

Returns: \Magento\Quote\Model\Quote

Definition at line 303 of file Item.php.

     {
         return $this->_quote;
     }

◆ getQuoteId()

getQuoteId ( )

{Returns Quote id.

Returns: string

}

Implements CartItemInterface.

Definition at line 1017 of file Item.php.

     {
         return $this->getData(self::KEY_QUOTE_ID);
     }

◆ getRealProductType()

getRealProductType ( )

Return real product type of item

@codeCoverageIgnore

Returns: string

Definition at line 545 of file Item.php.

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

◆ getSku()

getSku ( )

{Returns the product SKU.

Returns: string|null Product SKU. Otherwise, null.

}

Implements CartItemInterface.

Definition at line 953 of file Item.php.

     {
         return $this->getData(self::KEY_SKU);
     }

◆ isOptionsSaved()

isOptionsSaved ( )

Were options saved

@codeCoverageIgnore

Returns: bool

Definition at line 781 of file Item.php.

     {
         return $this->_flagOptionsSaved;
     }

◆ removeErrorInfosByParams()

removeErrorInfosByParams ( $params )

Removes error infos, that have parameters equal to passed in $params. $params can have following keys (if not set - then any item is good for this key): 'origin', 'code', 'message'

Parameters

array $params

Returns: $this

Definition at line 916 of file Item.php.

     {
         $removedItems = $this->_errorInfos->removeItemsByParams($params);
         foreach ($removedItems as $item) {
             if ($item['message'] !== null) {
                 $this->removeMessageByText($item['message']);
             }
         }
 
         if (!$this->_errorInfos->getItems()) {
             $this->_setHasError(false);
         }
 
         return $this;
     }

◆ removeOption()

removeOption ( $code )

Remove option from item options

Parameters

string $code

Returns: $this

Definition at line 678 of file Item.php.

     {
         $option = $this->getOptionByCode($code);
         if ($option) {
             $option->isDeleted(true);
         }
         return $this;
     }

◆ representProduct()

representProduct ( $product )

Check product representation in item

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Check maybe product is planned to be a child of some quote item - in this case we limit search only within same parent item

Definition at line 454 of file Item.php.

     {
         $itemProduct = $this->getProduct();
         if (!$product || $itemProduct->getId() != $product->getId()) {
             return false;
         }
 
         $stickWithinParent = $product->getStickWithinParent();
         if ($stickWithinParent) {
             if ($this->getParentItem() !== $stickWithinParent) {
                 return false;
             }
         }
 
         // Check options
         $itemOptions = $this->getOptionsByCode();
         $productOptions = $product->getCustomOptions();
 
         if (!$this->compareOptions($itemOptions, $productOptions)) {
             return false;
         }
         if (!$this->compareOptions($productOptions, $itemOptions)) {
             return false;
         }
         return true;
     }

◆ saveItemOptions()

saveItemOptions ( )

Save item options

Returns: $this

Definition at line 740 of file Item.php.

     {
         foreach ($this->_options as $index => $option) {
             if ($option->isDeleted()) {
                 $option->delete();
                 unset($this->_options[$index]);
                 unset($this->_optionsByCode[$option->getCode()]);
             } else {
                 if (!$option->getItem() || !$option->getItem()->getId()) {
                     $option->setItem($this);
                 }
                 $option->save();
             }
         }
 
         $this->_flagOptionsSaved = true;
         // Report to watchers that options were saved
 
         return $this;
     }

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\Quote\Api\Data\CartItemExtensionInterface $extensionAttributes )

{}

Parameters

\Magento\Quote\Api\Data\CartItemExtensionInterface $extensionAttributes

Returns: $this

Definition at line 1069 of file Item.php.

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

◆ setHasError()

setHasError ( $flag )

Sets flag, whether this quote item has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote item errors. When FALSE - clears whole list of quote item errors. It's recommended to use addErrorInfo() instead - to be able to remove error statuses later.

Parameters

bool $flag

Returns: $this

See also: addErrorInfo()

Definition at line 854 of file Item.php.

     {
         if ($flag) {
             $this->addErrorInfo();
         } else {
             $this->_clearErrorInfo();
         }
         return $this;
     }

◆ setIsOptionsSaved()

setIsOptionsSaved ( $flag )

Mar option save requirement

@codeCoverageIgnore

Parameters

bool $flag

Returns: void

Definition at line 769 of file Item.php.

     {
         $this->_flagOptionsSaved = $flag;
     }

◆ setItemId()

setItemId ( $itemID )

{Sets the item ID.

Parameters

int $itemId

Returns: $this

}

Implements CartItemInterface.

Definition at line 945 of file Item.php.

     {
         return $this->setData(self::KEY_ITEM_ID, $itemID);
     }

◆ setName()

setName ( $name )

{Sets the product name.

Parameters

string $name

Returns: $this

}

Implements CartItemInterface.

Definition at line 985 of file Item.php.

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

◆ setOptions()

setOptions ( $options )

Initialize quote item options

Parameters

array $options

Returns: $this

Definition at line 573 of file Item.php.

     {
         if (is_array($options)) {
             foreach ($options as $option) {
                 $this->addOption($option);
             }
         }
         return $this;
     }

◆ setPrice()

setPrice ( $price )

{Sets the product price.

Parameters

float $price

Returns: $this

}

Implements CartItemInterface.

Definition at line 1001 of file Item.php.

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

◆ setProduct()

setProduct ( $product )

Setup product for quote item

Parameters

\Magento\Catalog\Model\Product $product

Returns: $this

Definition at line 422 of file Item.php.

     {
         if ($this->getQuote()) {
             $product->setStoreId($this->getQuote()->getStoreId());
             $product->setCustomerGroupId($this->getQuote()->getCustomerGroupId());
         }
         $this->setData('product', $product)
             ->setProductId($product->getId())
             ->setProductType($product->getTypeId())
             ->setSku($this->getProduct()->getSku())
             ->setName($product->getName())
             ->setWeight($this->getProduct()->getWeight())
             ->setTaxClassId($product->getTaxClassId())
             ->setBaseCost($product->getCost());
 
         $stockItem = $product->getExtensionAttributes()->getStockItem();
         $this->setIsQtyDecimal($stockItem ? $stockItem->getIsQtyDecimal() : false);
 
         $this->_eventManager->dispatch(
             'sales_quote_item_set_product',
             ['product' => $product, 'quote_item' => $this]
         );
 
         return $this;
     }

◆ setProductOption()

setProductOption ( \Magento\Quote\Api\Data\ProductOptionInterface $productOption )

Sets product option

Parameters

\Magento\Quote\Api\Data\ProductOptionInterface $productOption

Returns: $this

Definition at line 1046 of file Item.php.

     {
         return $this->setData(self::KEY_PRODUCT_OPTION, $productOption);
     }

◆ setProductType()

setProductType ( $productType )

{Sets the product type.

Parameters

string $productType

Returns: $this

}

Implements CartItemInterface.

Definition at line 1009 of file Item.php.

     {
         return $this->setData(self::KEY_PRODUCT_TYPE, $productType);
     }

◆ setQty()

setQty ( $qty )

Declare quote item quantity

Parameters

float $qty

Returns: $this

Implements CartItemInterface.

Definition at line 347 of file Item.php.

     {
         $qty = $this->_prepareQty($qty);
         $oldQty = $this->_getData(self::KEY_QTY);
         $this->setData(self::KEY_QTY, $qty);
 
         $this->_eventManager->dispatch('sales_quote_item_qty_set_after', ['item' => $this]);
 
         if ($this->getQuote() && $this->getQuote()->getIgnoreOldQty()) {
             return $this;
         }
 
         if ($this->getUseOldQty()) {
             $this->setData(self::KEY_QTY, $oldQty);
         }
 
         return $this;
     }

◆ setQtyOptions()

setQtyOptions ( $qtyOptions )

Set option product with Qty

@codeCoverageIgnore

Parameters

array $qtyOptions

Returns: $this

Definition at line 411 of file Item.php.

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

◆ setQuote()

setQuote ( \Magento\Quote\Model\Quote $quote )

Declare quote model object

Parameters

\Magento\Quote\Model\Quote $quote

Returns: $this

Definition at line 288 of file Item.php.

     {
         $this->_quote = $quote;
         $this->setQuoteId($quote->getId());
         $this->setStoreId($quote->getStoreId());
         return $this;
     }

◆ setQuoteId()

setQuoteId ( $quoteId )

{Sets Quote id.

Parameters

string $quoteId

Returns: $this

}

Implements CartItemInterface.

Definition at line 1025 of file Item.php.

     {
         return $this->setData(self::KEY_QUOTE_ID, $quoteId);
     }

◆ setSku()

setSku ( $sku )

{Sets the product SKU.

Parameters

string $sku

Returns: $this

}

Implements CartItemInterface.

Definition at line 961 of file Item.php.

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

◆ toArray()

toArray ( array $arrAttributes = [] )

Convert Quote Item to array

Parameters

array $arrAttributes

Returns: array

Definition at line 556 of file Item.php.

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

◆ updateQtyOption()

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

Can specify specific actions for ability to change given quote options values Example: cataloginventory decimal qty validation may change qty to int, so need to change quote item qty option value.

Parameters

\Magento\Framework\DataObject	$option
int \| float \| null	$value

Returns: $this

Definition at line 653 of file Item.php.

     {
         $optionProduct = $option->getProduct();
         $options = $this->getQtyOptions();
 
         if (isset($options[$optionProduct->getId()])) {
             $options[$optionProduct->getId()]->setValue($value);
         }
 
         $this->getProduct()->getTypeInstance()->updateQtyOption(
             $this->getOptions(),
             $option,
             $value,
             $this->getProduct()
         );
 
         return $this;
     }

Field Documentation

◆ $_errorInfos

$_errorInfos

protected

Definition at line 155 of file Item.php.

◆ $_eventObject

$_eventObject = 'item'

protected

Definition at line 114 of file Item.php.

◆ $_eventPrefix

$_eventPrefix = 'sales_quote_item'

protected

Definition at line 105 of file Item.php.

◆ $_flagOptionsSaved

$_flagOptionsSaved

protected

Flag stating that options were successfully saved

Definition at line 148 of file Item.php.

◆ $_itemOptionFactory

$_itemOptionFactory

protected

Definition at line 165 of file Item.php.

◆ $_localeFormat

$_localeFormat

protected

Definition at line 160 of file Item.php.

◆ $_notRepresentOptions

$_notRepresentOptions = ['info_buyRequest']

protected

Definition at line 142 of file Item.php.

◆ $_options

$_options = []

protected

Definition at line 128 of file Item.php.

◆ $_optionsByCode

$_optionsByCode = []

protected

Definition at line 135 of file Item.php.

◆ $_quote

$_quote

protected

Definition at line 121 of file Item.php.

◆ $quoteItemCompare

$quoteItemCompare

protected

Definition at line 170 of file Item.php.

◆ $stockRegistry

$stockRegistry

protected

Definition at line 176 of file Item.php.

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

vendor/magento/module-quote/Model/Quote/Item.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ _addOptionCode()

◆ _clearErrorInfo()

◆ _construct()

◆ _hasModelChanged()

◆ _prepareQty()

◆ _setHasError()

◆ addErrorInfo()

◆ addOption()

◆ addQty()

◆ afterSave()

◆ beforeSave()

◆ compare()

◆ compareOptions()

◆ getAddress()

◆ getBuyRequest()

◆ getErrorInfos()

◆ getExtensionAttributes()

◆ getItemId()

◆ getName()

◆ getOptionByCode()

◆ getOptions()

◆ getOptionsByCode()

◆ getPrice()

◆ getProductOption()

◆ getProductType()

◆ getQty()

◆ getQuote()

◆ getQuoteId()

◆ getRealProductType()

◆ getSku()

◆ isOptionsSaved()

◆ removeErrorInfosByParams()

◆ removeOption()

◆ representProduct()

◆ saveItemOptions()

◆ setExtensionAttributes()

◆ setHasError()

◆ setIsOptionsSaved()

◆ setItemId()

◆ setName()

◆ setOptions()

◆ setPrice()

◆ setProduct()

◆ setProductOption()

◆ setProductType()

◆ setQty()

◆ setQtyOptions()

◆ setQuote()

◆ setQuoteId()

◆ setSku()

◆ toArray()

◆ updateQtyOption()

Field Documentation

◆ $_errorInfos

◆ $_eventObject

◆ $_eventPrefix

◆ $_flagOptionsSaved

◆ $_itemOptionFactory

◆ $_localeFormat

◆ $_notRepresentOptions

◆ $_options

◆ $_optionsByCode

◆ $_quote

◆ $quoteItemCompare

◆ $stockRegistry