Url Class Reference

Inheritance diagram for Url:

Public Member Functions
	__construct (\Magento\Framework\App\Route\ConfigInterface $routeConfig, \Magento\Framework\App\RequestInterface $request, \Magento\Framework\Url\SecurityInfoInterface $urlSecurityInfo, \Magento\Framework\Url\ScopeResolverInterface $scopeResolver, \Magento\Framework\Session\Generic $session, \Magento\Framework\Session\SidResolverInterface $sidResolver, \Magento\Framework\Url\RouteParamsResolverFactory $routeParamsResolverFactory, \Magento\Framework\Url\QueryParamsResolverInterface $queryParamsResolver, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\Url\RouteParamsPreprocessorInterface $routeParamsPreprocessor, $scopeType, array $data=[], HostChecker $hostChecker=null, Json $serializer=null)
	setUseSession ($useSession)
	getUseSession ()
	getConfigData ($key, $prefix=null)
	setRequest (\Magento\Framework\App\RequestInterface $request)
	setScope ($params)
	getBaseUrl ($params=[])
	getRouteUrl ($routePath=null, $routeParams=null)
	addSessionParam ()
	addQueryParams (array $data)
	setQueryParam ($key, $data)
	getUrl ($routePath=null, $routeParams=null)
	getRebuiltUrl ($url)
	escape ($value)
	getDirectUrl ($url, $params=[])
	sessionUrlVar ($html)
	useSessionIdForUrl ($secure=false)
	isOwnOriginUrl ()
	getRedirectUrl ($url)
	getCurrentUrl ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Member Functions
	_parseUrl ($url)
	_getConfigCacheId ($path)
	_getConfig ($path)
	_getRequest ()
	_getType ()
	_isSecure ()
	_getScope ()
	_setRoutePath ($data)
	_getActionPath ()
	_getRoutePath ($routeParams=[])
	_setRouteName ($data)
	_getRouteFrontName ()
	_getRouteName ($default=null)
	_setControllerName ($data)
	_getControllerName ($default=null)
	_setActionName ($data)
	_getActionName ($default=null)
	_setRouteParams (array $data, $unsetOldParams=true)
	_getRouteParams ()
	_setQuery ($data)
	_getQuery ($escape=false)
	_getFragment ()
	_prepareSessionUrl ($url)
	getRouteParamsResolver ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_reservedRouteParams
	$_scopeType
	$_request
	$_useSession
	$_urlSecurityInfo
	$_session
	$_sidResolver
	$_routeConfig
	$_scopeResolver
	$_queryParamsResolver
	$_scopeConfig
	$routeParamsPreprocessor
Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes
static	$_configDataCache
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Additional Inherited Members
Data Fields inherited from UrlInterface
const	URL_TYPE_LINK = 'link'
const	URL_TYPE_DIRECT_LINK = 'direct_link'
const	URL_TYPE_WEB = 'web'
const	URL_TYPE_MEDIA = 'media'
const	URL_TYPE_STATIC = 'static'
const	URL_TYPE_JS = 'js'
const	DEFAULT_URL_TYPE = 'link'
const	DEFAULT_CONTROLLER_NAME = 'index'
const	DEFAULT_ACTION_NAME = 'index'
const	REWRITE_REQUEST_PATH_ALIAS = 'rewrite_request_path'
const	SESSION_NAMESPACE = 'frontend'

Detailed Description

URL

Properties:

