Inheritance diagram for User:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\User\Helper\Data $userData, \Magento\Backend\App\ConfigInterface $config, \Magento\Framework\Validator\DataObjectFactory $validatorObjectFactory, \Magento\Authorization\Model\RoleFactory $roleFactory, \Magento\Framework\Mail\Template\TransportBuilder $transportBuilder, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Store\Model\StoreManagerInterface $storeManager, UserValidationRules $validationRules, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], Json $serializer=null, DeploymentConfig $deploymentConfig=null, ?NotificatorInterface $notificator=null)

	__sleep ()

	__wakeup ()

	beforeSave ()

	afterSave ()

	saveExtra ($data)

	getRoles ()

	getRole ()

	deleteFromRole ()

	roleUserExists ()

	sendPasswordResetConfirmationEmail ()

	sendPasswordResetNotificationEmail ()

	sendNotificationEmailsIfRequired ()

	getName ($separator=' ')

	getAclRole ()

	authenticate ($username, $password)

	verifyIdentity ($password)

	login ($username, $password)

	reload ()

	loadByUsername ($username)

	hasAssigned2Role ($user)

	changeResetPasswordLinkToken ($newToken)

	isResetPasswordLinkTokenExpired ()

	hasAvailableResources ()

	setHasAvailableResources ($hasResources)

	getFirstName ()

	setFirstName ($firstName)

	getLastName ()

	setLastName ($lastName)

	getEmail ()

	setEmail ($email)

	getUserName ()

	setUserName ($userName)

	getPassword ()

	setPassword ($password)

	getCreated ()

	setCreated ($created)

	getModified ()

	setModified ($modified)

	getIsActive ()

	setIsActive ($isActive)

	getInterfaceLocale ()

	setInterfaceLocale ($interfaceLocale)

	performIdentityCheck ($passwordString)

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)

Public Member Functions inherited from UserInterface
	getId ()

	setId ($id)

Data Fields
const	XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template'

const	XML_PATH_FORGOT_EMAIL_IDENTITY = 'admin/emails/forgot_email_identity'

const	XML_PATH_USER_NOTIFICATION_TEMPLATE = 'admin/emails/user_notification_template'

const	XML_PATH_RESET_PASSWORD_TEMPLATE = 'admin/emails/reset_password_template'

const	MESSAGE_ID_PASSWORD_EXPIRED = 'magento_user_password_expired'

Protected Member Functions
	_construct ()

	_willSavePassword ()

	validatePasswordChange ()

	createChangesDescriptionString ()

	sendUserNotificationEmail ($changes, $email=null)

	_getEncodedPassword ($password)

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 = 'admin_user'

	$_role

	$_hasResources = true

	$_userData = null

	$_config

	$_validatorObject

	$_roleFactory

	$_encryptor

	$_transportBuilder

	$_storeManager

	$validationRules

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

Admin user model

@api @method string getLogdate() @method \Magento\User\Model\User setLogdate(string $value) @method int getLognum() @method \Magento\User\Model\User setLognum(int $value) @method int getReloadAclFlag() @method \Magento\User\Model\User setReloadAclFlag(int $value) @method string getExtra() @method \Magento\User\Model\User setExtra(string $value) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.ExcessivePublicCount) @api

Since: 100.0.2

