How is a frontend page's absense (404 Not found, no route, «Whoops, our bad») handled?

dmitry_fedyuk (Dmitry Fedyuk) May 4, 2017, 7:15pm #1

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/App/FrontController.php#L47-L50


/** @var \Magento\Framework\App\RouterInterface $router */
foreach ($this->_routerList as $router) {
    try {
        $actionInstance = $router->match($request);

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Store/etc/frontend/di.xml#L23-L27


<item name="default" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Framework\App\Router\DefaultRouter</item>
    <item name="disable" xsi:type="boolean">false</item>
    <item name="sortOrder" xsi:type="string">100</item>
</item>

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/App/Router/DefaultRouter.php#L36-L51


/**
 * Modify request and set to no-route action
 *
 * @param RequestInterface $request
 * @return boolean
 */
public function match(RequestInterface $request)
{
    foreach ($this->noRouteHandlerList->getHandlers() as $noRouteHandler) {
        if ($noRouteHandler->process($request)) {
            break;
        }
    }


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

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Store/etc/di.xml#L203-L212


<type name="Magento\Framework\App\Router\NoRouteHandlerList">
    <arguments>
        <argument name="handlerClassesList" xsi:type="array">
            <item name="default" xsi:type="array">
                <item name="class" xsi:type="string">Magento\Framework\App\Router\NoRouteHandler</item>
                <item name="sortOrder" xsi:type="string">100</item>
            </item>
        </argument>
    </arguments>
</type>

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/App/Router/NoRouteHandler.php#L32-L34


public function process(\Magento\Framework\App\RequestInterface $request)
{
    $noRoutePath = $this->_config->getValue('web/default/no_route', 'default');

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/App/Router/NoRouteHandler.php#L35-L44




if ($noRoutePath) {
    $noRoute = explode('/', $noRoutePath);
} else {
    $noRoute = [];
}


$moduleName = isset($noRoute[0]) ? $noRoute[0] : 'core';
$actionPath = isset($noRoute[1]) ? $noRoute[1] : 'index';
$actionName = isset($noRoute[2]) ? $noRoute[2] : 'index';

github.com

magento/magento2/blob/1464a2c/lib/internal/Magento/Framework/App/Router/NoRouteHandler.php#L46-L48


$request->setModuleName($moduleName)->setControllerName($actionPath)->setActionName($actionName);


return true;

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Cms/Controller/Noroute/Index.php#L28-L44


/**
 * Render CMS 404 Not found page
 *
 * @return \Magento\Framework\Controller\ResultInterface
 */
public function execute()
{
    $pageId = $this->_objectManager->get(
        'Magento\Framework\App\Config\ScopeConfigInterface',
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE
    )->getValue(
        \Magento\Cms\Helper\Page::XML_PATH_NO_ROUTE_PAGE,
        \Magento\Store\Model\ScopeInterface::SCOPE_STORE
    );
    /** @var \Magento\Cms\Helper\Page $pageHelper */
    $pageHelper = $this->_objectManager->get('Magento\Cms\Helper\Page');
    $resultPage = $pageHelper->prepareResultPage($this, $pageId);

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Cms/Helper/Page.php#L154-L155


$resultPage->addHandle('cms_page_view');
$resultPage->addPageLayoutHandles(['id' => $this->_page->getIdentifier()]);

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Cms/Helper/Page.php#L157-L160


$this->_eventManager->dispatch(
    'cms_page_render',
    ['page' => $this->_page, 'controller_action' => $action]
);

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Cms/Helper/Page.php#L162-L169


if ($this->_page->getCustomLayoutUpdateXml() && $inRange) {
    $layoutUpdate = $this->_page->getCustomLayoutUpdateXml();
} else {
    $layoutUpdate = $this->_page->getLayoutUpdateXml();
}
if (!empty($layoutUpdate)) {
    $resultPage->getLayout()->getUpdate()->addUpdate($layoutUpdate);
}

github.com

magento/magento2/blob/1464a2c/app/code/Magento/Cms/Helper/Page.php#L171-L175


$contentHeadingBlock = $resultPage->getLayout()->getBlock('page_content_heading');
if ($contentHeadingBlock) {
    $contentHeading = $this->_escaper->escapeHtml($this->_page->getContentHeading());
    $contentHeadingBlock->setContentHeading($contentHeading);
}

Further reading: How is a frontend page rendered?

How is the default router (Magento\Framework\App\Router\DefaultRouter) implemented?

How is a CMS page rendered?

dmitry_fedyuk (Dmitry Fedyuk) May 4, 2017, 10:37pm #2

See also: