Inheritance diagram for QuoteManagement:

Public Member Functions
	__construct (EventManager $eventManager, QuoteValidator $quoteValidator, OrderFactory $orderFactory, OrderManagement $orderManagement, CustomerManagement $customerManagement, ToOrderConverter $quoteAddressToOrder, ToOrderAddressConverter $quoteAddressToOrderAddress, ToOrderItemConverter $quoteItemToOrderItem, ToOrderPaymentConverter $quotePaymentToOrderPayment, UserContextInterface $userContext, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository, \Magento\Customer\Model\CustomerFactory $customerModelFactory, \Magento\Quote\Model\Quote\AddressFactory $quoteAddressFactory, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, StoreManagerInterface $storeManager, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Customer\Model\Session $customerSession, \Magento\Customer\Api\AccountManagementInterface $accountManagement, \Magento\Quote\Model\QuoteFactory $quoteFactory, \Magento\Quote\Model\QuoteIdMaskFactory $quoteIdMaskFactory=null, \Magento\Customer\Api\AddressRepositoryInterface $addressRepository=null)

	createEmptyCart ()

	createEmptyCartForCustomer ($customerId)

	placeOrder ($cartId, PaymentInterface $paymentMethod=null)

	getCartForCustomer ($customerId)

	submit (QuoteEntity $quote, $orderData=[])

Public Member Functions inherited from CartManagementInterface
	assignCustomer ($cartId, $customerId, $storeId)

Protected Member Functions
	submitQuote (QuoteEntity $quote, $orderData=[])

Additional Inherited Members
Data Fields inherited from CartManagementInterface
const	METHOD_GUEST = 'guest'

Detailed Description

Class QuoteManagement

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 31 of file QuoteManagement.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	EventManager	$eventManager,
		QuoteValidator	$quoteValidator,
		OrderFactory	$orderFactory,
		OrderManagement	$orderManagement,
		CustomerManagement	$customerManagement,
		ToOrderConverter	$quoteAddressToOrder,
		ToOrderAddressConverter	$quoteAddressToOrderAddress,
		ToOrderItemConverter	$quoteItemToOrderItem,
		ToOrderPaymentConverter	$quotePaymentToOrderPayment,
		UserContextInterface	$userContext,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository,
		\Magento\Customer\Model\CustomerFactory	$customerModelFactory,
		\Magento\Quote\Model\Quote\AddressFactory	$quoteAddressFactory,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		StoreManagerInterface	$storeManager,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Customer\Api\AccountManagementInterface	$accountManagement,
		\Magento\Quote\Model\QuoteFactory	$quoteFactory,
		\Magento\Quote\Model\QuoteIdMaskFactory	$quoteIdMaskFactory = `null`,
		\Magento\Customer\Api\AddressRepositoryInterface	$addressRepository = `null`
	)

Parameters

EventManager	$eventManager
QuoteValidator	$quoteValidator
OrderFactory	$orderFactory
OrderManagement	$orderManagement
CustomerManagement	$customerManagement
ToOrderConverter	$quoteAddressToOrder
ToOrderAddressConverter	$quoteAddressToOrderAddress
ToOrderItemConverter	$quoteItemToOrderItem
ToOrderPaymentConverter	$quotePaymentToOrderPayment
UserContextInterface	$userContext
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository
\Magento\Customer\Model\CustomerFactory	$customerModelFactory
\Magento\Quote\Model\Quote\AddressFactory	$quoteAddressFactory

Definition at line 173 of file QuoteManagement.php.

       {
         $this->eventManager = $eventManager;
         $this->quoteValidator = $quoteValidator;
         $this->orderFactory = $orderFactory;
         $this->orderManagement = $orderManagement;
         $this->customerManagement = $customerManagement;
         $this->quoteAddressToOrder = $quoteAddressToOrder;
         $this->quoteAddressToOrderAddress = $quoteAddressToOrderAddress;
         $this->quoteItemToOrderItem = $quoteItemToOrderItem;
         $this->quotePaymentToOrderPayment = $quotePaymentToOrderPayment;
         $this->userContext = $userContext;
         $this->quoteRepository = $quoteRepository;
         $this->customerRepository = $customerRepository;
         $this->customerModelFactory = $customerModelFactory;
         $this->quoteAddressFactory = $quoteAddressFactory;
         $this->dataObjectHelper = $dataObjectHelper;
         $this->storeManager = $storeManager;
         $this->checkoutSession = $checkoutSession;
         $this->accountManagement = $accountManagement;
         $this->customerSession = $customerSession;
         $this->quoteFactory = $quoteFactory;
         $this->quoteIdMaskFactory = $quoteIdMaskFactory ?: ObjectManager::getInstance()
             ->get(\Magento\Quote\Model\QuoteIdMaskFactory::class);
         $this->addressRepository = $addressRepository ?: ObjectManager::getInstance()
             ->get(\Magento\Customer\Api\AddressRepositoryInterface::class);
     }

