How to get a customer by his ID with the \Magento\Customer\Api\CustomerRepositoryInterface::getById()?

dmitry_fedyuk · April 4, 2016, 10:29pm

Context: How to get a customer by his ID?

Interface

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Api/CustomerRepositoryInterface.php#L40-L49

Implementation

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/ResourceModel/CustomerRepository.php#L246-L253

Usages

magento/magento2/blob/ab051bf/app/code/Magento/Checkout/Model/Session.php#L256-L260


if ($this->_customer) {
    $quote->setCustomer($this->_customer);
} elseif ($this->_customerSession->isLoggedIn()) {
    $quote->setCustomer($this->customerRepository->getById($this->_customerSession->getCustomerId()));
}

6

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Checkout/Model/Cart/CollectQuote.php#L69-L87


public function collect(\Magento\Quote\Model\Quote $quote)
{
    if ($this->customerSession->isLoggedIn()) {
        $customer = $this->customerRepository->getById($this->customerSession->getCustomerId());
        if ($defaultShipping = $customer->getDefaultShipping()) {
            $address = $this->addressRepository->getById($defaultShipping);
            if ($address) {
                /** @var \Magento\Quote\Api\Data\EstimateAddressInterface $estimatedAddress */
                $estimatedAddress = $this->estimatedAddressFactory->create();
                $estimatedAddress->setCountryId($address->getCountryId());
                $estimatedAddress->setPostcode($address->getPostcode());
                $estimatedAddress->setRegion((string)$address->getRegion()->getRegion());
                $estimatedAddress->setRegionId($address->getRegionId());
                $this->shippingMethodManager->estimateByAddress($quote->getId(), $estimatedAddress);
                $this->quoteRepository->save($quote);
            }
        }
    }
}

7

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Checkout/Model/Type/Onepage.php#L615-L635


/**
 * Prepare quote for customer order submit
 *
 * @return void
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
protected function _prepareCustomerQuote()
{
    $quote = $this->getQuote();
    $billing = $quote->getBillingAddress();
    $shipping = $quote->isVirtual() ? null : $quote->getShippingAddress();


    $customer = $this->customerRepository->getById($this->getCustomerSession()->getCustomerId());
    $hasDefaultBilling = (bool)$customer->getDefaultBilling();
    $hasDefaultShipping = (bool)$customer->getDefaultShipping();


    if ($shipping && !$shipping->getSameAsBilling() &&
        (!$shipping->getCustomerId() || $shipping->getSaveInAddressBook())
    ) {
        $shippingAddress = $shipping->exportCustomerAddress();
        if (!$hasDefaultShipping) {

8

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Account/Dashboard.php#L66-L74


/**
 * Return the Customer given the customer Id stored in the session.
 *
 * @return \Magento\Customer\Api\Data\CustomerInterface
 */
public function getCustomer()
{
    return $this->customerRepository->getById($this->customerSession->getCustomerId());
}

9

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Address/Book.php#L158-L173


/**
 * @return \Magento\Customer\Api\Data\CustomerInterface|null
 */
public function getCustomer()
{
    $customer = $this->getData('customer');
    if ($customer === null) {
        try {
            $customer = $this->customerRepository->getById($this->currentCustomer->getCustomerId());
        } catch (\Magento\Framework\Exception\NoSuchEntityException $e) {
            return null;
        }
        $this->setData('customer', $customer);
    }
    return $customer;
}

10

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Adminhtml/Edit.php#L152-L166


/**
 * Retrieve the header text, either the name of an existing customer or 'New Customer'.
 *
 * @return \Magento\Framework\Phrase|string
 */
public function getHeaderText()
{
    $customerId = $this->getCustomerId();
    if ($customerId) {
        $customerData = $this->customerRepository->getById($customerId);
        return $this->escapeHtml($this->_viewHelper->getCustomerName($customerData));
    } else {
        return __('New Customer');
    }
}

11

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Adminhtml/Edit/Form.php#L69-L83


$customerId = $this->_coreRegistry->registry(RegistryConstants::CURRENT_CUSTOMER_ID);


if ($customerId) {
    $form->addField('id', 'hidden', ['name' => 'customer_id']);
    $customer = $this->_customerRepository->getById($customerId);
    $form->setValues(
        $this->_extensibleDataObjectConverter->toFlatArray(
            $customer,
            [],
            '\Magento\Customer\Api\Data\CustomerInterface'
        )
    )->addValues(
        ['customer_id' => $customerId]
    );
}

12

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Widget/Gender.php#L83-L91


/**
 * Get current customer from session
 *
 * @return CustomerInterface
 */
public function getCustomer()
{
    return $this->customerRepository->getById($this->_customerSession->getCustomerId());
}

13

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Controller/Account/Confirm.php#L96-L115


try {
    $customerId = $this->getRequest()->getParam('id', false);
    $key = $this->getRequest()->getParam('key', false);
    if (empty($customerId) || empty($key)) {
        throw new \Exception(__('Bad request.'));
    }


    // log in and send greeting email
    $customerEmail = $this->customerRepository->getById($customerId)->getEmail();
    $customer = $this->customerAccountManagement->activate($customerEmail, $key);
    $this->session->setCustomerDataAsLoggedIn($customer);


    $this->messageManager->addSuccess($this->getSuccessMessage());
    $resultRedirect->setUrl($this->getSuccessRedirect());
    return $resultRedirect;
} catch (StateException $e) {
    $this->messageManager->addException($e, __('This confirmation key is invalid or has expired.'));
} catch (\Exception $e) {
    $this->messageManager->addException($e, __('There was an error confirming the account'));
}

14

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Controller/Account/Edit.php#L69-L80

15

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Controller/Account/ResetPasswordPost.php#L73-L90

16

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Controller/Adminhtml/Index/Edit.php#L29-L49

dmitry_fedyuk · April 5, 2016, 1:58am