Inheritance diagram for Customer:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Eav\Model\Config $config, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Customer\Model\ResourceModel\Customer $resource, \Magento\Customer\Model\Config\Share $configShare, \Magento\Customer\Model\AddressFactory $addressFactory, \Magento\Customer\Model\ResourceModel\Address\CollectionFactory $addressesFactory, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, GroupRepositoryInterface $groupRepository, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Framework\Stdlib\DateTime $dateTime, CustomerInterfaceFactory $customerDataFactory, DataObjectProcessor $dataObjectProcessor, \Magento\Framework\Api\DataObjectHelper $dataObjectHelper, \Magento\Customer\Api\CustomerMetadataInterface $metadataService, \Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], AccountConfirmation $accountConfirmation=null)

	_construct ()

	updateData ($customer)

	getSharingConfig ()

	authenticate ($login, $password)

	loadByEmail ($customerEmail)

	changePassword ($newPassword)

	getName ()

	addAddress (Address $address)

	getAddressById ($addressId)

	getAddressItemById ($addressId)

	getAddressCollection ()

	getAddressesCollection ()

	getAddresses ()

	getAttributes ()

	getAttribute ($attributeCode)

	setPassword ($password)

	hashPassword ($password, $salt=true)

	validatePassword ($password)

	encryptPassword ($password)

	decryptPassword ($password)

	getPrimaryAddress ($attributeCode)

	getPrimaryBillingAddress ()

	getDefaultBillingAddress ()

	getPrimaryShippingAddress ()

	getDefaultShippingAddress ()

	getPrimaryAddressIds ()

	getPrimaryAddresses ()

	getAdditionalAddresses ()

	isAddressPrimary (Address $address)

	sendNewAccountEmail ($type='registered', $backUrl='', $storeId='0')

	isConfirmationRequired ()

	getRandomConfirmationKey ()

	sendPasswordReminderEmail ()

	sendPasswordResetConfirmationEmail ()

	getGroupId ()

	getTaxClassId ()

	getStore ()

	getSharedStoreIds ()

	getSharedWebsiteIds ()

	setStore (\Magento\Store\Model\Store $store)

	validate ()

	unsetSubscription ()

	cleanAllAddresses ()

	addError ($error)

	getErrors ()

	resetErrors ()

	beforeDelete ()

	afterSave ()

	afterDeleteCommit ()

	getCreatedAtTimestamp ()

	reset ()

	isDeleteable ()

	setIsDeleteable ($value)

	isReadonly ()

	setIsReadonly ($value)

	__clone ()

	getEntityType ()

	changeResetPasswordLinkToken ($passwordLinkToken)

	isResetPasswordLinkTokenExpired ()

	getResetPasswordLinkExpirationPeriod ()

	isCustomerLocked ()

	getPasswordConfirm ()

	getPassword ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	XML_PATH_REGISTER_EMAIL_TEMPLATE = 'customer/create_account/email_template'

const	XML_PATH_REGISTER_EMAIL_IDENTITY = 'customer/create_account/email_identity'

const	XML_PATH_REMIND_EMAIL_TEMPLATE = 'customer/password/remind_email_template'

const	XML_PATH_FORGOT_EMAIL_TEMPLATE = 'customer/password/forgot_email_template'

const	XML_PATH_FORGOT_EMAIL_IDENTITY = 'customer/password/forgot_email_identity'

const	XML_PATH_RESET_PASSWORD_TEMPLATE = 'customer/password/reset_password_template'

const	XML_PATH_IS_CONFIRM = 'customer/create_account/confirm'

const	XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'customer/create_account/email_confirmation_template'

const	XML_PATH_CONFIRMED_EMAIL_TEMPLATE = 'customer/create_account/email_confirmed_template'

const	XML_PATH_GENERATE_HUMAN_FRIENDLY_ID = 'customer/create_account/generate_human_friendly_id'

const	SUBSCRIBED_YES = 'yes'

const	SUBSCRIBED_NO = 'no'

const	ENTITY = 'customer'

const	CUSTOMER_GRID_INDEXER_ID = 'customer_grid'

const	XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD = 'customer/password/reset_link_expiration_period'

Protected Member Functions
	canSkipConfirmation ()

	_getWebsiteStoreId ($defaultStoreId=null)

	_createAddressInstance ()

	_createAddressCollection ()

	getTemplateTypes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'customer'

	$_eventObject = 'customer'

	$_errors = []

	$_attributes

	$_addressesCollection

	$_isDeleteable = true

	$_isReadonly = false

	$_storeManager

	$_config

	$_scopeConfig

	$_configShare

	$_addressFactory

	$_addressesFactory

	$_transportBuilder

	$_groupRepository

	$_encryptor

	$mathRandom

	$dateTime

	$customerDataFactory

	$dataObjectProcessor

	$dataObjectHelper

	$metadataService

	$indexerRegistry

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Customer model

