TYPO3\CMS\Backend\Routing\Router

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	match()	0	13	3
A	matchRequest()	0	17	1
A	addRoute()	0	4	1
A	getRoutes()	0	3	1
A	__construct()	0	3	1
A	getRouteCollection()	0	3	1

<?php

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Backend\Routing;

use Psr\Http\Message\ServerRequestInterface;
use Symfony\Component\Routing\Matcher\UrlMatcher;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\Routing\Route as SymfonyRoute;
use Symfony\Component\Routing\RouteCollection as SymfonyRouteCollection;
use TYPO3\CMS\Backend\Routing\Exception\ResourceNotFoundException;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\HttpUtility;

/**
 * Implementation of a class for adding routes, collecting throughout the Bootstrap
 * to register all sorts of Backend Routes, and to fetch the main Collection in order
 * to resolve a route (see ->match() and ->matchRequest()).
 *
 * Ideally, the Router is solely instantiated and accessed via the Bootstrap, the RequestHandler and the UriBuilder.
 *
 * See \TYPO3\CMS\Backend\Http\RequestHandler for more details on route matching() and Bootstrap->initializeBackendRouting().
 *
 * The architecture is inspired by the Symfony Routing Component.
 */
class Router implements SingletonInterface
{
    /**
     * All routes used in the Backend
     * @var SymfonyRouteCollection
     */
    protected $routeCollection;

    public function __construct()
    {
        $this->routeCollection = new SymfonyRouteCollection();
    }
    /**
     * Adds a new route with the identifiers
     *
     * @param string $routeIdentifier
     * @param Route $route
     */
    public function addRoute($routeIdentifier, $route)
    {
        $symfonyRoute = new SymfonyRoute($route->getPath(), [], [], $route->getOptions());
        $this->routeCollection->add($routeIdentifier, $symfonyRoute);
    }

    /**
     * Fetch all registered routes, only use in UriBuilder
     *
     * @return Route[]
     */
    public function getRoutes(): iterable
    {
        return $this->routeCollection->getIterator();

The expression return $this->routeCollection->getIterator() returns the type ArrayIterator which is incompatible with the documented return type TYPO3\CMS\Backend\Routing\Route[].

    }

    /**
     * @internal only use in Core, this should not be exposed
     * @return SymfonyRouteCollection
     */
    public function getRouteCollection(): SymfonyRouteCollection
    {
        return $this->routeCollection;
    }

    /**
     * Tries to match a URL path with a set of routes.
     *
     * @param string $pathInfo The path info to be parsed
     * @return Route the first Route object found
     * @throws ResourceNotFoundException If the resource could not be found
     */
    public function match($pathInfo)
    {
        foreach ($this->routeCollection->getIterator() as $routeIdentifier => $route) {
            // This check is done in a simple way as there are no parameters yet (get parameters only)
            if ($route->getPath() === $pathInfo) {
                $routeResult = new Route($route->getPath(), $route->getOptions());
                // Store the name of the Route in the _identifier option so the token can be checked against that
                $routeResult->setOption('_identifier', $routeIdentifier);
                return $routeResult;
            }
        }

        throw new ResourceNotFoundException('The requested resource "' . $pathInfo . '" was not found.', 1425389240);
    }

    /**
     * Tries to match a URI against the registered routes
     *
     * @param ServerRequestInterface $request
     * @return Route the first Route object found
     */
    public function matchRequest(ServerRequestInterface $request)
    {
        // Allow the login page to be displayed if routing is not used and on index.php
        // (consolidate RouteDispatcher::evaluateReferrer() when changing 'login' to something different)
        $path = $request->getQueryParams()['route'] ?? $request->getParsedBody()['route'] ?? '/login';

        $context = new RequestContext(
            '',
            $request->getMethod(),
            (string)HttpUtility::idn_to_ascii($request->getUri()->getHost()),
            $request->getUri()->getScheme()
        );
        $result = (new UrlMatcher($this->routeCollection, $context))->match($path);
        $matchedSymfonyRoute = $this->routeCollection->get($result['_route']);
        $route = new Route($matchedSymfonyRoute->getPath(), $matchedSymfonyRoute->getOptions());
        $route->setOption('_identifier', $result['_route']);
        return $route;
    }
}