Redirect Class Reference

Public Member Functions
	__construct (RequestInterface $request, Session $customerSession, ScopeConfigInterface $scopeConfig, StoreManagerInterface $storeManager, UrlInterface $url, DecoderInterface $urlDecoder, CustomerUrl $customerUrl, ResultFactory $resultFactory, HostChecker $hostChecker=null)
	setCookieManager ($value)
	getRedirectCookie ()
	setRedirectCookie ($route)
	clearRedirectCookie ()

Data Fields
const	LOGIN_REDIRECT_URL = 'login_redirect'

Protected Member Functions
	updateLastCustomerId ()
	prepareRedirectUrl ()
	processLoggedCustomer ()
	getCookieManager ()

Protected Attributes
	$request
	$scopeConfig
	$storeManager
	$urlDecoder
	$customerUrl
	$url
	$resultFactory
	$cookieManager

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 26 of file Redirect.php.

Constructor & Destructor Documentation

__construct()

__construct	(	RequestInterface	$request,
		Session	$customerSession,
		ScopeConfigInterface	$scopeConfig,
		StoreManagerInterface	$storeManager,
		UrlInterface	$url,
		DecoderInterface	$urlDecoder,
		CustomerUrl	$customerUrl,
		ResultFactory	$resultFactory,
		HostChecker	$hostChecker = null
	)

Parameters

RequestInterface	$request
Session	$customerSession
ScopeConfigInterface	$scopeConfig
StoreManagerInterface	$storeManager
UrlInterface	$url
DecoderInterface	$urlDecoder
CustomerUrl	$customerUrl
ResultFactory	$resultFactory
HostChecker | null	$hostChecker

Definition at line 93 of file Redirect.php.

      {
        $this->request = $request;
        $this->session = $customerSession;
        $this->scopeConfig = $scopeConfig;
        $this->storeManager = $storeManager;
        $this->url = $url;
        $this->urlDecoder = $urlDecoder;
        $this->customerUrl = $customerUrl;
        $this->resultFactory = $resultFactory;
        $this->hostChecker = $hostChecker ?: ObjectManager::getInstance()->get(HostChecker::class);
    }

Member Function Documentation

clearRedirectCookie()

clearRedirectCookie

(

)

Clear cookie with requested route

Returns

void

Definition at line 290 of file Redirect.php.

    {
        $this->getCookieManager()->deleteCookie(self::LOGIN_REDIRECT_URL);
    }

getCookieManager()

getCookieManager ( )

protected

Get Cookie manager. For release backward compatibility.

Deprecated:

100.0.10

Returns

CookieManagerInterface

Definition at line 244 of file Redirect.php.

    {
        if (!is_object($this->cookieManager)) {
            $this->cookieManager = ObjectManager::getInstance()->get(CookieManagerInterface::class);
        }
        return $this->cookieManager;
    }

getRedirectCookie()

getRedirectCookie

(

)

Get redirect route from cookie for case of successful login/registration

Returns

null|string

Definition at line 269 of file Redirect.php.

    {
        return $this->getCookieManager()->getCookie(self::LOGIN_REDIRECT_URL, null);
    }

prepareRedirectUrl()

prepareRedirectUrl ( )

protected

Prepare redirect URL

Returns

void

Definition at line 161 of file Redirect.php.

    {
        $baseUrl = $this->storeManager->getStore()->getBaseUrl();

        $url = $this->session->getBeforeAuthUrl();
        if (!$url) {
            $url = $baseUrl;
        }

        switch ($url) {
            case $baseUrl:
                if ($this->session->isLoggedIn()) {
                    $this->processLoggedCustomer();
                } else {
                    $this->applyRedirect($this->customerUrl->getLoginUrl());
                }
                break;

            case $this->customerUrl->getLogoutUrl():
                $this->applyRedirect($this->customerUrl->getDashboardUrl());
                break;

            default:
                if (!$this->session->getAfterAuthUrl()) {
                    $this->session->setAfterAuthUrl($this->session->getBeforeAuthUrl());
                }
                if ($this->session->isLoggedIn()) {
                    $this->applyRedirect($this->session->getAfterAuthUrl(true));
                }
                break;
        }
    }

processLoggedCustomer()

processLoggedCustomer ( )

protected

Prepare redirect URL for logged in customer

Redirect customer to the last page visited after logging in.

Returns

void

Definition at line 201 of file Redirect.php.

    {
        // Set default redirect URL for logged in customer
        $this->applyRedirect($this->customerUrl->getAccountUrl());

        if (!$this->scopeConfig->isSetFlag(
            CustomerUrl::XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD,
            ScopeInterface::SCOPE_STORE
        )
        ) {
            $referer = $this->request->getParam(CustomerUrl::REFERER_QUERY_PARAM_NAME);
            if ($referer) {
                $referer = $this->urlDecoder->decode($referer);
                preg_match('/logoutSuccess\//', $referer, $matches, PREG_OFFSET_CAPTURE);
                if (!empty($matches)) {
                    $referer = str_replace('logoutSuccess/', '', $referer);
                }
                if ($this->hostChecker->isOwnOrigin($referer)) {
                    $this->applyRedirect($referer);
                }
            }
        } elseif ($this->session->getAfterAuthUrl()) {
            $this->applyRedirect($this->session->getAfterAuthUrl(true));
        }
    }

setCookieManager()

setCookieManager

(

$value

)

Set cookie manager. For unit tests.

Deprecated:

100.0.10

Parameters

object

$value

Returns

void

Definition at line 259 of file Redirect.php.

    {
        $this->cookieManager = $value;
    }

setRedirectCookie()

setRedirectCookie

(

$route

)

Save redirect route to cookie for case of successful login/registration

Parameters

string

$route

Returns

void

Definition at line 280 of file Redirect.php.

    {
        $this->getCookieManager()->setPublicCookie(self::LOGIN_REDIRECT_URL, $route);
    }

updateLastCustomerId()

updateLastCustomerId ( )

protected

Update last customer id, if required

Returns

void

Definition at line 144 of file Redirect.php.

    {
        $lastCustomerId = $this->session->getLastCustomerId();
        if (isset($lastCustomerId)
            && $this->session->isLoggedIn()
            && $lastCustomerId != $this->session->getId()
        ) {
            $this->session->unsBeforeAuthUrl()
                ->setLastCustomerId($this->session->getId());
        }
    }

Field Documentation

$cookieManager

$cookieManager

protected

Definition at line 70 of file Redirect.php.

$customerUrl

$customerUrl

protected

Definition at line 54 of file Redirect.php.

$request

$request

protected

Definition at line 34 of file Redirect.php.

$resultFactory

$resultFactory

protected

Definition at line 65 of file Redirect.php.

$scopeConfig

$scopeConfig

protected

Definition at line 39 of file Redirect.php.

$storeManager

$storeManager

protected

Definition at line 44 of file Redirect.php.

$url

$url

protected

Definition at line 60 of file Redirect.php.

$urlDecoder

$urlDecoder

protected

Definition at line 49 of file Redirect.php.

LOGIN_REDIRECT_URL

const LOGIN_REDIRECT_URL = 'login_redirect'

URL to redirect user on successful login or registration

Definition at line 29 of file Redirect.php.

---

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

• vendor/magento/module-customer/Model/Account/Redirect.php