Authentication Class Reference

Inheritance diagram for Authentication:

Public Member Functions
	__construct (\Magento\Backend\Model\Auth $auth, \Magento\Backend\Model\UrlInterface $url, \Magento\Framework\App\ResponseInterface $response, \Magento\Framework\App\ActionFlag $actionFlag, \Magento\Framework\Message\ManagerInterface $messageManager, \Magento\Backend\Model\UrlInterface $backendUrl, \Magento\Framework\Controller\Result\RedirectFactory $resultRedirectFactory, \Magento\Backend\App\BackendAppList $backendAppList, \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator)
	aroundDispatch (\Magento\Backend\App\AbstractAction $subject, \Closure $proceed, \Magento\Framework\App\RequestInterface $request)

Protected Member Functions
	_processNotLoggedInUser (\Magento\Framework\App\RequestInterface $request)
	_performLogin (\Magento\Framework\App\RequestInterface $request)
	_redirectIfNeededAfterLogin (\Magento\Framework\App\RequestInterface $request)

Protected Attributes
	$_auth
	$_openActions
	$_url
	$_response
	$_actionFlag
	$messageManager
	$backendUrl
	$backendAppList
	$resultRedirectFactory
	$formKeyValidator

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 13 of file Authentication.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Model\Auth	$auth,
		\Magento\Backend\Model\UrlInterface	$url,
		\Magento\Framework\App\ResponseInterface	$response,
		\Magento\Framework\App\ActionFlag	$actionFlag,
		\Magento\Framework\Message\ManagerInterface	$messageManager,
		\Magento\Backend\Model\UrlInterface	$backendUrl,
		\Magento\Framework\Controller\Result\RedirectFactory	$resultRedirectFactory,
		\Magento\Backend\App\BackendAppList	$backendAppList,
		\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator
	)

Parameters

\Magento\Backend\Model\Auth	$auth
\Magento\Backend\Model\UrlInterface	$url
\Magento\Framework\App\ResponseInterface	$response
\Magento\Framework\App\ActionFlag	$actionFlag
\Magento\Framework\Message\ManagerInterface	$messageManager
\Magento\Backend\Model\UrlInterface	$backendUrl
\Magento\Framework\Controller\Result\RedirectFactory	$resultRedirectFactory
\Magento\Backend\App\BackendAppList	$backendAppList
\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator

Definition at line 82 of file Authentication.php.

      {
        $this->_auth = $auth;
        $this->_url = $url;
        $this->_response = $response;
        $this->_actionFlag = $actionFlag;
        $this->messageManager = $messageManager;
        $this->backendUrl = $backendUrl;
        $this->resultRedirectFactory = $resultRedirectFactory;
        $this->backendAppList = $backendAppList;
        $this->formKeyValidator = $formKeyValidator;
    }

Member Function Documentation

_performLogin()

_performLogin ( \Magento\Framework\App\RequestInterface  $request )

protected

Performs login, if user submitted login form

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

bool

Definition at line 196 of file Authentication.php.

    {
        $outputValue = true;
        $postLogin = $request->getPost('login');
        $username = isset($postLogin['username']) ? $postLogin['username'] : '';
        $password = isset($postLogin['password']) ? $postLogin['password'] : '';
        $request->setPostValue('login', null);

        try {
            $this->_auth->login($username, $password);
        } catch (AuthenticationException $e) {
            if (!$request->getParam('messageSent')) {
                $this->messageManager->addErrorMessage($e->getMessage());
                $request->setParam('messageSent', true);
                $outputValue = false;
            }
        }
        return $outputValue;
    }

_processNotLoggedInUser()

_processNotLoggedInUser ( \Magento\Framework\App\RequestInterface  $request )

protected

Process not logged in user data

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

void

