AdminSessionsManager Class Reference

Public Member Functions
	__construct (ConfigInterface $securityConfig, \Magento\Backend\Model\Auth\Session $authSession, \Magento\Security\Model\AdminSessionInfoFactory $adminSessionInfoFactory, \Magento\Security\Model\ResourceModel\AdminSessionInfo\CollectionFactory $adminSessionInfoCollectionFactory, \Magento\Framework\Stdlib\DateTime\DateTime $dateTime, RemoteAddress $remoteAddress)
	processLogin ()
	processProlong ()
	processLogout ()
	getCurrentSession ()
	getLogoutReasonMessageByStatus ($statusCode)
	getLogoutReasonMessage ()
	getSessionsForCurrentUser ()
	logoutOtherUserSessions ()
	cleanExpiredSessions ()

Data Fields
const	ADMIN_SESSION_LIFETIME = 86400
const	LOGOUT_REASON_USER_LOCKED = 10

Protected Member Functions
	createNewSession ()
	createAdminSessionInfoCollection ()

Protected Attributes
	$securityConfig
	$authSession
	$adminSessionInfoFactory
	$adminSessionInfoCollectionFactory
	$currentSession

Detailed Description

Admin Sessions Manager Model

@api

Since

100.1.0

Definition at line 18 of file AdminSessionsManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ConfigInterface	$securityConfig,
		\Magento\Backend\Model\Auth\Session	$authSession,
		\Magento\Security\Model\AdminSessionInfoFactory	$adminSessionInfoFactory,
		\Magento\Security\Model\ResourceModel\AdminSessionInfo\CollectionFactory	$adminSessionInfoCollectionFactory,
		\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime,
		RemoteAddress	$remoteAddress
	)

Parameters

ConfigInterface	$securityConfig
\Magento\Backend\Model\Auth\Session	$authSession
AdminSessionInfoFactory	$adminSessionInfoFactory
CollectionFactory	$adminSessionInfoCollectionFactory
\Magento\Framework\Stdlib\DateTime\DateTime	$dateTime
RemoteAddress	$remoteAddress

Definition at line 86 of file AdminSessionsManager.php.

      {
        $this->securityConfig = $securityConfig;
        $this->authSession = $authSession;
        $this->adminSessionInfoFactory = $adminSessionInfoFactory;
        $this->adminSessionInfoCollectionFactory = $adminSessionInfoCollectionFactory;
        $this->dateTime = $dateTime;
        $this->remoteAddress = $remoteAddress;
    }

Member Function Documentation

cleanExpiredSessions()

cleanExpiredSessions

(

)

Clean expired Admin Sessions

Returns

$this

Since

100.1.0

Definition at line 276 of file AdminSessionsManager.php.

    {
        $this->createAdminSessionInfoCollection()->deleteSessionsOlderThen(
            $this->dateTime->gmtTimestamp() - self::ADMIN_SESSION_LIFETIME
        );

        return $this;
    }

createAdminSessionInfoCollection()

createAdminSessionInfoCollection ( )

protected

Returns

\Magento\Security\Model\ResourceModel\AdminSessionInfo\Collection

Since

100.1.0

Definition at line 311 of file AdminSessionsManager.php.

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

createNewSession()

createNewSession ( )

protected

Create new record

Returns

$this

Since

100.1.0

Definition at line 291 of file AdminSessionsManager.php.

    {
        $this->adminSessionInfoFactory
            ->create()
            ->setData(
                [
                    'session_id' => $this->authSession->getSessionId(),
                    'user_id' => $this->authSession->getUser()->getId(),
                    'ip' => $this->remoteAddress->getRemoteAddress(),
                    'status' => AdminSessionInfo::LOGGED_IN
                ]
            )->save();

        return $this;
    }

getCurrentSession()

getCurrentSession

(

)

Get current session record

Returns

AdminSessionInfo

Since

100.1.0

Definition at line 173 of file AdminSessionsManager.php.

    {
        if (!$this->currentSession) {
            $this->currentSession = $this->adminSessionInfoFactory->create();
            $this->currentSession->load($this->authSession->getSessionId(), 'session_id');
        }

        return $this->currentSession;
    }

getLogoutReasonMessage()

getLogoutReasonMessage

(

)

Get message with explanation of logout reason

Returns

string

Since

100.1.0

Definition at line 226 of file AdminSessionsManager.php.

    {
        return $this->getLogoutReasonMessageByStatus(
            $this->getCurrentSession()->getStatus()
        );
    }

getLogoutReasonMessageByStatus()

getLogoutReasonMessageByStatus

(

$statusCode

)

Get logout reason message by status

Parameters

int

$statusCode

Returns

string

Since

100.1.0

