Inheritance diagram for Customer:

Public Member Functions
	__construct (\Magento\Eav\Model\Entity\Context $context, \Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot $entitySnapshot, \Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite $entityRelationComposite, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Validator\Factory $validatorFactory, \Magento\Framework\Stdlib\DateTime $dateTime, \Magento\Store\Model\StoreManagerInterface $storeManager, $data=[])

	loadByEmail (\Magento\Customer\Model\Customer $customer, $email)

	changePassword (\Magento\Customer\Model\Customer $customer, $newPassword)

	findEmailDuplicates ()

	checkCustomerId ($customerId)

	getWebsiteId ($customerId)

	setNewIncrementId (\Magento\Framework\DataObject $object)

	changeResetPasswordLinkToken (\Magento\Customer\Model\Customer $customer, $passwordLinkToken)

Public Member Functions inherited from AbstractEntity
	__construct (\Magento\Eav\Model\Entity\Context $context, \Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot $entitySnapshot, \Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite $entityRelationComposite, $data=[])

	save (\Magento\Framework\Model\AbstractModel $object)

Public Member Functions inherited from AbstractEntity
	__construct (Context $context, $data=[])

	setConnection ($connection)

	getConnection ()

	getIdFieldName ()

	getTable ($alias)

	setType ($type)

	getEntityType ()

	getType ()

	getTypeId ()

	unsetAttributes ($attributes=null)

	addAttribute (AbstractAttribute $attribute, $object=null)

	isPartialLoad ($flag=null)

	isPartialSave ($flag=null)

	loadAllAttributes ($object=null)

	getSortedAttributes ($setId=null)

	attributesCompare ($firstAttribute, $secondAttribute)

	getAttributesByCode ()

	getAttributesByTable ()

	getEntityTable ()

	getLinkField ()

	getEntityIdField ()

	getValueEntityIdField ()

	getValueTablePrefix ()

	getEntityTablePrefix ()

	isAttributeStatic ($attribute)

	validate ($object)

	setNewIncrementId (DataObject $object)

	checkAttributeUniqueValue (AbstractAttribute $attribute, $object)

	getDefaultAttributeSourceModel ()

	load ($object, $entityId, $attributes=[])

	save (\Magento\Framework\Model\AbstractModel $object)

	saveAttribute (DataObject $object, $attributeCode)

	delete ($object)

	getDefaultAttributes ()

	afterLoad (DataObject $object)

	beforeSave (DataObject $object)

	afterSave (DataObject $object)

	beforeDelete (DataObject $object)

	afterDelete (DataObject $object)

Public Member Functions inherited from AbstractResource
	__construct ()

	getConnection ()

	beginTransaction ()

	addCommitCallback ($callback)

	commit ()

	rollBack ()

	getValidationRulesBeforeSave ()

Protected Member Functions
	_getDefaultAttributes ()

	_validate ($customer)

	_afterSave (\Magento\Framework\DataObject $customer)

	_getLoadRowSelect ($object, $rowId)

Protected Member Functions inherited from AbstractEntity
	_afterLoad (\Magento\Framework\DataObject $object)

	isModified (\Magento\Framework\Model\AbstractModel $object)

Protected Member Functions inherited from AbstractEntity
	_construct ()

	_getConfig ()

	_isApplicableAttribute ($object, $attribute)

	_isCallableAttributeInstance ($instance, $method, $args)

	loadAttributesMetadata ($attributes)

	_loadModelAttributes ($object)

	_prepareLoadSelect (array $selects)

	_getLoadRowSelect ($object, $rowId)

	_getLoadAttributesSelect ($object, $table)

	_setAttributeValue ($object, $valueRow)

	processSave ($object)

	_getOrigObject ($object)

	_collectSaveData ($newObject)

	_canUpdateAttribute (AbstractAttribute $attribute, $v, array &$origData)

	_getStaticFieldProperties ($field)

	_prepareStaticValue ($key, $value)

	_insertAttribute ($object, $attribute, $value)

	_updateAttribute ($object, $attribute, $valueId, $value)

	_saveAttribute ($object, $attribute, $value)

	_processAttributeValues ()

	_prepareValueForSave ($value, AbstractAttribute $attribute)

	_deleteAttributes ($object, $table, $info)

	getAttributeRow ($entity, $object, $attribute)

	evaluateDelete ($object, $id, $connection)

	_afterLoad (DataObject $object)

	_beforeSave (DataObject $object)

	_afterSave (DataObject $object)

	_beforeDelete (DataObject $object)

	_afterDelete (DataObject $object)

	_getDefaultAttributeModel ()

	_getDefaultAttributes ()

	_isAttributeValueEmpty (AbstractAttribute $attribute, $value)

	getAttributeLoader ()

	loadAttributesForObject ($attributes, $object=null)

