Inheritance diagram for Quote:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Quote\Model\QuoteValidator $quoteValidator, \Magento\Catalog\Helper\Product $catalogProduct, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\App\Config\ScopeConfigInterface $config, \Magento\Quote\Model\Quote\AddressFactory $quoteAddressFactory, \Magento\Customer\Model\CustomerFactory $customerFactory, \Magento\Customer\Api\GroupRepositoryInterface $groupRepository, \Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory $quoteItemCollectionFactory, \Magento\Quote\Model\Quote\ItemFactory $quoteItemFactory, \Magento\Framework\Message\Factory $messageFactory, \Magento\Sales\Model\Status\ListFactory $statusListFactory, \Magento\Catalog\Api\ProductRepositoryInterface $productRepository, \Magento\Quote\Model\Quote\PaymentFactory $quotePaymentFactory, \Magento\Quote\Model\ResourceModel\Quote\Payment\CollectionFactory $quotePaymentCollectionFactory, \Magento\Framework\DataObject\Copy $objectCopyService, \Magento\CatalogInventory\Api\StockRegistryInterface $stockRegistry, \Magento\Quote\Model\Quote\Item\Processor $itemProcessor, \Magento\Framework\DataObject\Factory $objectFactory, \Magento\Customer\Api\AddressRepositoryInterface $addressRepository, \Magento\Framework\Api\SearchCriteriaBuilder $criteriaBuilder, \Magento\Framework\Api\FilterBuilder $filterBuilder, \Magento\Customer\Api\Data\AddressInterfaceFactory $addressDataFactory, \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerDataFactory, \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, \Magento\Framework\Api\ExtensibleDataObjectConverter $extensibleDataObjectConverter, \Magento\Quote\Model\Cart\CurrencyFactory $currencyFactory, JoinProcessorInterface $extensionAttributesJoinProcessor, Quote\TotalsCollector $totalsCollector, Quote\TotalsReader $totalsReader, \Magento\Quote\Model\ShippingFactory $shippingFactory, \Magento\Quote\Model\ShippingAssignmentFactory $shippingAssignmentFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], \Magento\Sales\Model\OrderIncrementIdChecker $orderIncrementIdChecker=null)

	getCurrency ()

	setCurrency (\Magento\Quote\Api\Data\CurrencyInterface $currency=null)

	getItems ()

	setItems (array $items=null)

	getCreatedAt ()

	setCreatedAt ($createdAt)

	getUpdatedAt ()

	setUpdatedAt ($updatedAt)

	getConvertedAt ()

	setConvertedAt ($convertedAt)

	getIsActive ()

	setIsActive ($isActive)

	setIsVirtual ($isVirtual)

	getItemsCount ()

	setItemsCount ($itemsCount)

	getItemsQty ()

	setItemsQty ($itemsQty)

	getOrigOrderId ()

	setOrigOrderId ($origOrderId)

	getReservedOrderId ()

	setReservedOrderId ($reservedOrderId)

	getCustomerIsGuest ()

	setCustomerIsGuest ($customerIsGuest)

	getCustomerNote ()

	setCustomerNote ($customerNote)

	getCustomerNoteNotify ()

	setCustomerNoteNotify ($customerNoteNotify)

	getStoreId ()

	setStoreId ($storeId)

	getStore ()

	setStore (\Magento\Store\Model\Store $store)

	getSharedStoreIds ()

	beforeSave ()

	loadByCustomer ($customer)

	loadActive ($quoteId)

	loadByIdWithoutStore ($quoteId)

	assignCustomer (\Magento\Customer\Api\Data\CustomerInterface $customer)

	setCustomer (\Magento\Customer\Api\Data\CustomerInterface $customer=null)

	getCustomer ()

	setCustomerAddressData (array $addresses)

	addCustomerAddress (\Magento\Customer\Api\Data\AddressInterface $address)

	updateCustomerData (\Magento\Customer\Api\Data\CustomerInterface $customer)

	getCustomerGroupId ()

	getCustomerTaxClassId ()

	setCustomerTaxClassId ($customerTaxClassId)

	getAddressesCollection ()

	getBillingAddress ()

	getShippingAddress ()

	getAllShippingAddresses ()

	getAllAddresses ()

	getAddressById ($addressId)

	getAddressByCustomerAddressId ($addressId)

	removeAddress ($addressId)

	removeAllAddresses ()

	addAddress (\Magento\Quote\Api\Data\AddressInterface $address)

	setBillingAddress (\Magento\Quote\Api\Data\AddressInterface $address=null)

	setShippingAddress (\Magento\Quote\Api\Data\AddressInterface $address=null)

	addShippingAddress (\Magento\Quote\Api\Data\AddressInterface $address)

	getItemsCollection ($useCache=true)

	getAllVisibleItems ()

	hasItems ()

	hasItemsWithDecimalQty ()

	hasProductId ($productId)

	getItemById ($itemId)

	deleteItem (\Magento\Quote\Model\Quote\Item $item)

	removeItem ($itemId)

	removeAllItems ()

	addItem (\Magento\Quote\Model\Quote\Item $item)

	addProduct (\Magento\Catalog\Model\Product $product, $request=null, $processMode=\Magento\Catalog\Model\Product\Type\AbstractType::PROCESS_MODE_FULL)

	updateItem ($itemId, $buyRequest, $params=null)

	getItemByProduct ($product)

	getItemsSummaryQty ()

	getItemVirtualQty ()

	getPaymentsCollection ()

	getPayment ()

	setPayment (PaymentInterface $payment)

	removePayment ()

	collectTotals ()

	getTotals ()

	addMessage ($message, $index='error')

	getMessages ()

	getErrors ()

	setHasError ($flag)

	addErrorInfo ( $type='error', $origin=null, $code=null, $message=null, $additionalData=null)

	removeErrorInfosByParams ($type, $params)

	removeMessageByText ($type, $text)

	reserveOrderId ()

	isVirtual ()

	getIsVirtual ()

	hasVirtualItems ()

	merge (Quote $quote)

	addressCollectionWasSet ()

	itemsCollectionWasSet ()

	paymentsCollectionWasSet ()

	currentPaymentWasSet ()

	getCheckoutMethod ($originalMethod=false)

	getShippingAddressesItems ()

	setCheckoutMethod ($checkoutMethod)

	preventSaving ()

	isPreventSaving ()

	isMultipleShippingAddresses ()

	getExtensionAttributes ()

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

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 CartInterface
	getId ()

	setId ($id)

	setCustomer (\Magento\Customer\Api\Data\CustomerInterface $customer=null)

	setBillingAddress (\Magento\Quote\Api\Data\AddressInterface $billingAddress=null)

	setCurrency (\Magento\Quote\Api\Data\CurrencyInterface $currency=null)

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

Data Fields
const	CHECKOUT_METHOD_LOGIN_IN = 'login_in'

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 CartInterface
const	KEY_ID = 'id'

const	KEY_ENTITY_ID = 'entity_id'

const	KEY_CREATED_AT = 'created_at'

const	KEY_UPDATED_AT = 'updated_at'

const	KEY_CONVERTED_AT = 'converted_at'

const	KEY_IS_ACTIVE = 'is_active'

const	KEY_IS_VIRTUAL = 'is_virtual'

const	KEY_ITEMS = 'items'

const	KEY_ITEMS_COUNT = 'items_count'

const	KEY_ITEMS_QTY = 'items_qty'

const	KEY_CUSTOMER = 'customer'

const	KEY_CHECKOUT_METHOD = 'checkout_method'

const	KEY_SHIPPING_ADDRESS = 'shipping_address'

const	KEY_BILLING_ADDRESS = 'billing_address'

const	KEY_RESERVED_ORDER_ID = 'reserved_order_id'

const	KEY_ORIG_ORDER_ID = 'orig_order_id'

const	KEY_CURRENCY = 'currency'

const	KEY_CUSTOMER_IS_GUEST = 'customer_is_guest'

const	KEY_CUSTOMER_NOTE = 'customer_note'

const	KEY_CUSTOMER_NOTE_NOTIFY = 'customer_note_notify'

const	KEY_CUSTOMER_TAX_CLASS_ID = 'customer_tax_class_id'

const	KEY_STORE_ID = 'store_id'

Protected Member Functions
	_construct ()

	_getAddressByType ($type)

	_addCatalogProduct (\Magento\Catalog\Model\Product $product, $qty=1)

	addPayment (PaymentInterface $payment)

	_setHasError ($flag)

	_clearErrorInfo ()

	_afterLoad ()

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'

	$_eventObject = 'quote'

	$_customer

	$_addresses

	$_items

	$_payments

	$_currentPayment

	$_errorInfoGroups = []

	$_preventSaving = false

	$_catalogProduct

	$quoteValidator

	$_scopeConfig

	$_storeManager

	$_config

	$_quoteAddressFactory

	$_customerFactory

	$groupRepository

	$_quoteItemCollectionFactory

	$_quoteItemFactory

	$messageFactory

	$_statusListFactory

	$productRepository

	$_quotePaymentFactory

	$_quotePaymentCollectionFactory

	$_objectCopyService

	$addressRepository

	$searchCriteriaBuilder

	$filterBuilder

	$stockRegistry

	$itemProcessor

	$objectFactory

	$extensibleDataObjectConverter

	$addressDataFactory

	$customerDataFactory

	$customerRepository

	$currencyFactory

	$dataObjectHelper

	$extensionAttributesJoinProcessor

	$totalsCollector

	$totalsReader

	$shippingFactory

	$shippingAssignmentFactory

	$shippingAddressesItems

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
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Quote model

Supported events: sales_quote_load_after sales_quote_save_before sales_quote_save_after sales_quote_delete_before sales_quote_delete_after