• request
• relative_url: true, false
• type: 'link', 'skin', 'js', 'media'
• scope: instanceof \Magento\Framework\Url\ScopeInterface
• secure: true, false
• scheme: 'http', 'https'
• user: 'user'
• password: 'password'
• host: 'localhost'
• port: 80, 443
• base_path: '/dev/magento/'
• base_script: 'index.php'
• scopeview_path: 'scopeview/'
• route_path: 'module/controller/action/param1/value1/param2/value2'
• route_name: 'module'
• controller_name: 'controller'
• action_name: 'action'
• route_params: array('param1'=>'value1', 'param2'=>'value2')
• query: (?)'param1=value1&param2=value2'
• query_array: array('param1'=>'value1', 'param2'=>'value2')
• fragment: (#)'fragment-anchor'

@codingStandardsIgnoreStart URL structure:

https://user:password@host:443/base_path/[base_script][scopeview_path]route_name/controller_name/action_name/param1/value1?query_param=query_value::fragment __________A___________/____________________________________B_____________________________________/ __________________C___________________/ __________________D_________________/ _____E_____/ _____________F______________/ ___________________________G______________________/ ___________________________________________________H____________________________________________________/ @codingStandardsIgnoreEnd

• A: authority
• B: path
• C: absolute_base_url
• D: action_path
• E: route_params
• F: host_url
• G: route_path
• H: route_url @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

Definition at line 66 of file Url.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Route\ConfigInterface	$routeConfig,
		\Magento\Framework\App\RequestInterface	$request,
		\Magento\Framework\Url\SecurityInfoInterface	$urlSecurityInfo,
		\Magento\Framework\Url\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\Session\Generic	$session,
		\Magento\Framework\Session\SidResolverInterface	$sidResolver,
		\Magento\Framework\Url\RouteParamsResolverFactory	$routeParamsResolverFactory,
		\Magento\Framework\Url\QueryParamsResolverInterface	$queryParamsResolver,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\Url\RouteParamsPreprocessorInterface	$routeParamsPreprocessor,
			$scopeType,
		array	$data = [],
		HostChecker	$hostChecker = null,
		Json	$serializer = null
	)

Parameters

\Magento\Framework\App\Route\ConfigInterface	$routeConfig
\Magento\Framework\App\RequestInterface	$request
\Magento\Framework\Url\SecurityInfoInterface	$urlSecurityInfo
\Magento\Framework\Url\ScopeResolverInterface	$scopeResolver
\Magento\Framework\Session\Generic	$session
\Magento\Framework\Session\SidResolverInterface	$sidResolver
\Magento\Framework\Url\RouteParamsResolverFactory	$routeParamsResolverFactory
\Magento\Framework\Url\QueryParamsResolverInterface	$queryParamsResolver
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\Url\RouteParamsPreprocessorInterface	$routeParamsPreprocessor
string	$scopeType
array	$data
HostChecker | null	$hostChecker
Json | null	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 213 of file Url.php.

      {
        $this->_request = $request;
        $this->_routeConfig = $routeConfig;
        $this->_urlSecurityInfo = $urlSecurityInfo;
        $this->_scopeResolver = $scopeResolver;
        $this->_session = $session;
        $this->_sidResolver = $sidResolver;
        $this->_routeParamsResolverFactory = $routeParamsResolverFactory;
        $this->_queryParamsResolver = $queryParamsResolver;
        $this->_scopeConfig = $scopeConfig;
        $this->routeParamsPreprocessor = $routeParamsPreprocessor;
        $this->_scopeType = $scopeType;
        $this->hostChecker = $hostChecker ?: \Magento\Framework\App\ObjectManager::getInstance()
            ->get(HostChecker::class);
        $this->serializer = $serializer ?: ObjectManager::getInstance()->get(Json::class);
        parent::__construct($data);
    }

Member Function Documentation

_getActionName()

_getActionName (   $default = null )

protected

Retrieve action name

Parameters

mixed

$default

Returns

string|null

Definition at line 701 of file Url.php.

    {
        return $this->_getData('action_name') ? $this->_getData('action_name') : $default;
    }

_getActionPath()

_getActionPath ( )

protected

Retrieve action path

Returns

string