@api @method int getWebsiteId() getWebsiteId() @method Customer setWebsiteId($value) @method int getStoreId() getStoreId() @method string getEmail() getEmail() @method mixed getDisableAutoGroupChange() @method Customer setDisableAutoGroupChange($value) @method Customer setGroupId($value) @method Customer setDefaultBilling($value) @method Customer setDefaultShipping($value) @method Customer setPasswordHash($string) @method string getPasswordHash() @method string getConfirmation() @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 46 of file Customer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Eav\Model\Config	$config,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Customer\Model\ResourceModel\Customer	$resource,
		\Magento\Customer\Model\Config\Share	$configShare,
		\Magento\Customer\Model\AddressFactory	$addressFactory,
		\Magento\Customer\Model\ResourceModel\Address\CollectionFactory	$addressesFactory,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		GroupRepositoryInterface	$groupRepository,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		CustomerInterfaceFactory	$customerDataFactory,
		DataObjectProcessor	$dataObjectProcessor,
		\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper,
		\Magento\Customer\Api\CustomerMetadataInterface	$metadataService,
		\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		AccountConfirmation	$accountConfirmation = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Eav\Model\Config	$config
ScopeConfigInterface	$scopeConfig
ResourceCustomer	$resource
Share	$configShare
AddressFactory	$addressFactory
CollectionFactory	$addressesFactory
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
GroupRepositoryInterface	$groupRepository
\Magento\Framework\Encryption\EncryptorInterface	$encryptor
\Magento\Framework\Stdlib\DateTime	$dateTime
CustomerInterfaceFactory	$customerDataFactory
DataObjectProcessor	$dataObjectProcessor
\Magento\Framework\Api\DataObjectHelper	$dataObjectHelper
CustomerMetadataInterface	$metadataService
\Magento\Framework\Indexer\IndexerRegistry	$indexerRegistry
\Magento\Framework\Data\Collection\AbstractDb \| null	$resourceCollection
array	$data
AccountConfirmation \| null	$accountConfirmation	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 247 of file Customer.php.

       {
         $this->metadataService = $metadataService;
         $this->_scopeConfig = $scopeConfig;
         $this->_storeManager = $storeManager;
         $this->_config = $config;
         $this->_configShare = $configShare;
         $this->_addressFactory = $addressFactory;
         $this->_addressesFactory = $addressesFactory;
         $this->_transportBuilder = $transportBuilder;
         $this->_groupRepository = $groupRepository;
         $this->_encryptor = $encryptor;
         $this->dateTime = $dateTime;
         $this->customerDataFactory = $customerDataFactory;
         $this->dataObjectProcessor = $dataObjectProcessor;
         $this->dataObjectHelper = $dataObjectHelper;
         $this->indexerRegistry = $indexerRegistry;
         $this->accountConfirmation = $accountConfirmation ?: ObjectManager::getInstance()
             ->get(AccountConfirmation::class);
         parent::__construct(
             $context,
             $registry,
             $resource,
             $resourceCollection,
             $data
         );
     }

Member Function Documentation

◆ __clone()

__clone ( )

Clone current object

Returns: void

Definition at line 1193 of file Customer.php.

     {
         $newAddressCollection = $this->getPrimaryAddresses();
         $newAddressCollection = array_merge($newAddressCollection, $this->getAdditionalAddresses());
         $this->setId(null);
         $this->cleanAllAddresses();
         foreach ($newAddressCollection as $address) {
             $this->addAddress(clone $address);
         }
     }

◆ _construct()

_construct ( )

Initialize customer model

Returns: void

Definition at line 301 of file Customer.php.

     {
         $this->_init(\Magento\Customer\Model\ResourceModel\Customer::class);
     }

◆ _createAddressCollection()

_createAddressCollection ( )

protected

Returns: \Magento\Customer\Model\ResourceModel\Address\Collection

Definition at line 1305 of file Customer.php.

     {
         return $this->_addressesFactory->create();
     }

◆ _createAddressInstance()

_createAddressInstance ( )

protected

Returns: Address

Definition at line 1297 of file Customer.php.

     {
         return $this->_addressFactory->create();
     }

◆ _getWebsiteStoreId()

_getWebsiteStoreId ( $defaultStoreId = null )

protected

Get either first store ID from a set website or the provided as default

Parameters

int | string | null $defaultStoreId

Returns: int

Definition at line 1221 of file Customer.php.

     {
         if ($this->getWebsiteId() != 0 && empty($defaultStoreId)) {
             $storeIds = $this->_storeManager->getWebsite($this->getWebsiteId())->getStoreIds();
             reset($storeIds);
             $defaultStoreId = current($storeIds);
         }
         return $defaultStoreId;
     }

◆ addAddress()

addAddress ( Address $address )

Add address to address collection

Parameters

Address $address

Returns: $this

Definition at line 465 of file Customer.php.

     {
         $this->getAddressesCollection()->addItem($address);
         return $this;
     }

◆ addError()

addError ( $error )

Add error

Parameters

mixed $error

Returns: $this

Definition at line 1017 of file Customer.php.

     {
         $this->_errors[] = $error;
         return $this;
     }

◆ afterDeleteCommit()

afterDeleteCommit ( )

Init indexing process after customer delete

Returns: \Magento\Framework\Model\AbstractModel

Definition at line 1074 of file Customer.php.

     {
         $this->reindex();
         return parent::afterDeleteCommit();
     }

◆ afterSave()

afterSave ( )

Processing object after save data