@api @method int getIsMultiShipping() @method Quote setIsMultiShipping(int $value) @method float getStoreToBaseRate() @method Quote setStoreToBaseRate(float $value) @method float getStoreToQuoteRate() @method Quote setStoreToQuoteRate(float $value) @method string getBaseCurrencyCode() @method Quote setBaseCurrencyCode(string $value) @method string getStoreCurrencyCode() @method Quote setStoreCurrencyCode(string $value) @method string getQuoteCurrencyCode() @method Quote setQuoteCurrencyCode(string $value) @method float getGrandTotal() @method Quote setGrandTotal(float $value) @method float getBaseGrandTotal() @method Quote setBaseGrandTotal(float $value) @method int getCustomerId() @method Quote setCustomerId(int $value) @method Quote setCustomerGroupId(int $value) @method string getCustomerEmail() @method Quote setCustomerEmail(string $value) @method string getCustomerPrefix() @method Quote setCustomerPrefix(string $value) @method string getCustomerFirstname() @method Quote setCustomerFirstname(string $value) @method string getCustomerMiddlename() @method Quote setCustomerMiddlename(string $value) @method string getCustomerLastname() @method Quote setCustomerLastname(string $value) @method string getCustomerSuffix() @method Quote setCustomerSuffix(string $value) @method string getCustomerDob() @method Quote setCustomerDob(string $value) @method string getRemoteIp() @method Quote setRemoteIp(string $value) @method string getAppliedRuleIds() @method Quote setAppliedRuleIds(string $value) @method string getPasswordHash() @method Quote setPasswordHash(string $value) @method string getCouponCode() @method Quote setCouponCode(string $value) @method string getGlobalCurrencyCode() @method Quote setGlobalCurrencyCode(string $value) @method float getBaseToGlobalRate() @method Quote setBaseToGlobalRate(float $value) @method float getBaseToQuoteRate() @method Quote setBaseToQuoteRate(float $value) @method string getCustomerTaxvat() @method Quote setCustomerTaxvat(string $value) @method string getCustomerGender() @method Quote setCustomerGender(string $value) @method float getSubtotal() @method Quote setSubtotal(float $value) @method float getBaseSubtotal() @method Quote setBaseSubtotal(float $value) @method float getSubtotalWithDiscount() @method Quote setSubtotalWithDiscount(float $value) @method float getBaseSubtotalWithDiscount() @method Quote setBaseSubtotalWithDiscount(float $value) @method int getIsChanged() @method Quote setIsChanged(int $value) @method int getTriggerRecollect() @method Quote setTriggerRecollect(int $value) @method string getExtShippingInfo() @method Quote setExtShippingInfo(string $value) @method int getGiftMessageId() @method Quote setGiftMessageId(int $value) @method bool|null getIsPersistent() @method Quote setIsPersistent(bool $value) @method Quote setSharedStoreIds(array $values) @method Quote setWebsite($value) @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 107 of file Quote.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Quote\Model\QuoteValidator	$quoteValidator,
		\Magento\Catalog\Helper\Product	$catalogProduct,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\App\Config\ScopeConfigInterface	$config,
		\Magento\Quote\Model\Quote\AddressFactory	$quoteAddressFactory,
		\Magento\Customer\Model\CustomerFactory	$customerFactory,
		\Magento\Customer\Api\GroupRepositoryInterface	$groupRepository,
		\Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory	$quoteItemCollectionFactory,
		\Magento\Quote\Model\Quote\ItemFactory	$quoteItemFactory,
		\Magento\Framework\Message\Factory	$messageFactory,
		\Magento\Sales\Model\Status\ListFactory	$statusListFactory,
		\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository,
		\Magento\Quote\Model\Quote\PaymentFactory	$quotePaymentFactory,
		\Magento\Quote\Model\ResourceModel\Quote\Payment\CollectionFactory	$quotePaymentCollectionFactory,
		\Magento\Framework\DataObject\Copy	$objectCopyService,
		\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry,
		\Magento\Quote\Model\Quote\Item\Processor	$itemProcessor,
		\Magento\Framework\DataObject\Factory	$objectFactory,
		\Magento\Customer\Api\AddressRepositoryInterface	$addressRepository,
		\Magento\Framework\Api\SearchCriteriaBuilder	$criteriaBuilder,
		\Magento\Framework\Api\FilterBuilder	$filterBuilder,
		\Magento\Customer\Api\Data\AddressInterfaceFactory	$addressDataFactory,
		\Magento\Customer\Api\Data\CustomerInterfaceFactory	$customerDataFactory,
		\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		\Magento\Framework\Api\ExtensibleDataObjectConverter	$extensibleDataObjectConverter,
		\Magento\Quote\Model\Cart\CurrencyFactory	$currencyFactory,
		JoinProcessorInterface	$extensionAttributesJoinProcessor,
		Quote\TotalsCollector	$totalsCollector,
		Quote\TotalsReader	$totalsReader,
		\Magento\Quote\Model\ShippingFactory	$shippingFactory,
		\Magento\Quote\Model\ShippingAssignmentFactory	$shippingAssignmentFactory,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		\Magento\Sales\Model\OrderIncrementIdChecker	$orderIncrementIdChecker = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
