How are an order's getCustomerEmail() and setCustomerEmail() methods implemented and used?

dmitrii_fediuk · April 21, 2016, 4:46pm

Interface: \Magento\Sales\Api\Data\OrderInterface

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Api/Data/OrderInterface.php#L2313-L2319


/**
 * Sets the customer email address for the order.
 *
 * @param string $customerEmail
 * @return $this
 */
public function setCustomerEmail($customerEmail);

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Api/Data/OrderInterface.php#L917-L922


/**
 * Gets the customer email address for the order.
 *
 * @return string Customer email address.
 */
public function getCustomerEmail();

Implementation: \Magento\Sales\Model\Order

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Model/Order.php#L4039-L4045


/**
 * {@inheritdoc}
 */
public function setCustomerEmail($customerEmail)
{
    return $this->setData(OrderInterface::CUSTOMER_EMAIL, $customerEmail);
}

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Model/Order.php#L2495-L2503


/**
 * Returns customer_email
 *
 * @return string
 */
public function getCustomerEmail()
{
    return $this->getData(OrderInterface::CUSTOMER_EMAIL);
}

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Api/Data/OrderInterface.php#L397-L400


/*
 * Customer email address.
 */
const CUSTOMER_EMAIL = 'customer_email';

Usages: setCustomerEmail()

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

Usages: getCustomerEmail()

1. \Magento\Checkout\Block\Registration::getEmailAddress()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Checkout/Block/Registration.php#L72-L81


/**
 * Retrieve current email address
 *
 * @return string
 * @codeCoverageIgnore
 */
public function getEmailAddress()
{
    return $this->checkoutSession->getLastRealOrder()->getCustomerEmail();
}

2. \Magento\Sales\Model\Order::setBillingAddress()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Model/Order.php#L897-L915


/**
 * Sets the billing address, if any, for the order.
 *
 * @param \Magento\Sales\Api\Data\OrderAddressInterface $address
 * @return $this
 */
public function setBillingAddress(\Magento\Sales\Api\Data\OrderAddressInterface $address = null)
{
    $old = $this->getBillingAddress();
    if (!empty($old) && !empty($address)) {
        $address->setId($old->getId());
    }


    if (!empty($address)) {
        $address->setEmail($this->getCustomerEmail());
        $this->addAddress($address->setAddressType('billing'));
    }
    return $this;
}

3. \Magento\Sales\Model\Order::setShippingAddress()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Model/Order.php#L917-L935


/**
 * Declare order shipping address
 *
 * @param \Magento\Sales\Api\Data\OrderAddressInterface $address
 * @return $this
 */
public function setShippingAddress(\Magento\Sales\Api\Data\OrderAddressInterface $address = null)
{
    $old = $this->getShippingAddress();
    if (!empty($old) && !empty($address)) {
        $address->setId($old->getId());
    }


    if (!empty($address)) {
        $address->setEmail($this->getCustomerEmail());
        $this->addAddress($address->setAddressType('shipping'));
    }
    return $this;
}

4. \Magento\Sales\Model\Order\Email\Sender::prepareTemplate()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/Model/Order/Email/Sender.php#L86-L105


/**
 * @param Order $order
 * @return void
 */
protected function prepareTemplate(Order $order)
{
    $this->templateContainer->setTemplateOptions($this->getTemplateOptions());


    if ($order->getCustomerIsGuest()) {
        $templateId = $this->identityContainer->getGuestTemplateId();
        $customerName = $order->getBillingAddress()->getName();
    } else {
        $templateId = $this->identityContainer->getTemplateId();
        $customerName = $order->getCustomerName();
    }


    $this->identityContainer->setCustomerName($customerName);
    $this->identityContainer->setCustomerEmail($order->getCustomerEmail());
    $this->templateContainer->setTemplateId($templateId);
}

5. Magento/Sales/view/adminhtml/templates/order/view/info.phtml

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Sales/view/adminhtml/templates/order/view/info.phtml#L132-L133


<th><?php /* @escapeNotVerified */ echo __('Email') ?></th>
<td><a href="mailto:<?php echo $block->escapeHtml($_order->getCustomerEmail()) ?>"><?php echo $block->escapeHtml($_order->getCustomerEmail()) ?></a></td>

6. \Magento\Authorizenet\Model\Authorizenet::buildRequest()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Authorizenet/Model/Authorizenet.php#L326-L344


$billing = $order->getBillingAddress();
if (!empty($billing)) {
    $request->setXFirstName($billing->getFirstname())
        ->setXLastName($billing->getLastname())
        ->setXCompany($billing->getCompany())
        ->setXAddress($billing->getStreetLine(1))
        ->setXCity($billing->getCity())
        ->setXState($billing->getRegion())
        ->setXZip($billing->getPostcode())
        ->setXCountry($billing->getCountry())
        ->setXPhone($billing->getTelephone())
        ->setXFax($billing->getFax())
        ->setXCustId($order->getCustomerId())
        ->setXCustomerIp($order->getRemoteIp())
        ->setXCustomerTaxId($billing->getTaxId())
        ->setXEmail($order->getCustomerEmail())
        ->setXEmailCustomer($this->getConfigData('email_customer'))
        ->setXMerchantEmail($this->getConfigData('merchant_email'));
}

7. \Magento\Authorizenet\Model\Directpost\Request::setDataFromOrder()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Authorizenet/Model/Directpost/Request.php#L117-L135


$billing = $order->getBillingAddress();
if (!empty($billing)) {
    $this->setXFirstName(strval($billing->getFirstname()))
        ->setXLastName(strval($billing->getLastname()))
        ->setXCompany(strval($billing->getCompany()))
        ->setXAddress(strval($billing->getStreetLine(1)))
        ->setXCity(strval($billing->getCity()))
        ->setXState(strval($billing->getRegion()))
        ->setXZip(strval($billing->getPostcode()))
        ->setXCountry(strval($billing->getCountry()))
        ->setXPhone(strval($billing->getTelephone()))
        ->setXFax(strval($billing->getFax()))
        ->setXCustId(strval($billing->getCustomerId()))
        ->setXCustomerIp(strval($order->getRemoteIp()))
        ->setXCustomerTaxId(strval($billing->getTaxId()))
        ->setXEmail(strval($order->getCustomerEmail()))
        ->setXEmailCustomer(strval($paymentMethod->getConfigData('email_customer')))
        ->setXMerchantEmail(strval($paymentMethod->getConfigData('merchant_email')));
}

8. \Magento\Paypal\Model\Direct::_placeOrder()

9. \Magento\Paypal\Model\Payflowpro::fillCustomerContacts()

github.com

magento/magento2/blob/ebba9e7/app/code/Magento/Paypal/Model/Payflowpro.php#L832-L836


$billing = $order->getBillingAddress();
if (!empty($billing)) {
    $request = $this->setBilling($request, $billing);
    $request->setEmail($order->getCustomerEmail());
}

dmitrii_fediuk · April 21, 2016, 5:03pm