Router Class Reference

Inheritance diagram for Router:

Protected Member Functions
	_shouldRedirectToSecure ()
Protected Member Functions inherited from Base
	parseRequest (\Magento\Framework\App\RequestInterface $request)
	matchModuleFrontName (\Magento\Framework\App\RequestInterface $request, $param)
	matchActionPath (\Magento\Framework\App\RequestInterface $request, $param)
	getNotFoundAction ($currentModuleName)
	matchAction (\Magento\Framework\App\RequestInterface $request, array $params)
	_checkShouldBeSecure (\Magento\Framework\App\RequestInterface $request, $path='')
	_shouldRedirectToSecure ()

Protected Attributes
	$_url
	$_requiredParams = ['areaFrontName', 'moduleFrontName', 'actionPath', 'actionName']
	$applyNoRoute = true
	$pathPrefix = \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE
Protected Attributes inherited from Base
	$actionFactory
	$actionInterface = \Magento\Framework\App\ActionInterface::class
	$_modules = []
	$_dispatchData = []
	$_requiredParams = ['moduleFrontName', 'actionPath', 'actionName']
	$_routeConfig
	$_urlSecurityInfo
	$_scopeConfig
	$_url
	$_storeManager
	$_responseFactory
	$_defaultPath
	$nameBuilder
	$reservedNames = ['new', 'print', 'switch', 'return']
	$applyNoRoute = false
	$pathPrefix = null
	$actionList
	$pathConfig

Additional Inherited Members
Public Member Functions inherited from Base
	__construct (\Magento\Framework\App\Router\ActionList $actionList, \Magento\Framework\App\ActionFactory $actionFactory, \Magento\Framework\App\DefaultPathInterface $defaultPath, \Magento\Framework\App\ResponseFactory $responseFactory, \Magento\Framework\App\Route\ConfigInterface $routeConfig, \Magento\Framework\UrlInterface $url, \Magento\Framework\Code\NameBuilder $nameBuilder, \Magento\Framework\App\Router\PathConfigInterface $pathConfig)
	match (\Magento\Framework\App\RequestInterface $request)
	getActionClassName ($module, $actionPath)
Public Member Functions inherited from RouterInterface
	match (RequestInterface $request)
Data Fields inherited from Base
const	NO_ROUTE = 'noroute'

Detailed Description

@api

Since

100.0.2

Definition at line 15 of file Router.php.

Member Function Documentation

_shouldRedirectToSecure()

_shouldRedirectToSecure ( )

protected

Check whether redirect should be used for secure routes

Returns

bool

Definition at line 48 of file Router.php.

    {
        return false;
    }

Field Documentation

$_requiredParams

$_requiredParams = ['areaFrontName', 'moduleFrontName', 'actionPath', 'actionName']

protected

Definition at line 28 of file Router.php.

$_url

$_url

protected

Definition at line 20 of file Router.php.

$applyNoRoute

$applyNoRoute = true

protected

Definition at line 36 of file Router.php.

$pathPrefix

$pathPrefix = \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE

protected

Definition at line 41 of file Router.php.

---

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

• vendor/magento/module-backend/App/Router.php