QuoteValidator	$quoteValidator
\Magento\Catalog\Helper\Product	$catalogProduct
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\App\Config\ScopeConfigInterface	$config
Quote\AddressFactory	$quoteAddressFactory
\Magento\Customer\Model\CustomerFactory	$customerFactory
\Magento\Customer\Api\GroupRepositoryInterface	$groupRepository
\Magento\Quote\Model\ResourceModel\Quote\Item\CollectionFactory	$quoteItemCollectionFactory
Quote\ItemFactory	$quoteItemFactory
\Magento\Framework\Message\Factory	$messageFactory
Status\ListFactory	$statusListFactory
\Magento\Catalog\Api\ProductRepositoryInterface	$productRepository
Quote\PaymentFactory	$quotePaymentFactory
\Magento\Quote\Model\ResourceModel\Quote\Payment\CollectionFactory	$quotePaymentCollectionFactory
\Magento\Framework\DataObject\Copy	$objectCopyService
\Magento\CatalogInventory\Api\StockRegistryInterface	$stockRegistry
Quote\Item\Processor	$itemProcessor
\Magento\Framework\DataObject\Factory	$objectFactory
\Magento\Customer\Api\AddressRepositoryInterface	$addressRepository
\Magento\Framework\Api\SearchCriteriaBuilder	$criteriaBuilder
\Magento\Framework\Api\FilterBuilder	$filterBuilder
\Magento\Customer\Api\Data\AddressInterfaceFactory	$addressDataFactory
\Magento\Customer\Api\Data\CustomerInterfaceFactory	$customerDataFactory
\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
\Magento\Framework\Api\ExtensibleDataObjectConverter	$extensibleDataObjectConverter
Cart\CurrencyFactory	$currencyFactory
JoinProcessorInterface	$extensionAttributesJoinProcessor
Quote\TotalsCollector	$totalsCollector
Quote\TotalsReader	$totalsReader
ShippingFactory	$shippingFactory
ShippingAssignmentFactory	$shippingAssignmentFactory
\Magento\Framework\Model\ResourceModel\AbstractResource \| null	$resource
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$data
\Magento\Sales\Model\OrderIncrementIdChecker \| null	$orderIncrementIdChecker	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 406 of file Quote.php.

       {
         $this->quoteValidator = $quoteValidator;
         $this->_catalogProduct = $catalogProduct;
         $this->_scopeConfig = $scopeConfig;
         $this->_storeManager = $storeManager;
         $this->_config = $config;
         $this->_quoteAddressFactory = $quoteAddressFactory;
         $this->_customerFactory = $customerFactory;
         $this->groupRepository = $groupRepository;
         $this->_quoteItemCollectionFactory = $quoteItemCollectionFactory;
         $this->_quoteItemFactory = $quoteItemFactory;
         $this->messageFactory = $messageFactory;
         $this->_statusListFactory = $statusListFactory;
         $this->productRepository = $productRepository;
         $this->_quotePaymentFactory = $quotePaymentFactory;
         $this->_quotePaymentCollectionFactory = $quotePaymentCollectionFactory;
         $this->_objectCopyService = $objectCopyService;
         $this->addressRepository = $addressRepository;
         $this->searchCriteriaBuilder = $criteriaBuilder;
         $this->filterBuilder = $filterBuilder;
         $this->stockRegistry = $stockRegistry;
         $this->itemProcessor = $itemProcessor;
         $this->objectFactory = $objectFactory;
         $this->addressDataFactory = $addressDataFactory;
         $this->customerDataFactory = $customerDataFactory;
         $this->customerRepository = $customerRepository;
         $this->dataObjectHelper = $dataObjectHelper;
         $this->extensibleDataObjectConverter = $extensibleDataObjectConverter;
         $this->currencyFactory = $currencyFactory;
         $this->extensionAttributesJoinProcessor = $extensionAttributesJoinProcessor;
         $this->totalsCollector = $totalsCollector;
         $this->totalsReader = $totalsReader;
         $this->shippingFactory = $shippingFactory;
         $this->shippingAssignmentFactory = $shippingAssignmentFactory;
         $this->orderIncrementIdChecker = $orderIncrementIdChecker ?: ObjectManager::getInstance()
             ->get(\Magento\Sales\Model\OrderIncrementIdChecker::class);
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ _addCatalogProduct()

_addCatalogProduct	(	\Magento\Catalog\Model\Product	$product,
			$qty = `1`
	)

protected

Adding catalog product object data to quote

Parameters

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

Returns: \Magento\Quote\Model\Quote\Item @SuppressWarnings(PHPMD.UnusedFormalParameter)

We can't modify existing child items

Definition at line 1695 of file Quote.php.

     {
         $newItem = false;
         $item = $this->getItemByProduct($product);
         if (!$item) {
             $item = $this->_quoteItemFactory->create();
             $item->setQuote($this);
             if ($this->_appState->getAreaCode() === \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE) {
                 $item->setStoreId($this->getStore()->getId());
             } else {
                 $item->setStoreId($this->_storeManager->getStore()->getId());
             }
             $newItem = true;
         }
 
         if ($item->getId() && $product->getParentProductId()) {
             return $item;
         }
 
         $item->setOptions($product->getCustomOptions())->setProduct($product);
 
         // Add only item that is not in quote already (there can be other new or already saved item
         if ($newItem) {
             $this->addItem($item);
         }
 
         return $item;
     }

◆ _afterLoad()

_afterLoad ( )

protected

Trigger collect totals after loading, if required

Returns: $this

Definition at line 2416 of file Quote.php.

     {
         // collect totals and save me, if required
         if (1 == $this->getTriggerRecollect()) {
             $this->collectTotals()
                 ->setTriggerRecollect(0)
                 ->save();
         }
         return parent::_afterLoad();
     }

◆ _clearErrorInfo()

_clearErrorInfo ( )

protected

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

Returns: $this

Definition at line 2096 of file Quote.php.

     {
         $this->_errorInfoGroups = [];
         $this->_setHasError(false);
         return $this;
     }

◆ _construct()

_construct ( )

protected

Init resource model

Returns: void

Definition at line 500 of file Quote.php.

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

◆ _getAddressByType()

_getAddressByType ( $type )

protected

Retrieve quote address by type

Parameters

string $type

Returns: Address

Definition at line 1133 of file Quote.php.

     {
         foreach ($this->getAddressesCollection() as $address) {
             if ($address->getAddressType() == $type && !$address->isDeleted()) {
                 return $address;
             }
         }
 
         $address = $this->_quoteAddressFactory->create()->setAddressType($type);
         $this->addAddress($address);
         return $address;
     }

◆ _setHasError()

_setHasError ( $flag )

protected

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

@codeCoverageIgnore

Parameters

bool $flag

Returns: $this

Definition at line 2066 of file Quote.php.

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

◆ addAddress()

addAddress ( \Magento\Quote\Api\Data\AddressInterface $address )

Add address.

Parameters

\Magento\Quote\Api\Data\AddressInterface $address

Returns: $this

Definition at line 1310 of file Quote.php.

     {
         $address->setQuote($this);
         if (!$address->getId()) {
             $this->getAddressesCollection()->addItem($address);
         }
         return $this;
     }

◆ addCustomerAddress()

addCustomerAddress ( \Magento\Customer\Api\Data\AddressInterface $address )

Add address to the customer, created out of a Data Object

TODO refactor in scope of MAGETWO-19930

Parameters

\Magento\Customer\Api\Data\AddressInterface $address

Returns: $this

Definition at line 1042 of file Quote.php.

     {
         $addresses = (array)$this->getCustomer()->getAddresses();
         $addresses[] = $address;
         $this->getCustomer()->setAddresses($addresses);
         $this->updateCustomerData($this->getCustomer());
         return $this;
     }

◆ addErrorInfo()

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

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

Parameters

string	$type	An internal error type ('error', 'qty', etc.), passed then to adding messages routine
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 2113 of file Quote.php.

       {
         if (!isset($this->_errorInfoGroups[$type])) {
             $this->_errorInfoGroups[$type] = $this->_statusListFactory->create();
         }
 
         $this->_errorInfoGroups[$type]->addItem($origin, $code, $message, $additionalData);
 
         if ($message !== null) {
             $this->addMessage($message, $type);
         }
         $this->_setHasError(true);
 
         return $this;
     }

◆ addItem()

addItem ( \Magento\Quote\Model\Quote\Item $item )

Adding new item to quote

Parameters

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

Returns: $this

Exceptions

Definition at line 1577 of file Quote.php.

     {
         $item->setQuote($this);
         if (!$item->getId()) {
             $this->getItemsCollection()->addItem($item);
             $this->_eventManager->dispatch('sales_quote_add_item', ['quote_item' => $item]);
         }
         return $this;
     }

◆ addMessage()

addMessage	(	$message,
		$index = `'error'`
	)

Add message.

Parameters

string	$message
string	$index

Returns: $this

Definition at line 2008 of file Quote.php.

     {
         $messages = $this->getData('messages');
         if (null === $messages) {
             $messages = [];
         }
 
         if (isset($messages[$index])) {
             return $this;
         }
 
         $message = $this->messageFactory->create(\Magento\Framework\Message\MessageInterface::TYPE_ERROR, $message);
 
         $messages[$index] = $message;
         $this->setData('messages', $messages);
         return $this;
     }

◆ addPayment()

addPayment ( PaymentInterface $payment )

protected

Adds a payment to quote

Parameters

PaymentInterface $payment

Returns: $this

Definition at line 1937 of file Quote.php.

     {
         $payment->setQuote($this);
         if (!$payment->getId()) {
             $this->getPaymentsCollection()->addItem($payment);
         }
         return $this;
     }

◆ addProduct()

addProduct	(	\Magento\Catalog\Model\Product	$product,
			$request = `null`,
			$processMode = `\Magento\Catalog\Model\Product\Type\AbstractType::PROCESS_MODE_FULL`
	)

Add product. Returns error message if product type instance can't prepare product.

Parameters

mixed	$product
null \| float \| \Magento\Framework\DataObject	$request
null \| string	$processMode

Returns: \Magento\Quote\Model\Quote\Item|string

Exceptions

Error message

If prepare process return one object

As parent item we should always use the item of first added product

Definition at line 1598 of file Quote.php.

       {
         if ($request === null) {
             $request = 1;
         }
         if (is_numeric($request)) {
             $request = $this->objectFactory->create(['qty' => $request]);
         }
         if (!$request instanceof \Magento\Framework\DataObject) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('We found an invalid request for adding product to quote.')
             );
         }
 
         if (!$product->isSalable()) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('Product that you are trying to add is not available.')
             );
         }
 
         $cartCandidates = $product->getTypeInstance()->prepareForCartAdvanced($request, $product, $processMode);
 
         if (is_string($cartCandidates) || $cartCandidates instanceof \Magento\Framework\Phrase) {
             return (string)$cartCandidates;
         }
 
         if (!is_array($cartCandidates)) {
             $cartCandidates = [$cartCandidates];
         }
 
         $parentItem = null;
         $errors = [];
         $item = null;
         $items = [];
         foreach ($cartCandidates as $candidate) {
             // Child items can be sticked together only within their parent
             $stickWithinParent = $candidate->getParentProductId() ? $parentItem : null;
             $candidate->setStickWithinParent($stickWithinParent);
 
             $item = $this->getItemByProduct($candidate);
             if (!$item) {
                 $item = $this->itemProcessor->init($candidate, $request);
                 $item->setQuote($this);
                 $item->setOptions($candidate->getCustomOptions());
                 $item->setProduct($candidate);
                 // Add only item that is not in quote already
                 $this->addItem($item);
             }
             $items[] = $item;
 
             if (!$parentItem) {
                 $parentItem = $item;
             }
             if ($parentItem && $candidate->getParentProductId() && !$item->getParentItem()) {
                 $item->setParentItem($parentItem);
             }
 
             $this->itemProcessor->prepare($item, $request, $candidate);
 
             // collect errors instead of throwing first one
             if ($item->getHasError()) {
                 foreach ($item->getMessage(false) as $message) {
                     if (!in_array($message, $errors)) {
                         // filter duplicate messages
                         $errors[] = $message;
                     }
                 }
             }
         }
         if (!empty($errors)) {
             throw new \Magento\Framework\Exception\LocalizedException(__(implode("\n", $errors)));
         }
 
         $this->_eventManager->dispatch('sales_quote_product_add_after', ['items' => $items]);
         return $parentItem;
     }

◆ addressCollectionWasSet()

addressCollectionWasSet ( )

Checks if it was set

Returns: bool

Definition at line 2432 of file Quote.php.

     {
         return null !== $this->_addresses;
     }

◆ addShippingAddress()

addShippingAddress ( \Magento\Quote\Api\Data\AddressInterface $address )

Add shipping address.

Parameters

\Magento\Quote\Api\Data\AddressInterface $address

Returns: $this

Definition at line 1367 of file Quote.php.

     {
         $this->setShippingAddress($address);
         return $this;
     }

◆ assignCustomer()

assignCustomer ( \Magento\Customer\Api\Data\CustomerInterface $customer )

Assign customer model object data to quote

Parameters

\Magento\Customer\Api\Data\CustomerInterface $customer

Returns: $this

Definition at line 911 of file Quote.php.

     {
         return $this->assignCustomerWithAddressChange($customer);
     }

◆ beforeSave()

beforeSave ( )

Prepare data before save

Returns: $this

Currency logic

global - currency which is set for default in backend base - currency which is set for current website. all attributes that have 'base_' prefix saved in this currency quote/order - currency which was selected by customer or configured by admin for current store. currency in which customer sees price thought all checkout.

Rates: base_to_global & base_to_quote/base_to_order