Definition at line 549 of file Url.php.

    {
        if (!$this->_getRouteName()) {
            return '';
        }

        $hasParams = (bool) $this->_getRouteParams();
        $path = $this->_getRouteFrontName() . '/';

        if ($this->_getControllerName()) {
            $path .= $this->_getControllerName() . '/';
        } elseif ($hasParams) {
            $path .= self::DEFAULT_CONTROLLER_NAME . '/';
        }
        if ($this->_getActionName()) {
            $path .= $this->_getActionName() . '/';
        } elseif ($hasParams) {
            $path .= self::DEFAULT_ACTION_NAME . '/';
        }

        return $path;
    }

_getConfig()

_getConfig (   $path )

protected

Get config data by path

Parameters

string

$path

Returns

null|string

Definition at line 340 of file Url.php.

    {
        return $this->_scopeConfig->getValue(
            $path,
            $this->_scopeType,
            $this->_getScope()
        );
    }

_getConfigCacheId()

_getConfigCacheId (   $path )

protected

Get cache id for config path

Parameters

string

$path

Returns

string

Definition at line 329 of file Url.php.

    {
        return $this->_getScope()->getCode() . '/' . $path;
    }

_getControllerName()

_getControllerName (   $default = null )

protected

Retrieve controller name

Parameters

mixed

$default

Returns

string|null

Definition at line 672 of file Url.php.

    {
        return $this->_getData('controller_name') ? $this->_getData('controller_name') : $default;
    }

_getFragment()

_getFragment ( )

protected

Retrieve URL fragment

Returns

string|null

Definition at line 825 of file Url.php.

    {
        return $this->_getData('fragment');
    }

_getQuery()

_getQuery (   $escape = false )

protected

Get query params part of url

Parameters

bool

$escape

"&" escape flag

Returns

string

Definition at line 790 of file Url.php.

    {
        return $this->_queryParamsResolver->getQuery($escape);
    }

_getRequest()

_getRequest ( )

protected

Zend request object

Returns

\Magento\Framework\App\RequestInterface

Definition at line 366 of file Url.php.

    {
        return $this->_request;
    }

_getRouteFrontName()

_getRouteFrontName ( )

protected

Retrieve route front name

Returns

string

Definition at line 625 of file Url.php.

    {
        if (!$this->hasData('route_front_name')) {
            $frontName = $this->_routeConfig->getRouteFrontName(
                $this->_getRouteName(),
                $this->_scopeResolver->getAreaCode()
            );
            $this->setData('route_front_name', $frontName);
        }
        return $this->_getData('route_front_name');
    }

_getRouteName()

_getRouteName (   $default = null )

protected

Retrieve route name

Parameters

mixed

$default

Returns

string|null

Definition at line 643 of file Url.php.

    {
        return $this->_getData('route_name') ? $this->_getData('route_name') : $default;
    }

_getRouteParams()

_getRouteParams ( )

protected

Retrieve route params

Returns

array

Definition at line 724 of file Url.php.

    {
        return $this->getRouteParamsResolver()->getRouteParams();
    }

_getRoutePath()

_getRoutePath (   $routeParams = [] )

protected

Retrieve route path

Parameters

array

$routeParams

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 579 of file Url.php.

    {
        if (!$this->hasData('route_path')) {
            $routePath = $this->_getRequest()->getAlias(self::REWRITE_REQUEST_PATH_ALIAS);
            if (!empty($routeParams['_use_rewrite']) && $routePath !== null) {
                $this->setData('route_path', $routePath);
                return $routePath;
            }
            $routePath = $this->_getActionPath();
            if ($this->_getRouteParams()) {
                foreach ($this->_getRouteParams() as $key => $value) {
                    if ($value === null || false === $value || '' === $value || !is_scalar($value)) {
                        continue;
                    }
                    $routePath .= $key . '/' . $value . '/';
                }
            }
            $this->setData('route_path', $routePath);
        }
        return $this->_getData('route_path');
    }

_getScope()

_getScope ( )

protected

Get current scope for the url instance

Returns

\Magento\Framework\Url\ScopeInterface

Definition at line 439 of file Url.php.

    {
        if (!$this->hasData('scope')) {
            $this->setScope(null);
        }
        return $this->_getData('scope');
    }

_getType()