Definition at line 152 of file Authentication.php.

    {
        $isRedirectNeeded = false;
        if ($request->getPost('login')) {
            if ($this->formKeyValidator->validate($request)) {
                if ($this->_performLogin($request)) {
                    $isRedirectNeeded = $this->_redirectIfNeededAfterLogin($request);
                }
            } else {
                $this->_actionFlag->set('', \Magento\Framework\App\ActionInterface::FLAG_NO_DISPATCH, true);
                $this->_response->setRedirect($this->_url->getCurrentUrl());
                $this->messageManager->addErrorMessage(__('Invalid Form Key. Please refresh the page.'));
                $isRedirectNeeded = true;
            }
        }
        if (!$isRedirectNeeded && !$request->isForwarded()) {
            if ($request->getParam('isIframe')) {
                $request->setForwarded(true)
                    ->setRouteName('adminhtml')
                    ->setControllerName('auth')
                    ->setActionName('deniedIframe')
                    ->setDispatched(false);
            } elseif ($request->getParam('isAjax')) {
                $request->setForwarded(true)
                    ->setRouteName('adminhtml')
                    ->setControllerName('auth')
                    ->setActionName('deniedJson')
                    ->setDispatched(false);
            } else {
                $request->setForwarded(true)
                    ->setRouteName('adminhtml')
                    ->setControllerName('auth')
                    ->setActionName('login')
                    ->setDispatched(false);
            }
        }
    }

_redirectIfNeededAfterLogin()

_redirectIfNeededAfterLogin ( \Magento\Framework\App\RequestInterface  $request )

protected

Checks, whether Magento requires redirection after successful admin login, and redirects user, if needed

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

bool

Definition at line 222 of file Authentication.php.

    {
        $requestUri = null;

        // Checks, whether secret key is required for admin access or request uri is explicitly set
        if ($this->_url->useSecretKey()) {
            $requestUri = $this->_url->getUrl('*/*/*', ['_current' => true]);
        } elseif ($request) {
            $requestUri = $request->getRequestUri();
        }

        if (!$requestUri) {
            return false;
        }

        $this->_response->setRedirect($requestUri);
        $this->_actionFlag->set('', \Magento\Framework\App\ActionInterface::FLAG_NO_DISPATCH, true);
        return true;
    }

aroundDispatch()

aroundDispatch	(	\Magento\Backend\App\AbstractAction	$subject,
		\Closure	$proceed,
		\Magento\Framework\App\RequestInterface	$request
	)

Parameters

\Magento\Backend\App\AbstractAction	$subject
\Closure	$proceed
\Magento\Framework\App\RequestInterface	$request

Returns

mixed @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 112 of file Authentication.php.

      {
        $requestedActionName = $request->getActionName();
        if (in_array($requestedActionName, $this->_openActions)) {
            $request->setDispatched(true);
        } else {
            if ($this->_auth->getUser()) {
                $this->_auth->getUser()->reload();
            }
            if (!$this->_auth->isLoggedIn()) {
                $this->_processNotLoggedInUser($request);
            } else {
                $this->_auth->getAuthStorage()->prolong();

                $backendApp = null;
                if ($request->getParam('app')) {
                    $backendApp = $this->backendAppList->getCurrentApp();
                }

                if ($backendApp) {
                    $resultRedirect = $this->resultRedirectFactory->create();
                    $baseUrl = \Magento\Framework\App\Request\Http::getUrlNoScript($this->backendUrl->getBaseUrl());
                    $baseUrl = $baseUrl . $backendApp->getStartupPage();
                    return $resultRedirect->setUrl($baseUrl);
                }
            }
        }
        $this->_auth->getAuthStorage()->refreshAcl();
        return $proceed($request);
    }

Field Documentation

$_actionFlag

$_actionFlag

protected

Definition at line 44 of file Authentication.php.

$_auth

$_auth

protected

Definition at line 18 of file Authentication.php.

$_openActions

$_openActions

protected

Initial value:

= [
        'forgotpassword',
        'resetpassword',
        'resetpasswordpost',
        'logout',
        'refresh', 
    ]

Definition at line 23 of file Authentication.php.

$_response

$_response

protected

Definition at line 39 of file Authentication.php.

$_url

$_url

protected

Definition at line 34 of file Authentication.php.

$backendAppList

$backendAppList

protected

Definition at line 59 of file Authentication.php.

$backendUrl

$backendUrl

protected

Definition at line 54 of file Authentication.php.

$formKeyValidator

$formKeyValidator

protected

Definition at line 69 of file Authentication.php.

$messageManager

$messageManager

protected

Definition at line 49 of file Authentication.php.

$resultRedirectFactory

$resultRedirectFactory

protected

Definition at line 64 of file Authentication.php.

---

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

• vendor/magento/module-backend/App/Action/Plugin/Authentication.php