Definition at line 804 of file Quote.php.

     {
         $globalCurrencyCode = $this->_config->getValue(
             \Magento\Directory\Model\Currency::XML_PATH_CURRENCY_BASE,
             'default'
         );
         $baseCurrency = $this->getStore()->getBaseCurrency();
 
         if ($this->hasForcedCurrency()) {
             $quoteCurrency = $this->getForcedCurrency();
         } else {
             $quoteCurrency = $this->getStore()->getCurrentCurrency();
         }
 
         $this->setGlobalCurrencyCode($globalCurrencyCode);
         $this->setBaseCurrencyCode($baseCurrency->getCode());
         $this->setStoreCurrencyCode($baseCurrency->getCode());
         $this->setQuoteCurrencyCode($quoteCurrency->getCode());
 
         $this->setBaseToGlobalRate($baseCurrency->getRate($globalCurrencyCode));
         $this->setBaseToQuoteRate($baseCurrency->getRate($quoteCurrency));
 
         if (!$this->hasChangedFlag() || $this->getChangedFlag() == true) {
             $this->setIsChanged(1);
         } else {
             $this->setIsChanged(0);
         }
 
         if ($this->_customer) {
             $this->setCustomerId($this->_customer->getId());
         }
 
         //mark quote if it has virtual products only
         $this->setIsVirtual($this->getIsVirtual());
 
         if ($this->hasDataChanges()) {
             $this->setUpdatedAt(null);
         }
 
         parent::beforeSave();
     }

◆ collectTotals()

collectTotals ( )

Collect totals

Returns: $this

Definition at line 1978 of file Quote.php.

     {
         if ($this->getTotalsCollectedFlag()) {
             return $this;
         }
 
         $total = $this->totalsCollector->collect($this);
         $this->addData($total->getData());
 
         $this->setTotalsCollectedFlag(true);
         return $this;
     }

◆ currentPaymentWasSet()

currentPaymentWasSet ( )

Checks if it was set

Returns: bool

Definition at line 2462 of file Quote.php.

     {
         return null !== $this->_currentPayment;
     }

◆ deleteItem()

deleteItem ( \Magento\Quote\Model\Quote\Item $item )

Delete quote item. If it does not have identifier then it will be only removed from collection

Parameters

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

Returns: $this

Definition at line 1495 of file Quote.php.

     {
         if ($item->getId()) {
             $this->removeItem($item->getId());
         } else {
             $quoteItems = $this->getItemsCollection();
             $items = [$item];
             if ($item->getHasChildren()) {
                 foreach ($item->getChildren() as $child) {
                     $items[] = $child;
                 }
             }
             foreach ($quoteItems as $key => $quoteItem) {
                 foreach ($items as $item) {
                     if ($quoteItem->compare($item)) {
                         $quoteItems->removeItemByKey($key);
                     }
                 }
             }
         }
 
         return $this;
     }

◆ getAddressByCustomerAddressId()

getAddressByCustomerAddressId ( $addressId )

Get address by customer address id.

Parameters

int | string $addressId

Returns: Address|false

Definition at line 1220 of file Quote.php.

     {
         foreach ($this->getAddressesCollection() as $address) {
             if (!$address->isDeleted() && $address->getCustomerAddressId() == $addressId) {
                 return $address;
             }
         }
         return false;
     }

◆ getAddressById()

getAddressById ( $addressId )

Get address by id.

Parameters

int $addressId

Returns: Address|false

Definition at line 1204 of file Quote.php.

     {
         foreach ($this->getAddressesCollection() as $address) {
             if ($address->getId() == $addressId) {
                 return $address;
             }
         }
         return false;
     }

◆ getAddressesCollection()

getAddressesCollection ( )

Retrieve quote address collection

Returns: \Magento\Eav\Model\Entity\Collection\AbstractCollection

Definition at line 1113 of file Quote.php.

     {
         if (null === $this->_addresses) {
             $this->_addresses = $this->_quoteAddressFactory->create()->getCollection()->setQuoteFilter($this->getId());
 
             if ($this->getId()) {
                 foreach ($this->_addresses as $address) {
                     $address->setQuote($this);
                 }
             }
         }
         return $this->_addresses;
     }

◆ getAllAddresses()

getAllAddresses ( )

Get all quote addresses

Returns: \Magento\Quote\Model\Quote\Address[]

Definition at line 1187 of file Quote.php.

     {
         $addresses = [];
         foreach ($this->getAddressesCollection() as $address) {
             if (!$address->isDeleted()) {
                 $addresses[] = $address;
             }
         }
         return $addresses;
     }

◆ getAllShippingAddresses()

getAllShippingAddresses ( )

Get all shipping addresses.

Returns: array

Definition at line 1171 of file Quote.php.

     {
         $addresses = [];
         foreach ($this->getAddressesCollection() as $address) {
             if ($address->getAddressType() == Address::TYPE_SHIPPING && !$address->isDeleted()) {
                 $addresses[] = $address;
             }
         }
         return $addresses;
     }

◆ getAllVisibleItems()

getAllVisibleItems ( )

Get array of all items what can be display directly

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

Definition at line 1415 of file Quote.php.

     {
         $items = [];
         foreach ($this->getItemsCollection() as $item) {
             if (!$item->isDeleted() && !$item->getParentItemId() && !$item->getParentItem()) {
                 $items[] = $item;
             }
         }
         return $items;
     }

◆ getBillingAddress()

getBillingAddress ( )

Retrieve quote billing address

Returns: Address

Implements CartInterface.

Definition at line 1151 of file Quote.php.

     {
         return $this->_getAddressByType(Address::TYPE_BILLING);
     }

◆ getCheckoutMethod()

getCheckoutMethod ( $originalMethod = false )

Return checkout method code

Parameters

boolean $originalMethod if true return defined method from beginning

Returns: string

Definition at line 2473 of file Quote.php.

     {
         if ($this->getCustomerId() && !$originalMethod) {
             return self::CHECKOUT_METHOD_LOGIN_IN;
         }
         return $this->_getData(self::KEY_CHECKOUT_METHOD);
     }

◆ getConvertedAt()

getConvertedAt ( )

Returns the cart conversion date and time.

Returns: string|null Cart conversion date and time. Otherwise, null.

Implements CartInterface.

Definition at line 588 of file Quote.php.

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

◆ getCreatedAt()

getCreatedAt ( )

Returns the cart creation date and time.

Returns: string|null Cart creation date and time. Otherwise, null.

Implements CartInterface.

Definition at line 556 of file Quote.php.

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

◆ getCurrency()

getCurrency ( )

Returns information about quote currency, such as code, exchange rate, and so on.

Returns: \Magento\Quote\Api\Data\CurrencyInterface|null Quote currency information. Otherwise, null. @codeCoverageIgnoreStart

Implements CartInterface.

Definition at line 511 of file Quote.php.

     {
         $currency = $this->getData(self::KEY_CURRENCY);
         if (!$currency) {
             $currency = $this->currencyFactory->create()
                 ->setGlobalCurrencyCode($this->getGlobalCurrencyCode())
                 ->setBaseCurrencyCode($this->getBaseCurrencyCode())
                 ->setStoreCurrencyCode($this->getStoreCurrencyCode())
                 ->setQuoteCurrencyCode($this->getQuoteCurrencyCode())
                 ->setStoreToBaseRate($this->getStoreToBaseRate())
                 ->setStoreToQuoteRate($this->getStoreToQuoteRate())
                 ->setBaseToGlobalRate($this->getBaseToGlobalRate())
                 ->setBaseToQuoteRate($this->getBaseToQuoteRate());
             $this->setData(self::KEY_CURRENCY, $currency);
         }
         return $currency;
     }

◆ getCustomer()

getCustomer ( )

Retrieve customer model object

Returns: \Magento\Customer\Api\Data\CustomerInterface|\Magento\Framework\Api\ExtensibleDataInterface

@TODO: Remove the method after all external usages are refactored in MAGETWO-19930 _customer and _customerFactory variables should be eliminated as well

Implements CartInterface.

Definition at line 999 of file Quote.php.

     {
         if (null === $this->_customer) {
             try {
                 $this->_customer = $this->customerRepository->getById($this->getCustomerId());
             } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
                 $this->_customer = $this->customerDataFactory->create();
                 $this->_customer->setId(null);
             }
         }
 
         return $this->_customer;
     }

◆ getCustomerGroupId()

getCustomerGroupId ( )

Retrieve customer group id

Returns: int

Definition at line 1070 of file Quote.php.

     {
         if ($this->hasData('customer_group_id')) {
             return $this->getData('customer_group_id');
         } elseif ($this->getCustomerId()) {
             return $this->getCustomer()->getGroupId();
         } else {
             return GroupInterface::NOT_LOGGED_IN_ID;
         }
     }

◆ getCustomerIsGuest()

getCustomerIsGuest ( )

True for guest customers, false for logged in customers

Returns: bool|null

Implements CartInterface.

Definition at line 692 of file Quote.php.

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

◆ getCustomerNote()

getCustomerNote ( )

Customer notice text

Returns: string|null

Implements CartInterface.

Definition at line 708 of file Quote.php.

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

◆ getCustomerNoteNotify()

getCustomerNoteNotify ( )

Send customer notification flag

Returns: bool|null

Implements CartInterface.

Definition at line 724 of file Quote.php.

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

◆ getCustomerTaxClassId()

getCustomerTaxClassId ( )

Get customer tax class ID.

Returns: int|null

tax class can vary at any time. so instead of using the value from session, we need to retrieve from db every time to get the correct tax class

Implements CartInterface.

Definition at line 1084 of file Quote.php.

     {
         //if (!$this->getData('customer_group_id') && !$this->getData('customer_tax_class_id')) {
         $groupId = $this->getCustomerGroupId();
         if ($groupId !== null) {
             $taxClassId = $this->groupRepository->getById($this->getCustomerGroupId())->getTaxClassId();
             $this->setCustomerTaxClassId($taxClassId);
         }
 
         return $this->getData(self::KEY_CUSTOMER_TAX_CLASS_ID);
     }

◆ getErrors()

getErrors ( )

Retrieve current quote errors

Returns: array

