How are a quote's getCustomerEmail() and setCustomerEmail() methods implemented and used?

dmitry_fedyuk · April 21, 2016, 4:54pm

Interface: \Magento\Quote\Model\Quote

magento/magento2/blob/ebba9e7/app/code/Magento/Quote/Model/Quote.php#L47-L48


* @method string getCustomerEmail()
* @method Quote setCustomerEmail(string $value)

Implementation: \Magento\Quote\Model\Quote

The methods are implemented through the magic __call() method.

Usages: setCustomerEmail()

Details: How is a customer email set to a quote?

Usages: getCustomerEmail()

1. \Magento\Quote\Model\QuoteManagement::submitQuote()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Quote/Model/QuoteManagement.php#L473-L480


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());

2. \Magento\Checkout\Helper\Data::sendPaymentFailedEmail()

3. \Magento\Quote\Model\Quote\Address::getEmail()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Quote/Model/Quote/Address.php#L1562-L1573


/**
 * {@inheritdoc}
 */
public function getEmail()
{
    $email = $this->getData(self::KEY_EMAIL);
    if (!$email && $this->getQuote()) {
        $email = $this->getQuote()->getCustomerEmail();
        $this->setEmail($email);
    }
    return $email;
}

4. \Magento\Quote\Model\Quote\Address\BillingAddressPersister::save()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Quote/Model/Quote/Address/BillingAddressPersister.php#L58-L74


$saveInAddressBook = $address->getSaveInAddressBook() ? 1 : 0;
if ($customerAddressId) {
    try {
        $addressData = $this->addressRepository->getById($customerAddressId);
    } catch (NoSuchEntityException $e) {
        // do nothing if customer is not found by id
    }
    $address = $quote->getBillingAddress()->importCustomerAddressData($addressData);
    if ($useForShipping) {
        $shippingAddress = $quote->getShippingAddress()->importCustomerAddressData($addressData);
        $shippingAddress->setSaveInAddressBook($saveInAddressBook);
    }
} elseif ($quote->getCustomerId()) {
    $address->setEmail($quote->getCustomerEmail());
}
$address->setSaveInAddressBook($saveInAddressBook);
$quote->setBillingAddress($address);

5. \Magento\Sales\Block\Adminhtml\Order\Create\Form\Account::getFormValues()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Block/Adminhtml/Order/Create/Form/Account.php#L161-L180


public function getFormValues()
{
    try {
        $customer = $this->customerRepository->getById($this->getCustomerId());
    } catch (\Exception $e) {
        /** If customer does not exist do nothing. */
    }
    $data = isset($customer) ? $this->_extensibleDataObjectConverter->toFlatArray($customer, [], '\Magento\Customer\Api\Data\CustomerInterface') : [];
    foreach ($this->getQuote()->getData() as $key => $value) {
        if (strpos($key, 'customer_') === 0) {
            $data[substr($key, 9)] = $value;
        }
    }


    if ($this->getQuote()->getCustomerEmail()) {
        $data['email'] = $this->getQuote()->getCustomerEmail();
    }


    return $data;
}

dmitry_fedyuk · April 21, 2016, 5:02pm