_getType ( )

protected

Retrieve URL type

Returns

string

Definition at line 376 of file Url.php.

    {
        if (!$this->getRouteParamsResolver()->hasData('type')) {
            $this->getRouteParamsResolver()->setData('type', self::DEFAULT_URL_TYPE);
        }
        return $this->getRouteParamsResolver()->getType();
    }

_isSecure()

_isSecure ( )

protected

Retrieve is secure mode URL

Returns

bool

Definition at line 389 of file Url.php.

    {
        if ($this->_request->isSecure()) {
            if ($this->getRouteParamsResolver()->hasData('secure')) {
                return (bool) $this->getRouteParamsResolver()->getData('secure');
            }
            return true;
        }

        if ($this->getRouteParamsResolver()->hasData('secure_is_forced')) {
            return (bool) $this->getRouteParamsResolver()->getData('secure');
        }

        if (!$this->_getScope()->isUrlSecure()) {
            return false;
        }

        if (!$this->getRouteParamsResolver()->hasData('secure')) {
            if ($this->_getType() == UrlInterface::URL_TYPE_LINK) {
                $pathSecure = $this->_urlSecurityInfo->isSecure('/' . $this->_getActionPath());
                $this->getRouteParamsResolver()->setData('secure', $pathSecure);
            } elseif ($this->_getType() == UrlInterface::URL_TYPE_STATIC) {
                $isRequestSecure = $this->_getRequest()->isSecure();
                $this->getRouteParamsResolver()->setData('secure', $isRequestSecure);
            } else {
                $this->getRouteParamsResolver()->setData('secure', true);
            }
        }

        return $this->getRouteParamsResolver()->getData('secure');
    }

_parseUrl()

_parseUrl (   $url )

protected

Initialize object data from retrieved url

Parameters

string

$url

Returns

\Magento\Framework\UrlInterface

Definition at line 252 of file Url.php.

    {
        $data = parse_url($url);
        $parts = [
            'scheme' => 'setScheme',
            'host' => 'setHost',
            'port' => 'setPort',
            'user' => 'setUser',
            'pass' => 'setPassword',
            'path' => 'setPath',
            'query' => '_setQuery',
            'fragment' => 'setFragment',
        ];

        foreach ($parts as $component => $method) {
            if (isset($data[$component])) {
                $this->{$method}($data[$component]);
            }
        }
        return $this;
    }

_prepareSessionUrl()

_prepareSessionUrl (   $url )

protected

Check and add session id to URL

Parameters

string

$url

Returns

\Magento\Framework\UrlInterface

Definition at line 976 of file Url.php.

    {
        if (!$this->getUseSession()) {
            return $this;
        }
        $sessionId = $this->_session->getSessionIdForHost($url);
        if ($this->_sidResolver->getUseSessionVar() && !$sessionId) {
            $this->setQueryParam('___SID', $this->_isSecure() ? 'S' : 'U');
        } elseif ($sessionId) {
            $this->setQueryParam($this->_sidResolver->getSessionIdQueryParam($this->_session), $sessionId);
        }
        return $this;
    }

_setActionName()

_setActionName (   $data )

protected

Set Action name Reseted route path if action name has change

Parameters

string

$data

Returns

\Magento\Framework\UrlInterface

Definition at line 684 of file Url.php.

    {
        if ($this->_getData('action_name') == $data) {
            return $this;
        }
        $this->unsetData('route_path');
        $this->setData('action_name', $data);
        $this->_queryParamsResolver->unsetData('secure');
        return $this;
    }

_setControllerName()

_setControllerName (   $data )

protected

Set Controller Name

Reset action name and route path if has change

Parameters

string

$data

Returns

\Magento\Framework\UrlInterface

Definition at line 656 of file Url.php.

    {
        if ($this->_getData('controller_name') == $data) {
            return $this;
        }
        $this->unsetData('route_path')->unsetData('action_name');
        $this->_queryParamsResolver->unsetData('secure');
        return $this->setData('controller_name', $data);
    }