Member Function Documentation

◆ createEmptyCart()

createEmptyCart ( )

{Creates an empty cart and quote for a guest.

Returns: int Cart ID.

Exceptions

}

Implements CartManagementInterface.

Definition at line 226 of file QuoteManagement.php.

     {
         $storeId = $this->storeManager->getStore()->getStoreId();
         $quote = $this->createAnonymousCart($storeId);
 
         $quote->setBillingAddress($this->quoteAddressFactory->create());
         $quote->setShippingAddress($this->quoteAddressFactory->create());
 
         try {
             $quote->getShippingAddress()->setCollectShippingRates(true);
             $this->quoteRepository->save($quote);
         } catch (\Exception $e) {
             throw new CouldNotSaveException(__("The quote can't be created."));
         }
         return $quote->getId();
     }

◆ createEmptyCartForCustomer()

createEmptyCartForCustomer ( $customerId )

{Creates an empty cart and quote for a specified customer if customer does not have a cart yet.

Parameters

int $customerId The customer ID.

Returns: int new cart ID if customer did not have a cart or ID of the existing cart otherwise.

Exceptions

}

Implements CartManagementInterface.

Definition at line 246 of file QuoteManagement.php.

     {
         $storeId = $this->storeManager->getStore()->getStoreId();
         $quote = $this->createCustomerCart($customerId, $storeId);
 
         try {
             $this->quoteRepository->save($quote);
         } catch (\Exception $e) {
             throw new CouldNotSaveException(__("The quote can't be created."));
         }
         return (int)$quote->getId();
     }

◆ getCartForCustomer()

getCartForCustomer ( $customerId )

{Returns information for the cart for a specified customer.

Parameters

int $customerId The customer ID.

Returns: \Magento\Quote\Api\Data\CartInterface Cart object.

Exceptions

}

Implements CartManagementInterface.

Definition at line 384 of file QuoteManagement.php.

     {
         return $this->quoteRepository->getActiveForCustomer($customerId);
     }

◆ placeOrder()

placeOrder	(		$cartId,
		PaymentInterface	$paymentMethod = `null`
	)

{Places an order for a specified cart.

Parameters

int	$cartId	The cart ID.
PaymentInterface \| null	$paymentMethod

Exceptions

}

Implements CartManagementInterface.

Definition at line 337 of file QuoteManagement.php.

     {
         $quote = $this->quoteRepository->getActive($cartId);
         if ($paymentMethod) {
             $paymentMethod->setChecks([
                 \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_CHECKOUT,
                 \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_COUNTRY,
                 \Magento\Payment\Model\Method\AbstractMethod::CHECK_USE_FOR_CURRENCY,
                 \Magento\Payment\Model\Method\AbstractMethod::CHECK_ORDER_TOTAL_MIN_MAX,
                 \Magento\Payment\Model\Method\AbstractMethod::CHECK_ZERO_TOTAL,
             ]);
             $quote->getPayment()->setQuote($quote);
 
             $data = $paymentMethod->getData();
             $quote->getPayment()->importData($data);
         }
 
         if ($quote->getCheckoutMethod() === self::METHOD_GUEST) {
             $quote->setCustomerId(null);
             $quote->setCustomerEmail($quote->getBillingAddress()->getEmail());
             $quote->setCustomerIsGuest(true);
             $quote->setCustomerGroupId(\Magento\Customer\Api\Data\GroupInterface::NOT_LOGGED_IN_ID);
         }
 
         $this->eventManager->dispatch('checkout_submit_before', ['quote' => $quote]);
 
         $order = $this->submit($quote);
 
         if (null == $order) {
             throw new LocalizedException(
                 __('A server error stopped your order from being placed. Please try to place your order again.')
             );
         }
 
         $this->checkoutSession->setLastQuoteId($quote->getId());
         $this->checkoutSession->setLastSuccessQuoteId($quote->getId());
         $this->checkoutSession->setLastOrderId($order->getId());
         $this->checkoutSession->setLastRealOrderId($order->getIncrementId());
         $this->checkoutSession->setLastOrderStatus($order->getStatus());
 
         $this->eventManager->dispatch('checkout_submit_all_after', ['order' => $order, 'quote' => $quote]);
         return $order->getId();
     }