Definition at line 2046 of file Quote.php.

     {
         $errors = [];
         foreach ($this->getMessages() as $message) {
             /* @var $error \Magento\Framework\Message\AbstractMessage */
             if ($message->getType() == \Magento\Framework\Message\MessageInterface::TYPE_ERROR) {
                 $errors[] = $message;
             }
         }
         return $errors;
     }

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object or create a new one.

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

Implements CartInterface.

Definition at line 2575 of file Quote.php.

     {
         return $this->_getExtensionAttributes();
     }

◆ getIsActive()

getIsActive ( )

Determines whether the cart is still active.

Returns: bool|null Active status flag value. Otherwise, null.

Implements CartInterface.

Definition at line 604 of file Quote.php.

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

◆ getIsVirtual()

getIsVirtual ( )

Check quote for virtual product only

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements CartInterface.

Definition at line 2330 of file Quote.php.

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

◆ getItemById()

getItemById ( $itemId )

Retrieve item model object by item identifier

Parameters

int $itemId

Returns: \Magento\Quote\Model\Quote\Item|false

Definition at line 1478 of file Quote.php.

     {
         foreach ($this->getItemsCollection() as $item) {
             if ($item->getId() == $itemId) {
                 return $item;
             }
         }
 
         return false;
     }

◆ getItemByProduct()

getItemByProduct ( $product )

Retrieve quote item by product id

Parameters

\Magento\Catalog\Model\Product $product

Returns: \Magento\Quote\Model\Quote\Item|bool

Definition at line 1813 of file Quote.php.

     {
         foreach ($this->getAllItems() as $item) {
             if ($item->representProduct($product)) {
                 return $item;
             }
         }
         return false;
     }

◆ getItems()

getItems ( )

Lists items in the cart.

Returns: \Magento\Quote\Api\Data\CartItemInterface[]|null Array of items. Otherwise, null.

Implements CartInterface.

Definition at line 540 of file Quote.php.

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

◆ getItemsCollection()

getItemsCollection ( $useCache = true )

Retrieve quote items collection

Parameters

bool $useCache

Returns: \Magento\Eav\Model\Entity\Collection\AbstractCollection @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 1380 of file Quote.php.

     {
         if ($this->hasItemsCollection()) {
             return $this->getData('items_collection');
         }
         if (null === $this->_items) {
             $this->_items = $this->_quoteItemCollectionFactory->create();
             $this->extensionAttributesJoinProcessor->process($this->_items);
             $this->_items->setQuote($this);
         }
         return $this->_items;
     }

◆ getItemsCount()

getItemsCount ( )

Returns the number of different items or products in the cart.

Returns: int|null Number of different items or products in the cart. Otherwise, null.

Implements CartInterface.

Definition at line 628 of file Quote.php.

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

◆ getItemsQty()

getItemsQty ( )

Returns the total quantity of all cart items.

Returns: float|null Total quantity of all cart items. Otherwise, null.

Implements CartInterface.

Definition at line 644 of file Quote.php.

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

◆ getItemsSummaryQty()

getItemsSummaryQty ( )

Get items summary qty.

Returns: int

Definition at line 1828 of file Quote.php.

     {
         $qty = $this->getData('all_items_qty');
         if (null === $qty) {
             $qty = 0;
             foreach ($this->getAllItems() as $item) {
                 if ($item->getParentItem()) {
                     continue;
                 }
 
                 $children = $item->getChildren();
                 if ($children && $item->isShipSeparately()) {
                     foreach ($children as $child) {
                         $qty += $child->getQty() * $item->getQty();
                     }
                 } else {
                     $qty += $item->getQty();
                 }
             }
             $this->setData('all_items_qty', $qty);
         }
         return $qty;
     }

◆ getItemVirtualQty()

getItemVirtualQty ( )

Get item virtual qty.

Returns: int

Definition at line 1857 of file Quote.php.

     {
         $qty = $this->getData('virtual_items_qty');
         if (null === $qty) {
             $qty = 0;
             foreach ($this->getAllItems() as $item) {
                 if ($item->getParentItem()) {
                     continue;
                 }
 
                 $children = $item->getChildren();
                 if ($children && $item->isShipSeparately()) {
                     foreach ($children as $child) {
                         if ($child->getProduct()->getIsVirtual()) {
                             $qty += $child->getQty();
                         }
                     }
                 } else {
                     if ($item->getProduct()->getIsVirtual()) {
                         $qty += $item->getQty();
                     }
                 }
             }
             $this->setData('virtual_items_qty', $qty);
         }
         return $qty;
     }

◆ getMessages()

getMessages ( )

Retrieve current quote messages

Returns: array

Definition at line 2031 of file Quote.php.

     {
         $messages = $this->getData('messages');
         if (null === $messages) {
             $messages = [];
             $this->setData('messages', $messages);
         }
         return $messages;
     }

◆ getOrigOrderId()

getOrigOrderId ( )

Returns the original order ID for the cart.

Returns: int|null Original order ID. Otherwise, null.

Implements CartInterface.

Definition at line 660 of file Quote.php.

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

◆ getPayment()

getPayment ( )

Get payment.

Returns: \Magento\Quote\Model\Quote\Payment

Definition at line 1911 of file Quote.php.

     {
         if (null === $this->_currentPayment || !$this->_currentPayment) {
             $this->_currentPayment = $this->_quotePaymentCollectionFactory->create()
                 ->setQuoteFilter($this->getId())
                 ->getFirstItem();
         }
         if ($payment = $this->_currentPayment) {
             if ($this->getId()) {
                 $payment->setQuote($this);
             }
             if (!$payment->isDeleted()) {
                 return $payment;
             }
         }
         $payment = $this->_quotePaymentFactory->create();
         $this->addPayment($payment);
         return $payment;
     }

◆ getPaymentsCollection()

getPaymentsCollection ( )

Get payments collection.

Returns: \Magento\Eav\Model\Entity\Collection\AbstractCollection

Definition at line 1892 of file Quote.php.

     {
         if (null === $this->_payments) {
             $this->_payments = $this->_quotePaymentCollectionFactory->create()->setQuoteFilter($this->getId());
 
             if ($this->getId()) {
                 foreach ($this->_payments as $payment) {
                     $payment->setQuote($this);
                 }
             }
         }
         return $this->_payments;
     }

◆ getReservedOrderId()

getReservedOrderId ( )

Returns the reserved order ID for the cart.

Returns: int|null Reserved order ID. Otherwise, null.

Implements CartInterface.

Definition at line 676 of file Quote.php.

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

◆ getSharedStoreIds()

getSharedStoreIds ( )

Get all available store ids for quote

Returns: array

Definition at line 786 of file Quote.php.

     {
         $ids = $this->_getData('shared_store_ids');
         if ($ids === null || !is_array($ids)) {
             $website = $this->getWebsite();
             if ($website) {
                 return $website->getStoreIds();
             }
             return $this->getStore()->getWebsite()->getStoreIds();
         }
         return $ids;
     }

◆ getShippingAddress()

getShippingAddress ( )

Retrieve quote shipping address

Returns: Address

Definition at line 1161 of file Quote.php.

     {
         return $this->_getAddressByType(Address::TYPE_SHIPPING);
     }

◆ getShippingAddressesItems()

getShippingAddressesItems ( )

Get quote items assigned to different quote addresses populated per item qty.

Returns: array

Definition at line 2486 of file Quote.php.

     {
         if ($this->shippingAddressesItems !== null) {
             return $this->shippingAddressesItems;
         }
         $items = [];
         $addresses = $this->getAllAddresses();
         foreach ($addresses as $address) {
             foreach ($address->getAllItems() as $item) {
                 if ($item->getParentItemId()) {
                     continue;
                 }
                 if ($item->getProduct()->getIsVirtual()) {
                     $items[] = $item;
                     continue;
                 }
                 if ($item->getQty() > 1) {
                     for ($itemIndex = 0, $itemQty = $item->getQty(); $itemIndex < $itemQty; $itemIndex++) {
                         if ($itemIndex == 0) {
                             $addressItem = $item;
                         } else {
                             $addressItem = clone $item;
                         }
                         $addressItem->setQty(1)->setCustomerAddressId($address->getCustomerAddressId())->save();
                         $items[] = $addressItem;
                     }
                 } else {
                     $item->setCustomerAddressId($address->getCustomerAddressId());
                     $items[] = $item;
                 }
             }
         }
         $this->shippingAddressesItems = $items;
         return $items;
     }

◆ getStore()

getStore ( )

Get quote store model object

Returns: \Magento\Store\Model\Store

Definition at line 764 of file Quote.php.

     {
         return $this->_storeManager->getStore($this->getStoreId());
     }

◆ getStoreId()

getStoreId ( )

Get store identifier

Returns: int

Implements CartInterface.

Definition at line 742 of file Quote.php.

     {
         if (!$this->hasStoreId()) {
             return $this->_storeManager->getStore()->getId();
         }
         return (int)$this->_getData(self::KEY_STORE_ID);
     }

◆ getTotals()

getTotals ( )

Get all quote totals (sorted by priority)

Returns: AddressTotal[]

Definition at line 1996 of file Quote.php.

     {
         return $this->totalsReader->fetch($this, $this->getData());
     }

◆ getUpdatedAt()

getUpdatedAt ( )

Returns the cart last update date and time.

Returns: string|null Cart last update date and time. Otherwise, null.

Implements CartInterface.

Definition at line 572 of file Quote.php.

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

◆ hasItems()

hasItems ( )

Checking items availability

Returns: bool

Definition at line 1431 of file Quote.php.

     {
         return sizeof($this->getAllItems()) > 0;
     }

◆ hasItemsWithDecimalQty()

hasItemsWithDecimalQty ( )

Checking availability of items with decimal qty

Returns: bool