_setQuery()

_setQuery (   $data )

protected

Set URL query param(s)

Parameters

mixed

$data

Returns

\Magento\Framework\UrlInterface

Definition at line 779 of file Url.php.

    {
        return $this->_queryParamsResolver->setQuery($data);
    }

_setRouteName()

_setRouteName (   $data )

protected

Set route name

Parameters

string

$data

Returns

\Magento\Framework\UrlInterface

Definition at line 607 of file Url.php.

    {
        if ($this->_getData('route_name') == $data) {
            return $this;
        }
        $this->unsetData('route_front_name')
            ->unsetData('route_path')
            ->unsetData('controller_name')
            ->unsetData('action_name');
        $this->_queryParamsResolver->unsetData('secure');
        return $this->setData('route_name', $data);
    }

_setRouteParams()

_setRouteParams ( array  $data,   $unsetOldParams = true  )

protected

Set route params

Parameters

array	$data
boolean	$unsetOldParams

Returns

\Magento\Framework\UrlInterface

Definition at line 713 of file Url.php.

    {
        $this->getRouteParamsResolver()->setRouteParams($data, $unsetOldParams);
        return $this;
    }

_setRoutePath()

_setRoutePath (   $data )

protected

Set Route Parameters

Parameters

string

$data

Returns

\Magento\Framework\UrlInterface @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 498 of file Url.php.

    {
        if ($this->_getData('route_path') == $data) {
            return $this;
        }

        $this->unsetData('route_path');
        $routePieces = explode('/', $data);

        $route = array_shift($routePieces);
        if ('*' === $route) {
            $route = $this->_getRequest()->getRouteName();
        }
        $this->_setRouteName($route);

        $controller = '';
        if (!empty($routePieces)) {
            $controller = array_shift($routePieces);
            if ('*' === $controller) {
                $controller = $this->_getRequest()->getControllerName();
            }
        }
        $this->_setControllerName($controller);

        $action = '';
        if (!empty($routePieces)) {
            $action = array_shift($routePieces);
            if ('*' === $action) {
                $action = $this->_getRequest()->getActionName();
            }
        }
        $this->_setActionName($action);

        if (!empty($routePieces)) {
            while (!empty($routePieces)) {
                $key = array_shift($routePieces);
                if (!empty($routePieces)) {
                    $value = array_shift($routePieces);
                    $this->getRouteParamsResolver()->setRouteParam($key, $value);
                }
            }
        }

        return $this;
    }

addQueryParams()

addQueryParams

(

array

$data

)

Add query Params as array

Parameters

array

$data

Returns

\Magento\Framework\UrlInterface

Implements UrlInterface.

Definition at line 801 of file Url.php.

    {
        $this->_queryParamsResolver->addQueryParams($data);
        return $this;
    }

addSessionParam()

addSessionParam

(

)

Add session param

Returns

\Magento\Framework\UrlInterface

Implements UrlInterface.

Definition at line 764 of file Url.php.

    {
        $this->setQueryParam(
            $this->_sidResolver->getSessionIdQueryParam($this->_session),
            $this->_session->getSessionId()
        );
        return $this;
    }

escape()

escape

(

$value

)

Escape (enclosure) URL string

Parameters

string

$value

Returns

string

Deprecated:

101.0.0

Implements UrlInterface.

Definition at line 1029 of file Url.php.

    {
        $value = str_replace('"', '%22', $value);
        $value = str_replace("'", '%27', $value);
        $value = str_replace('>', '%3E', $value);
        $value = str_replace('<', '%3C', $value);
        return $value;
    }

getBaseUrl()

getBaseUrl

(

$params = []

)

Retrieve Base URL

Parameters

array

$params

Returns

string

Original Scope

Add availability support urls without scope code

Implements UrlInterface.