Returns: $this

Definition at line 1060 of file Customer.php.

     {
         $indexer = $this->indexerRegistry->get(self::CUSTOMER_GRID_INDEXER_ID);
         if ($indexer->getState()->getStatus() == StateInterface::STATUS_VALID) {
             $this->_getResource()->addCommitCallback([$this, 'reindex']);
         }
         return parent::afterSave();
     }

◆ authenticate()

authenticate	(	$login,
		$password
	)

Authenticate customer

Parameters

string	$login
string	$password

Returns: bool

Exceptions

Definition at line 391 of file Customer.php.

     {
         $this->loadByEmail($login);
         if ($this->getConfirmation() && $this->isConfirmationRequired()) {
             throw new EmailNotConfirmedException(
                 __("This account isn't confirmed. Verify and try again.")
             );
         }
         if (!$this->validatePassword($password)) {
             throw new InvalidEmailOrPasswordException(
                 __('Invalid login or password.')
             );
         }
         $this->_eventManager->dispatch(
             'customer_customer_authenticated',
             ['model' => $this, 'password' => $password]
         );
 
         return true;
     }

◆ beforeDelete()

beforeDelete ( )

Prepare customer for delete

Returns: $this

Definition at line 1049 of file Customer.php.

     {
         //TODO : Revisit and figure handling permissions in MAGETWO-11084 Implementation: Service Context Provider
         return parent::beforeDelete();
     }

◆ canSkipConfirmation()

canSkipConfirmation ( )

protected

Check whether confirmation may be skipped when registering using certain email address

Returns: bool

Deprecated:: 101.0.4

See also: AccountConfirmation::isConfirmationRequired

Definition at line 1171 of file Customer.php.

     {
         if (!$this->getId()) {
             return false;
         }
 
         /* If an email was used to start the registration process and it is the same email as the one
            used to register, then this can skip confirmation.
            */
         $skipConfirmationIfEmail = $this->_registry->registry("skip_confirmation_if_email");
         if (!$skipConfirmationIfEmail) {
             return false;
         }
 
         return strtolower($skipConfirmationIfEmail) === strtolower($this->getEmail());
     }

◆ changePassword()

changePassword ( $newPassword )

Change customer password

Parameters

string $newPassword

Returns: $this

Definition at line 430 of file Customer.php.

     {
         $this->_getResource()->changePassword($this, $newPassword);
         return $this;
     }

◆ changeResetPasswordLinkToken()

changeResetPasswordLinkToken ( $passwordLinkToken )

Change reset password link token

Stores new reset password link token

Parameters

string $passwordLinkToken

Returns: $this

Exceptions

Definition at line 1240 of file Customer.php.

     {
         if (!is_string($passwordLinkToken) || empty($passwordLinkToken)) {
             throw new AuthenticationException(
                 __('A valid password reset token is missing. Enter and try again.')
             );
         }
         $this->_getResource()->changeResetPasswordLinkToken($this, $passwordLinkToken);
         return $this;
     }

◆ cleanAllAddresses()

cleanAllAddresses ( )

Clean all addresses

Returns: void

Definition at line 1006 of file Customer.php.

     {
         $this->_addressesCollection = null;
     }

◆ decryptPassword()

decryptPassword ( $password )

Decrypt password

Parameters

string $password

Returns: string

Definition at line 619 of file Customer.php.

     {
         return $this->_encryptor->decrypt($password);
     }

◆ encryptPassword()

encryptPassword ( $password )

Encrypt password

Parameters

string $password

Returns: string

Definition at line 608 of file Customer.php.

     {
         return $this->_encryptor->encrypt($password);
     }

◆ getAdditionalAddresses()

getAdditionalAddresses ( )

Retrieve not default addresses

Returns: Address[]

Definition at line 725 of file Customer.php.

     {
         $addresses = [];
         $primatyIds = $this->getPrimaryAddressIds();
         foreach ($this->getAddressesCollection() as $address) {
             if (!in_array($address->getId(), $primatyIds)) {
                 $addresses[] = $address;
             }
         }
         return $addresses;
     }

◆ getAddressById()

getAddressById ( $addressId )

Retrieve customer address by address id

Parameters

int $addressId

Returns: Address

Definition at line 477 of file Customer.php.

     {
         return $this->_createAddressInstance()->load($addressId);
     }

◆ getAddressCollection()

getAddressCollection ( )

Retrieve not loaded address collection

Returns: \Magento\Customer\Model\ResourceModel\Address\Collection

Definition at line 498 of file Customer.php.

     {
         return $this->_createAddressCollection();
     }

◆ getAddresses()

getAddresses ( )

Retrieve customer address array

Returns: \Magento\Framework\DataObject[]

Definition at line 529 of file Customer.php.

     {
         return $this->getAddressesCollection()->getItems();
     }

◆ getAddressesCollection()

getAddressesCollection ( )

Customer addresses collection

Returns: \Magento\Customer\Model\ResourceModel\Address\Collection

Definition at line 508 of file Customer.php.

     {
         if ($this->_addressesCollection === null) {
             $this->_addressesCollection = $this->getAddressCollection()->setCustomerFilter(
                 $this
             )->addAttributeToSelect(
                 '*'
             );
             foreach ($this->_addressesCollection as $address) {
                 $address->setCustomer($this);
             }
         }
 
         return $this->_addressesCollection;
     }

