How to get a customer by his ID with the \Magento\Customer\Model\CustomerRegistry::retrieve()?

dmitry_fedyuk · April 4, 2016, 10:26pm

Context: How to get a customer by his ID?

Interface

https://github.com/magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/CustomerRegistry.php#L68-L75

Implementation

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/CustomerRegistry.php#L76-L91


{
    if (isset($this->customerRegistryById[$customerId])) {
        return $this->customerRegistryById[$customerId];
    }
    /** @var Customer $customer */
    $customer = $this->customerFactory->create()->load($customerId);
    if (!$customer->getId()) {
        // customer does not exist
        throw NoSuchEntityException::singleField('customerId', $customerId);
    } else {
        $emailKey = $this->getEmailKey($customer->getEmail(), $customer->getWebsiteId());
        $this->customerRegistryById[$customerId] = $customer;
        $this->customerRegistryByEmail[$emailKey] = $customer;
        return $customer;
    }
}

Usages

1

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Block/Adminhtml/Edit/UnlockButton.php#L37-L57


/**
 * Returns Unlock button data
 *
 * @return array
 */
public function getButtonData()
{
    $customerId = $this->getCustomerId();
    $data = [];
    if ($customerId) {
        $customer = $this->customerRegistry->retrieve($customerId);
        if ($customer->isCustomerLocked()) {
            $data = [
                'label' => __('Unlock'),
                'class' => 'unlock unlock-customer',
                'on_click' => sprintf("location.href = '%s';", $this->getUnlockUrl()),
                'sort_order' => 50,
            ];
        }
    }
    return $data;

2

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/Authentication.php#L140-L147


/**
 * {@inheritdoc}
 */
public function isLocked($customerId)
{
    $currentCustomer = $this->customerRegistry->retrieve($customerId);
    return $currentCustomer->isCustomerLocked();
}

3

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/CustomerRegistry.php#L146-L165


public function retrieveSecureData($customerId)
{
    if (isset($this->customerSecureRegistryById[$customerId])) {
        return $this->customerSecureRegistryById[$customerId];
    }
    /** @var Customer $customer */
    $customer = $this->retrieve($customerId);
    /** @var $customerSecure CustomerSecure*/
    $customerSecure = $this->customerSecureFactory->create();
    $customerSecure->setPasswordHash($customer->getPasswordHash());
    $customerSecure->setRpToken($customer->getRpToken());
    $customerSecure->setRpTokenCreatedAt($customer->getRpTokenCreatedAt());
    $customerSecure->setDeleteable($customer->isDeleteable());
    $customerSecure->setFailuresNum($customer->getFailuresNum());
    $customerSecure->setFirstFailure($customer->getFirstFailure());
    $customerSecure->setLockExpires($customer->getLockExpires());
    $this->customerSecureRegistryById[$customer->getId()] = $customerSecure;


    return $customerSecure;
}

4

github.com

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/ResourceModel/AddressRepository.php#L104-L124


$customerModel = $this->customerRegistry->retrieve($address->getCustomerId());
if ($address->getId()) {
    $addressModel = $this->addressRegistry->retrieve($address->getId());
}


if ($addressModel === null) {
    $addressModel = $this->addressFactory->create();
    $addressModel->updateData($address);
    $addressModel->setCustomer($customerModel);
} else {
    $addressModel->updateData($address);
}


$inputException = $this->_validate($addressModel);
if ($inputException->wasErrorAdded()) {
    throw $inputException;
}
$addressModel->save();
// Clean up the customer registry since the Address save has a
// side effect on customer : \Magento\Customer\Model\ResourceModel\Address::_afterSave
$this->customerRegistry->remove($address->getCustomerId());

magento/magento2/blob/ab051bf/app/code/Magento/Customer/Model/ResourceModel/CustomerRepository.php#L312-L321


/**
 * {@inheritdoc}
 */
public function deleteById($customerId)
{
    $customerModel = $this->customerRegistry->retrieve($customerId);
    $customerModel->delete();
    $this->customerRegistry->remove($customerId);
    return true;
}

dmitry_fedyuk · April 5, 2016, 1:58am