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, \Magento\Backend\Helper\Data $backendHelper, \Magento\Backend\Model\Menu\Config $menuConfig, \Magento\Framework\App\CacheInterface $cache, \Magento\Backend\Model\Auth\Session $authSession, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Store\Model\StoreFactory $storeFactory, \Magento\Framework\Data\Form\FormKey $formKey, array $data=[], HostChecker $hostChecker=null, Json $serializer=null)

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

	getSecretKey ($routeName=null, $controller=null, $action=null)

	useSecretKey ()

	turnOnSecretKey ()

	turnOffSecretKey ()

	renewSecretUrls ()

	getStartupPageUrl ()

	findFirstAvailableMenu ()

	setSession (\Magento\Backend\Model\Auth\Session $session)

	getAreaFrontName ()

Public Member Functions inherited from Url
	__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)

Data Fields
const	XML_PATH_USE_SECURE_KEY = 'admin/security/use_form_key'

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'

Data Fields inherited from UrlInterface
const	SECRET_KEY_PARAM_NAME = 'key'

const	XML_PATH_STARTUP_MENU_ITEM = 'admin/startup/menu_item_id'

Protected Member Functions
	_isSecure ()

	_setRouteParams (array $data, $unsetOldParams=true)

	_getMenu ()

	_getSession ()

	_getActionPath ()

	_getScope ()

	_getConfigCacheId ($path)

	_getConfig ($path)

Protected Member Functions inherited from Url
	_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
	$_session

	$_menu

	$_startupMenuItemId

	$_backendHelper

	$_menuConfig

	$_cache

	$_encryptor

	$_storeFactory

	$formKey

	$_scope

Protected Attributes inherited from Url
	$_reservedRouteParams

	$_scopeType

	$_request

	$_useSession

	$_urlSecurityInfo

	$_session

	$_sidResolver

	$_routeConfig

	$_scopeResolver

	$_queryParamsResolver

	$_scopeConfig

	$routeParamsPreprocessor

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from Url
static	$_configDataCache

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

Detailed Description

Class \Magento\Backend\Model\UrlInterface

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 19 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,
		\Magento\Backend\Helper\Data	$backendHelper,
		\Magento\Backend\Model\Menu\Config	$menuConfig,
		\Magento\Framework\App\CacheInterface	$cache,
		\Magento\Backend\Model\Auth\Session	$authSession,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Store\Model\StoreFactory	$storeFactory,
		\Magento\Framework\Data\Form\FormKey	$formKey,
		array	$data = `[]`,
		HostChecker	$hostChecker = `null`,
		Json	$serializer = `null`
	)

Constructor

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
\Magento\Backend\Helper\Data	$backendHelper
Menu\Config	$menuConfig
\Magento\Framework\App\CacheInterface	$cache
Auth\Session	$authSession
\Magento\Framework\Encryption\EncryptorInterface	$encryptor
\Magento\Store\Model\StoreFactory	$storeFactory
\Magento\Framework\Data\Form\FormKey	$formKey
array	$data
HostChecker \| null	$hostChecker
Json	$serializer	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 110 of file Url.php.

       {
         $this->_encryptor = $encryptor;
         $hostChecker = $hostChecker ?: ObjectManager::getInstance()->get(HostChecker::class);
         parent::__construct(
             $routeConfig,
             $request,
             $urlSecurityInfo,
             $scopeResolver,
             $session,
             $sidResolver,
             $routeParamsResolverFactory,
             $queryParamsResolver,
             $scopeConfig,
             $routeParamsPreprocessor,
             $scopeType,
             $data,
             $hostChecker,
             $serializer
         );
         $this->_backendHelper = $backendHelper;
         $this->_menuConfig = $menuConfig;
         $this->_cache = $cache;
         $this->_session = $authSession;
         $this->formKey = $formKey;
         $this->_storeFactory = $storeFactory;
     }

Member Function Documentation

◆ _getActionPath()

_getActionPath ( )

protected

Retrieve action path. Add backend area front name as a prefix to action path

Returns: string

Definition at line 410 of file Url.php.

     {
         $path = parent::_getActionPath();
         if ($path) {
             if ($this->getAreaFrontName()) {
                 $path = $this->getAreaFrontName() . '/' . $path;
             }
         }
         return $path;
     }

◆ _getConfig()

_getConfig ( $path )

protected

Get config data by path Use only global config values for backend

Parameters

string $path

Returns: null|string

Definition at line 457 of file Url.php.

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

◆ _getConfigCacheId()

_getConfigCacheId ( $path )

protected

Get cache id for config path

Parameters

string $path

Returns: string

Definition at line 445 of file Url.php.

     {
         return 'admin/' . $path;
     }

◆ _getMenu()

_getMenu ( )

protected

Get Menu model

Returns: \Magento\Backend\Model\Menu