◆ getAddressItemById()

getAddressItemById ( $addressId )

Getting customer address object from collection by identifier

Parameters

int $addressId

Returns: Address

Definition at line 488 of file Customer.php.

     {
         return $this->getAddressesCollection()->getItemById($addressId);
     }

◆ getAttribute()

getAttribute ( $attributeCode )

Get customer attribute model object

Parameters

string $attributeCode

Returns: \Magento\Customer\Model\ResourceModel\Attribute | null

Definition at line 553 of file Customer.php.

     {
         $this->getAttributes();
         if (isset($this->_attributes[$attributeCode])) {
             return $this->_attributes[$attributeCode];
         }
         return null;
     }

◆ getAttributes()

getAttributes ( )

Retrieve all customer attributes

Returns: Attribute[]

Definition at line 539 of file Customer.php.

     {
         if ($this->_attributes === null) {
             $this->_attributes = $this->_getResource()->loadAllAttributes($this)->getSortedAttributes();
         }
         return $this->_attributes;
     }

◆ getCreatedAtTimestamp()

getCreatedAtTimestamp ( )

Get customer created at date timestamp

Returns: int|null

Definition at line 1097 of file Customer.php.

     {
         $date = $this->getCreatedAt();
         if ($date) {
             return (new \DateTime($date))->getTimestamp();
         }
         return null;
     }

◆ getDefaultBillingAddress()

getDefaultBillingAddress ( )

Get customer default billing address

Returns: Address

Definition at line 652 of file Customer.php.

     {
         return $this->getPrimaryBillingAddress();
     }

◆ getDefaultShippingAddress()

getDefaultShippingAddress ( )

Get default customer shipping address

Returns: Address

Definition at line 672 of file Customer.php.

     {
         return $this->getPrimaryShippingAddress();
     }

◆ getEntityType()

getEntityType ( )

Return Entity Type instance

Returns: \Magento\Eav\Model\Entity\Type

Definition at line 1209 of file Customer.php.

     {
         return $this->_getResource()->getEntityType();
     }

◆ getErrors()

getErrors ( )

Retrieve errors

Returns: array

Definition at line 1028 of file Customer.php.

     {
         return $this->_errors;
     }

◆ getGroupId()

getGroupId ( )

Retrieve customer group identifier

Returns: int

Definition at line 881 of file Customer.php.

     {
         if (!$this->hasData('group_id')) {
             $storeId = $this->getStoreId() ? $this->getStoreId() : $this->_storeManager->getStore()->getId();
             $groupId = $this->_scopeConfig->getValue(
                 GroupManagement::XML_PATH_DEFAULT_ID,
                 ScopeInterface::SCOPE_STORE,
                 $storeId
             );
             $this->setData('group_id', $groupId);
         }
         return $this->getData('group_id');
     }

◆ getName()

getName ( )

Get full customer name

Returns: string

Definition at line 441 of file Customer.php.

     {
         $name = '';
 
         if ($this->_config->getAttribute('customer', 'prefix')->getIsVisible() && $this->getPrefix()) {
             $name .= $this->getPrefix() . ' ';
         }
         $name .= $this->getFirstname();
         if ($this->_config->getAttribute('customer', 'middlename')->getIsVisible() && $this->getMiddlename()) {
             $name .= ' ' . $this->getMiddlename();
         }
         $name .= ' ' . $this->getLastname();
         if ($this->_config->getAttribute('customer', 'suffix')->getIsVisible() && $this->getSuffix()) {
             $name .= ' ' . $this->getSuffix();
         }
         return $name;
     }

◆ getPassword()

getPassword ( )

Return Password

Returns: string

Since: 100.1.0

Definition at line 1362 of file Customer.php.

     {
         return (string) $this->getData('password');
     }

◆ getPasswordConfirm()

getPasswordConfirm ( )

Return Password Confirmation

Returns: string

Since: 100.1.0

Definition at line 1351 of file Customer.php.

     {
         return (string) $this->getData('password_confirm');
     }

◆ getPrimaryAddress()

getPrimaryAddress ( $attributeCode )

Retrieve default address by type(attribute)

Parameters

string $attributeCode address type attribute code

Returns: Address|false

Definition at line 630 of file Customer.php.

     {
         $primaryAddress = $this->getAddressesCollection()->getItemById($this->getData($attributeCode));
 
         return $primaryAddress ? $primaryAddress : false;
     }

◆ getPrimaryAddresses()

getPrimaryAddresses ( )

Retrieve all customer default addresses

Returns: Address[]

Definition at line 699 of file Customer.php.

     {
         $addresses = [];
         $primaryBilling = $this->getPrimaryBillingAddress();
         if ($primaryBilling) {
             $addresses[] = $primaryBilling;
             $primaryBilling->setIsPrimaryBilling(true);
         }
 
         $primaryShipping = $this->getPrimaryShippingAddress();
         if ($primaryShipping) {
             if ($primaryBilling && $primaryBilling->getId() == $primaryShipping->getId()) {
                 $primaryBilling->setIsPrimaryShipping(true);
             } else {
                 $primaryShipping->setIsPrimaryShipping(true);
                 $addresses[] = $primaryShipping;
             }
         }
         return $addresses;
     }

