Router Class Reference

Inheritance diagram for Router:

Public Member Functions
	__construct (\Magento\Framework\App\ActionFactory $actionFactory, UrlInterface $url, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\App\ResponseInterface $response, UrlFinderInterface $urlFinder)
	match (RequestInterface $request)

Protected Member Functions
	processRedirect ($request, $rewrite)
	redirect ($request, $url, $code)
	getRewrite ($requestPath, $storeId)

Protected Attributes
	$actionFactory
	$url
	$storeManager
	$response
	$urlFinder

Detailed Description

UrlRewrite Controller Router

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 23 of file Router.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\ActionFactory	$actionFactory,
		UrlInterface	$url,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\App\ResponseInterface	$response,
		UrlFinderInterface	$urlFinder
	)

Parameters

\Magento\Framework\App\ActionFactory	$actionFactory
UrlInterface	$url
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\App\ResponseInterface	$response
UrlFinderInterface	$urlFinder

Definition at line 57 of file Router.php.

      {
        $this->actionFactory = $actionFactory;
        $this->url = $url;
        $this->storeManager = $storeManager;
        $this->response = $response;
        $this->urlFinder = $urlFinder;
    }

Member Function Documentation

getRewrite()

getRewrite (   $requestPath,   $storeId  )

protected

Parameters

string	$requestPath
int	$storeId

Returns

UrlRewrite|null

Definition at line 142 of file Router.php.

    {
        return $this->urlFinder->findOneByData([
            UrlRewrite::REQUEST_PATH => ltrim($requestPath, '/'),
            UrlRewrite::STORE_ID => $storeId,
        ]);
    }

match()

match

(

RequestInterface

$request

)

Match corresponding URL Rewrite and modify request.

Parameters

RequestInterface | HttpRequest

$request

Returns

ActionInterface|null

Implements RouterInterface.

Definition at line 78 of file Router.php.

    {
        $rewrite = $this->getRewrite(
            $request->getPathInfo(),
            $this->storeManager->getStore()->getId()
        );

        if ($rewrite === null) {
            //No rewrite rule matching current URl found, continuing with
            //processing of this URL.
            return null;
        }
        if ($rewrite->getRedirectType()) {
            //Rule requires the request to be redirected to another URL
            //and cannot be processed further.
            return $this->processRedirect($request, $rewrite);
        }
        //Rule provides actual URL that can be processed by a controller.
        $request->setAlias(
            UrlInterface::REWRITE_REQUEST_PATH_ALIAS,
            $rewrite->getRequestPath()
        );
        $request->setPathInfo('/' . $rewrite->getTargetPath());
        return $this->actionFactory->create(
            \Magento\Framework\App\Action\Forward::class
        );
    }

processRedirect()

processRedirect (   $request,   $rewrite  )

protected

Parameters

RequestInterface	$request
UrlRewrite	$rewrite

Returns

ActionInterface|null

Definition at line 112 of file Router.php.

    {
        $target = $rewrite->getTargetPath();
        if ($rewrite->getEntityType() !== Rewrite::ENTITY_TYPE_CUSTOM
            || ($prefix = substr($target, 0, 6)) !== 'http:/' && $prefix !== 'https:'
        ) {
            $target = $this->url->getUrl('', ['_direct' => $target]);
        }
        return $this->redirect($request, $target, $rewrite->getRedirectType());
    }

redirect()

redirect (   $request,   $url,   $code  )

protected

Parameters

RequestInterface | HttpRequest	$request
string	$url
int	$code

Returns

ActionInterface

Definition at line 129 of file Router.php.

    {
        $this->response->setRedirect($url, $code);
        $request->setDispatched(true);

        return $this->actionFactory->create(Redirect::class);
    }

Field Documentation

$actionFactory

$actionFactory

protected

Definition at line 28 of file Router.php.

$response

$response

protected

Definition at line 43 of file Router.php.

$storeManager

$storeManager

protected

Definition at line 38 of file Router.php.

$url

Magento Framework UrlInterface $url

protected

Definition at line 33 of file Router.php.

$urlFinder

$urlFinder

protected

Definition at line 48 of file Router.php.

---

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

• vendor/magento/module-url-rewrite/Controller/Router.php