How is the CMS frontend router (Magento\Cms\Controller\Router) implemented?

dmitry_fedyuk · May 4, 2017, 11:45am

Magento_Cms/etc/frontend/di.xml

magento/magento2/blob/2.1.6/app/code/Magento/Cms/etc/frontend/di.xml#L9-L19


<type name="Magento\Framework\App\RouterList">
    <arguments>
        <argument name="routerList" xsi:type="array">
            <item name="cms" xsi:type="array">
                <item name="class" xsi:type="string">Magento\Cms\Controller\Router</item>
                <item name="disable" xsi:type="boolean">false</item>
                <item name="sortOrder" xsi:type="string">60</item>
            </item>
        </argument>
    </arguments>
</type>

Magento\Cms\Controller\Router

Magento\Framework\App\RouterInterface

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/App/RouterInterface.php#L10-L19


interface RouterInterface
{
/**
 * Match application action by request
 *
 * @param RequestInterface $request
 * @return ActionInterface
 */
public function match(RequestInterface $request);
}

Magento\Cms\Controller\Router::match()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Cms/Controller/Router.php#L86-L124


/**
 * Validate and Match Cms Page and modify request
 *
 * @param \Magento\Framework\App\RequestInterface $request
 * @return bool
 */
public function match(\Magento\Framework\App\RequestInterface $request)
{
    $identifier = trim($request->getPathInfo(), '/');


    $condition = new \Magento\Framework\DataObject(['identifier' => $identifier, 'continue' => true]);
    $this->_eventManager->dispatch(
        'cms_controller_router_match_before',
        ['router' => $this, 'condition' => $condition]
    );
    $identifier = $condition->getIdentifier();


    if ($condition->getRedirectUrl()) {
        $this->_response->setRedirect($condition->getRedirectUrl());
        $request->setDispatched(true);
        return $this->actionFactory->create('Magento\Framework\App\Action\Redirect');
    }


    if (!$condition->getContinue()) {
        return null;
    }


    /** @var \Magento\Cms\Model\Page $page */
    $page = $this->_pageFactory->create();
    $pageId = $page->checkIdentifier($identifier, $this->_storeManager->getStore()->getId());
    if (!$pageId) {
        return null;
    }


    $request->setModuleName('cms')->setControllerName('page')->setActionName('view')->setParam('page_id', $pageId);
    $request->setAlias(\Magento\Framework\Url::REWRITE_REQUEST_PATH_ALIAS, $identifier);


    return $this->actionFactory->create('Magento\Framework\App\Action\Forward');
}

An example of $request

dmitry_fedyuk · May 4, 2017, 11:45am