◆ getPrimaryAddressIds()

getPrimaryAddressIds ( )

Retrieve ids of default addresses

Returns: array

Definition at line 682 of file Customer.php.

     {
         $ids = [];
         if ($this->getDefaultBilling()) {
             $ids[] = $this->getDefaultBilling();
         }
         if ($this->getDefaultShipping()) {
             $ids[] = $this->getDefaultShipping();
         }
         return $ids;
     }

◆ getPrimaryBillingAddress()

getPrimaryBillingAddress ( )

Get customer default billing address

Returns: Address

Definition at line 642 of file Customer.php.

     {
         return $this->getPrimaryAddress('default_billing');
     }

◆ getPrimaryShippingAddress()

getPrimaryShippingAddress ( )

Get default customer shipping address

Returns: Address

Definition at line 662 of file Customer.php.

     {
         return $this->getPrimaryAddress('default_shipping');
     }

◆ getRandomConfirmationKey()

getRandomConfirmationKey ( )

Generate random confirmation key

Returns: string

Definition at line 803 of file Customer.php.

     {
         return md5(uniqid());
     }

◆ getResetPasswordLinkExpirationPeriod()

getResetPasswordLinkExpirationPeriod ( )

Retrieve customer reset password link expiration period in days

Returns: int

Definition at line 1286 of file Customer.php.

     {
         return (int)$this->_scopeConfig->getValue(
             self::XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD,
             ScopeConfigInterface::SCOPE_TYPE_DEFAULT
         );
     }

◆ getSharedStoreIds()

getSharedStoreIds ( )

Retrieve shared store ids

Returns: array

Definition at line 924 of file Customer.php.

     {
         $ids = $this->_getData('shared_store_ids');
         if ($ids === null) {
             $ids = [];
             if ((bool)$this->getSharingConfig()->isWebsiteScope()) {
                 $ids = $this->_storeManager->getWebsite($this->getWebsiteId())->getStoreIds();
             } else {
                 foreach ($this->_storeManager->getStores() as $store) {
                     $ids[] = $store->getId();
                 }
             }
             $this->setData('shared_store_ids', $ids);
         }
 
         return $ids;
     }

◆ getSharedWebsiteIds()

getSharedWebsiteIds ( )

Retrieve shared website ids

Returns: int[]

Definition at line 947 of file Customer.php.

     {
         $ids = $this->_getData('shared_website_ids');
         if ($ids === null) {
             $ids = [];
             if ((bool)$this->getSharingConfig()->isWebsiteScope()) {
                 $ids[] = $this->getWebsiteId();
             } else {
                 foreach ($this->_storeManager->getWebsites() as $website) {
                     $ids[] = $website->getId();
                 }
             }
             $this->setData('shared_website_ids', $ids);
         }
         return $ids;
     }

◆ getSharingConfig()

getSharingConfig ( )

Retrieve customer sharing configuration model

Returns: Share

Definition at line 377 of file Customer.php.

     {
         return $this->_configShare;
     }

◆ getStore()

getStore ( )

Retrieve store where customer was created

Returns: \Magento\Store\Model\Store

Definition at line 914 of file Customer.php.

     {
         return $this->_storeManager->getStore($this->getStoreId());
     }

◆ getTaxClassId()

getTaxClassId ( )

Retrieve customer tax class identifier

Returns: int

Definition at line 900 of file Customer.php.

     {
         if (!$this->getData('tax_class_id')) {
             $groupTaxClassId = $this->_groupRepository->getById($this->getGroupId())->getTaxClassId();
             $this->setData('tax_class_id', $groupTaxClassId);
         }
         return $this->getData('tax_class_id');
     }

◆ getTemplateTypes()

getTemplateTypes ( )

protected

Returns: array

'registered' welcome email, when confirmation is disabled 'confirmed' welcome email, when confirmation is enabled 'confirmation' email with confirmation link

Definition at line 1313 of file Customer.php.

     {
         $types = [
             'registered' => self::XML_PATH_REGISTER_EMAIL_TEMPLATE,
             'confirmed' => self::XML_PATH_CONFIRMED_EMAIL_TEMPLATE,
             'confirmation' => self::XML_PATH_CONFIRM_EMAIL_TEMPLATE,
         ];
         return $types;
     }

◆ hashPassword()

hashPassword	(	$password,
		$salt = `true`
	)

Hash customer password

Parameters

string	$password
bool \| int \| string	$salt

Returns: string

Definition at line 582 of file Customer.php.

     {
         return $this->_encryptor->getHash($password, $salt);
     }

◆ isAddressPrimary()

isAddressPrimary ( Address $address )

Check if address is primary

Parameters

Address $address

Returns: boolean

Definition at line 743 of file Customer.php.

     {
         if (!$address->getId()) {
             return false;
         }
         return $address->getId() == $this->getDefaultBilling() || $address->getId() == $this->getDefaultShipping();
     }

◆ isConfirmationRequired()

isConfirmationRequired ( )