Definition at line 1441 of file Quote.php.

     {
         foreach ($this->getAllItems() as $item) {
             $stockItemDo = $this->stockRegistry->getStockItem(
                 $item->getProduct()->getId(),
                 $item->getStore()->getWebsiteId()
             );
             if ($stockItemDo->getItemId() && $stockItemDo->getIsQtyDecimal()) {
                 return true;
             }
         }
         return false;
     }

◆ hasProductId()

hasProductId ( $productId )

Checking product exist in Quote

Parameters

int $productId

Returns: bool

Definition at line 1461 of file Quote.php.

     {
         foreach ($this->getAllItems() as $item) {
             if ($item->getProductId() == $productId) {
                 return true;
             }
         }
 
         return false;
     }

◆ hasVirtualItems()

hasVirtualItems ( )

Has a virtual products on quote

Returns: bool

Definition at line 2340 of file Quote.php.

     {
         $hasVirtual = false;
         foreach ($this->getItemsCollection() as $item) {
             if ($item->getParentItemId()) {
                 continue;
             }
             if ($item->getProduct()->isVirtual()) {
                 $hasVirtual = true;
             }
         }
         return $hasVirtual;
     }

◆ isMultipleShippingAddresses()

isMultipleShippingAddresses ( )

Check if there are more than one shipping address

Returns: bool

Definition at line 2565 of file Quote.php.

     {
         return \count($this->getAllShippingAddresses()) > 1;
     }

◆ isPreventSaving()

isPreventSaving ( )

Check if model can be saved

@codeCoverageIgnore

Returns: bool

Definition at line 2555 of file Quote.php.

     {
         return $this->_preventSaving;
     }

◆ isVirtual()

isVirtual ( )

Check quote for virtual product only

Returns: bool

Definition at line 2306 of file Quote.php.

     {
         $isVirtual = true;
         $countItems = 0;
         foreach ($this->getItemsCollection() as $_item) {
             /* @var $_item \Magento\Quote\Model\Quote\Item */
             if ($_item->isDeleted() || $_item->getParentItemId()) {
                 continue;
             }
             $countItems++;
             if (!$_item->getProduct()->getIsVirtual()) {
                 $isVirtual = false;
                 break;
             }
         }
         return $countItems == 0 ? false : $isVirtual;
     }

◆ itemsCollectionWasSet()

itemsCollectionWasSet ( )

Checks if it was set

Returns: bool

Definition at line 2442 of file Quote.php.

     {
         return null !== $this->_items;
     }

◆ loadActive()

loadActive ( $quoteId )

Loading only active quote

Parameters

int $quoteId

Returns: $this

Definition at line 885 of file Quote.php.

     {
         $this->_getResource()->loadActive($this, $quoteId);
         $this->_afterLoad();
         return $this;
     }

◆ loadByCustomer()

loadByCustomer ( $customer )

Loading quote data by customer

Parameters

\Magento\Customer\Model\Customer | int $customer

Deprecated:: 101.0.0

Returns: $this

Definition at line 866 of file Quote.php.

     {
         /* @TODO: remove this if after external usages of loadByCustomerId are refactored in MAGETWO-19935 */
         if ($customer instanceof \Magento\Customer\Model\Customer || $customer instanceof CustomerInterface) {
             $customerId = $customer->getId();
         } else {
             $customerId = (int)$customer;
         }
         $this->_getResource()->loadByCustomerId($this, $customerId);
         $this->_afterLoad();
         return $this;
     }

◆ loadByIdWithoutStore()

loadByIdWithoutStore ( $quoteId )

Loading quote by identifier

Parameters

int $quoteId

Returns: $this

Definition at line 898 of file Quote.php.

     {
         $this->_getResource()->loadByIdWithoutStore($this, $quoteId);
         $this->_afterLoad();
         return $this;
     }

◆ merge()

merge ( Quote $quote )

Merge quotes

Parameters

Quote $quote

Returns: $this

Init shipping and billing address if quote is new

Definition at line 2360 of file Quote.php.

     {
         $this->_eventManager->dispatch(
             $this->_eventPrefix . '_merge_before',
             [$this->_eventObject => $this, 'source' => $quote]
         );
 
         foreach ($quote->getAllVisibleItems() as $item) {
             $found = false;
             foreach ($this->getAllItems() as $quoteItem) {
                 if ($quoteItem->compare($item)) {
                     $quoteItem->setQty($quoteItem->getQty() + $item->getQty());
                     $this->itemProcessor->merge($item, $quoteItem);
                     $found = true;
                     break;
                 }
             }
 
             if (!$found) {
                 $newItem = clone $item;
                 $this->addItem($newItem);
                 if ($item->getHasChildren()) {
                     foreach ($item->getChildren() as $child) {
                         $newChild = clone $child;
                         $newChild->setParentItem($newItem);
                         $this->addItem($newChild);
                     }
                 }
             }
         }
 
         if (!$this->getId()) {
             $this->getShippingAddress();
             $this->getBillingAddress();
         }
 
         if ($quote->getCouponCode()) {
             $this->setCouponCode($quote->getCouponCode());
         }
 
         $this->_eventManager->dispatch(
             $this->_eventPrefix . '_merge_after',
             [$this->_eventObject => $this, 'source' => $quote]
         );
 
         return $this;
     }

◆ paymentsCollectionWasSet()

paymentsCollectionWasSet ( )

Checks if it was set

Returns: bool

Definition at line 2452 of file Quote.php.

     {
         return null !== $this->_payments;
     }

◆ preventSaving()

preventSaving ( )

Prevent quote from saving

@codeCoverageIgnore

Returns: $this

Definition at line 2542 of file Quote.php.

     {
         $this->_preventSaving = true;
         return $this;
     }

◆ removeAddress()

removeAddress ( $addressId )

Remove address.

Parameters

int | string $addressId

Returns: $this

Definition at line 1256 of file Quote.php.

     {
         foreach ($this->getAddressesCollection() as $address) {
             if ($address->getId() == $addressId) {
                 $address->isDeleted(true);
                 break;
             }
         }
         return $this;
     }

◆ removeAllAddresses()

removeAllAddresses ( )

Leave no more than one billing and one shipping address, fill them with default data

Returns: $this

Definition at line 1272 of file Quote.php.

     {
         $addressByType = [];
         $addressesCollection = $this->getAddressesCollection();
 
         // mark all addresses as deleted
         foreach ($addressesCollection as $address) {
             $type = $address->getAddressType();
             if (!isset($addressByType[$type]) || $addressByType[$type]->getId() > $address->getId()) {
                 $addressByType[$type] = $address;
             }
             $address->isDeleted(true);
         }
 
         // create new billing and shipping addresses filled with default values, set this data to existing records
         foreach ($addressByType as $type => $address) {
             $id = $address->getId();
             $emptyAddress = $this->_getAddressByType($type);
             $address->setData($emptyAddress->getData())->setId($id)->isDeleted(false);
             $emptyAddress->setDeleteImmediately(true);
         }
 
         // remove newly created billing and shipping addresses from collection to avoid senseless delete queries
         foreach ($addressesCollection as $key => $item) {
             if ($item->getDeleteImmediately()) {
                 $addressesCollection->removeItemByKey($key);
             }
         }
 
         return $this;
     }

◆ removeAllItems()

removeAllItems ( )

Mark all quote items as deleted (empty quote)

Returns: $this

Definition at line 1558 of file Quote.php.

     {
         foreach ($this->getItemsCollection() as $itemId => $item) {
             if ($item->getId() === null) {
                 $this->getItemsCollection()->removeItemByKey($itemId);
             } else {
                 $item->isDeleted(true);
             }
         }
         return $this;
     }

◆ removeErrorInfosByParams()

