Url Class Reference

Public Member Functions
	__construct (Session $customerSession, ScopeConfigInterface $scopeConfig, RequestInterface $request, UrlInterface $urlBuilder, EncoderInterface $urlEncoder, \Magento\Framework\Url\DecoderInterface $urlDecoder=null, \Magento\Framework\Url\HostChecker $hostChecker=null)
	getLoginUrl ()
	getLoginUrlParams ()
	getLoginPostUrl ()
	getLogoutUrl ()
	getDashboardUrl ()
	getAccountUrl ()
	getRegisterUrl ()
	getRegisterPostUrl ()
	getEditUrl ()
	getEditPostUrl ()
	getForgotPasswordUrl ()
	getEmailConfirmationUrl ($email=null)

Data Fields
const	ROUTE_ACCOUNT_LOGIN = 'customer/account/login'
const	XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD = 'customer/startup/redirect_dashboard'
const	REFERER_QUERY_PARAM_NAME = 'referer'

Protected Attributes
	$urlBuilder
	$request
	$scopeConfig
	$customerSession
	$urlEncoder

Detailed Description

Customer url model

Definition at line 17 of file Url.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Session	$customerSession,
		ScopeConfigInterface	$scopeConfig,
		RequestInterface	$request,
		UrlInterface	$urlBuilder,
		EncoderInterface	$urlEncoder,
		\Magento\Framework\Url\DecoderInterface	$urlDecoder = null,
		\Magento\Framework\Url\HostChecker	$hostChecker = null
	)

Parameters

Session	$customerSession
ScopeConfigInterface	$scopeConfig
RequestInterface	$request
UrlInterface	$urlBuilder
EncoderInterface	$urlEncoder
\Magento\Framework\Url\DecoderInterface | null	$urlDecoder
\Magento\Framework\Url\HostChecker | null	$hostChecker

Definition at line 78 of file Url.php.

      {
        $this->request = $request;
        $this->urlBuilder = $urlBuilder;
        $this->scopeConfig = $scopeConfig;
        $this->customerSession = $customerSession;
        $this->urlEncoder = $urlEncoder;
        $this->urlDecoder = $urlDecoder ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Url\DecoderInterface::class);
        $this->hostChecker = $hostChecker ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(\Magento\Framework\Url\HostChecker::class);
    }

Member Function Documentation

getAccountUrl()

getAccountUrl

(

)

Retrieve customer account page url

Returns

string

Definition at line 177 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account');
    }

getDashboardUrl()

getDashboardUrl

(

)

Retrieve customer dashboard url

Returns

string

Definition at line 167 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account');
    }

getEditPostUrl()

getEditPostUrl

(

)

Retrieve customer edit POST URL

Returns

string

Definition at line 217 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/editpost');
    }

getEditUrl()

getEditUrl

(

)

Retrieve customer account edit form url

Returns

string

Definition at line 207 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/edit');
    }

getEmailConfirmationUrl()

getEmailConfirmationUrl

(

$email = null

)

Retrieve confirmation URL for Email

Parameters

string

$email

Returns

string

Definition at line 238 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/confirmation', ['_query' => ['email' => $email]]);
    }

getForgotPasswordUrl()

getForgotPasswordUrl

(

)

Retrieve url of forgot password page

Returns

string

Definition at line 227 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/forgotpassword');
    }

getLoginPostUrl()

getLoginPostUrl

(

)

Retrieve customer login POST URL

Returns

string

Definition at line 140 of file Url.php.

    {
        $params = [];
        $referer = $this->getRequestReferrer();
        if ($referer) {
            $params = [
                self::REFERER_QUERY_PARAM_NAME => $referer,
            ];
        }
        return $this->urlBuilder->getUrl('customer/account/loginPost', $params);
    }

getLoginUrl()

getLoginUrl

(

)

Retrieve customer login url

Returns

string

Definition at line 103 of file Url.php.

    {
        return $this->urlBuilder->getUrl(self::ROUTE_ACCOUNT_LOGIN, $this->getLoginUrlParams());
    }

getLoginUrlParams()

getLoginUrlParams

(

)

Retrieve parameters of customer login url

Returns

array

Definition at line 113 of file Url.php.

    {
        $params = [];
        $referer = $this->getRequestReferrer();
        if (!$referer
            && !$this->scopeConfig->isSetFlag(
                self::XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD,
                ScopeInterface::SCOPE_STORE
            )
            && !$this->customerSession->getNoReferer()
        ) {
            $referer = $this->urlBuilder->getUrl('*/*/*', ['_current' => true, '_use_rewrite' => true]);
            $referer = $this->urlEncoder->encode($referer);
        }

        if ($referer) {
            $params = [self::REFERER_QUERY_PARAM_NAME => $referer];
        }

        return $params;
    }

getLogoutUrl()

getLogoutUrl

(

)

Retrieve customer logout url

Returns

string

Definition at line 157 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/logout');
    }

getRegisterPostUrl()

getRegisterPostUrl

(

)

Retrieve customer register form post url

Returns

string

Definition at line 197 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/createpost');
    }

getRegisterUrl()

getRegisterUrl

(

)

Retrieve customer register form url

Returns

string

Definition at line 187 of file Url.php.

    {
        return $this->urlBuilder->getUrl('customer/account/create');
    }

Field Documentation

$customerSession

$customerSession

protected

Definition at line 52 of file Url.php.

$request

$request

protected

Definition at line 42 of file Url.php.

$scopeConfig

$scopeConfig

protected

Definition at line 47 of file Url.php.

$urlBuilder

$urlBuilder

protected

Definition at line 37 of file Url.php.

$urlEncoder

$urlEncoder

protected

Definition at line 57 of file Url.php.

REFERER_QUERY_PARAM_NAME

const REFERER_QUERY_PARAM_NAME = 'referer'

Query param name for last url visited

Definition at line 32 of file Url.php.

ROUTE_ACCOUNT_LOGIN

const ROUTE_ACCOUNT_LOGIN = 'customer/account/login'

Route for customer account login page

Definition at line 22 of file Url.php.

XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD

const XML_PATH_CUSTOMER_STARTUP_REDIRECT_TO_DASHBOARD = 'customer/startup/redirect_dashboard'

Config name for Redirect Customer to Account Dashboard after Logging in setting

Definition at line 27 of file Url.php.

---

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

• vendor/magento/module-customer/Model/Url.php