Definition at line 361 of file Url.php.

     {
         if ($this->_menu === null) {
             $this->_menu = $this->_menuConfig->getMenu();
         }
         return $this->_menu;
     }

◆ _getScope()

_getScope ( )

protected

Get scope for the url instance

Returns: \Magento\Store\Model\Store

Definition at line 426 of file Url.php.

     {
         if (!$this->_scope) {
             $this->_scope = $this->_storeFactory->create(
                 [
                     'url' => $this,
                     'data' => ['code' => 'admin', 'force_disable_rewrites' => false, 'disable_store_in_url' => true],
                 ]
             );
         }
         return $this->_scope;
     }

◆ _getSession()

_getSession ( )

protected

Retrieve auth session

Returns: \Magento\Backend\Model\Auth\Session

Definition at line 386 of file Url.php.

     {
         return $this->_session;
     }

◆ _isSecure()

_isSecure ( )

protected

Retrieve is secure mode for ULR logic

Returns: bool

Definition at line 164 of file Url.php.

     {
         if ($this->hasData('secure_is_forced')) {
             return $this->getData('secure');
         }
         return $this->_scopeConfig->isSetFlag('web/secure/use_in_adminhtml');
     }

◆ _setRouteParams()

_setRouteParams	(	array	$data,
			$unsetOldParams = `true`
	)

protected

Force strip secret key param if _nosecret param specified

Parameters

array	$data
bool	$unsetOldParams

Returns: $this

Definition at line 179 of file Url.php.

     {
         if (isset($data['_nosecret'])) {
             $this->setNoSecret(true);
             unset($data['_nosecret']);
         } else {
             $this->setNoSecret(false);
         }
         unset($data['_scope_to_url']);
         return parent::_setRouteParams($data, $unsetOldParams);
     }

◆ findFirstAvailableMenu()

findFirstAvailableMenu ( )

Find first menu item that user is able to access

Returns: string

Implements UrlInterface.

Definition at line 340 of file Url.php.

     {
         /* @var $menu \Magento\Backend\Model\Menu\Item */
         $menu = $this->_getMenu();
         $item = $menu->getFirstAvailable();
         $action = $item ? $item->getAction() : null;
         if (!$item) {
             $user = $this->_getSession()->getUser();
             if ($user) {
                 $user->setHasAvailableResources(false);
             }
             $action = '*/*/denied';
         }
         return $action;
     }

◆ getAreaFrontName()

getAreaFrontName ( )

Return backend area front name, defined in configuration

Returns: string

Implements UrlInterface.

Definition at line 396 of file Url.php.

     {
         if (!$this->_getData('area_front_name')) {
             $this->setData('area_front_name', $this->_backendHelper->getAreaFrontName());
         }
         return $this->_getData('area_front_name');
     }

◆ getSecretKey()

getSecretKey	(	$routeName = `null`,
		$controller = `null`,
		$action = `null`
	)

Generate secret key for controller and action based on form key

Parameters

string	$routeName
string	$controller	Controller name
string	$action	Action name

Returns: string

Implements UrlInterface.

Definition at line 246 of file Url.php.

     {
         $salt = $this->formKey->getFormKey();
         $request = $this->_getRequest();
         if (!$routeName) {
             if ($request->getBeforeForwardInfo('route_name') !== null) {
                 $routeName = $request->getBeforeForwardInfo('route_name');
             } else {
                 $routeName = $request->getRouteName();
             }
         }
         if (!$controller) {
             if ($request->getBeforeForwardInfo('controller_name') !== null) {
                 $controller = $request->getBeforeForwardInfo('controller_name');
             } else {
                 $controller = $request->getControllerName();
             }
         }
         if (!$action) {
             if ($request->getBeforeForwardInfo('action_name') !== null) {
                 $action = $request->getBeforeForwardInfo('action_name');
             } else {
                 $action = $request->getActionName();
             }
         }
         $secret = $routeName . $controller . $action . $salt;
         return $this->_encryptor->getHash($secret);
     }

◆ getStartupPageUrl()

getStartupPageUrl ( )

Find admin start page url

Returns: string

Implements UrlInterface.

Definition at line 322 of file Url.php.

     {
         $menuItem = $this->_getMenu()->get(
             $this->_scopeConfig->getValue(self::XML_PATH_STARTUP_MENU_ITEM, $this->_scopeType)
         );
         if ($menuItem !== null) {
             if ($menuItem->isAllowed() && $menuItem->getAction()) {
                 return $menuItem->getAction();
             }
         }
         return $this->findFirstAvailableMenu();
     }

◆ getUrl()

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

Custom logic to retrieve Urls

Parameters

string	$routePath
array	$routeParams

Returns: string

Implements UrlInterface.