Protected Member Functions inherited from AbstractResource
	_construct ()

	_serializeField (DataObject $object, $field, $defaultValue=null, $unsetEmpty=false)

	_unserializeField (DataObject $object, $field, $defaultValue=null)

	_prepareDataForTable (DataObject $object, $table)

	_prepareTableValueForSave ($value, $type)

	_getColumnsForEntityLoad (\Magento\Framework\Model\AbstractModel $object, $tableName)

	getSerializer ()

Protected Attributes
	$_validatorFactory

	$_scopeConfig

	$dateTime

	$storeManager

Protected Attributes inherited from AbstractEntity
	$entitySnapshot

	$entityRelationComposite

Protected Attributes inherited from AbstractEntity
	$attributeLoader

	$connectionName

	$_type

	$_attributesByCode = []

	$_attributesByTable = []

	$_staticAttributes = []

	$_entityTable

	$_describeTable = []

	$_entityIdField

	$linkIdField

	$_valueEntityIdField

	$_valueTablePrefix

	$_entityTablePrefix

	$_isPartialLoad = false

	$_isPartialSave = false

	$_sortingSetId = null

	$_attributeValuesToDelete = []

	$_attributeValuesToSave = []

	$_resource

	$_eavConfig

	$_attrSetEntity

	$_localeFormat

	$_resourceHelper

	$_universalFactory

	$transactionManager

	$objectRelationProcessor

Protected Attributes inherited from AbstractResource
	$serializer

	$_logger

Additional Inherited Members
Static Protected Attributes inherited from AbstractEntity
static	$_attributeBackendTables = []

Detailed Description

Customer entity resource model

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 21 of file Customer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Eav\Model\Entity\Context	$context,
		\Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot	$entitySnapshot,
		\Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite	$entityRelationComposite,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Validator\Factory	$validatorFactory,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
			$data = `[]`
	)

Parameters

\Magento\Eav\Model\Entity\Context	$context
\Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot	$entitySnapshot
\Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite	$entityRelationComposite
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Validator\Factory	$validatorFactory
\Magento\Framework\Stdlib\DateTime	$dateTime
\Magento\Store\Model\StoreManagerInterface	$storeManager
array	$data

Definition at line 60 of file Customer.php.

       {
         parent::__construct($context, $entitySnapshot, $entityRelationComposite, $data);
         $this->_scopeConfig = $scopeConfig;
         $this->_validatorFactory = $validatorFactory;
         $this->dateTime = $dateTime;
         $this->storeManager = $storeManager;
         $this->setType('customer');
         $this->setConnection('customer_read', 'customer_write');
     }

Member Function Documentation

◆ _afterSave()

_afterSave ( \Magento\Framework\DataObject $customer )

protected

Save customer addresses and set default addresses in attributes backend

Parameters

\Magento\Framework\DataObject $customer

Returns: $this

Definition at line 198 of file Customer.php.

     {
         $this->getNotificationStorage()->add(
             NotificationStorage::UPDATE_CUSTOMER_SESSION,
             $customer->getId()
         );
         return parent::_afterSave($customer);
     }

◆ _getDefaultAttributes()

_getDefaultAttributes ( )

protected

Retrieve customer entity default attributes

Returns: string[]

Definition at line 84 of file Customer.php.

     {
         return [
             'created_at',
             'updated_at',
             'increment_id',
             'store_id',
             'website_id'
         ];
     }

◆ _getLoadRowSelect()

_getLoadRowSelect	(	$object,
		$rowId
	)

protected

Retrieve select object for loading base entity row

Parameters

\Magento\Framework\DataObject	$object
string \| int	$rowId

Returns: \Magento\Framework\DB\Select

Definition at line 214 of file Customer.php.

     {
         $select = parent::_getLoadRowSelect($object, $rowId);
         if ($object->getWebsiteId() && $object->getSharingConfig()->isWebsiteScope()) {
             $select->where('website_id =?', (int)$object->getWebsiteId());
         }
 
         return $select;
     }

◆ _validate()

_validate ( $customer )

protected

Validate customer entity

Parameters

\Magento\Customer\Model\Customer $customer

Returns: void

Exceptions

Definition at line 166 of file Customer.php.

     {
         $validator = $this->_validatorFactory->createValidator('customer', 'save');
 
         if (!$validator->isValid($customer)) {
             throw new ValidatorException(
                 null,
                 null,
                 $validator->getMessages()
             );
         }
     }

◆ changePassword()

changePassword	(	\Magento\Customer\Model\Customer	$customer,
			$newPassword
	)

Change customer password

Parameters

\Magento\Customer\Model\Customer	$customer
string	$newPassword

Returns: $this

