SidResolver Class Reference

Inheritance diagram for SidResolver:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\UrlInterface $urlBuilder, \Magento\Framework\App\RequestInterface $request, $scopeType, array $sidNameMap=[], State $appState=null)
	getSid (SessionManagerInterface $session)
	getSessionIdQueryParam (SessionManagerInterface $session)
	setUseSessionVar ($var)
	getUseSessionVar ()
	setUseSessionInUrl ($flag=true)
	getUseSessionInUrl ()
Public Member Functions inherited from SidResolverInterface
	getSid (\Magento\Framework\Session\SessionManagerInterface $session)
	getSessionIdQueryParam (\Magento\Framework\Session\SessionManagerInterface $session)

Data Fields
const	XML_PATH_USE_FRONTEND_SID = 'web/session/use_frontend_sid'
Data Fields inherited from SidResolverInterface
const	SESSION_ID_QUERY_PARAM = 'SID'

Protected Attributes
	$scopeConfig
	$urlBuilder
	$request
	$sidNameMap
	$_useSessionVar = false
	$_useSessionInUrl
	$_scopeType

Detailed Description

Definition at line 12 of file SidResolver.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\UrlInterface	$urlBuilder,
		\Magento\Framework\App\RequestInterface	$request,
			$scopeType,
		array	$sidNameMap = [],
		State	$appState = null
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\UrlInterface	$urlBuilder
\Magento\Framework\App\RequestInterface	$request
string	$scopeType
array	$sidNameMap
State | null	$appState

Definition at line 72 of file SidResolver.php.

      {
        $this->scopeConfig = $scopeConfig;
        $this->urlBuilder = $urlBuilder;
        $this->request = $request;
        $this->sidNameMap = $sidNameMap;
        $this->_scopeType = $scopeType;
        $this->appState = $appState ?: \Magento\Framework\App\ObjectManager::getInstance()->get(State::class);
    }

Member Function Documentation

getSessionIdQueryParam()

getSessionIdQueryParam

(

SessionManagerInterface

$session

)

Get session id query param

Parameters

SessionManagerInterface

$session

Returns

string

Definition at line 117 of file SidResolver.php.

    {
        $sessionName = $session->getName();
        if ($sessionName && isset($this->sidNameMap[$sessionName])) {
            return $this->sidNameMap[$sessionName];
        }
        return self::SESSION_ID_QUERY_PARAM;
    }

getSid()

getSid

(

SessionManagerInterface

$session

)

Parameters

SessionManagerInterface

$session

Returns

string|null

Definition at line 92 of file SidResolver.php.

    {
        if ($this->appState->getAreaCode() !== \Magento\Framework\App\Area::AREA_FRONTEND) {
            return null;
        }

        $sidKey = null;

        $useSidOnFrontend = $this->getUseSessionInUrl();
        if ($useSidOnFrontend && $this->request->getQuery(
            $this->getSessionIdQueryParam($session),
            false
        ) && $this->urlBuilder->isOwnOriginUrl()
        ) {
            $sidKey = $this->request->getQuery($this->getSessionIdQueryParam($session));
        }
        return $sidKey;
    }

getUseSessionInUrl()

getUseSessionInUrl

(

)

Retrieve use session in URL flag.

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements SidResolverInterface.

Definition at line 167 of file SidResolver.php.

    {
        if ($this->_useSessionInUrl === null) {
            //Using config value by default, can be overridden by using the
            //setter.
            $this->_useSessionInUrl = (bool)$this->scopeConfig->getValue(
                self::XML_PATH_USE_FRONTEND_SID,
                $this->_scopeType
            );
        }

        return $this->_useSessionInUrl;
    }

getUseSessionVar()

getUseSessionVar

(

)

Retrieve use flag session var instead of SID for URL

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements SidResolverInterface.

Definition at line 144 of file SidResolver.php.

    {
        return $this->_useSessionVar;
    }

setUseSessionInUrl()

setUseSessionInUrl

(

$flag = true

)

Set Use session in URL flag

Parameters

bool

$flag

Returns

$this

Implements SidResolverInterface.

Definition at line 155 of file SidResolver.php.

    {
        $this->_useSessionInUrl = (bool)$flag;
        return $this;
    }

setUseSessionVar()

setUseSessionVar

(

$var

)

Set use session var instead of SID for URL

Parameters

bool

$var

Returns

$this

Implements SidResolverInterface.

Definition at line 132 of file SidResolver.php.

    {
        $this->_useSessionVar = (bool)$var;
        return $this;
    }

Field Documentation

$_scopeType

$_scopeType

protected

Definition at line 57 of file SidResolver.php.

$_useSessionInUrl

$_useSessionInUrl

protected

Definition at line 52 of file SidResolver.php.

$_useSessionVar

$_useSessionVar = false

protected

Definition at line 44 of file SidResolver.php.

$request

$request

protected

Definition at line 32 of file SidResolver.php.

$scopeConfig

$scopeConfig

protected

Definition at line 22 of file SidResolver.php.

$sidNameMap

$sidNameMap

protected

Definition at line 37 of file SidResolver.php.

$urlBuilder

$urlBuilder

protected

Definition at line 27 of file SidResolver.php.

XML_PATH_USE_FRONTEND_SID

const XML_PATH_USE_FRONTEND_SID = 'web/session/use_frontend_sid'

Config path for flag whether use SID on frontend

Definition at line 17 of file SidResolver.php.

---

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

• vendor/magento/framework/Session/SidResolver.php