Check if accounts confirmation is required in config

Returns: bool

Deprecated:: 101.0.4

See also: AccountConfirmation::isConfirmationRequired

Definition at line 791 of file Customer.php.

     {
         $websiteId = $this->getWebsiteId() ? $this->getWebsiteId() : null;
 
         return $this->accountConfirmation->isConfirmationRequired($websiteId, $this->getId(), $this->getEmail());
     }

◆ isCustomerLocked()

isCustomerLocked ( )

Check if customer is locked

Returns: boolean

Since: 100.1.0

Definition at line 1334 of file Customer.php.

     {
         if ($this->getLockExpires()) {
             $lockExpires = new \DateTime($this->getLockExpires());
             if ($lockExpires > new \DateTime()) {
                 return true;
             }
         }
         return false;
     }

◆ isDeleteable()

isDeleteable ( )

Checks model is deletable

Returns: boolean

Definition at line 1125 of file Customer.php.

     {
         return $this->_isDeleteable;
     }

◆ isReadonly()

isReadonly ( )

Checks model is readonly

Returns: boolean

Definition at line 1147 of file Customer.php.

     {
         return $this->_isReadonly;
     }

◆ isResetPasswordLinkTokenExpired()

isResetPasswordLinkTokenExpired ( )

Check if current reset password link token is expired

Returns: boolean

Definition at line 1256 of file Customer.php.

     {
         $linkToken = $this->getRpToken();
         $linkTokenCreatedAt = $this->getRpTokenCreatedAt();
 
         if (empty($linkToken) || empty($linkTokenCreatedAt)) {
             return true;
         }
 
         $expirationPeriod = $this->getResetPasswordLinkExpirationPeriod();
 
         $currentTimestamp = (new \DateTime())->getTimestamp();
         $tokenTimestamp = (new \DateTime($linkTokenCreatedAt))->getTimestamp();
         if ($tokenTimestamp > $currentTimestamp) {
             return true;
         }
 
         $dayDifference = floor(($currentTimestamp - $tokenTimestamp) / (24 * 60 * 60));
         if ($dayDifference >= $expirationPeriod) {
             return true;
         }
 
         return false;
     }

◆ loadByEmail()

loadByEmail ( $customerEmail )

Load customer by email

Parameters

string $customerEmail

Returns: $this

Definition at line 418 of file Customer.php.

     {
         $this->_getResource()->loadByEmail($this, $customerEmail);
         return $this;
     }

◆ reset()

reset ( )

Reset all model data

Returns: $this

Definition at line 1111 of file Customer.php.

     {
         $this->setData([]);
         $this->setOrigData();
         $this->_attributes = null;
 
         return $this;
     }

◆ resetErrors()

resetErrors ( )

Reset errors array

Returns: $this

Definition at line 1038 of file Customer.php.

     {
         $this->_errors = [];
         return $this;
     }

◆ sendNewAccountEmail()

sendNewAccountEmail	(	$type = `'registered'`,
		$backUrl = `''`,
		$storeId = `'0'`
	)

Send email with new account related information

Parameters

string	$type
string	$backUrl
string	$storeId

Returns: $this

Exceptions

Definition at line 760 of file Customer.php.

     {
         $types = $this->getTemplateTypes();
 
         if (!isset($types[$type])) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('The transactional account email type is incorrect. Verify and try again.')
             );
         }
 
         if (!$storeId) {
             $storeId = $this->_getWebsiteStoreId($this->getSendemailStoreId());
         }
 
         $this->_sendEmailTemplate(
             $types[$type],
             self::XML_PATH_REGISTER_EMAIL_IDENTITY,
             ['customer' => $this, 'back_url' => $backUrl, 'store' => $this->getStore()],
             $storeId
         );
 
         return $this;
     }

◆ sendPasswordReminderEmail()

sendPasswordReminderEmail ( )

Send email with new customer password

Returns: $this

Definition at line 813 of file Customer.php.

     {
         $this->_sendEmailTemplate(
             self::XML_PATH_REMIND_EMAIL_TEMPLATE,
             self::XML_PATH_FORGOT_EMAIL_IDENTITY,
             ['customer' => $this, 'store' => $this->getStore()],
             $this->getStoreId()
         );
 
         return $this;
     }

◆ sendPasswordResetConfirmationEmail()

sendPasswordResetConfirmationEmail ( )

Send email with reset password confirmation link

Returns: $this

Definition at line 859 of file Customer.php.

     {
         $storeId = $this->getStoreId();
         if (!$storeId) {
             $storeId = $this->_getWebsiteStoreId();
         }
 
         $this->_sendEmailTemplate(
             self::XML_PATH_FORGOT_EMAIL_TEMPLATE,
             self::XML_PATH_FORGOT_EMAIL_IDENTITY,
             ['customer' => $this, 'store' => $this->getStore()],
             $storeId
         );
 
         return $this;
     }

◆ setIsDeleteable()

setIsDeleteable ( $value )

Set is deletable flag

Parameters

boolean $value

Returns: $this

Definition at line 1136 of file Customer.php.

     {
         $this->_isDeleteable = (bool)$value;
         return $this;
     }

◆ setIsReadonly()