Definition at line 198 of file Url.php.

     {
         if (filter_var($routePath, FILTER_VALIDATE_URL)) {
             return $routePath;
         }
 
         $cacheSecretKey = false;
         if (isset($routeParams['_cache_secret_key'])) {
             unset($routeParams['_cache_secret_key']);
             $cacheSecretKey = true;
         }
         $result = parent::getUrl($routePath, $routeParams);
         if (!$this->useSecretKey()) {
             return $result;
         }
 
         $this->getRouteParamsResolver()->unsetData('route_params');
         $this->_setRoutePath($routePath);
         $extraParams = $this->getRouteParamsResolver()->getRouteParams();
         $routeName = $this->_getRouteName('*');
         $controllerName = $this->_getControllerName(self::DEFAULT_CONTROLLER_NAME);
         $actionName = $this->_getActionName(self::DEFAULT_ACTION_NAME);
 
         if (!isset($routeParams[self::SECRET_KEY_PARAM_NAME])) {
             if (!is_array($routeParams)) {
                 $routeParams = [];
             }
             $secretKey = $cacheSecretKey
                 ? "\${$routeName}/{$controllerName}/{$actionName}\$"
                 : $this->getSecretKey($routeName, $controllerName, $actionName);
             $routeParams[self::SECRET_KEY_PARAM_NAME] = $secretKey;
         }
 
         if (!empty($extraParams)) {
             $routeParams = array_merge($extraParams, $routeParams);
         }
 
         return parent::getUrl("{$routeName}/{$controllerName}/{$actionName}", $routeParams);
     }

◆ renewSecretUrls()

renewSecretUrls ( )

Refresh admin menu cache etc.

Returns: void

Implements UrlInterface.

Definition at line 312 of file Url.php.

     {
         $this->_cache->clean([\Magento\Backend\Block\Menu::CACHE_TAGS]);
     }

◆ setSession()

setSession ( \Magento\Backend\Model\Auth\Session $session )

Set custom auth session

Parameters

\Magento\Backend\Model\Auth\Session $session

Returns: $this

Implements UrlInterface.

Definition at line 375 of file Url.php.

     {
         $this->_session = $session;
         return $this;
     }

◆ turnOffSecretKey()

turnOffSecretKey ( )

Disable secret key using

Returns: $this

Implements UrlInterface.

Definition at line 301 of file Url.php.

     {
         $this->setNoSecret(true);
         return $this;
     }

◆ turnOnSecretKey()

turnOnSecretKey ( )

Enable secret key using

Returns: $this

Implements UrlInterface.

Definition at line 290 of file Url.php.

     {
         $this->setNoSecret(false);
         return $this;
     }

◆ useSecretKey()

useSecretKey ( )

Return secret key settings flag

Returns: bool

Implements UrlInterface.

Definition at line 280 of file Url.php.

     {
         return $this->_scopeConfig->isSetFlag(self::XML_PATH_USE_SECURE_KEY) && !$this->getNoSecret();
     }

Field Documentation

◆ $_backendHelper

$_backendHelper

protected

Definition at line 50 of file Url.php.

◆ $_cache

$_cache

protected

Definition at line 62 of file Url.php.

◆ $_encryptor

$_encryptor

protected

Definition at line 67 of file Url.php.

◆ $_menu

$_menu

protected

Definition at line 38 of file Url.php.

◆ $_menuConfig

$_menuConfig

protected

Definition at line 57 of file Url.php.

◆ $_scope

$_scope

protected

Definition at line 82 of file Url.php.

◆ $_session

$_session

protected

Definition at line 33 of file Url.php.

◆ $_startupMenuItemId

$_startupMenuItemId

protected

Definition at line 45 of file Url.php.

◆ $_storeFactory

$_storeFactory

protected

Definition at line 72 of file Url.php.

◆ $formKey

$formKey

protected

Definition at line 77 of file Url.php.

◆ XML_PATH_USE_SECURE_KEY

const XML_PATH_USE_SECURE_KEY = 'admin/security/use_form_key'

Whether to use a security key in the backend

Bug:: Currently, this constant is slightly misleading: it says "form key", but in fact it is used by URLs, too

Definition at line 26 of file Url.php.

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

vendor/magento/module-backend/Model/Url.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getActionPath()

◆ _getConfig()

◆ _getConfigCacheId()

◆ _getMenu()

◆ _getScope()

◆ _getSession()

◆ _isSecure()

◆ _setRouteParams()

◆ findFirstAvailableMenu()

◆ getAreaFrontName()

◆ getSecretKey()

◆ getStartupPageUrl()

◆ getUrl()

◆ renewSecretUrls()

◆ setSession()

◆ turnOffSecretKey()

◆ turnOnSecretKey()

◆ useSecretKey()

Field Documentation

◆ $_backendHelper

◆ $_cache

◆ $_encryptor

◆ $_menu

◆ $_menuConfig

◆ $_scope

◆ $_session

◆ $_startupMenuItemId

◆ $_storeFactory

◆ $formKey

◆ XML_PATH_USE_SECURE_KEY