Definition at line 453 of file Url.php.

    {
        $origScope = $this->_getScope();

        if (isset($params['_scope'])) {
            $this->setScope($params['_scope']);
        }
        if (isset($params['_type'])) {
            $this->getRouteParamsResolver()->setType($params['_type']);
        }

        if (isset($params['_secure'])) {
            $this->getRouteParamsResolver()->setSecure($params['_secure']);
        }

        if ($this->_getType() == UrlInterface::URL_TYPE_LINK
            && $this->_getRequest()->isDirectAccessFrontendName(
                $this->_getRouteFrontName()
            )
        ) {
            $this->getRouteParamsResolver()->setType(UrlInterface::URL_TYPE_DIRECT_LINK);
        }

        $result = $this->_getScope()->getBaseUrl($this->_getType(), $this->_isSecure());

        // setting back the original scope
        $this->setScope($origScope);
        $this->getRouteParamsResolver()->setType(self::DEFAULT_URL_TYPE);

        return $result;
    }

getConfigData()

getConfigData	(		$key,
			$prefix = null
	)

Retrieve configuration data

Parameters

string	$key
string | null	$prefix

Returns

string

Definition at line 307 of file Url.php.

    {
        if ($prefix === null) {
            $prefix = 'web/' . ($this->_isSecure() ? 'secure' : 'unsecure') . '/';
        }
        $path = $prefix . $key;

        $cacheId = $this->_getConfigCacheId($path);
        if (!isset(self::$_configDataCache[$cacheId])) {
            $data = $this->_getConfig($path);
            self::$_configDataCache[$cacheId] = $data;
        }

        return self::$_configDataCache[$cacheId];
    }

getCurrentUrl()

getCurrentUrl

(

)

Retrieve current url

Returns

string

Custom port

Implements UrlInterface.

Definition at line 1143 of file Url.php.

    {
        $httpHostWithPort = $this->_request->getHttpHost(false);
        $httpHostWithPort = explode(':', $httpHostWithPort);
        $httpHost = isset($httpHostWithPort[0]) ? $httpHostWithPort[0] : '';
        $port = '';
        if (isset($httpHostWithPort[1])) {
            $defaultPorts = [
                \Magento\Framework\App\Request\Http::DEFAULT_HTTP_PORT,
                \Magento\Framework\App\Request\Http::DEFAULT_HTTPS_PORT,
            ];
            if (!in_array($httpHostWithPort[1], $defaultPorts)) {
                $port = ':' . $httpHostWithPort[1];
            }
        }
        return $this->_request->getScheme() . '://' . $httpHost . $port . $this->_request->getRequestUri();
    }

getDirectUrl()

getDirectUrl	(		$url,
			$params = []
	)

Build url by direct url and parameters

Parameters

string	$url
array	$params

Returns

string

Implements UrlInterface.

Definition at line 1045 of file Url.php.

    {
        $params['_direct'] = $url;
        return $this->getUrl('', $params);
    }

getRebuiltUrl()

getRebuiltUrl

(

$url

)

Rebuild URL to handle the case when session ID was changed

Parameters

string

$url

Returns

string

Definition at line 996 of file Url.php.

    {
        $this->_parseUrl($url);
        $port = $this->getPort();
        if ($port) {
            $port = ':' . $port;
        } else {
            $port = '';
        }
        $url = $this->getScheme() . '://' . $this->getHost() . $port . $this->getPath();

        $this->_prepareSessionUrl($url);

        $query = $this->_getQuery();
        if ($query) {
            $url .= '?' . $query;
        }

        $fragment = $this->_getFragment();
        if ($fragment) {
            $url .= '#' . $this->getEscaper()->encodeUrlParam($fragment);
        }

        return $url;
    }

getRedirectUrl()

getRedirectUrl

(

$url

)

Return frontend redirect URL with SID and other session parameters if any

Parameters

string

$url

Returns

string

Implements UrlInterface.

Definition at line 1127 of file Url.php.

    {
        $this->_prepareSessionUrl($url);
        $query = $this->_getQuery(false);
        if ($query) {
            $url .= (strpos($url, '?') === false ? '?' : '&') . $query;
        }

        return $url;
    }