Definition at line 190 of file AdminSessionsManager.php.

    {
        switch ((int)$statusCode) {
            case AdminSessionInfo::LOGGED_IN:
                $reasonMessage = null;
                break;
            case AdminSessionInfo::LOGGED_OUT_BY_LOGIN:
                $reasonMessage = __(
                    'Someone logged into this account from another device or browser.'
                    .' Your current session is terminated.'
                );
                break;
            case AdminSessionInfo::LOGGED_OUT_MANUALLY:
                $reasonMessage = __(
                    'Your current session is terminated by another user of this account.'
                );
                break;
            case self::LOGOUT_REASON_USER_LOCKED:
                $reasonMessage = __(
                    'Your account is temporarily disabled. Please try again later.'
                );
                break;
            default:
                $reasonMessage = __('Your current session has been expired.');
                break;
        }

        return $reasonMessage;
    }

getSessionsForCurrentUser()

getSessionsForCurrentUser

(

)

Get sessions for current user

Returns

\Magento\Security\Model\ResourceModel\AdminSessionInfo\Collection

Since

100.1.0

Definition at line 239 of file AdminSessionsManager.php.

    {
        return $this->createAdminSessionInfoCollection()
            ->filterByUser($this->authSession->getUser()->getId(), \Magento\Security\Model\AdminSessionInfo::LOGGED_IN)
            ->filterExpiredSessions($this->securityConfig->getAdminSessionLifetime())
            ->loadData();
    }

logoutOtherUserSessions()

logoutOtherUserSessions

(

)

Logout another user sessions

Returns

$this

Since

100.1.0

Definition at line 253 of file AdminSessionsManager.php.

    {
        $collection = $this->createAdminSessionInfoCollection()
            ->filterByUser(
                $this->authSession->getUser()->getId(),
                \Magento\Security\Model\AdminSessionInfo::LOGGED_IN,
                $this->authSession->getSessionId()
            )
            ->filterExpiredSessions($this->securityConfig->getAdminSessionLifetime())
            ->loadData();

        $collection->setDataToAll('status', \Magento\Security\Model\AdminSessionInfo::LOGGED_OUT_MANUALLY)
            ->save();

        return $this;
    }

processLogin()

processLogin

(

)

Handle all others active sessions according Sharing Account Setting

Returns

$this

Since

100.1.0

Definition at line 108 of file AdminSessionsManager.php.

    {
        $this->createNewSession();

        $olderThen = $this->dateTime->gmtTimestamp() - $this->securityConfig->getAdminSessionLifetime();
        if (!$this->securityConfig->isAdminAccountSharingEnabled()) {
            $result = $this->createAdminSessionInfoCollection()->updateActiveSessionsStatus(
                AdminSessionInfo::LOGGED_OUT_BY_LOGIN,
                $this->getCurrentSession()->getUserId(),
                $this->getCurrentSession()->getSessionId(),
                $olderThen
            );
            if ($result) {
                $this->getCurrentSession()->setIsOtherSessionsTerminated(true);
            }
        }

        return $this;
    }

processLogout()

processLogout

(

)

Handle logout process

Returns

$this

Since

100.1.0

Definition at line 156 of file AdminSessionsManager.php.

    {
        $this->getCurrentSession()->setData(
            'status',
            AdminSessionInfo::LOGGED_OUT
        );
        $this->getCurrentSession()->save();

        return $this;
    }

processProlong()

processProlong

(

)

Handle Prolong process

Returns

$this

Since

100.1.0

Definition at line 134 of file AdminSessionsManager.php.

    {
        if ($this->lastProlongIsOldEnough()) {
            $this->getCurrentSession()->setData(
                'updated_at',
                date(
                    \Magento\Framework\Stdlib\DateTime::DATETIME_PHP_FORMAT,
                    $this->authSession->getUpdatedAt()
                )
            );
            $this->getCurrentSession()->save();
        }

        return $this;
    }

Field Documentation

$adminSessionInfoCollectionFactory

$adminSessionInfoCollectionFactory

protected

Definition at line 52 of file AdminSessionsManager.php.

$adminSessionInfoFactory

$adminSessionInfoFactory

protected

Definition at line 46 of file AdminSessionsManager.php.

$authSession

$authSession

protected

Definition at line 40 of file AdminSessionsManager.php.

$currentSession

$currentSession

protected

Definition at line 58 of file AdminSessionsManager.php.

$securityConfig

$securityConfig

protected

Definition at line 34 of file AdminSessionsManager.php.

ADMIN_SESSION_LIFETIME

const ADMIN_SESSION_LIFETIME = 86400

Admin Session lifetime (sec)

Definition at line 23 of file AdminSessionsManager.php.

LOGOUT_REASON_USER_LOCKED

const LOGOUT_REASON_USER_LOCKED = 10

Logout reason when current user has been locked out

Definition at line 28 of file AdminSessionsManager.php.

---

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

• vendor/magento/module-security/Model/AdminSessionsManager.php