removeErrorInfosByParams	(	$type,
		$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

string	$type	An internal error type ('error', 'qty', etc.), passed then to adding messages routine
array	$params

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 2144 of file Quote.php.

     {
         if ($type && !isset($this->_errorInfoGroups[$type])) {
             return $this;
         }
 
         $errorLists = [];
         if ($type) {
             $errorLists[] = $this->_errorInfoGroups[$type];
         } else {
             $errorLists = $this->_errorInfoGroups;
         }
 
         foreach ($errorLists as $type => $errorList) {
             $removedItems = $errorList->removeItemsByParams($params);
             foreach ($removedItems as $item) {
                 if ($item['message'] !== null) {
                     $this->removeMessageByText($type, $item['message']);
                 }
             }
         }
 
         $errorsExist = false;
         foreach ($this->_errorInfoGroups as $errorListCheck) {
             if ($errorListCheck->getItems()) {
                 $errorsExist = true;
                 break;
             }
         }
         if (!$errorsExist) {
             $this->_setHasError(false);
         }
 
         return $this;
     }

◆ removeItem()

removeItem ( $itemId )

Remove quote item by item identifier

Parameters

int $itemId

Returns: $this

If we remove item from quote - we can't use multishipping mode

Definition at line 1525 of file Quote.php.

     {
         $item = $this->getItemById($itemId);
 
         if ($item) {
             $item->setQuote($this);
             $this->setIsMultiShipping(false);
             $item->isDeleted(true);
             if ($item->getHasChildren()) {
                 foreach ($item->getChildren() as $child) {
                     $child->isDeleted(true);
                 }
             }
 
             $parent = $item->getParentItem();
             if ($parent) {
                 $parent->isDeleted(true);
             }
 
             $this->_eventManager->dispatch('sales_quote_remove_item', ['quote_item' => $item]);
         }
 
         return $this;
     }

◆ removeMessageByText()

removeMessageByText	(	$type,
		$text
	)

Removes message by text

Parameters

string	$type
string	$text

Returns: $this

Definition at line 2187 of file Quote.php.

     {
         $messages = $this->getData('messages');
         if (null === $messages) {
             $messages = [];
         }
 
         if (!isset($messages[$type])) {
             return $this;
         }
 
         $message = $messages[$type];
         if ($message instanceof \Magento\Framework\Message\AbstractMessage) {
             $message = $message->getText();
         } elseif (!is_string($message)) {
             return $this;
         }
         if ($message == $text) {
             unset($messages[$type]);
             $this->setData('messages', $messages);
         }
         return $this;
     }

◆ removePayment()

removePayment ( )

Remove payment.

Returns: $this

Definition at line 1967 of file Quote.php.

     {
         $this->getPayment()->isDeleted(true);
         return $this;
     }

◆ reserveOrderId()

reserveOrderId ( )

Generate new increment order id and associate it with current quote

Returns: $this

Definition at line 2216 of file Quote.php.

     {
         if (!$this->getReservedOrderId()) {
             $this->setReservedOrderId($this->_getResource()->getReservedOrderId($this));
         } else {
             //checking if reserved order id was already used for some order
             //if yes reserving new one if not using old one
             if ($this->orderIncrementIdChecker->isIncrementIdUsed($this->getReservedOrderId())) {
                 $this->setReservedOrderId($this->_getResource()->getReservedOrderId($this));
             }
         }
         return $this;
     }

◆ setBillingAddress()

setBillingAddress ( \Magento\Quote\Api\Data\AddressInterface $address = null )

Set billing address.

Parameters

\Magento\Quote\Api\Data\AddressInterface $address

Returns: $this

Definition at line 1325 of file Quote.php.

     {
         $old = $this->getAddressesCollection()->getItemById($address->getId())
             ?? $this->getBillingAddress();
         if (!empty($old)) {
             $old->addData($address->getData());
         } else {
             $this->addAddress($address->setAddressType(Address::TYPE_BILLING));
         }
 
         return $this;
     }

◆ setCheckoutMethod()

setCheckoutMethod ( $checkoutMethod )

Sets the payment method that is used to process the cart.

@codeCoverageIgnore

Parameters

string $checkoutMethod

Returns: $this

Definition at line 2530 of file Quote.php.

     {
         return $this->setData(self::KEY_CHECKOUT_METHOD, $checkoutMethod);
     }

◆ setConvertedAt()

setConvertedAt ( $convertedAt )

Sets the cart conversion date and time.

Parameters

string $convertedAt

Returns: $this

Implements CartInterface.

Definition at line 596 of file Quote.php.

     {
         return $this->setData(self::KEY_CONVERTED_AT, $convertedAt);
     }

◆ setCreatedAt()

setCreatedAt ( $createdAt )

Sets the cart creation date and time.

Parameters

string $createdAt

Returns: $this

Implements CartInterface.

Definition at line 564 of file Quote.php.

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

◆ setCurrency()

setCurrency ( \Magento\Quote\Api\Data\CurrencyInterface $currency = null )

Definition at line 532 of file Quote.php.

     {
         return $this->setData(self::KEY_CURRENCY, $currency);
     }

◆ setCustomer()

setCustomer ( \Magento\Customer\Api\Data\CustomerInterface $customer = null )

Define customer object

Parameters

\Magento\Customer\Api\Data\CustomerInterface $customer

Returns: $this

Definition at line 974 of file Quote.php.

     {
         /* @TODO: Remove the method after all external usages are refactored in MAGETWO-19930 */
         $this->_customer = $customer;
         $this->setCustomerId($customer->getId());
         $origAddresses = $customer->getAddresses();
         $customer->setAddresses([]);
         $customerDataFlatArray = $this->objectFactory->create(
             $this->extensibleDataObjectConverter->toFlatArray(
                 $customer,
                 [],
                 \Magento\Customer\Api\Data\CustomerInterface::class
             )
         );
         $customer->setAddresses($origAddresses);
         $this->_objectCopyService->copyFieldsetToTarget('customer_account', 'to_quote', $customerDataFlatArray, $this);
 
         return $this;
     }

◆ setCustomerAddressData()

setCustomerAddressData ( array $addresses )

Substitute customer addresses

Parameters

Definition at line 1023 of file Quote.php.

     {
         foreach ($addresses as $address) {
             if (!$address->getId()) {
                 $this->addCustomerAddress($address);
             }
         }
 
         return $this;
     }

◆ setCustomerIsGuest()

setCustomerIsGuest ( $customerIsGuest )

Sets true for guest customers, false for logged in customers

Parameters

bool $customerIsGuest

Returns: $this

Implements CartInterface.

Definition at line 700 of file Quote.php.

     {
         return $this->setData(self::KEY_CUSTOMER_IS_GUEST, $customerIsGuest);
     }

◆ setCustomerNote()

setCustomerNote ( $customerNote )

Sets Customer notice text

Parameters

string $customerNote

Returns: $this

Implements CartInterface.

Definition at line 716 of file Quote.php.

     {
         return $this->setData(self::KEY_CUSTOMER_NOTE, $customerNote);
     }

◆ setCustomerNoteNotify()

setCustomerNoteNotify ( $customerNoteNotify )

Sets send customer notification flag

Parameters

bool $customerNoteNotify

Returns: $this

Implements CartInterface.

Definition at line 732 of file Quote.php.

     {
         return $this->setData(self::KEY_CUSTOMER_NOTE_NOTIFY, $customerNoteNotify);
     }

◆ setCustomerTaxClassId()

setCustomerTaxClassId ( $customerTaxClassId )

Set customer tax class ID.

Parameters

int $customerTaxClassId

Returns: $this

Implements CartInterface.

Definition at line 1103 of file Quote.php.

     {
         return $this->setData(self::KEY_CUSTOMER_TAX_CLASS_ID, $customerTaxClassId);
     }

◆ setExtensionAttributes()

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

Set an extension attributes object.

Parameters

\Magento\Quote\Api\Data\CartExtensionInterface $extensionAttributes

Returns: $this

Definition at line 2586 of file Quote.php.

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

◆ setHasError()

setHasError ( $flag )

Sets flag, whether this quote has some error associated with it. When TRUE - also adds 'unknown' error information to list of quote errors. When FALSE - clears whole list of quote 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 2081 of file Quote.php.

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

◆ setIsActive()

setIsActive ( $isActive )

Sets whether the cart is still active.

Parameters

bool $isActive

Returns: $this

Implements CartInterface.

Definition at line 612 of file Quote.php.

     {
         return $this->setData(self::KEY_IS_ACTIVE, $isActive);
     }

◆ setIsVirtual()

setIsVirtual ( $isVirtual )

Definition at line 620 of file Quote.php.

     {
         return $this->setData(self::KEY_IS_VIRTUAL, $isVirtual);
     }

◆ setItems()

setItems ( array $items = null )

Sets items in the cart.

Parameters

Implements CartInterface.

Definition at line 548 of file Quote.php.

     {
         return $this->setData(self::KEY_ITEMS, $items);
     }

◆ setItemsCount()

setItemsCount ( $itemsCount )

Sets the number of different items or products in the cart.

Parameters

int $itemsCount

Returns: $this

Implements CartInterface.

Definition at line 636 of file Quote.php.

     {
         return $this->setData(self::KEY_ITEMS_COUNT, $itemsCount);
     }

◆ setItemsQty()

setItemsQty ( $itemsQty )

Sets the total quantity of all cart items.

Parameters

float $itemQty

Returns: $this

Implements CartInterface.

Definition at line 652 of file Quote.php.

     {
         return $this->setData(self::KEY_ITEMS_QTY, $itemsQty);
     }

◆ setOrigOrderId()

setOrigOrderId ( $origOrderId )

Sets the original order ID for the cart.

Parameters

int $origOrderId

Returns: $this

Implements CartInterface.

Definition at line 668 of file Quote.php.

     {
         return $this->setData(self::KEY_ORIG_ORDER_ID, $origOrderId);
     }

◆ setPayment()

setPayment ( PaymentInterface $payment )

Sets payment to current quote

Parameters

PaymentInterface $payment

Returns: PaymentInterface

Definition at line 1952 of file Quote.php.

     {
         if (!$this->getIsMultiPayment() && ($old = $this->getPayment())) {
             $payment->setId($old->getId());
         }
         $this->addPayment($payment);
 
         return $payment;
     }

◆ setReservedOrderId()

setReservedOrderId ( $reservedOrderId )

Sets the reserved order ID for the cart.

Parameters

int $reservedOrderId

Returns: $this

Implements CartInterface.

Definition at line 684 of file Quote.php.

     {
         return $this->setData(self::KEY_RESERVED_ORDER_ID, $reservedOrderId);
     }

◆ setShippingAddress()

setShippingAddress ( \Magento\Quote\Api\Data\AddressInterface $address = null )

Set shipping address

Parameters

\Magento\Quote\Api\Data\AddressInterface $address

Returns: $this

Definition at line 1344 of file Quote.php.

     {
         if ($this->getIsMultiShipping()) {
             $this->addAddress($address->setAddressType(Address::TYPE_SHIPPING));
         } else {
             $old = $this->getAddressesCollection()->getItemById($address->getId())
                 ?? $this->getShippingAddress();
             if (!empty($old)) {
                 $old->addData($address->getData());
             } else {
                 $this->addAddress($address->setAddressType(Address::TYPE_SHIPPING));
             }
         }
 
         return $this;
     }

◆ setStore()

setStore ( \Magento\Store\Model\Store $store )

Declare quote store model

Parameters

\Magento\Store\Model\Store $store

Returns: $this

Definition at line 775 of file Quote.php.

     {
         $this->setStoreId($store->getId());
         return $this;
     }

◆ setStoreId()

setStoreId ( $storeId )

Sets store identifier

Parameters

int $storeId

Returns: $this

Implements CartInterface.

Definition at line 753 of file Quote.php.

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

◆ setUpdatedAt()

setUpdatedAt ( $updatedAt )

Sets the cart last update date and time.

Parameters

string $updatedAt

Returns: $this

Implements CartInterface.

Definition at line 580 of file Quote.php.

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

◆ updateCustomerData()

updateCustomerData ( \Magento\Customer\Api\Data\CustomerInterface $customer )

Update customer data object

Parameters

\Magento\Customer\Api\Data\CustomerInterface $customer

Returns: $this

Definition at line 1057 of file Quote.php.

     {
         $quoteCustomer = $this->getCustomer();
         $this->dataObjectHelper->mergeDataObjects(CustomerInterface::class, $quoteCustomer, $customer);
         $this->setCustomer($quoteCustomer);
         return $this;
     }

◆ updateItem()

updateItem	(	$itemId,
		$buyRequest,
		$params = `null`
	)

Updates quote item with new configuration

$params sets how current item configuration must be taken into account and additional options. It's passed to \Magento\Catalog\Helper\Product->addParamsToBuyRequest() to compose resulting buyRequest.

Basically it can hold

'current_config', \Magento\Framework\DataObject or array - current buyRequest that configures product in this item, used to restore currently attached files
'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file options (file inputs), so they won't intersect with other submitted options

For more options see \Magento\Catalog\Helper\Product->addParamsToBuyRequest()

Parameters

int	$itemId
\Magento\Framework\DataObject	$buyRequest
null \| array \| \Magento\Framework\DataObject	$params

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

Exceptions

Product configuration didn't stick to original quote item It either has same configuration as some other quote item's product or completely new configuration

Definition at line 1750 of file Quote.php.

     {
         $item = $this->getItemById($itemId);
         if (!$item) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('This is the wrong quote item id to update configuration.')
             );
         }
         $productId = $item->getProduct()->getId();
 
         //We need to create new clear product instance with same $productId
         //to set new option values from $buyRequest
         $product = clone $this->productRepository->getById($productId, false, $this->getStore()->getId());
 
         if (!$params) {
             $params = new \Magento\Framework\DataObject();
         } elseif (is_array($params)) {
             $params = new \Magento\Framework\DataObject($params);
         }
         $params->setCurrentConfig($item->getBuyRequest());
         $buyRequest = $this->_catalogProduct->addParamsToBuyRequest($buyRequest, $params);
 
         $buyRequest->setResetCount(true);
         $resultItem = $this->addProduct($product, $buyRequest);
 
         if (is_string($resultItem)) {
             throw new \Magento\Framework\Exception\LocalizedException(__($resultItem));
         }
 
         if ($resultItem->getParentItem()) {
             $resultItem = $resultItem->getParentItem();
         }
 
         if ($resultItem->getId() != $itemId) {
             $this->removeItem($itemId);
             $items = $this->getAllItems();
             foreach ($items as $item) {
                 if ($item->getProductId() == $productId && $item->getId() != $resultItem->getId()) {
                     if ($resultItem->compare($item)) {
                         // Product configuration is same as in other quote item
                         $resultItem->setQty($resultItem->getQty() + $item->getQty());
                         $this->removeItem($item->getId());
                         break;
                     }
                 }
             }
         } else {
             $resultItem->setQty($buyRequest->getQty());
         }
 
         return $resultItem;
     }