getRouteParamsResolver()

getRouteParamsResolver ( )

protected

Get Route Params Resolver

Returns

Url\RouteParamsResolverInterface

Definition at line 1167 of file Url.php.

    {
        if (!$this->_routeParamsResolver) {
            $this->_routeParamsResolver = $this->_routeParamsResolverFactory->create();
        }
        return $this->_routeParamsResolver;
    }

getRouteUrl()

getRouteUrl	(		$routePath = null,
			$routeParams = null
	)

Retrieve route URL

Parameters

string	$routePath
array	$routeParams

Returns

string

Implements UrlInterface.

Definition at line 736 of file Url.php.

    {
        if (filter_var($routePath, FILTER_VALIDATE_URL)) {
            return $routePath;
        }

        $this->getRouteParamsResolver()->unsetData('route_params');

        if (isset($routeParams['_direct'])) {
            if (is_array($routeParams)) {
                $this->_setRouteParams($routeParams, false);
            }
            return $this->getBaseUrl() . $routeParams['_direct'];
        }

        $this->_setRoutePath($routePath);
        if (is_array($routeParams)) {
            $this->_setRouteParams($routeParams, false);
        }

        return $this->getBaseUrl($routeParams) . $this->_getRoutePath($routeParams);
    }

getUrl()

getUrl	(		$routePath = null,
			$routeParams = null
	)

Build and cache url by requested path and parameters

Parameters

string | null	$routePath
array | null	$routeParams

Returns

string @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements UrlInterface.

Definition at line 839 of file Url.php.

    {
        if (filter_var($routePath, FILTER_VALIDATE_URL)) {
            return $routePath;
        }

        $routeParams = $this->routeParamsPreprocessor
            ->execute($this->_scopeResolver->getAreaCode(), $routePath, $routeParams);

        $isCached = true;
        $isArray = is_array($routeParams);

        if ($isArray) {
            array_walk_recursive(
                $routeParams,
                function ($item) use (&$isCached) {
                    if (is_object($item)) {
                        $isCached = false;
                    }
                }
            );
        }

        if (!$isCached) {
            return $this->getUrlModifier()->execute(
                $this->createUrl($routePath, $routeParams)
            );
        }

        $cachedParams = $routeParams;
        if ($isArray) {
            ksort($cachedParams);
        }

        $cacheKey = sha1($routePath . $this->serializer->serialize($cachedParams));
        if (!isset($this->cacheUrl[$cacheKey])) {
            $this->cacheUrl[$cacheKey] = $this->getUrlModifier()->execute(
                $this->createUrl($routePath, $routeParams)
            );
        }

        return $this->cacheUrl[$cacheKey];
    }

getUseSession()

getUseSession

(

)

Retrieve use session rule

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements UrlInterface.

Definition at line 292 of file Url.php.

    {
        if ($this->_useSession === null) {
            $this->_useSession = $this->_sidResolver->getUseSessionInUrl();
        }
        return $this->_useSession;
    }

isOwnOriginUrl()

isOwnOriginUrl

(

)

Check if users originated URL is one of the domain URLs assigned to scopes

Returns

boolean

Implements UrlInterface.

Definition at line 1115 of file Url.php.

    {
        return $this->hostChecker->isOwnOrigin($this->_request->getServer('HTTP_REFERER'));
    }

sessionUrlVar()

sessionUrlVar

(

$html

)

Replace Session ID value in URL

Parameters

string

$html

Returns

string

Callback function for session replace

Parameters

array

$match

Returns

string

Implements UrlInterface.