◆ submit()

submit	(	QuoteEntity	$quote,
			$orderData = `[]`
	)

Submit quote

Parameters

Quote	$quote
array	$orderData

Returns: \Magento\Framework\Model\AbstractExtensibleModel|\Magento\Sales\Api\Data\OrderInterface|object|null

Exceptions

Definition at line 398 of file QuoteManagement.php.

     {
         if (!$quote->getAllVisibleItems()) {
             $quote->setIsActive(false);
             return null;
         }
 
         return $this->submitQuote($quote, $orderData);
     }

◆ submitQuote()

submitQuote	(	QuoteEntity	$quote,
			$orderData = `[]`
	)

protected

Submit quote

Parameters

Quote	$quote
array	$orderData

Returns: \Magento\Framework\Model\AbstractExtensibleModel|\Magento\Sales\Api\Data\OrderInterface|object

Exceptions

Definition at line 445 of file QuoteManagement.php.

     {
         $order = $this->orderFactory->create();
         $this->quoteValidator->validateBeforeSubmit($quote);
         if (!$quote->getCustomerIsGuest()) {
             if ($quote->getCustomerId()) {
                 $this->_prepareCustomerQuote($quote);
                 $this->customerManagement->validateAddresses($quote);
             }
             $this->customerManagement->populateCustomerInfo($quote);
         }
         $addresses = [];
         $quote->reserveOrderId();
         if ($quote->isVirtual()) {
             $this->dataObjectHelper->mergeDataObjects(
                 \Magento\Sales\Api\Data\OrderInterface::class,
                 $order,
                 $this->quoteAddressToOrder->convert($quote->getBillingAddress(), $orderData)
             );
         } else {
             $this->dataObjectHelper->mergeDataObjects(
                 \Magento\Sales\Api\Data\OrderInterface::class,
                 $order,
                 $this->quoteAddressToOrder->convert($quote->getShippingAddress(), $orderData)
             );
             $shippingAddress = $this->quoteAddressToOrderAddress->convert(
                 $quote->getShippingAddress(),
                 [
                     'address_type' => 'shipping',
                     'email' => $quote->getCustomerEmail()
                 ]
             );
             $shippingAddress->setData('quote_address_id', $quote->getShippingAddress()->getId());
             $addresses[] = $shippingAddress;
             $order->setShippingAddress($shippingAddress);
             $order->setShippingMethod($quote->getShippingAddress()->getShippingMethod());
         }
         $billingAddress = $this->quoteAddressToOrderAddress->convert(
             $quote->getBillingAddress(),
             [
                 'address_type' => 'billing',
                 'email' => $quote->getCustomerEmail()
             ]
         );
         $billingAddress->setData('quote_address_id', $quote->getBillingAddress()->getId());
         $addresses[] = $billingAddress;
         $order->setBillingAddress($billingAddress);
         $order->setAddresses($addresses);
         $order->setPayment($this->quotePaymentToOrderPayment->convert($quote->getPayment()));
         $order->setItems($this->resolveItems($quote));
         if ($quote->getCustomer()) {
             $order->setCustomerId($quote->getCustomer()->getId());
         }
         $order->setQuoteId($quote->getId());
         $order->setCustomerEmail($quote->getCustomerEmail());
         $order->setCustomerFirstname($quote->getCustomerFirstname());
         $order->setCustomerMiddlename($quote->getCustomerMiddlename());
         $order->setCustomerLastname($quote->getCustomerLastname());
 
         $this->eventManager->dispatch(
             'sales_model_service_quote_submit_before',
             [
                 'order' => $order,
                 'quote' => $quote
             ]
         );
         try {
             $order = $this->orderManagement->place($order);
             $quote->setIsActive(false);
             $this->eventManager->dispatch(
                 'sales_model_service_quote_submit_success',
                 [
                     'order' => $order,
                     'quote' => $quote
                 ]
             );
             $this->quoteRepository->save($quote);
         } catch (\Exception $e) {
             if (!empty($this->addressesToSync)) {
                 foreach ($this->addressesToSync as $addressId) {
                     $this->addressRepository->deleteById($addressId);
                 }
             }
             $this->eventManager->dispatch(
                 'sales_model_service_quote_submit_failure',
                 [
                     'order'     => $order,
                     'quote'     => $quote,
                     'exception' => $e
                 ]
             );
             throw $e;
         }
         return $order;
     }

