How is the base router (Magento\Framework\App\Router\Base) implemented?

dmitry_fedyuk · May 4, 2017, 6:52pm

Magento_Store/etc/frontend/di.xml

magento/magento2/blob/2.1.6/app/code/Magento/Store/etc/frontend/di.xml#L18-L22


<item name="standard" xsi:type="array">
    <item name="class" xsi:type="string">Magento\Framework\App\Router\Base</item>
    <item name="disable" xsi:type="boolean">false</item>
    <item name="sortOrder" xsi:type="string">20</item>
</item>

Magento\Framework\App\Router\Base::match()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/App/Router/Base.php#L151-L162


/**
 * Match provided request and if matched - return corresponding controller
 *
 * @param \Magento\Framework\App\RequestInterface $request
 * @return \Magento\Framework\App\ActionInterface|null
 */
public function match(\Magento\Framework\App\RequestInterface $request)
{
    $params = $this->parseRequest($request);


    return $this->matchAction($request, $params);
}

Magento\Framework\App\Router\Base::matchAction()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/App/Router/Base.php#L255-L322


/**
 * Create matched controller instance
 *
 * @param \Magento\Framework\App\RequestInterface $request
 * @param array $params
 * @return \Magento\Framework\App\ActionInterface|null
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
protected function matchAction(\Magento\Framework\App\RequestInterface $request, array $params)
{
    $moduleFrontName = $this->matchModuleFrontName($request, $params['moduleFrontName']);
    if (empty($moduleFrontName)) {
        return null;
    }


    /**
     * Searching router args by module name from route using it as key
     */
    $modules = $this->_routeConfig->getModulesByFrontName($moduleFrontName);


    if (empty($modules) === true) {
        return null;
    }


    /**
     * Going through modules to find appropriate controller
     */
    $currentModuleName = null;
    $actionPath = null;
    $action = null;
    $actionInstance = null;


    $actionPath = $this->matchActionPath($request, $params['actionPath']);
    $action = $request->getActionName() ?: ($params['actionName'] ?: $this->_defaultPath->getPart('action'));
    $this->_checkShouldBeSecure($request, '/' . $moduleFrontName . '/' . $actionPath . '/' . $action);


    foreach ($modules as $moduleName) {
        $currentModuleName = $moduleName;


        $actionClassName = $this->actionList->get($moduleName, $this->pathPrefix, $actionPath, $action);
        if (!$actionClassName || !is_subclass_of($actionClassName, $this->actionInterface)) {
            continue;
        }


        $actionInstance = $this->actionFactory->create($actionClassName);
        break;
    }


    if (null == $actionInstance) {
        $actionInstance = $this->getNotFoundAction($currentModuleName);
        if ($actionInstance === null) {
            return null;
        }
        $action = 'noroute';
    }


    // set values only after all the checks are done
    $request->setModuleName($moduleFrontName);
    $request->setControllerName($actionPath);
    $request->setActionName($action);
    $request->setControllerModule($currentModuleName);
    $request->setRouteName($this->_routeConfig->getRouteByFrontName($moduleFrontName));
    if (isset($params['variables'])) {
        $request->setParams($params['variables']);
    }
    return $actionInstance;
}

dmitry_fedyuk · May 4, 2017, 6:53pm