Definition at line 1057 of file Url.php.

    {
        return preg_replace_callback(
            '#(\?|&|&)___SID=([SU])(&|&)?#',
            // @codingStandardsIgnoreStart
            // @codingStandardsIgnoreEnd
            function ($match) {
                if ($this->useSessionIdForUrl($match[2] == 'S' ? true : false)) {
                    return $match[1] . $this->_sidResolver->getSessionIdQueryParam($this->_session) . '='
                        . $this->_session->getSessionId() . (isset($match[3]) ? $match[3] : '');
                } else {
                    if ($match[1] == '?') {
                        return isset($match[3]) ? '?' : '';
                    } elseif ($match[1] == '&' || $match[1] == '&') {
                        return $match[3] ?? '';
                    }
                }
            },
            $html
        );
    }

setQueryParam()

setQueryParam	(		$key,
			$data
	)

Set query param

Parameters

string	$key
mixed	$data

Returns

\Magento\Framework\UrlInterface

Implements UrlInterface.

Definition at line 814 of file Url.php.

    {
        $this->_queryParamsResolver->setQueryParam($key, $data);
        return $this;
    }

setRequest()

setRequest

(

\Magento\Framework\App\RequestInterface

$request

)

Set request

Parameters

\Magento\Framework\App\RequestInterface

$request

Returns

\Magento\Framework\UrlInterface

Definition at line 355 of file Url.php.

    {
        $this->_request = $request;
        return $this;
    }

setScope()

setScope

(

$params

)

Set scope entity

Parameters

mixed

$params

Returns

\Magento\Framework\UrlInterface

Implements UrlInterface.

Definition at line 427 of file Url.php.

    {
        $this->setData('scope', $this->_scopeResolver->getScope($params));
        $this->getRouteParamsResolver()->setScope($this->_scopeResolver->getScope($params));
        return $this;
    }

setUseSession()

setUseSession

(

$useSession

)

Set use session rule

Parameters

bool

$useSession

Returns

\Magento\Framework\UrlInterface

Definition at line 280 of file Url.php.

    {
        $this->_useSession = (bool) $useSession;
        return $this;
    }

useSessionIdForUrl()

useSessionIdForUrl

(

$secure = false

)

Check and return use SID for URL

Parameters

bool

$secure

Returns

bool

Definition at line 1091 of file Url.php.

    {
        $key = 'use_session_id_for_url_' . (int)$secure;
        if ($this->getData($key) === null) {
            $httpHost = $this->_request->getHttpHost();
            $urlHost = parse_url(
                $this->_getScope()->getBaseUrl(UrlInterface::URL_TYPE_LINK, $secure),
                PHP_URL_HOST
            );

            if ($httpHost != $urlHost) {
                $this->setData($key, true);
            } else {
                $this->setData($key, false);
            }
        }
        return $this->getData($key);
    }

Field Documentation

$_configDataCache

$_configDataCache

staticprotected

Definition at line 73 of file Url.php.

$_queryParamsResolver

$_queryParamsResolver

protected

Definition at line 157 of file Url.php.

$_request

$_request

protected

Definition at line 106 of file Url.php.

$_reservedRouteParams

$_reservedRouteParams

protected

Initial value:

= [
        '_scope',
        '_type',
        '_secure',
        '_forced_secure',
        '_use_rewrite',
        '_nosid',
        '_absolute',
        '_current',
        '_direct',
        '_fragment',
        '_escape',
        '_query',
        '_scope_to_url',
    ]

Definition at line 80 of file Url.php.

$_routeConfig

$_routeConfig

protected

Definition at line 137 of file Url.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 169 of file Url.php.

$_scopeResolver

$_scopeResolver

protected

Definition at line 152 of file Url.php.

$_scopeType

$_scopeType

protected

Definition at line 99 of file Url.php.

$_session

$_session

protected

Definition at line 125 of file Url.php.

$_sidResolver

$_sidResolver

protected

Definition at line 130 of file Url.php.

$_urlSecurityInfo

$_urlSecurityInfo

protected

Definition at line 120 of file Url.php.

$_useSession

$_useSession

protected

Definition at line 113 of file Url.php.

$routeParamsPreprocessor

$routeParamsPreprocessor

protected

Definition at line 174 of file Url.php.

---

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

• vendor/magento/framework/Url.php