Field Documentation

◆ $_addresses

$_addresses

protected

Definition at line 136 of file Quote.php.

◆ $_catalogProduct

$_catalogProduct

protected

Definition at line 176 of file Quote.php.

◆ $_config

$_config

protected

Definition at line 200 of file Quote.php.

◆ $_currentPayment

$_currentPayment

protected

Definition at line 155 of file Quote.php.

◆ $_customer

$_customer

protected

Definition at line 129 of file Quote.php.

◆ $_customerFactory

$_customerFactory

protected

Definition at line 210 of file Quote.php.

◆ $_errorInfoGroups

$_errorInfoGroups = []

protected

Definition at line 162 of file Quote.php.

◆ $_eventObject

$_eventObject = 'quote'

protected

Definition at line 122 of file Quote.php.

◆ $_eventPrefix

$_eventPrefix = 'sales_quote'

protected

Definition at line 117 of file Quote.php.

◆ $_items

$_items

protected

Definition at line 143 of file Quote.php.

◆ $_objectCopyService

$_objectCopyService

protected

Definition at line 257 of file Quote.php.

◆ $_payments

$_payments

protected

Definition at line 150 of file Quote.php.

◆ $_preventSaving

$_preventSaving = false

protected

Definition at line 169 of file Quote.php.

◆ $_quoteAddressFactory

$_quoteAddressFactory

protected

Definition at line 205 of file Quote.php.

◆ $_quoteItemCollectionFactory

$_quoteItemCollectionFactory

protected

Definition at line 222 of file Quote.php.

◆ $_quoteItemFactory

$_quoteItemFactory

protected

Definition at line 227 of file Quote.php.

◆ $_quotePaymentCollectionFactory

$_quotePaymentCollectionFactory

protected

Definition at line 252 of file Quote.php.

◆ $_quotePaymentFactory

$_quotePaymentFactory

protected

Definition at line 247 of file Quote.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 190 of file Quote.php.

◆ $_statusListFactory

$_statusListFactory

protected

Definition at line 237 of file Quote.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 195 of file Quote.php.

◆ $addressDataFactory

$addressDataFactory

protected

Definition at line 303 of file Quote.php.

◆ $addressRepository

$addressRepository

protected

Definition at line 264 of file Quote.php.

◆ $currencyFactory

$currencyFactory

protected

Definition at line 318 of file Quote.php.

◆ $customerDataFactory

$customerDataFactory

protected

Definition at line 308 of file Quote.php.

◆ $customerRepository

$customerRepository

protected

Definition at line 313 of file Quote.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 323 of file Quote.php.

◆ $extensibleDataObjectConverter

$extensibleDataObjectConverter

protected

Definition at line 298 of file Quote.php.

◆ $extensionAttributesJoinProcessor

$extensionAttributesJoinProcessor

protected

Definition at line 328 of file Quote.php.

◆ $filterBuilder

$filterBuilder

protected

Definition at line 278 of file Quote.php.

◆ $groupRepository

$groupRepository

protected

Definition at line 217 of file Quote.php.

◆ $itemProcessor

$itemProcessor

protected

Definition at line 288 of file Quote.php.

◆ $messageFactory

$messageFactory

protected

Definition at line 232 of file Quote.php.

◆ $objectFactory

$objectFactory

protected

Definition at line 293 of file Quote.php.

◆ $productRepository

$productRepository

protected

Definition at line 242 of file Quote.php.

◆ $quoteValidator

$quoteValidator

protected

Definition at line 183 of file Quote.php.

◆ $searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 271 of file Quote.php.

◆ $shippingAddressesItems

$shippingAddressesItems

protected

Definition at line 355 of file Quote.php.

◆ $shippingAssignmentFactory

$shippingAssignmentFactory

protected

Definition at line 348 of file Quote.php.

◆ $shippingFactory

$shippingFactory

protected

Definition at line 343 of file Quote.php.

◆ $stockRegistry

$stockRegistry

protected

Definition at line 283 of file Quote.php.

◆ $totalsCollector

$totalsCollector

protected

Definition at line 333 of file Quote.php.

◆ $totalsReader

$totalsReader

protected

Definition at line 338 of file Quote.php.

◆ CHECKOUT_METHOD_LOGIN_IN

const CHECKOUT_METHOD_LOGIN_IN = 'login_in'

Checkout login method key

Definition at line 112 of file Quote.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addCatalogProduct()

◆ _afterLoad()

◆ _clearErrorInfo()

◆ _construct()

◆ _getAddressByType()

◆ _setHasError()

◆ addAddress()

◆ addCustomerAddress()

◆ addErrorInfo()

◆ addItem()

◆ addMessage()

◆ addPayment()

◆ addProduct()

◆ addressCollectionWasSet()

◆ addShippingAddress()

◆ assignCustomer()

◆ beforeSave()

◆ collectTotals()

◆ currentPaymentWasSet()

◆ deleteItem()

◆ getAddressByCustomerAddressId()

◆ getAddressById()

◆ getAddressesCollection()

◆ getAllAddresses()

◆ getAllShippingAddresses()

◆ getAllVisibleItems()

◆ getBillingAddress()

◆ getCheckoutMethod()

◆ getConvertedAt()

◆ getCreatedAt()

◆ getCurrency()

◆ getCustomer()

◆ getCustomerGroupId()

◆ getCustomerIsGuest()

◆ getCustomerNote()

◆ getCustomerNoteNotify()

◆ getCustomerTaxClassId()

◆ getErrors()

◆ getExtensionAttributes()

◆ getIsActive()

◆ getIsVirtual()

◆ getItemById()

◆ getItemByProduct()

◆ getItems()

◆ getItemsCollection()

◆ getItemsCount()

◆ getItemsQty()

◆ getItemsSummaryQty()

◆ getItemVirtualQty()

◆ getMessages()

◆ getOrigOrderId()

◆ getPayment()

◆ getPaymentsCollection()

◆ getReservedOrderId()

◆ getSharedStoreIds()

◆ getShippingAddress()

◆ getShippingAddressesItems()

◆ getStore()

◆ getStoreId()

◆ getTotals()

◆ getUpdatedAt()

◆ hasItems()

◆ hasItemsWithDecimalQty()

◆ hasProductId()

◆ hasVirtualItems()

◆ isMultipleShippingAddresses()

◆ isPreventSaving()

◆ isVirtual()

◆ itemsCollectionWasSet()

◆ loadActive()

◆ loadByCustomer()