Definition at line 38 of file User.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\User\Helper\Data	$userData,
		\Magento\Backend\App\ConfigInterface	$config,
		\Magento\Framework\Validator\DataObjectFactory	$validatorObjectFactory,
		\Magento\Authorization\Model\RoleFactory	$roleFactory,
		\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		UserValidationRules	$validationRules,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`,
		Json	$serializer = `null`,
		DeploymentConfig	$deploymentConfig = `null`,
		?NotificatorInterface	$notificator = `null`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\User\Helper\Data	$userData
\Magento\Backend\App\ConfigInterface	$config
\Magento\Framework\Validator\DataObjectFactory	$validatorObjectFactory
\Magento\Authorization\Model\RoleFactory	$roleFactory
\Magento\Framework\Mail\Template\TransportBuilder	$transportBuilder
\Magento\Framework\Encryption\EncryptorInterface	$encryptor
\Magento\Store\Model\StoreManagerInterface	$storeManager
UserValidationRules	$validationRules
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data
Json	$serializer
DeploymentConfig \| null	$deploymentConfig
NotificatorInterface \| null	$notificator	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 166 of file User.php.

       {
         $this->_encryptor = $encryptor;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
         $this->_userData = $userData;
         $this->_config = $config;
         $this->_validatorObject = $validatorObjectFactory;
         $this->_roleFactory = $roleFactory;
         $this->_transportBuilder = $transportBuilder;
         $this->_storeManager = $storeManager;
         $this->validationRules = $validationRules;
         $this->serializer = $serializer
             ?: ObjectManager::getInstance()->get(Json::class);
         $this->deploymentConfig = $deploymentConfig
             ?: ObjectManager::getInstance()->get(DeploymentConfig::class);
         $this->notificator = $notificator
             ?: ObjectManager::getInstance()->get(NotificatorInterface::class);
     }

Member Function Documentation

◆ __sleep()

__sleep ( )

Removing dependencies and leaving only entity's properties.

Returns: string[]

Definition at line 216 of file User.php.

     {
         $properties = parent::__sleep();
         return array_diff(
             $properties,
             [
                 '_eventManager',
                 '_userData',
                 '_config',
                 '_validatorObject',
                 '_roleFactory',
                 '_encryptor',
                 '_transportBuilder',
                 '_storeManager',
                 '_validatorBeforeSave',
                 'validationRules',
                 'serializer',
                 'deploymentConfig',
                 'notificator'
             ]
         );
     }

◆ __wakeup()

__wakeup ( )

Restoring required objects after serialization.

Returns: void

Definition at line 244 of file User.php.

     {
         parent::__wakeup();
         $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
         $this->serializer = $objectManager->get(Json::class);
         $this->_eventManager = $objectManager->get(\Magento\Framework\Event\ManagerInterface::class);
         $this->_userData = $objectManager->get(\Magento\User\Helper\Data::class);
         $this->_config = $objectManager->get(\Magento\Backend\App\ConfigInterface::class);
         $this->_registry = $objectManager->get(\Magento\Framework\Registry::class);
         $this->_validatorObject = $objectManager->get(\Magento\Framework\Validator\DataObjectFactory::class);
         $this->_roleFactory = $objectManager->get(\Magento\Authorization\Model\RoleFactory::class);
         $this->_encryptor = $objectManager->get(\Magento\Framework\Encryption\EncryptorInterface::class);
         $this->_transportBuilder = $objectManager->get(\Magento\Framework\Mail\Template\TransportBuilder::class);
         $this->_storeManager = $objectManager->get(\Magento\Store\Model\StoreManagerInterface::class);
         $this->validationRules = $objectManager->get(UserValidationRules::class);
         $this->deploymentConfig = $objectManager->get(DeploymentConfig::class);
         $this->notificator = $objectManager->get(NotificatorInterface::class);
     }

◆ _construct()

_construct ( )

protected

Initialize user model

Returns: void

Definition at line 206 of file User.php.

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

◆ _getEncodedPassword()

_getEncodedPassword ( $password )

protected

Retrieve encoded password

Parameters

string $password

Returns: string

Definition at line 683 of file User.php.

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

◆ _willSavePassword()

_willSavePassword ( )

protected

Whether the password saving is going to occur

Returns: bool

Definition at line 292 of file User.php.

     {
         return $this->isObjectNew() || $this->hasData('password') && $this->dataHasChangedFor('password');
     }

◆ afterSave()

afterSave ( )

Process data after model is saved

Returns: $this

Definition at line 371 of file User.php.

     {
         $this->_role = null;
         return parent::afterSave();
     }

◆ authenticate()

authenticate	(	$username,
		$password
	)

Authenticate user name and password and save loaded record

Parameters

string	$username
string	$password

Returns: bool

Exceptions

Implements StorageInterface.

Definition at line 564 of file User.php.

     {
         $config = $this->_config->isSetFlag('admin/security/use_case_sensitive_login');
         $result = false;
 
         try {
             $this->_eventManager->dispatch(
                 'admin_user_authenticate_before',
                 ['username' => $username, 'user' => $this]
             );
             $this->loadByUsername($username);
             $sensitive = $config ? $username == $this->getUserName() : true;
             if ($sensitive && $this->getId()) {
                 $result = $this->verifyIdentity($password);
             }
 
             $this->_eventManager->dispatch(
                 'admin_user_authenticate_after',
                 ['username' => $username, 'password' => $password, 'user' => $this, 'result' => $result]
             );
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             $this->unsetData();
             throw $e;
         }
 
         if (!$result) {
             $this->unsetData();
         }
         return $result;
     }

◆ beforeSave()

beforeSave ( )

Processing data before model save

Returns: $this

Definition at line 268 of file User.php.

     {
         $data = [
             'extra' => $this->serializer->serialize($this->getExtra()),
         ];
 
         if ($this->_willSavePassword()) {
             $data['password'] = $this->_getEncodedPassword($this->getPassword());
         }
 
         if ($this->getIsActive() !== null) {
             $data['is_active'] = intval($this->getIsActive());
         }
 
         $this->addData($data);
 
         return parent::beforeSave();
     }

◆ changeResetPasswordLinkToken()

changeResetPasswordLinkToken ( $newToken )

Change reset password link token

Stores new reset password link token and its creation time

Parameters

string $newToken

Returns: $this

Exceptions

Definition at line 697 of file User.php.

     {
         if (!is_string($newToken) || empty($newToken)) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 __('The password reset token is incorrect. Verify the token and try again.')
             );
         }
         $this->setRpToken($newToken);
         $this->setRpTokenCreatedAt((new \DateTime())->format(\Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT));
 
         return $this;
     }

◆ createChangesDescriptionString()

createChangesDescriptionString ( )

protected

Create changes description string

Returns: string

Since: 100.1.0

Definition at line 495 of file User.php.

     {
         $changes = [];
 
         if ($this->getEmail() != $this->getOrigData('email') && $this->getOrigData('email')) {
             $changes[] = __('email');
         }
 
         if ($this->getPassword()
             && $this->getOrigData('password')
             && $this->getPassword() != $this->getOrigData('password')) {
             $changes[] = __('password');
         }
 
         if ($this->getUserName() != $this->getOrigData('username') && $this->getOrigData('username')) {
             $changes[] = __('username');
         }
 
         return implode(', ', $changes);
     }

◆ deleteFromRole()

deleteFromRole ( )

Unassign user from his current role

Returns: $this

Definition at line 424 of file User.php.

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

◆ getAclRole()

getAclRole ( )

Get user ACL role

Returns: string

Definition at line 551 of file User.php.

     {
         return $this->getRole()->getId();
     }

◆ getCreated()

getCreated ( )

@inheritDoc

Implements UserInterface.

Definition at line 845 of file User.php.

     {
         return $this->_getData('created');
     }

◆ getEmail()

getEmail ( )

@inheritDoc

Implements UserInterface.

Definition at line 797 of file User.php.

     {
         return $this->_getData('email');
     }

◆ getFirstName()

getFirstName ( )

@inheritDoc

Implements UserInterface.

Definition at line 765 of file User.php.

     {
         return $this->_getData('firstname');
     }

◆ getInterfaceLocale()

getInterfaceLocale ( )

@inheritDoc

Implements UserInterface.

Definition at line 893 of file User.php.

     {
         return $this->_getData('interface_locale');
     }

◆ getIsActive()

getIsActive ( )

@inheritDoc

Implements UserInterface.

Definition at line 877 of file User.php.

     {
         return $this->_getData('is_active');
     }

◆ getLastName()

getLastName ( )

@inheritDoc

Implements UserInterface.

Definition at line 781 of file User.php.

     {
         return $this->_getData('lastname');
     }

◆ getModified()

getModified ( )

@inheritDoc

Implements UserInterface.

Definition at line 861 of file User.php.

     {
         return $this->_getData('modified');
     }

◆ getName()

getName ( $separator = ' ' )

Retrieve user name

Parameters

string $separator

Returns: string

Definition at line 541 of file User.php.

     {
         return $this->getFirstName() . $separator . $this->getLastName();
     }

◆ getPassword()

getPassword ( )

@inheritDoc

Implements UserInterface.

Definition at line 829 of file User.php.

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

◆ getRole()

getRole ( )

Get admin role model

Returns: \Magento\Authorization\Model\Role

Definition at line 407 of file User.php.

     {
         if (null === $this->_role) {
             $this->_role = $this->_roleFactory->create();
             $roles = $this->getRoles();
             if ($roles && isset($roles[0]) && $roles[0]) {
                 $this->_role->load($roles[0]);
             }
         }
         return $this->_role;
     }

◆ getRoles()

getRoles ( )

Retrieve user roles

Returns: array

Definition at line 397 of file User.php.

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

◆ getUserName()

getUserName ( )

@inheritDoc

Implements UserInterface.

Definition at line 813 of file User.php.

     {
         return $this->_getData('username');
     }

◆ hasAssigned2Role()

hasAssigned2Role ( $user )

Check if user is assigned to any role

Parameters

int | \Magento\User\Model\User $user

Returns: null|array

Definition at line 672 of file User.php.

     {
         return $this->getResource()->hasAssigned2Role($user);
     }

◆ hasAvailableResources()

hasAvailableResources ( )

Check if user has available resources

Returns: bool

Implements StorageInterface.

Definition at line 745 of file User.php.

     {
         return $this->_hasResources;
     }

◆ isResetPasswordLinkTokenExpired()

isResetPasswordLinkTokenExpired ( )

Check if current reset password link token is expired

Returns: bool

Definition at line 715 of file User.php.

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

◆ loadByUsername()

loadByUsername ( $username )

Load user by its username

Parameters

string $username

Returns: $this

Definition at line 656 of file User.php.

     {
         $data = $this->getResource()->loadByUsername($username);
         if ($data !== false) {
             $this->setData($data);
             $this->setOrigData();
         }
         return $this;
     }

◆ login()

login	(	$username,
		$password
	)

Login user

Parameters

string	$username
string	$password

Returns: $this

Implements StorageInterface.

Definition at line 629 of file User.php.

     {
         if ($this->authenticate($username, $password)) {
             $this->getResource()->recordLogin($this);
         }
         return $this;
     }

◆ performIdentityCheck()

performIdentityCheck ( $passwordString )

Security check for admin user

Parameters

string $passwordString

Returns: $this

Exceptions

Definition at line 915 of file User.php.

     {
         try {
             $isCheckSuccessful = $this->verifyIdentity($passwordString);
         } catch (\Magento\Framework\Exception\AuthenticationException $e) {
             $isCheckSuccessful = false;
         }
         $this->_eventManager->dispatch(
             'admin_user_authenticate_after',
             [
                 'username' => $this->getUserName(),
                 'password' => $passwordString,
                 'user' => $this,
                 'result' => $isCheckSuccessful
             ]
         );
         // Check if lock information has been updated in observers
         $clonedUser = clone($this);
         $clonedUser->reload();
         if ($clonedUser->getLockExpires()) {
             throw new \Magento\Framework\Exception\State\UserLockedException(
                 __('Your account is temporarily disabled. Please try again later.')
             );
         }
 
         if (!$isCheckSuccessful) {
             throw new \Magento\Framework\Exception\AuthenticationException(
                 __('The password entered for the current user is invalid. Verify the password and try again.')
             );
         }
 
         return $this;
     }

◆ reload()

reload ( )

Reload current user

Returns: $this

Implements StorageInterface.

Definition at line 642 of file User.php.

     {
         $userId = $this->getId();
         $this->setId(null);
         $this->load($userId);
         return $this;
     }

◆ roleUserExists()

roleUserExists ( )

Check if such combination role/user exists.

Returns: bool

Definition at line 435 of file User.php.

     {
         $result = $this->_getResource()->roleUserExists($this);
         return is_array($result) && count($result) > 0 ? true : false;
     }

◆ saveExtra()

saveExtra ( $data )

Save admin user extra data (like configuration sections state)

Parameters

array $data

Returns: $this

Definition at line 383 of file User.php.

     {
         if (is_array($data)) {
             $data = $this->serializer->serialize($data);
         }
         $this->_getResource()->saveExtra($this, $data);
         return $this;
     }

◆ sendNotificationEmailsIfRequired()

sendNotificationEmailsIfRequired ( )

Check changes and send notification emails.

Exceptions

NotificationExceptionInterface

Returns: $this

Since: 100.1.0

Definition at line 476 of file User.php.

     {
         if ($this->isObjectNew()) {
             //Notification about a new user.
             $this->notificator->sendCreated($this);
         } elseif ($changes = $this->createChangesDescriptionString()) {
             //User changed.
             $this->notificator->sendUpdated($this, explode(', ', $changes));
         }
 
         return $this;
     }

◆ sendPasswordResetConfirmationEmail()

sendPasswordResetConfirmationEmail ( )

Send email with reset password confirmation link.

Deprecated:

See also: NotificatorInterface::sendForgotPassword()

Returns: $this

Definition at line 449 of file User.php.

     {
         $this->notificator->sendForgotPassword($this);
 
         return $this;
     }

◆ sendPasswordResetNotificationEmail()

sendPasswordResetNotificationEmail ( )

Send email to when password is resetting

Exceptions

NotificationExceptionInterface

Returns: $this

Deprecated:: 100.1.0

Definition at line 463 of file User.php.

     {
         $this->sendNotificationEmailsIfRequired();
         return $this;
     }

◆ sendUserNotificationEmail()

sendUserNotificationEmail	(	$changes,
		$email = `null`
	)

protected

Send user notification email.

Parameters

string	$changes
string	$email

Exceptions

NotificationExceptionInterface

Returns: $this

Since: 100.1.0

Deprecated:

See also: NotificatorInterface::sendUpdated() @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 528 of file User.php.

     {
         $this->notificator->sendUpdated($this, explode(', ', $changes));
 
         return $this;
     }

◆ setCreated()

setCreated ( $created )

@inheritDoc

Implements UserInterface.

Definition at line 853 of file User.php.

     {
         return $this->setData('created', $created);
     }

◆ setEmail()

setEmail ( $email )

@inheritDoc

Implements UserInterface.

Definition at line 805 of file User.php.

     {
         return $this->setData('email', $email);
     }

◆ setFirstName()

setFirstName ( $firstName )

@inheritDoc

Implements UserInterface.

Definition at line 773 of file User.php.

     {
         return $this->setData('firstname', $firstName);
     }

◆ setHasAvailableResources()

setHasAvailableResources ( $hasResources )

Set user has available resources

Parameters

bool $hasResources

Returns: $this

Implements StorageInterface.

Definition at line 756 of file User.php.

     {
         $this->_hasResources = $hasResources;
         return $this;
     }

◆ setInterfaceLocale()

setInterfaceLocale ( $interfaceLocale )

@inheritDoc

Implements UserInterface.

Definition at line 901 of file User.php.

     {
         return $this->setData('interface_locale', $interfaceLocale);
     }

◆ setIsActive()

setIsActive ( $isActive )

@inheritDoc

Implements UserInterface.

Definition at line 885 of file User.php.

     {
         return $this->setData('is_active', $isActive);
     }

◆ setLastName()

setLastName ( $lastName )

@inheritDoc

Implements UserInterface.

Definition at line 789 of file User.php.

     {
         return $this->setData('lastname', $lastName);
     }

◆ setModified()

setModified ( $modified )

@inheritDoc

Implements UserInterface.

Definition at line 869 of file User.php.

     {
         return $this->setData('modified', $modified);
     }

◆ setPassword()

setPassword ( $password )

@inheritDoc

Implements UserInterface.

Definition at line 837 of file User.php.

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

◆ setUserName()

setUserName ( $userName )

@inheritDoc

Implements UserInterface.

Definition at line 821 of file User.php.

     {
         return $this->setData('username', $userName);
     }

◆ validatePasswordChange()

validatePasswordChange ( )

protected

Make sure admin password was changed.

New password is compared to at least 4 previous passwords to prevent setting them again

Returns: bool|string[]

Since: 100.0.3

Definition at line 346 of file User.php.

     {
         $password = $this->getPassword();
         if ($password && !$this->getForceNewPassword() && $this->getId()) {
             $errorMessage = __('Sorry, but this password has already been used. Please create another.');
             // Check if password is equal to the current one
             if ($this->_encryptor->isValidHash($password, $this->getOrigData('password'))) {
                 return [$errorMessage];
             }
 
             // Check whether password was used before
             foreach ($this->getResource()->getOldPasswords($this) as $oldPasswordHash) {
                 if ($this->_encryptor->isValidHash($password, $oldPasswordHash)) {
                     return [$errorMessage];
                 }
             }
         }
         return true;
     }

◆ verifyIdentity()

verifyIdentity ( $password )

Ensure that provided password matches the current user password. Check if the current user account is active.

Parameters

string $password

Returns: bool

Exceptions

Definition at line 602 of file User.php.

     {
         $result = false;
         if ($this->_encryptor->validateHash($password, $this->getPassword())) {
             if ($this->getIsActive() != '1') {
                 throw new AuthenticationException(
                     __(
                         'The account sign-in was incorrect or your account is disabled temporarily. '
                         . 'Please wait and try again later.'
                     )
                 );
             }
             if (!$this->hasAssigned2Role($this->getId())) {
                 throw new AuthenticationException(__('More permissions are needed to access this.'));
             }
             $result = true;
         }
         return $result;
     }

Field Documentation

◆ $_config

$_config

protected

Definition at line 96 of file User.php.

◆ $_encryptor

$_encryptor

protected

Definition at line 115 of file User.php.

◆ $_eventPrefix

$_eventPrefix = 'admin_user'

protected

Definition at line 68 of file User.php.

◆ $_hasResources

$_hasResources = true

protected

Definition at line 82 of file User.php.

◆ $_role

$_role

protected

Definition at line 75 of file User.php.

◆ $_roleFactory

$_roleFactory

protected

Definition at line 110 of file User.php.

◆ $_storeManager

$_storeManager

protected

Deprecated:

Definition at line 125 of file User.php.

◆ $_transportBuilder

$_transportBuilder

protected

Deprecated:

Definition at line 120 of file User.php.

◆ $_userData

$_userData = null

protected

Definition at line 89 of file User.php.

◆ $_validatorObject

$_validatorObject

protected

Definition at line 103 of file User.php.

◆ $validationRules

$validationRules

protected

Definition at line 130 of file User.php.

◆ MESSAGE_ID_PASSWORD_EXPIRED

const MESSAGE_ID_PASSWORD_EXPIRED = 'magento_user_password_expired'

Definition at line 61 of file User.php.

◆ XML_PATH_FORGOT_EMAIL_IDENTITY

const XML_PATH_FORGOT_EMAIL_IDENTITY = 'admin/emails/forgot_email_identity'

Deprecated:

See also: \Magento\User\Model\Spi\NotificatorInterface

Definition at line 50 of file User.php.

◆ XML_PATH_FORGOT_EMAIL_TEMPLATE

const XML_PATH_FORGOT_EMAIL_TEMPLATE = 'admin/emails/forgot_email_template'

Deprecated:

See also: \Magento\User\Model\Spi\NotificatorInterface

Definition at line 44 of file User.php.

◆ XML_PATH_RESET_PASSWORD_TEMPLATE

const XML_PATH_RESET_PASSWORD_TEMPLATE = 'admin/emails/reset_password_template'

Deprecated:

Definition at line 59 of file User.php.

◆ XML_PATH_USER_NOTIFICATION_TEMPLATE

const XML_PATH_USER_NOTIFICATION_TEMPLATE = 'admin/emails/user_notification_template'

Deprecated:

See also: \Magento\User\Model\Spi\NotificatorInterface

Definition at line 56 of file User.php.

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

vendor/magento/module-user/Model/User.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _construct()

◆ _getEncodedPassword()

◆ _willSavePassword()

◆ afterSave()

◆ authenticate()

◆ beforeSave()

◆ changeResetPasswordLinkToken()

◆ createChangesDescriptionString()

◆ deleteFromRole()

◆ getAclRole()

◆ getCreated()

◆ getEmail()

◆ getFirstName()

◆ getInterfaceLocale()

◆ getIsActive()

◆ getLastName()

◆ getModified()

◆ getName()

◆ getPassword()

◆ getRole()

◆ getRoles()

◆ getUserName()

◆ hasAssigned2Role()

◆ hasAvailableResources()

◆ isResetPasswordLinkTokenExpired()

◆ loadByUsername()

◆ login()

◆ performIdentityCheck()

◆ reload()

◆ roleUserExists()

◆ saveExtra()

◆ sendNotificationEmailsIfRequired()

◆ sendPasswordResetConfirmationEmail()

◆ sendPasswordResetNotificationEmail()

◆ sendUserNotificationEmail()

◆ setCreated()

◆ setEmail()

◆ setFirstName()

◆ setHasAvailableResources()

◆ setInterfaceLocale()

◆ setIsActive()

◆ setLastName()

◆ setModified()

◆ setPassword()

◆ setUserName()

◆ validatePasswordChange()

◆ verifyIdentity()

Field Documentation

◆ $_config

◆ $_encryptor

◆ $_eventPrefix

◆ $_hasResources

◆ $_role

◆ $_roleFactory

◆ $_storeManager

◆ $_transportBuilder

◆ $_userData

◆ $_validatorObject

◆ $validationRules

◆ MESSAGE_ID_PASSWORD_EXPIRED

◆ XML_PATH_FORGOT_EMAIL_IDENTITY

◆ XML_PATH_FORGOT_EMAIL_TEMPLATE

◆ XML_PATH_RESET_PASSWORD_TEMPLATE

◆ XML_PATH_USER_NOTIFICATION_TEMPLATE