Definition at line 270 of file Customer.php.

     {
         $customer->setPassword($newPassword);
         return $this;
     }

◆ changeResetPasswordLinkToken()

changeResetPasswordLinkToken	(	\Magento\Customer\Model\Customer	$customer,
			$passwordLinkToken
	)

Change reset password link token

Stores new reset password link token and its creation time

Parameters

\Magento\Customer\Model\Customer	$customer
string	$passwordLinkToken

Returns: $this

Definition at line 374 of file Customer.php.

     {
         if (is_string($passwordLinkToken) && !empty($passwordLinkToken)) {
             $customer->setRpToken($passwordLinkToken);
             $customer->setRpTokenCreatedAt(
                 (new \DateTime())->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT)
             );
         }
         return $this;
     }

◆ checkCustomerId()

checkCustomerId ( $customerId )

Check customer by id

Parameters

int $customerId

Returns: bool

Definition at line 307 of file Customer.php.

     {
         $connection = $this->getConnection();
         $bind = ['entity_id' => (int)$customerId];
         $select = $connection->select()->from(
             $this->getTable('customer_entity'),
             'entity_id'
         )->where(
             'entity_id = :entity_id'
         )->limit(
             1
         );
 
         $result = $connection->fetchOne($select, $bind);
         if ($result) {
             return true;
         }
         return false;
     }

◆ findEmailDuplicates()

findEmailDuplicates ( )

Check whether there are email duplicates of customers in global scope

Returns: bool

Definition at line 281 of file Customer.php.

     {
         $connection = $this->getConnection();
         $select = $connection->select()->from(
             $this->getTable('customer_entity'),
             ['email', 'cnt' => 'COUNT(*)']
         )->group(
             'email'
         )->order(
             'cnt DESC'
         )->limit(
             1
         );
         $lookup = $connection->fetchRow($select);
         if (empty($lookup)) {
             return false;
         }
         return $lookup['cnt'] > 1;
     }

◆ getWebsiteId()

getWebsiteId ( $customerId )

Get customer website id

Parameters

int $customerId

Returns: int

Definition at line 333 of file Customer.php.

     {
         $connection = $this->getConnection();
         $bind = ['entity_id' => (int)$customerId];
         $select = $connection->select()->from(
             $this->getTable('customer_entity'),
             'website_id'
         )->where(
             'entity_id = :entity_id'
         );
 
         return $connection->fetchOne($select, $bind);
     }

◆ loadByEmail()

loadByEmail	(	\Magento\Customer\Model\Customer	$customer,
			$email
	)

Load customer by email

Parameters

\Magento\Customer\Model\Customer	$customer
string	$email

Returns: $this

Exceptions

Definition at line 232 of file Customer.php.

     {
         $connection = $this->getConnection();
         $bind = ['customer_email' => $email];
         $select = $connection->select()->from(
             $this->getEntityTable(),
             [$this->getEntityIdField()]
         )->where(
             'email = :customer_email'
         );
 
         if ($customer->getSharingConfig()->isWebsiteScope()) {
             if (!$customer->hasData('website_id')) {
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __("A customer website ID wasn't specified. The ID must be specified to use the website scope.")
                 );
             }
             $bind['website_id'] = (int)$customer->getWebsiteId();
             $select->where('website_id = :website_id');
         }
 
         $customerId = $connection->fetchOne($select, $bind);
         if ($customerId) {
             $this->load($customer, $customerId);
         } else {
             $customer->setData([]);
         }
 
         return $this;
     }

◆ setNewIncrementId()

setNewIncrementId ( \Magento\Framework\DataObject $object )

Custom setter of increment ID if its needed

Parameters

\Magento\Framework\DataObject $object

Returns: $this

Definition at line 353 of file Customer.php.

     {
         if ($this->_scopeConfig->getValue(
             \Magento\Customer\Model\Customer::XML_PATH_GENERATE_HUMAN_FRIENDLY_ID,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             parent::setNewIncrementId($object);
         }
         return $this;
     }

Field Documentation

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 33 of file Customer.php.

◆ $_validatorFactory

$_validatorFactory

protected

Definition at line 26 of file Customer.php.

◆ $dateTime

$dateTime

protected

Definition at line 38 of file Customer.php.

◆ $storeManager

$storeManager

protected

Definition at line 43 of file Customer.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _afterSave()

◆ _getDefaultAttributes()

◆ _getLoadRowSelect()

◆ _validate()

◆ changePassword()

◆ changeResetPasswordLinkToken()

◆ checkCustomerId()

◆ findEmailDuplicates()

◆ getWebsiteId()

◆ loadByEmail()

◆ setNewIncrementId()

Field Documentation

◆ $_scopeConfig

◆ $_validatorFactory

◆ $dateTime

◆ $storeManager