Auth Class Reference

Public Member Functions
	__construct (\Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Backend\Helper\Data $backendData, \Magento\Backend\Model\Auth\StorageInterface $authStorage, \Magento\Backend\Model\Auth\Credential\StorageInterface $credentialStorage, \Magento\Framework\App\Config\ScopeConfigInterface $coreConfig, \Magento\Framework\Data\Collection\ModelFactory $modelFactory)
	setAuthStorage ($storage)
	getAuthStorage ()
	getUser ()
	getCredentialStorage ()
	login ($username, $password)
	logout ()
	isLoggedIn ()

Static Public Member Functions
static	throwException (Phrase $msg=null)

Protected Member Functions
	_initCredentialStorage ()

Protected Attributes
	$_authStorage
	$_credentialStorage
	$_backendData
	$_eventManager
	$_coreConfig
	$_modelFactory

Detailed Description

Backend Auth model

@api

Since

100.0.2

Definition at line 19 of file Auth.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Backend\Helper\Data	$backendData,
		\Magento\Backend\Model\Auth\StorageInterface	$authStorage,
		\Magento\Backend\Model\Auth\Credential\StorageInterface	$credentialStorage,
		\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig,
		\Magento\Framework\Data\Collection\ModelFactory	$modelFactory
	)

Parameters

\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Backend\Helper\Data	$backendData
\Magento\Backend\Model\Auth\StorageInterface	$authStorage
\Magento\Backend\Model\Auth\Credential\StorageInterface	$credentialStorage
\Magento\Framework\App\Config\ScopeConfigInterface	$coreConfig
\Magento\Framework\Data\Collection\ModelFactory	$modelFactory

Definition at line 63 of file Auth.php.

      {
        $this->_eventManager = $eventManager;
        $this->_backendData = $backendData;
        $this->_authStorage = $authStorage;
        $this->_credentialStorage = $credentialStorage;
        $this->_coreConfig = $coreConfig;
        $this->_modelFactory = $modelFactory;
    }

Member Function Documentation

_initCredentialStorage()

_initCredentialStorage ( )

protected

Initialize credential storage from configuration

Returns

void

Definition at line 123 of file Auth.php.

    {
        $this->_credentialStorage = $this->_modelFactory->create(
            \Magento\Backend\Model\Auth\Credential\StorageInterface::class
        );
    }

getAuthStorage()

getAuthStorage

(

)

Return auth storage. If auth storage was not defined outside - returns default object of auth storage

Returns

\Magento\Backend\Model\Auth\StorageInterface @codeCoverageIgnore

Definition at line 102 of file Auth.php.

    {
        return $this->_authStorage;
    }

getCredentialStorage()

getCredentialStorage

(

)

Return credential storage object

Returns

null|\Magento\Backend\Model\Auth\Credential\StorageInterface @codeCoverageIgnore

Definition at line 136 of file Auth.php.

    {
        return $this->_credentialStorage;
    }

getUser()

getUser

(

)

Return current (successfully authenticated) user, an instance of \Magento\Backend\Model\Auth\Credential\StorageInterface

Returns

\Magento\Backend\Model\Auth\Credential\StorageInterface

Definition at line 113 of file Auth.php.

    {
        return $this->getAuthStorage()->getUser();
    }

isLoggedIn()

isLoggedIn

(

)

Check if current user is logged in

Returns

bool

Definition at line 216 of file Auth.php.

    {
        return $this->getAuthStorage()->isLoggedIn();
    }

login()

login	(		$username,
			$password
	)

Perform login process

Parameters

string	$username
string	$password

Returns

void

Exceptions

Definition at line 149 of file Auth.php.

    {
        if (empty($username) || empty($password)) {
            self::throwException(
                __(
                    'The account sign-in was incorrect or your account is disabled temporarily. '
                    . 'Please wait and try again later.'
                )
            );
        }

        try {
            $this->_initCredentialStorage();
            $this->getCredentialStorage()->login($username, $password);
            if ($this->getCredentialStorage()->getId()) {
                $this->getAuthStorage()->setUser($this->getCredentialStorage());
                $this->getAuthStorage()->processLogin();

                $this->_eventManager->dispatch(
                    'backend_auth_user_login_success',
                    ['user' => $this->getCredentialStorage()]
                );
            }

            if (!$this->getAuthStorage()->getUser()) {
                self::throwException(
                    __(
                        'The account sign-in was incorrect or your account is disabled temporarily. '
                        . 'Please wait and try again later.'
                    )
                );
            }
        } catch (PluginAuthenticationException $e) {
            $this->_eventManager->dispatch(
                'backend_auth_user_login_failed',
                ['user_name' => $username, 'exception' => $e]
            );
            throw $e;
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->_eventManager->dispatch(
                'backend_auth_user_login_failed',
                ['user_name' => $username, 'exception' => $e]
            );
            self::throwException(
                __(
                    $e->getMessage()? : 'The account sign-in was incorrect or your account is disabled temporarily. '
                        . 'Please wait and try again later.'
                )
            );
        }
    }

logout()

logout

(

)

Perform logout process

Returns

void

Definition at line 206 of file Auth.php.

    {
        $this->getAuthStorage()->processLogout();
    }

setAuthStorage()

setAuthStorage

(

$storage

)

Set auth storage if it is instance of \Magento\Backend\Model\Auth\StorageInterface

Parameters

\Magento\Backend\Model\Auth\StorageInterface

$storage

Returns

$this

Exceptions

Definition at line 86 of file Auth.php.

    {
        if (!$storage instanceof \Magento\Backend\Model\Auth\StorageInterface) {
            self::throwException(__('Authentication storage is incorrect.'));
        }
        $this->_authStorage = $storage;
        return $this;
    }

throwException()

static throwException ( Phrase  $msg = null )

static

Throws specific Backend Authentication \Exception

Parameters

\Magento\Framework\Phrase

$msg

Returns

void

Exceptions

Definition at line 229 of file Auth.php.

    {
        if ($msg === null) {
            $msg = __('An authentication error occurred. Verify and try again.');
        }
        throw new AuthenticationException($msg);
    }

Field Documentation

$_authStorage

$_authStorage

protected

Definition at line 24 of file Auth.php.

$_backendData

$_backendData

protected

Definition at line 36 of file Auth.php.

$_coreConfig

$_coreConfig

protected

Definition at line 48 of file Auth.php.

$_credentialStorage

$_credentialStorage

protected

Definition at line 29 of file Auth.php.

$_eventManager

$_eventManager

protected

Definition at line 43 of file Auth.php.

$_modelFactory

$_modelFactory

protected

Definition at line 53 of file Auth.php.

---

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

• vendor/magento/module-backend/Model/Auth.php