setIsReadonly ( $value )

Set is readonly flag

Parameters

boolean $value

Returns: $this

Definition at line 1158 of file Customer.php.

     {
         $this->_isReadonly = (bool)$value;
         return $this;
     }

◆ setPassword()

setPassword ( $password )

Set plain and hashed password

Parameters

string $password

Returns: $this

Definition at line 568 of file Customer.php.

     {
         $this->setData('password', $password);
         $this->setPasswordHash($this->hashPassword($password));
         return $this;
     }

◆ setStore()

setStore ( \Magento\Store\Model\Store $store )

Set store to customer

Parameters

\Magento\Store\Model\Store $store

Returns: $this

Definition at line 970 of file Customer.php.

     {
         $this->setStoreId($store->getId());
         $this->setWebsiteId($store->getWebsite()->getId());
         return $this;
     }

◆ unsetSubscription()

unsetSubscription ( )

Unset subscription

Returns: $this

Definition at line 993 of file Customer.php.

     {
         if (isset($this->_isSubscribed)) {
             unset($this->_isSubscribed);
         }
         return $this;
     }

◆ updateData()

updateData ( $customer )

Update customer data

Parameters

\Magento\Customer\Api\Data\CustomerInterface $customer

Returns: $this

Definition at line 336 of file Customer.php.

     {
         $customerDataAttributes = $this->dataObjectProcessor->buildOutputDataArray(
             $customer,
             \Magento\Customer\Api\Data\CustomerInterface::class
         );
 
         foreach ($customerDataAttributes as $attributeCode => $attributeData) {
             if ($attributeCode == 'password') {
                 continue;
             }
             $this->setDataUsingMethod($attributeCode, $attributeData);
         }
 
         $customAttributes = $customer->getCustomAttributes();
         if ($customAttributes !== null) {
             foreach ($customAttributes as $attribute) {
                 $this->setData($attribute->getAttributeCode(), $attribute->getValue());
             }
         }
 
         $customerId = $customer->getId();
         if ($customerId) {
             $this->setId($customerId);
         }
 
         // Need to use attribute set or future updates can cause data loss
         if (!$this->getAttributeSetId()) {
             $this->setAttributeSetId(
                 CustomerMetadataInterface::ATTRIBUTE_SET_ID_CUSTOMER
             );
         }
 
         return $this;
     }

◆ validate()

validate ( )

Validate customer attribute values.

Deprecated:: 100.1.0

Returns: bool

Definition at line 983 of file Customer.php.

     {
         return true;
     }

◆ validatePassword()

validatePassword ( $password )

Validate password with salted hash

Parameters

string $password

Returns: boolean

Definition at line 593 of file Customer.php.

     {
         $hash = $this->getPasswordHash();
         if (!$hash) {
             return false;
         }
         return $this->_encryptor->validateHash($password, $hash);
     }

Field Documentation

◆ $_addressesCollection

$_addressesCollection

protected

Definition at line 121 of file Customer.php.

◆ $_addressesFactory

$_addressesFactory

protected

Definition at line 165 of file Customer.php.

◆ $_addressFactory

$_addressFactory

protected

Definition at line 160 of file Customer.php.

◆ $_attributes

$_attributes

protected

Definition at line 114 of file Customer.php.

◆ $_config

$_config

protected

Definition at line 145 of file Customer.php.

◆ $_configShare

$_configShare

protected

Definition at line 155 of file Customer.php.

◆ $_encryptor

$_encryptor

protected

Definition at line 180 of file Customer.php.

◆ $_errors

$_errors = []

protected

Definition at line 107 of file Customer.php.

◆ $_eventObject

$_eventObject = 'customer'

protected

Definition at line 100 of file Customer.php.

◆ $_eventPrefix

$_eventPrefix = 'customer'

protected

Definition at line 93 of file Customer.php.

◆ $_groupRepository

$_groupRepository

protected

Definition at line 175 of file Customer.php.

◆ $_isDeleteable

$_isDeleteable = true

protected

Definition at line 128 of file Customer.php.

◆ $_isReadonly

$_isReadonly = false

protected

Definition at line 135 of file Customer.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 150 of file Customer.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 140 of file Customer.php.

◆ $_transportBuilder

$_transportBuilder

protected

Definition at line 170 of file Customer.php.

◆ $customerDataFactory

$customerDataFactory

protected

Definition at line 195 of file Customer.php.

◆ $dataObjectHelper

$dataObjectHelper

protected

Definition at line 205 of file Customer.php.

◆ $dataObjectProcessor

$dataObjectProcessor

protected

Definition at line 200 of file Customer.php.

◆ $dateTime

$dateTime

protected

Definition at line 190 of file Customer.php.

◆ $indexerRegistry

$indexerRegistry

protected

Definition at line 215 of file Customer.php.

◆ $mathRandom

$mathRandom

protected

Definition at line 185 of file Customer.php.

◆ $metadataService

$metadataService

protected

Definition at line 210 of file Customer.php.

◆ CUSTOMER_GRID_INDEXER_ID

const CUSTOMER_GRID_INDEXER_ID = 'customer_grid'

Definition at line 81 of file Customer.php.

◆ ENTITY

const ENTITY = 'customer'