Field Documentation

◆ $accountManagement

$accountManagement

protected

Definition at line 126 of file QuoteManagement.php.

◆ $checkoutSession

$checkoutSession

protected

Definition at line 116 of file QuoteManagement.php.

◆ $customerManagement

$customerManagement

protected

Definition at line 56 of file QuoteManagement.php.

◆ $customerModelFactory

$customerModelFactory

protected

Definition at line 96 of file QuoteManagement.php.

◆ $customerRepository

$customerRepository

protected

Definition at line 91 of file QuoteManagement.php.

◆ $customerSession

$customerSession

protected

Definition at line 121 of file QuoteManagement.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 106 of file QuoteManagement.php.

◆ $eventManager

$eventManager

protected

Definition at line 36 of file QuoteManagement.php.

◆ $orderFactory

$orderFactory

protected

Definition at line 46 of file QuoteManagement.php.

◆ $orderManagement

$orderManagement

protected

Definition at line 51 of file QuoteManagement.php.

◆ $quoteAddressFactory

$quoteAddressFactory

protected

Definition at line 101 of file QuoteManagement.php.

◆ $quoteAddressToOrder

$quoteAddressToOrder

protected

Definition at line 61 of file QuoteManagement.php.

◆ $quoteAddressToOrderAddress

$quoteAddressToOrderAddress

protected

Definition at line 66 of file QuoteManagement.php.

◆ $quoteFactory

$quoteFactory

protected

Definition at line 131 of file QuoteManagement.php.

◆ $quoteItemToOrderItem

$quoteItemToOrderItem

protected

Definition at line 71 of file QuoteManagement.php.

◆ $quotePaymentToOrderPayment

$quotePaymentToOrderPayment

protected

Definition at line 76 of file QuoteManagement.php.

◆ $quoteRepository

$quoteRepository

protected

Definition at line 86 of file QuoteManagement.php.

◆ $quoteValidator

$quoteValidator

protected

Definition at line 41 of file QuoteManagement.php.

◆ $storeManager

$storeManager

protected

Definition at line 111 of file QuoteManagement.php.

◆ $userContext

$userContext

protected

Definition at line 81 of file QuoteManagement.php.

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

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

Protected Attributes
	$eventManager

	$quoteValidator

	$orderFactory

	$orderManagement

	$customerManagement

	$quoteAddressToOrder

	$quoteAddressToOrderAddress

	$quoteItemToOrderItem

	$quotePaymentToOrderPayment

	$userContext

	$quoteRepository

	$customerRepository

	$customerModelFactory

	$quoteAddressFactory

	$dataObjectHelper

	$storeManager

	$checkoutSession

	$customerSession

	$accountManagement

	$quoteFactory

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createEmptyCart()

◆ createEmptyCartForCustomer()

◆ getCartForCustomer()

◆ placeOrder()

◆ submit()

◆ submitQuote()

Field Documentation

◆ $accountManagement

◆ $checkoutSession

◆ $customerManagement

◆ $customerModelFactory

◆ $customerRepository

◆ $customerSession

◆ $dataObjectHelper

◆ $eventManager

◆ $orderFactory

◆ $orderManagement

◆ $quoteAddressFactory

◆ $quoteAddressToOrder

◆ $quoteAddressToOrderAddress

◆ $quoteFactory

◆ $quoteItemToOrderItem

◆ $quotePaymentToOrderPayment

◆ $quoteRepository

◆ $quoteValidator

◆ $storeManager

◆ $userContext