Definition at line 79 of file Customer.php.

◆ SUBSCRIBED_NO

const SUBSCRIBED_NO = 'no'

Definition at line 77 of file Customer.php.

◆ SUBSCRIBED_YES

const SUBSCRIBED_YES = 'yes'

Definition at line 75 of file Customer.php.

◆ XML_PATH_CONFIRM_EMAIL_TEMPLATE

const XML_PATH_CONFIRM_EMAIL_TEMPLATE = 'customer/create_account/email_confirmation_template'

Definition at line 69 of file Customer.php.

◆ XML_PATH_CONFIRMED_EMAIL_TEMPLATE

const XML_PATH_CONFIRMED_EMAIL_TEMPLATE = 'customer/create_account/email_confirmed_template'

Definition at line 71 of file Customer.php.

◆ XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD

const XML_PATH_CUSTOMER_RESET_PASSWORD_LINK_EXPIRATION_PERIOD = 'customer/password/reset_link_expiration_period'

Configuration path to expiration period of reset password link

Definition at line 86 of file Customer.php.

◆ XML_PATH_FORGOT_EMAIL_IDENTITY

const XML_PATH_FORGOT_EMAIL_IDENTITY = 'customer/password/forgot_email_identity'

Definition at line 59 of file Customer.php.

◆ XML_PATH_FORGOT_EMAIL_TEMPLATE

const XML_PATH_FORGOT_EMAIL_TEMPLATE = 'customer/password/forgot_email_template'

Definition at line 57 of file Customer.php.

◆ XML_PATH_GENERATE_HUMAN_FRIENDLY_ID

const XML_PATH_GENERATE_HUMAN_FRIENDLY_ID = 'customer/create_account/generate_human_friendly_id'

Definition at line 73 of file Customer.php.

◆ XML_PATH_IS_CONFIRM

const XML_PATH_IS_CONFIRM = 'customer/create_account/confirm'

Deprecated:

See also: AccountConfirmation::XML_PATH_IS_CONFIRM

Definition at line 67 of file Customer.php.

◆ XML_PATH_REGISTER_EMAIL_IDENTITY

const XML_PATH_REGISTER_EMAIL_IDENTITY = 'customer/create_account/email_identity'

Definition at line 53 of file Customer.php.

◆ XML_PATH_REGISTER_EMAIL_TEMPLATE

const XML_PATH_REGISTER_EMAIL_TEMPLATE = 'customer/create_account/email_template'

Configuration paths for email templates and identities

Definition at line 51 of file Customer.php.

◆ XML_PATH_REMIND_EMAIL_TEMPLATE

const XML_PATH_REMIND_EMAIL_TEMPLATE = 'customer/password/remind_email_template'

Definition at line 55 of file Customer.php.

◆ XML_PATH_RESET_PASSWORD_TEMPLATE

const XML_PATH_RESET_PASSWORD_TEMPLATE = 'customer/password/reset_password_template'

Definition at line 61 of file Customer.php.

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

vendor/magento/module-customer/Model/Customer.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ _construct()

◆ _createAddressCollection()

◆ _createAddressInstance()

◆ _getWebsiteStoreId()

◆ addAddress()

◆ addError()

◆ afterDeleteCommit()

◆ afterSave()

◆ authenticate()

◆ beforeDelete()

◆ canSkipConfirmation()

◆ changePassword()

◆ changeResetPasswordLinkToken()

◆ cleanAllAddresses()

◆ decryptPassword()

◆ encryptPassword()

◆ getAdditionalAddresses()

◆ getAddressById()

◆ getAddressCollection()

◆ getAddresses()

◆ getAddressesCollection()

◆ getAddressItemById()

◆ getAttribute()

◆ getAttributes()

◆ getCreatedAtTimestamp()

◆ getDefaultBillingAddress()

◆ getDefaultShippingAddress()

◆ getEntityType()

◆ getErrors()

◆ getGroupId()

◆ getName()

◆ getPassword()

◆ getPasswordConfirm()

◆ getPrimaryAddress()

◆ getPrimaryAddresses()

◆ getPrimaryAddressIds()

◆ getPrimaryBillingAddress()

◆ getPrimaryShippingAddress()

◆ getRandomConfirmationKey()

◆ getResetPasswordLinkExpirationPeriod()

◆ getSharedStoreIds()

◆ getSharedWebsiteIds()

◆ getSharingConfig()

◆ getStore()

◆ getTaxClassId()

◆ getTemplateTypes()

◆ hashPassword()

◆ isAddressPrimary()

◆ isConfirmationRequired()

◆ isCustomerLocked()

◆ isDeleteable()

◆ isReadonly()

◆ isResetPasswordLinkTokenExpired()

◆ loadByEmail()

◆ reset()

◆ resetErrors()

◆ sendNewAccountEmail()

◆ sendPasswordReminderEmail()

◆ sendPasswordResetConfirmationEmail()

◆ setIsDeleteable()

◆ setIsReadonly()

◆ setPassword()

◆ setStore()

◆ unsetSubscription()

◆ updateData()

◆ validate()

◆ validatePassword()

Field Documentation

◆ $_addressesCollection

◆ $_addressesFactory